Scenarios contained in feature files written in Gherkin language. Available scenarios can be found here.

Defined for the ownCloud Android app

Global overview

• Scenarios are defined with Gherkin Syntax.

• Steps are interpreted by Cucumber.

• Step implementation language: Java

• Device interaction with Appium

• Reports generated with Cucumber Reports

Get the code

• With git:

git clone https://github.com/owncloud/android-scenario-testing.git

• Download a zip file

Requirements

Different requirements:

• Appium instance running and reachable. Check this link to get futher info about Appium. Last Appium review: v2.11.2 (2024/07/10)

• At least, one device/emulator attached and reachable via adb. Check command adb devices to ensure Appium will get the device reference to interact with it.

• The environment variable $ANDROID_HOME needs to be correctly set up, pointing to the Android SDK folder

How to test

1. Build app

First, build the app from the expected branch/commit to get the test object. Before building, execute the following commands in the app's folder:

gsed -i 's/<bool name="wizard_enabled">true<\/bool>/<bool name="wizard_enabled">false<\/bool>/i' owncloudApp/src/main/res/values/setup.xml
gsed -i 's/<bool name="release_notes_enabled">true<\/bool>/<bool name="release_notes_enabled">false<\/bool>/i' owncloudApp/src/main/res/values/setup.xml
gsed -i '375,376d' owncloudApp/src/main/java/com/owncloud/android/presentation/authentication/LoginActivity.kt
gsed -i '380,414d' owncloudApp/src/main/java/com/owncloud/android/presentation/authentication/LoginActivity.kt

These instructions:

• will disable welcome wizard
• will disable the release notes
• will set basic auth as forced authentication method, required to execute the test suites

App is built via Android Studio or CLI (gradlew)

After building, the signed ownCloud.apk artifact is located in:

owncloudApp/build/outputs/apk/original/release

move the owncloud.apk to the correct place in the current tests project: /src/test/resources

(in the current repository will be always an owncloud.apk file located in the correct place.)

2. Execute tests

The script executeTests will launch the tests. The following environment variables must be set in advance

    $OC_SERVER_URL (mandatory): URL of ownCloud server to test against
    $APPIUM_URL (optional): Appium server URL.
        If Appium Server is not specified, will be used "localhost:4723/wd/hub"
    $UDID_DEVICE (optional): ID of the device/simulator to execute the tests in.
        This ID could be get by executing  `adb devices`

The script needs some parameters. Check help executeTests -h

To execute all tests but the ignored ones (or any other tagged ones):

export UDID_DEVICE=emulator-5554
export OC_SERVER_URL=https://my.owncloud.server
export APPIUM_URL=localhost:4723
./executeTests -t "not @ignore"

The execution will display step by step how the scenario is being executed.

More info in Cucumber reference

NOTE: Since there are two kinds of backends available (oC10, oCIS), not all tests are suitable to be executed over both. Those tests have been tagged with:

• nooc10: tests to be executed only over oCIS, not suitable for oC10.
• noocis: tests to be executed only over oC10, not suitable for oCIS.

It's important to execute the tests with the mentioned tags to avoid wrong positives. Example commands:

./executeTests -t "not @ignore and not @noocis"
This command will execute tests that are not ignored and suitable for oCIS. If this command is run over an oC10 instance, some tests will fail.

./executeTests -t "not @ignore and not @nooc10"
This command will execute tests that are not ignored and suitable for oC10. If this command is run over an oCIS instance, some tests will fail.

Results

In the folder target, you will find a report with the execution results in html and json formats.

Besides of that, by setting the cucumber.properties file allow to integrate reports with Cucumber reports. An account in such platform (integrated with GitHub) is enough to use it. A new env variable must be set in advance in order to send reports to the platform. Token is provided in the Cucumber Reports account for every collection:

export CUCUMBER_PUBLISH_TOKEN=d97...

Also, in cucumber.properties file with the following values (disabled by default):

cucumber.publish.quiet=false
cucumber.publish.enabled=true

Note: This repository was forked from Cucumber-java skeleton repository, which contains the base skeleton to start working.

Versioning

Up to date: 02/Aug/2024