automate branded client

Author: PrajwolAmatya

.gitignore

@@ -178,3 +178,4 @@ FakesAssemblies/
 test/gui/config.ini
 test/gui/reports
 */**/__pycache__/
+test/gui/users.json

test/gui/shared/scripts/bdd_hooks.py

@@ -35,6 +35,7 @@
 from helpers.FilesHelper import prefix_path_namespace, cleanup_created_paths
 from helpers.ReportHelper import save_video_recording, take_screenshot, is_video_enabled
 import helpers.api.oc10 as oc
+from helpers.UserHelper import init_predefined_users
 
 from pageObjects.Toolbar import Toolbar
 from pageObjects.AccountSetting import AccountSetting
@@ -56,6 +57,8 @@
 @OnFeatureStart
 def hook(context):
     init_config()
+    if get_config("predefined_users"):
+        init_predefined_users()
 
 
 # runs before every scenario

test/gui/shared/scripts/helpers/ConfigHelper.py

@@ -74,6 +74,8 @@ def get_default_home_dir():
     'tempFolderPath': 'TEMP_FOLDER_PATH',
     'clientConfigDir': 'CLIENT_CONFIG_DIR',
     'guiTestReportDir': 'GUI_TEST_REPORT_DIR',
+    'branded_client': 'BRANDED_CLIENT',
+    'predefined_users': 'PREDEFINED_USERS',
     'ocis': 'OCIS',
     'record_video_on_failure': 'RECORD_VIDEO_ON_FAILURE',
 }
@@ -97,6 +99,8 @@ def get_default_home_dir():
     'tempFolderPath': os.path.join(get_client_root_path(), 'temp'),
     'clientConfigDir': get_config_home(),
     'guiTestReportDir': os.path.abspath('../reports'),
+    'branded_client': 'ocis',
+    'predefined_users': False,
     'ocis': False,
     'record_video_on_failure': False,
     'files_for_upload': os.path.join(CURRENT_DIR.parent.parent, 'files-for-upload'),

test/gui/shared/scripts/helpers/SetupClientHelper.py

@@ -10,6 +10,8 @@
 from helpers.ConfigHelper import get_config, set_config, is_windows
 from helpers.ReportHelper import is_video_enabled
 
+from helpers.UserHelper import get_username_for_user, get_password_for_user
+
 
 def substitute_inline_codes(value):
     value = value.replace('%local_server%', get_config('localBackendUrl'))
@@ -37,9 +39,8 @@ def get_client_details(details):
         if row[0] == 'server':
             client_details.update({'server': row[1]})
         elif row[0] == 'user':
-            client_details.update({'user': row[1]})
-        elif row[0] == 'password':
-            client_details.update({'password': row[1]})
+            client_details.update({'user': get_username_for_user(row[1])})
+            client_details.update({'password': get_password_for_user(row[1])})
         elif row[0] == 'sync_folder':
             client_details.update({'sync_folder': row[1]})
     return client_details

test/gui/shared/scripts/helpers/UserHelper.py

@@ -1,5 +1,7 @@
 from base64 import b64encode
 from typing import NamedTuple
+import json
+import os
 
 
 class User(NamedTuple):
@@ -72,3 +74,20 @@ def get_displayname_for_user(username):
 
 def get_password_for_user(username):
     return get_user_info(username, "password")
+
+
+def get_username_for_user(username):
+    return get_user_info(username, "username")
+
+
+def init_predefined_users():
+    global test_users
+    with open(os.path.abspath("../users.json")) as f:
+        users = json.load(f)
+        for key, value in users.items():
+            test_users.update({key: User(
+                username=value["username"],
+                password=value["password"],
+                displayname=value["displayname"],
+                email=value["email"],
+            )})

test/gui/shared/scripts/helpers/WebUIHelper.py

@@ -1,4 +1,5 @@
 import re
+import random
 import squish
 from playwright.sync_api import sync_playwright, expect
 

test/gui/shared/scripts/helpers/api/provisioning.py

@@ -32,6 +32,9 @@ def add_user_to_group(user, group_name):
 
 
 def create_user(username):
+    if get_config("predefined_users"):
+        return
+
     if username in UserHelper.test_users:
         user = UserHelper.test_users[username]
     else:

test/gui/shared/steps/account_context.py

@@ -10,7 +10,7 @@
     get_client_details,
     get_resource_path,
 )
-from helpers.UserHelper import get_displayname_for_user, get_password_for_user
+from helpers.UserHelper import get_displayname_for_user, get_password_for_user, get_username_for_user
 from helpers.SyncHelper import (
     wait_for_initial_sync_to_complete,
     listen_sync_status_for_item,
@@ -28,6 +28,8 @@ def step(context):
 
 @Then('the account with displayname "|any|" and host "|any|" should be displayed')
 def step(context, displayname, _):
+    if get_config('predefined_users'):
+        displayname = get_displayname_for_user(displayname.split()[0].strip())
     displayname = substitute_inline_codes(displayname)
     Toolbar.account_exists(displayname)
 
@@ -48,9 +50,8 @@ def step(context, displayname, host):
 
 @Given('user "|any|" has set up a client with default settings')
 def step(context, username):
-    password = get_password_for_user(username)
     account_details = get_client_details(
-        [['server', '%local_server%'], ['user', username], ['password', password]]
+        [['server', '%local_server%'], ['user', username]]
     )
     start_client()
     AccountConnectionWizard.add_account(account_details)