PIA-634: Create a login and settings helper

As there are many steps to take for successful login and going to settings, two function where created to minimise the repetativeness of it in our SignOuTests.kt
pia-foss · Oct 9, 2023 · 14870b4 · 14870b4
1 parent 21537a2
commit 14870b4
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 30 deletions.
diff --git a/app/src/androidTest/java/helpers/ActionHelpers.kt b/app/src/androidTest/java/helpers/ActionHelpers.kt
@@ -1,6 +1,8 @@
 package com.privateinternetaccess.android.helpers
 
 import androidx.test.uiautomator.UiObject
+import com.privateinternetaccess.android.screens.steps.SideMenuStepObjects
+import com.privateinternetaccess.android.screens.steps.SignInStepObjects
 
 object ActionHelpers {
 
@@ -15,4 +17,26 @@ object ActionHelpers {
         field.click()
         field.text = data?.toString() ?: ""
     }
+
+    fun userLoginSuccess() {
+        SignInStepObjects().allowNotifications()
+        SignInStepObjects().reachSignInScreen()
+        SignInStepObjects().enterCredentials()
+        SignInStepObjects().clickOnLoginButton()
+        SignInStepObjects().allowVpnProfileCreation()
+    }
+
+    fun goToSettings(primarySettingsSection : UiObject, secondarySettingsSection : UiObject? = null ) {
+        SideMenuStepObjects().hamburgerMenu()
+        SideMenuStepObjects().settings()
+
+        if (primarySettingsSection.exists())
+        {
+            primarySettingsSection.click()
+        }
+        if (secondarySettingsSection != null)
+        {
+            secondarySettingsSection.click()
+        }
+    }
 }
diff --git a/app/src/androidTest/java/screens/objects/SideMenuPageObjects.kt b/app/src/androidTest/java/screens/objects/SideMenuPageObjects.kt
@@ -1,9 +1,9 @@
-package com.privateinternetaccess.android.screens.objects //why do we declare this instead of just screens.object when we start createed the file?
+package com.privateinternetaccess.android.screens.objects
 
 import com.privateinternetaccess.android.helpers.LocatorHelper
 
 
-class SideMenuPageObject {
+class SideMenuPageObjects {
 
     val hamburgerMenu = LocatorHelper.findByContentDesc("Open")
     val settings = LocatorHelper.findByText("Settings")

diff --git a/app/src/androidTest/java/tests/SignInTests.kt b/app/src/androidTest/java/tests/SignInTests.kt
@@ -5,6 +5,7 @@ import com.privateinternetaccess.android.core.BaseUiAutomatorClass
 import com.privateinternetaccess.android.screens.objects.MainScreenPageObjects
 import com.privateinternetaccess.android.screens.objects.SignInPageObjects
 import com.privateinternetaccess.android.screens.steps.SignInStepObjects
+import com.privateinternetaccess.android.helpers.ActionHelpers.userLoginSuccess
 import org.junit.Test
 
 class SignInTests : BaseUiAutomatorClass() {
@@ -13,11 +14,7 @@ class SignInTests : BaseUiAutomatorClass() {
 
     @Test
     fun successfulLoginWithValidCredentials() {
-        stepObjects.allowNotifications()
-        stepObjects.reachSignInScreen()
-        stepObjects.enterCredentials()
-        stepObjects.clickOnLoginButton()
-        stepObjects.allowVpnProfileCreation()
+        userLoginSuccess()
         assert(MainScreenPageObjects().connectButton.exists())
     }
 

diff --git a/app/src/androidTest/java/tests/SignOutTests.kt b/app/src/androidTest/java/tests/SignOutTests.kt
@@ -3,46 +3,30 @@ package com.privateinternetaccess.android.tests
 import com.privateinternetaccess.android.screens.steps.SideMenuStepObjects
 import com.privateinternetaccess.android.core.BaseUiAutomatorClass
 import com.privateinternetaccess.android.screens.objects.SideMenuPageObjects
-import com.privateinternetaccess.android.screens.steps.SignInStepObjects
+import com.privateinternetaccess.android.helpers.ActionHelpers.userLoginSuccess
+import com.privateinternetaccess.android.helpers.ActionHelpers.goToSettings
 import org.junit.Before
 import org.junit.Test
 
 class SignOutTests : BaseUiAutomatorClass() {
 
-    private val stepObjects = SignInStepObjects ()
     private val sideMenuStepObjects = SideMenuStepObjects()
-
-    //pre-requiste
+    private val sideMenuPageObjects = SideMenuPageObjects()
     @Before
     fun login () {
-        stepObjects.allowNotifications()
-        stepObjects.reachSignInScreen()
-        stepObjects.enterCredentials()
-        stepObjects.clickOnLoginButton()
-        stepObjects.allowVpnProfileCreation()
+        userLoginSuccess()
     }
 
     @Test
     fun logout() {
-        sideMenuStepObjects.hamburgerMenu()
-        sideMenuStepObjects.settings()
-        sideMenuStepObjects.general()
+        goToSettings(sideMenuPageObjects.general)
         sideMenuStepObjects.launchOnSystemStartUp()
-//        goToSettings(sideMenuPageObject.general)
         sideMenuStepObjects.back()
         sideMenuStepObjects.back()
         sideMenuStepObjects.hamburgerMenu()
         sideMenuStepObjects.logout()
-        //login
-        stepObjects.allowNotifications()
-        stepObjects.reachSignInScreen()
-        stepObjects.enterCredentials()
-        stepObjects.clickOnLoginButton()
-        stepObjects.allowVpnProfileCreation()
-        sideMenuStepObjects.hamburgerMenu()
-        sideMenuStepObjects.settings()
-        sideMenuStepObjects.general()
-//        goToSettings(sideMenuPageObject.general)
+        userLoginSuccess()
+        goToSettings(sideMenuPageObjects.general)
         assert(!SideMenuPageObjects().toggleLaunchOnSystemStartUp.isChecked())
     }
 }