Appium Driver for Codeception

Appium driver for codeception for writing mobile tests.

Requirement

1. PHP >= 7.0
2. Appium
3. Inspect App with Appium Desktop
4. Devices:
   • Android
     • Setup Android SDK on Mac
   • iOS
     • Install Xcode from the following link or run the following command inside your terminal:

       xcode-select --install

     • Install the Carthage dependency manager:

       brew install carthage

Table of Contents

• Install
• Tests
  • Writing tests for Android
  • Writing tests for iOS
  • Generating Actor classes
  • Your First Android Test
  • Your First iOS Test
  • Running tests

Install

Just add me-io/appium-driver-codeception to your project's composer.json file:

{
    "require": {
        "me-io/appium-driver-codeception": "~1"
    }
}

and then run composer install. This will install codeception appium driver and all it's dependencies. Or run the following command

composer require me-io/appium-driver-codeception

Tests

Now lets run the following command at the root directory of your project:

codecept bootstrap

This command will creates a configuration file for codeception and tests directory and default test suites.

Writing tests for Android

Now, lets create a new configuration file android.suite.yml inside tests directory and put the following contents inside of it.

class_name: AndroidGuy
modules:
  enabled:
    # Enable appium driver
    - \Appium\AppiumDriver 
    -  Asserts
  config:
    # Configuration for appium driver
    \Appium\AppiumDriver:
      host: 0.0.0.0
      port: 4723
      dummyRemote: false
      resetAfterSuite: true
      resetAfterCest: false
      resetAfterTest: false
      resetAfterStep: false
      capabilities:
        platformName: 'Android'
        deviceName: 'Android device'
        automationName: 'Appium'
        appPackage: io.selendroid.testapp
        fullReset: false
        noReset: false
        newCommandTimeout: 7200
        nativeInstrumentsLib: true
        connection_timeout: 500
        request_timeout: 500
        autoAcceptAlerts: true
        appActivity: io.selendroid.testapp.HomeScreenActivity
        skipUnlock: true

Note: deviceName should be set as Android device only for real device. For Android Emulator use the name of the virtual device.

Writing tests for iOS

Now, lets create a new configuration file ios.suite.yml inside tests directory and put the following contents inside of it.

class_name: IosGuy
modules:
  enabled:
    # Enable appium driver
    - \Appium\AppiumDriver
    -  Asserts
  config:
    # Configuration for appium driver
    \Appium\AppiumDriver:
      host: 0.0.0.0
      port: 4723
      dummyRemote: false
      resetAfterSuite: true
      resetAfterCest: false
      resetAfterTest: false
      resetAfterStep: false
      capabilities:
        # PATH OF YOUR APP (something like  /Users/username/Documents/ios.app)
        app: ''
        # xcideOrgId is Apple developer team identifier string.
        xcodeOrgId: ''
        # xcodeSigningId is a string representing a signing certificate. iPhone Developer by default.
        xcodeSigningId: 'iPhone Developer'
        platformName: 'iOS'
        platformVersion: '11.2'
        deviceName: 'iPhone8'
        # Your device udid
        udid: ''
        useNewWDA: false
        newCommandTimeout: 7200
        automationName: 'XCUITest'
        autoAcceptAlerts: true
        fullReset: false
        noReset: true
        nativeInstrumentsLib: true
        connection_timeout: 500
        request_timeout: 500
        skipUnlock: true
        clearSystemFiles: true
        showIOSLog: true

Generating Actor classes

Now we need to generate actor class for the AndroidGuy/IosGuy that we defined in android.suite.yml/ios.suite.yml. To generate the actor class for AndroidGuy/IosGuy run the following command inside your terminal:

codecept build

Your First Android Test

To create your first android test create a new directory android inside tests folder. After creating the android folder create a new file FirstAndroidCest.php and put the following contents inside of it:

class FirstAndroidCest
{
    public function changeLanguage(AndroidGuy $I)
    {
        $I->implicitWait([
            'ms' => 3500,
        ]);
        $text = $I->byId('id_of_button')->getText();
        $I->assertEquals('Hello, World!', $text);
    }
}

Your First iOS Test

To create your first iOS test create a new directory ios inside tests folder. After creating the ios directory create a new file FirstIosCest.php and put the following contents inside of it:

class FirstIosCest
{
    public function lockPhone(Ios $I)
    {
        $I->implicitWait([
            'ms' => 10000,
        ]);
        $I->assertEquals('Hello, World!', 'Hello, World!');
        $I->amGoingTo("lock phone");
        $I->lock([null]);
    }
}

Running tests

Run the appium server by running the following command:

appium

NOTE: If you want to change IP/Port run the appium command like this:

appium -a <IP Address> -p <Port>

After running the appium server now you need to start android emulator and install the application that you want to test. If you don't know how to start the emulator you can follow the following guide Setup Genymotion Android Emulators on Mac OS

Now run the following command inside your terminal to run the tests:

# For Android
codecept run android FirstAndroidCest.php --steps

# For iOS
codecept run ios FirstIosCest.php --steps

Note: While following the steps that are mentioned here if you get codecept command not found error try to run codecept command like this ./vendor/bin/codecept.

Contributors

A huge thanks to all of our contributors:

Mohamed Meabed 💻 📢	Zeeshan Ahmad 💻 🐛 ⚠️ 📖

License

The code is available under the MIT license.