[full-ci][gui-tests] Extend oAuth2 scenario (#11067)

* Update test.feature

* Update test.feature

* add step implementation for oauth2 login

* properly wait for AUT context to get removed

* login via oauth2 and wait for sync completion

* listen sync path if available

* fix oauth relogin

* refactor

---------

Co-authored-by: Salipa-Gurung <salipagurung@gmail.com>
Co-authored-by: Saw-jan <saw.jan.grg3e@gmail.com>

Author: 3 people

test/gui/shared/scripts/bdd_hooks.py

@@ -21,6 +21,7 @@
 from helpers.StacktraceHelper import getCoredumps, generateStacktrace
 from helpers.SyncHelper import closeSocketConnection, clearWaitedAfterSync
 from helpers.SpaceHelper import delete_project_spaces
+from helpers.SetupClientHelper import wait_until_app_killed
 from helpers.ConfigHelper import (
     init_config,
     get_config,
@@ -116,27 +117,6 @@ def scenarioFailed():
     )
 
 
-def isAppKilled(pid):
-    if os.path.isdir('/proc/{}'.format(pid)):
-        # process is still running
-        # wait 100ms before checking again
-        snooze(0.1)
-        return False
-    return True
-
-
-def waitUntilAppIsKilled(pid=0):
-    timeout = get_config('minSyncTimeout') * 1000
-    killed = waitFor(
-        lambda: isAppKilled(pid),
-        timeout,
-    )
-    if not killed:
-        test.log(
-            "Application was not terminated within {} milliseconds".format(timeout)
-        )
-
-
 # runs after every scenario
 # Order: 1
 # cleanup spaces
@@ -157,7 +137,6 @@ def hook(context):
 
     # capture a screenshot if there is error or test failure in the current scenario execution
     if scenarioFailed() and os.getenv('CI'):
-
         import gi
 
         gi.require_version('Gtk', '3.0')
@@ -183,7 +162,7 @@ def hook(context):
         # get pid before detaching
         pid = ctx.pid
         ctx.detach()
-        waitUntilAppIsKilled(pid)
+        wait_until_app_killed(pid)
 
     # delete local files/folders
     for filename in os.listdir(get_config('clientRootSyncPath')):

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

@@ -1,6 +1,6 @@
 from urllib.parse import urlparse
-import squish
-from os import makedirs
+import squish, test
+from os import makedirs, path
 from os.path import exists, join
 from helpers.SpaceHelper import get_space_id
 from helpers.ConfigHelper import get_config, set_config
@@ -20,7 +20,13 @@ def substituteInLineCodes(value):
 
 
 def getClientDetails(context):
-    clientDetails = {'server': '', 'user': '', 'password': '', 'sync_folder': ''}
+    clientDetails = {
+        'server': '',
+        'user': '',
+        'password': '',
+        'sync_folder': '',
+        'oauth': False,
+    }
     for row in context.table[0:]:
         row[1] = substituteInLineCodes(row[1])
         if row[0] == 'server':
@@ -152,3 +158,24 @@ def setUpClient(username, displayName, space="Personal"):
 
     startClient()
     listenSyncStatusForItem(syncPath)
+
+
+def is_app_killed(pid):
+    if path.isdir('/proc/{}'.format(pid)):
+        # process is still running
+        # wait 100ms before checking again
+        squish.snooze(0.1)
+        return False
+    return True
+
+
+def wait_until_app_killed(pid=0):
+    timeout = 5 * 1000
+    killed = squish.waitFor(
+        lambda: is_app_killed(pid),
+        timeout,
+    )
+    if not killed:
+        test.log(
+            "Application was not terminated within {} milliseconds".format(timeout)
+        )

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

@@ -51,6 +51,13 @@
     # default sync patterns for the initial sync (after adding account)
     # the pattern can be of TWO types depending on the available resources (files/folders)
     'initial': [
+        # when adding account via New Account wizard
+        [
+            SYNC_STATUS['REGISTER'],
+            SYNC_STATUS['UPDATE'],
+            SYNC_STATUS['UPDATE'],
+            SYNC_STATUS['UPDATE'],
+        ],
         # when syncing empty account (hidden files are ignored)
         [SYNC_STATUS['UPDATE'], SYNC_STATUS['OK']],
         # when syncing an account that has some files/folders

test/gui/shared/scripts/pageObjects/AccountConnectionWizard.py

@@ -7,6 +7,7 @@
     getTempResourcePath,
     setCurrentUserSyncPath,
 )
+from helpers.SyncHelper import listenSyncStatusForItem
 import test
 
 
@@ -169,9 +170,11 @@ def acceptCertificate():
         )
 
     @staticmethod
-    def addUserCreds(username, password):
+    def addUserCreds(username, password, oauth=False):
         if get_config('ocis'):
             AccountConnectionWizard.oidcLogin(username, password)
+        elif oauth:
+            AccountConnectionWizard.oauthLogin(username, password)
         else:
             AccountConnectionWizard.basicLogin(username, password)
 
@@ -215,17 +218,18 @@ def nextStep():
     @staticmethod
     def selectSyncFolder(user):
         # create sync folder for user
-        syncPath = createUserSyncPath(user)
+        sync_path = createUserSyncPath(user)
 
         AccountConnectionWizard.selectAdvancedConfig()
         squish.mouseClick(
             squish.waitForObject(AccountConnectionWizard.DIRECTORY_NAME_BOX)
         )
         squish.type(
             squish.waitForObject(AccountConnectionWizard.DIRECTORY_NAME_EDIT_BOX),
-            syncPath,
+            sync_path,
         )
         squish.clickButton(squish.waitForObject(AccountConnectionWizard.CHOOSE_BUTTON))
+        return sync_path
 
     @staticmethod
     def set_temp_folder_as_sync_folder(folder_name):
@@ -243,6 +247,7 @@ def set_temp_folder_as_sync_folder(folder_name):
             sync_path,
         )
         setCurrentUserSyncPath(sync_path)
+        return sync_path
 
     @staticmethod
     def addAccount(account_details):
@@ -257,16 +262,23 @@ def addAccountInformation(account_details):
                 AccountConnectionWizard.acceptCertificate()
         if account_details['user']:
             AccountConnectionWizard.addUserCreds(
-                account_details['user'], account_details['password']
+                account_details['user'],
+                account_details['password'],
+                account_details['oauth'],
             )
-
+        sync_path = ''
         if account_details['sync_folder']:
             AccountConnectionWizard.selectAdvancedConfig()
-            AccountConnectionWizard.set_temp_folder_as_sync_folder(
+            sync_path = AccountConnectionWizard.set_temp_folder_as_sync_folder(
                 account_details['sync_folder']
             )
         elif account_details['user']:
-            AccountConnectionWizard.selectSyncFolder(account_details['user'])
+            sync_path = AccountConnectionWizard.selectSyncFolder(
+                account_details['user']
+            )
+        if sync_path:
+            # listen for sync status
+            listenSyncStatusForItem(sync_path)
 
     @staticmethod
     def selectManualSyncFolderOption():

test/gui/shared/scripts/pageObjects/AccountSetting.py

@@ -47,6 +47,12 @@ class AccountSetting:
         "visible": 1,
         "window": names.loginRequiredDialog_OCC_LoginRequiredDialog,
     }
+    ACCOUNT_LOADING = {
+        "window": names.settings_OCC_SettingsDialog,
+        "name": "loadingPage",
+        "type": "QWidget",
+        "visible": 0,
+    }
 
     @staticmethod
     def accountAction(action):
@@ -131,13 +137,30 @@ def waitUntilAccountIsConnected(displayname, server, timeout=5000):
         )
 
         if not result:
-            raise Exception(
+            raise TimeoutError(
                 "Timeout waiting for the account to be connected for "
                 + str(timeout)
                 + " milliseconds"
             )
         return result
 
+    @staticmethod
+    def wait_until_sync_folder_is_configured(timeout=5000):
+        result = squish.waitFor(
+            lambda: not squish.waitForObjectExists(
+                AccountSetting.ACCOUNT_LOADING
+            ).visible,
+            timeout,
+        )
+
+        if not result:
+            raise TimeoutError(
+                "Timeout waiting for sync folder to be connected for "
+                + str(timeout)
+                + " milliseconds"
+            )
+        return result
+
     @staticmethod
     def confirmRemoveAllFiles():
         squish.clickButton(squish.waitForObject(AccountSetting.REMOVE_ALL_FILES))

test/gui/shared/scripts/pageObjects/EnterPassword.py

@@ -44,9 +44,20 @@ def oidcReLogin(username, password):
         authorize_via_webui(username, password)
 
     @staticmethod
-    def reLogin(username, password):
+    def oauthReLogin(username, password):
+        # wait 500ms for copy button to fully load
+        squish.snooze(1 / 2)
+        squish.clickButton(
+            squish.waitForObject(EnterPassword.COPY_URL_TO_CLIPBOARD_BUTTON)
+        )
+        authorize_via_webui(username, password, "oauth")
+
+    @staticmethod
+    def reLogin(username, password, oauth=False):
         if get_config('ocis'):
             EnterPassword.oidcReLogin(username, password)
+        elif oauth:
+            EnterPassword.oauthReLogin(username, password)
         else:
             EnterPassword.enterPassword(password)
 

test/gui/shared/scripts/pageObjects/Toolbar.py

@@ -1,7 +1,22 @@
 import squish
+from helpers.SetupClientHelper import wait_until_app_killed
 
 
 class Toolbar:
+    QUIT_CONFIRMATION_DIALOG = {
+        "type": "QMessageBox",
+        "unnamed": 1,
+        "visible": 1,
+        "windowTitle": "Quit ownCloud",
+    }
+    CONFIRM_QUIT_BUTTON = {
+        "text": "Yes",
+        "type": "QPushButton",
+        "unnamed": 1,
+        "visible": 1,
+        "window": QUIT_CONFIRMATION_DIALOG,
+    }
+
     @staticmethod
     def getItemSelector(item_name):
         return {
@@ -35,3 +50,14 @@ def getDisplayedAccountText(displayname, host):
     @staticmethod
     def open_settings_tab():
         squish.clickButton(squish.waitForObject(Toolbar.getItemSelector("Settings")))
+
+    @staticmethod
+    def quit_owncloud():
+        squish.clickButton(
+            squish.waitForObject(Toolbar.getItemSelector("Quit ownCloud"))
+        )
+        squish.clickButton(squish.waitForObject(Toolbar.CONFIRM_QUIT_BUTTON))
+        for ctx in squish.applicationContextList():
+            pid = ctx.pid
+            ctx.detach()
+            wait_until_app_killed(pid)

test/gui/shared/steps/account_context.py

@@ -65,6 +65,11 @@ def step(context):
     startClient()
 
 
+@When('the user starts the client')
+def step(context):
+    startClient()
+
+
 @When('the user opens the add-account dialog')
 def step(context):
     Toolbar.openNewAccountSetup()
@@ -74,6 +79,8 @@ def step(context):
 def step(context):
     account_details = getClientDetails(context)
     AccountConnectionWizard.addAccount(account_details)
+    # wait for files to sync
+    waitForInitialSyncToComplete(getResourcePath('/', account_details["user"]))
 
 
 @Given('the user has entered the following account information:')
@@ -117,6 +124,16 @@ def step(context, username):
     waitForInitialSyncToComplete(getResourcePath('/', username))
 
 
+@When('user "|any|" logs in to the client-UI with oauth2')
+def step(context, username):
+    AccountSetting.login()
+    password = getPasswordForUser(username)
+    EnterPassword.reLogin(username, password, True)
+
+    # wait for files to sync
+    waitForInitialSyncToComplete(getResourcePath('/', username))
+
+
 @When('user "|any|" opens login dialog')
 def step(context, username):
     AccountSetting.login()
@@ -131,11 +148,8 @@ def step(context, username, password):
 def step(context, username):
     displayname = getDisplaynameForUser(username)
     server = get_config('localBackendUrl')
-    test.compare(
-        AccountSetting.waitUntilAccountIsConnected(displayname, server),
-        True,
-        "User '%s' is connected" % username,
-    )
+    AccountSetting.waitUntilAccountIsConnected(displayname, server)
+    AccountSetting.wait_until_sync_folder_is_configured()
 
 
 @When('the user removes the connection for user "|any|" and host |any|')
@@ -230,14 +244,13 @@ def step(context):
     test.compare(True, AccountSetting.isLogDialogVisible(), "Log dialog is opened")
 
 
-@When('the user adds the following account with oauth2 enabled:')
+@When('the user adds the following oauth2 account:')
 def step(context):
     account_details = getClientDetails(context)
-    AccountConnectionWizard.addServer(account_details['server'])
-    AccountConnectionWizard.oauthLogin(
-        account_details['user'], account_details['password']
-    )
-    AccountConnectionWizard.nextStep()
+    account_details.update({'oauth': True})
+    AccountConnectionWizard.addAccount(account_details)
+    # wait for files to sync
+    waitForInitialSyncToComplete(getResourcePath('/', account_details["user"]))
 
 
 @When('the user cancels the sync connection wizard')
@@ -253,3 +266,8 @@ def step(context):
 @When('user "|any|" logs out from the login required dialog')
 def step(context, username):
     AccountSetting.logoutFromLoginRequiredDialog()
+
+
+@When("the user quits the client")
+def step(context):
+    Toolbar.quit_owncloud()

test/gui/shared/steps/spaces_context.py

@@ -58,6 +58,5 @@ def step(context, user, file_name, space_name, content):
     regexp=True,
 )
 def step(context, user, space_name, resource_name):
-    print(user, space_name, resource_name)
     exists = resource_exists(space_name, resource_name, user)
     test.compare(exists, True, "Resource exists")