concordialang-codeceptjs-appium

Concordia Language plug-in to generate test scripts for CodeceptJS with Appium


Keywords
concordialang, concordia-lang, concordia, codeceptjs, appium, test, script, e2e, plugin, plug-in, android, app, codecept, functional, ios, testing, web, windows
License
AGPL-3.0
Install
npm install concordialang-codeceptjs-appium@2.4.1

Documentation

npm version GitHub last commit

concordialang-codeceptjs-appium

🔌 Concordia Compiler Plug-in for CodeceptJS with Appium

Generates and executes test scripts for mobile or desktop applications. Uses CodeceptJS with Appium.

What's New

Compatibility

  • Version 2.x works with Concordia 2.0.0 or above.
  • Version 1.x works with Concordia 1.0.0 or above.

Installation

Note: If you want to test a web-based mobile or desktop application, you will have to install Java 8 or above, since Appium will need WebDriverIO, which requires Java.

  1. Access your application's folder from the terminal/console.

  2. Install it via Concordia or NPM:

    a) Installation via Concordia:

    concordia --plugin-install codeceptjs-appium

    b) Installation via NPM:

    npm i -D concordialang-codeceptjs-appium

You may also like to install

  1. Appium Doctor, if you are testing a mobile application

Attempts to diagnose and fix common Node, iOS and Android configuration issues before starting Appium.

npm i -g appium-doctor
  1. Appium Desktop, if you are testing a desktop application. It has its own installer

Appium Server and Inspector in Desktop GUIs for Mac, Windows, and Linux

Environment setup

Unfortunately, the setup process for testing mobile or desktop applications with Appium requires some manual effort.

Appium provides automation for a particular platform through a driver. Every driver comes with its own setup requirements - usually the same ones for app development. For example, to automate the tests of an Android app, you will need to install Android SDK. Likewise, an iOS app will need iOS SDK.

Appium Drivers:

Install the appropriate driver to test your application.

After installing it, you may want to set the Desired Capabilities.

Execution

Execute it with the Concordia Compiler. Example:

concordia --plugin codeceptjs-appium

Configuration file

CodeceptJS reads its configuration from codeceptjs.json. This plug-in adds the "Appium" to the property helpers with a very basic configuration:

{
	"helpers": {
		"Appium": {
			"platform": "Android",
			"app": "http://localhost",
			"device": "emulator"
		}
	}
}

Please see the Helper Configuration for details on how to configure it properly.

Supported CodeceptJS commands

See concordialang-codeceptjs-core.

License

AGPL © Thiago Delgado Pinto

GNU Affero General Public License version 3