[NEW] Improve test automation in Rocket Chat Android Repo

.circleci/config.yml

@@ -29,7 +29,7 @@ jobs:
       - store_artifacts:
           path: app/libs/
           destination: libs
-  code-analysis:
+  run-unit-tests:
     docker:
       - image: circleci/android:api-29
     environment:
@@ -55,14 +55,17 @@ jobs:
             - ~/.gradle/wrapper
           key: jars-{{ checksum "build.gradle" }}-{{ checksum  "app/build.gradle" }}-{{ checksum "player/build.gradle" }}-{{ checksum "core/build.gradle" }}-{{ checksum "util/build.gradle" }}-{{ checksum "draw/build.gradle" }}-{{ checksum "emoji/build.gradle" }}-{{ checksum "suggestions/build.gradle" }}
       - run:
-          name: Run Lint
+          name: Run Lint 
           command: ./gradlew lint
       - run:
           name: Run Unit test
-          command: ./gradlew test
+          command: ./gradlew --no-daemon testPlayDebugUnitTest
       - run:
-          name: Compile Instrumentation test
-          command: ./gradlew assembleAndroidTest
+          name: Generate reports
+          command: ./gradlew jacocoTestPlayDebugUnitTestReport
+      - run:
+          name: Send coverage
+          command: bash <(curl -s https://codecov.io/bash)
       - store_artifacts:
           path: app/build/reports/
           destination: reports
@@ -143,13 +146,12 @@ workflows:
   build-deploy:
     jobs:
       - build-kotlin-sdk
-      - code-analysis:
+      - run-unit-tests:
           requires:
             - build-kotlin-sdk
           filters:
             branches:
               ignore: # skip on merge commits.
-                - develop
                 - develop-2.x
                 - master
       - build-aab:

HOW_TO_RUN_TESTS.md

@@ -0,0 +1,28 @@
+### How to run Unit tests and UI tests on local machine
+
+#### Unit tests
+
+1. Fork the repo and setup the project on your local machine.
+2. Open Android Studio terminal
+3. Run gradlew test
+
+#### UI tests
+
+1. Fork the repo and setup the project on your local machine.
+2. Open Android Studio terminal and run the android emulator.
+3. Run gradlew connectedAndroidTest command on your AS Terminal (To run Android tests on each module and build variant in the project)
+4. Run gradlew connectedPlayDebugAndroidTest (for specific play variant)
+
+**Note:**
+1. Before running UI tests on the emulator device uninstall the existing version of RC app from it.
+2. It is advised to turn off all the animation of device, tests may fail if animations are on. To turn the animations off go to developer 
+option in device settings.
+3. It is advised to have good network connection and sufficient ram in you machine while running the UI tests
+
+
+###  Any organization that forks RC can run tests against their own server
+- Organisation using Rocket.Chat fork can also run the tests by doing some minor changes.
+- For tests to work properly, Organisations have to follow the instructions mentioned in [Config file](https://github.com/GOVINDDIXIT/Rocket.Chat.Android/blob/develop/app/src/main/java/testConfig/Config.kt) carefully which also include creating new user.
+- They have to create additional channels as mentioned in the config file.
+- Also they need to customise the links present in the config file according to their server requirements.
+

app/build.gradle

@@ -9,6 +9,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 apply plugin: 'kotlin-kapt'
 apply plugin: "com.github.ben-manes.versions"
+apply plugin: 'jacoco-android'
 
 android {
     compileSdkVersion versions.compileSdk
@@ -39,6 +40,35 @@ android {
         }
     }
 
+    kapt {
+        useBuildCache true
+    }
+
+    dexOptions {
+        preDexLibraries true
+        jumboMode false
+    }
+
+    testOptions {
+        unitTests.all {
+            jacoco {
+                includeNoLocationClasses = true
+            }
+        }
+        unitTests{
+            includeAndroidResources = true
+            returnDefaultValues = true
+        }
+    }
+
+    tasks.withType(Test) {
+        testLogging {
+            exceptionFormat "full"
+            events "passed", "failed"
+            showStandardStreams true
+        }
+    }
+
     signingConfigs {
         release {
             storeFile project.rootProject.file('Rocket.jks').getCanonicalFile()
@@ -69,6 +99,7 @@ android {
             buildConfigField "String", "RECOMMENDED_SERVER_VERSION", '"0.64.2"'
             signingConfig signingConfigs.debug
             applicationIdSuffix ".dev"
+            testCoverageEnabled true
         }
     }
 
@@ -180,6 +211,12 @@ dependencies {
     testImplementation libraries.truth
     androidTestImplementation libraries.espressoCore
     androidTestImplementation libraries.espressoIntents
+    androidTestImplementation libraries.espressoContrib
+    androidTestImplementation libraries.uiAutomator
+    testImplementation libraries.mockito
+    testImplementation libraries.mockitoInline
+    androidTestImplementation libraries.mockitoAndroid
+    androidTestImplementation libraries.runner
 }
 
 androidExtensions {

app/jacoco.gradle

@@ -0,0 +1,20 @@
+apply plugin: 'jacoco'
+
+task jacocoTestReport(type: JacocoReport, dependsOn: ['testPlayDebugUnitTest', 'createPlayDebugCoverageReport']) {
+
+    reports {
+        xml.enabled = true
+        html.enabled = true
+    }
+
+    def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*Test*.*', 'android/**/*.*']
+    def debugTree = fileTree(dir: "${buildDir}/intermediates/classes/debug", excludes: fileFilter)
+    def mainSrc = "${project.projectDir}/src/main/java"
+
+    sourceDirectories = files([mainSrc])
+    classDirectories = files([debugTree])
+    executionData = fileTree(dir: "$buildDir", includes: [
+            "jacoco/testPlayDebugUnitTest.exec",
+            "outputs/code-coverage/playDebugAndroidTest/connected/*coverage.ec"
+    ])
+}

app/src/androidTest/java/chat/rocket/android/authentication/login/ui/LoginFragmentTest.kt

@@ -0,0 +1,83 @@
+package chat.rocket.android.authentication.login.ui
+
+import androidx.test.espresso.Espresso.onView
+import androidx.test.espresso.action.ViewActions.*
+import androidx.test.espresso.assertion.ViewAssertions.matches
+import androidx.test.espresso.matcher.ViewMatchers.*
+import androidx.test.filters.LargeTest
+import androidx.test.rule.ActivityTestRule
+import chat.rocket.android.R
+import chat.rocket.android.analytics.event.ScreenViewEvent
+import chat.rocket.android.authentication.ui.AuthenticationActivity
+import chat.rocket.android.util.withHint
+import chat.rocket.android.util.extensions.addFragmentBackStack
+import org.hamcrest.Matchers.not
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import testConfig.Config.Companion.PASSWORD
+import testConfig.Config.Companion.SERVER_URL
+import testConfig.Config.Companion.USERNAME
+
+@LargeTest
+class LoginFragmentTest {
+
+    @JvmField
+    var activityRule = ActivityTestRule(AuthenticationActivity::class.java, true, true)
+
+    @Rule
+    fun rule() = activityRule
+
+    @Before
+    fun setUp() {
+        rule().activity.addFragmentBackStack(ScreenViewEvent.Login.screenName, R.id.fragment_container) {
+            newInstance(SERVER_URL)
+        }
+    }
+
+    @Test
+    fun check_UI_elements(){
+        onView(withId(R.id.text_login)).check(matches(withText("Login")))
+        onView(withId(R.id.text_username_or_email)).check(matches(withHint("Username or email")))
+        onView(withId(R.id.text_password)).check(matches(withHint("Password")))
+        onView(withId(R.id.button_log_in)).check(matches(withText("Login")))
+        onView(withId(R.id.button_forgot_your_password)).check(matches(withText("Forgot your password?")))
+    }
+
+    @Test
+    fun login_button_enable_if_details_are_filled(){
+        onView(withId(R.id.text_username_or_email)).perform(
+            typeText(USERNAME), closeSoftKeyboard()
+        )
+        onView(withId(R.id.text_password)).perform(
+            typeText(PASSWORD), closeSoftKeyboard()
+        )
+        onView(withId(R.id.button_log_in)).check(matches(isEnabled()))
+    }
+
+    @Test
+    fun login_button_disable_if_details_are_not_filled(){
+        onView(withId(R.id.text_username_or_email)).perform(
+            typeText(USERNAME), closeSoftKeyboard()
+        )
+        onView(withId(R.id.button_log_in)).check(matches(not(isEnabled())))
+    }
+
+    @Test
+    fun check_login_with_email_and_logout(){
+        onView(withId(R.id.text_username_or_email)).perform(
+            typeText(USERNAME), closeSoftKeyboard()
+        )
+        onView(withId(R.id.text_password)).perform(
+            typeText(PASSWORD), closeSoftKeyboard()
+        )
+        onView(withId(R.id.button_log_in)).perform(click())
+        Thread.sleep(15000)
+        onView(withContentDescription(R.string.abc_action_bar_up_description)).perform(click())
+        Thread.sleep(2000)
+        onView(withId(R.id.text_logout)).check(matches(isDisplayed()))
+            .perform(click())
+        onView(withText("LOGOUT")).perform(click())
+        Thread.sleep(2000)
+    }
+}

app/src/androidTest/java/chat/rocket/android/authentication/loginoptions/ui/LoginOptionsFragmentTest.kt

@@ -0,0 +1,97 @@
+package chat.rocket.android.authentication.loginoptions.ui
+
+import androidx.test.espresso.Espresso.onView
+import androidx.test.espresso.action.ViewActions.click
+import androidx.test.espresso.action.ViewActions.scrollTo
+import androidx.test.espresso.assertion.ViewAssertions.matches
+import androidx.test.espresso.matcher.ViewMatchers.*
+import androidx.test.filters.LargeTest
+import androidx.test.rule.ActivityTestRule
+import chat.rocket.android.R
+import chat.rocket.android.authentication.ui.AuthenticationActivity
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+
+@LargeTest
+class LoginOptionsFragmentTest {
+
+    @Rule
+    @JvmField
+    var activityRule = ActivityTestRule<AuthenticationActivity>(AuthenticationActivity::class.java)
+
+    @Before
+    fun setUp() {
+        onView(withId(R.id.join_community_container))
+            .perform(scrollTo(), click())
+        Thread.sleep(5000)
+    }
+
+    @Test
+    fun check_UI_element() {
+        onView(withId(R.id.button_facebook)).check(matches(withText("Continue with Facebook")))
+        onView(withId(R.id.button_google)).check(matches(withText("Continue with Google")))
+        onView(withId(R.id.button_gitlab)).check(matches(withText("Continue with GitLab")))
+    }
+
+    @Test
+    fun expand_collapse_accounts_and_check_UI_elements() {
+        onView(withId(R.id.button_expand_collapse_accounts))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.button_linkedin)).check(matches(withText("Continue with LinkedIn")))
+        onView(withId(R.id.button_github)).check(matches(withText("Continue with GitHub")))
+    }
+
+    @Test
+    fun click_login_with_email() {
+        onView(withId(R.id.button_login_with_email)).check(matches(withText("Login with e-mail")))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.text_login)).check(matches(withText("Login")))
+    }
+
+    @Test
+    fun check_create_an_account() {
+        onView(withId(R.id.button_create_an_account)).check(matches(withText("Create an account")))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.text_sign_up)).check(matches(withText("Sign up")))
+    }
+
+    @Test
+    fun check_facebook_button() {
+        onView(withId(R.id.button_facebook))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.web_view)).check(matches(isDisplayed()))
+    }
+
+    @Test
+    fun check_github_button() {
+        onView(withId(R.id.button_github))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.web_view)).check(matches(isDisplayed()))
+    }
+
+    @Test
+    fun check_google_button() {
+        onView(withId(R.id.button_google)).perform(scrollTo())
+            .perform(scrollTo(), click())
+        onView(withId(R.id.web_view)).check(matches(isDisplayed()))
+    }
+
+    @Test
+    fun check_linkedin_button() {
+        onView(withId(R.id.button_expand_collapse_accounts))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.button_linkedin))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.web_view)).check(matches(isDisplayed()))
+    }
+
+    @Test
+    fun check_gitlab_button() {
+        onView(withId(R.id.button_expand_collapse_accounts))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.button_gitlab))
+            .perform(scrollTo(), click())
+        onView(withId(R.id.web_view)).check(matches(isDisplayed()))
+    }
+}