PHPackages tajawal/codeception-appium - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. tajawal/codeception-appium ActiveLibrary tajawal/codeception-appium ========================== appium driver for codeception framework 1.0.1(7y ago)1916017[2 issues](https://github.com/tajawal/codeception-appium/issues)[4 PRs](https://github.com/tajawal/codeception-appium/pulls)MITPHPPHP >=7.0CI failing Since Feb 2Pushed 1mo ago34 watchersCompare [ Source](https://github.com/tajawal/codeception-appium)[ Packagist](https://packagist.org/packages/tajawal/codeception-appium)[ RSS](/packages/tajawal-codeception-appium/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependencies (6)Versions (11)Used By (0) Appium Driver for Codeception =============================== [](#--appium-driver-for-codeception-) Appium driver for codeception for writing mobile tests. --- [![Build Status](https://camo.githubusercontent.com/819494269f66a9fb067ce5ff9edce0ad35907b4f26e97ec5ae302fed991999c6/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6d652d696f2f61707069756d2d6472697665722d636f646563657074696f6e2e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/me-io/appium-driver-codeception)[![downloads](https://camo.githubusercontent.com/b13200cfaacc92568e3e16c32cdd87422b95991e231c730f074cd3566e70adf9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f6d652d696f2f61707069756d2d6472697665722d636f646563657074696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/me-io/appium-driver-codeception/stats)[![MIT License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/me-io/appium-driver-codeception/blob/master/LICENSE.md)[![Donate](https://camo.githubusercontent.com/21b9b3571c7f2fc583ad6b1b49aeb1524dd82f18a1b2e83c005c570cb71816ab/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d646f6e6174652d3137394244372e7376673f7374796c653d666c61742d73717561726573)](https://www.paypal.me/meabed) [![All Contributors](https://camo.githubusercontent.com/db0a672758a6b3f2641e6c6099e3fadfd608167acfae3b31425eb3917b0dc47f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f616c6c5f636f6e7472696275746f72732d322d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](#contributors)[![PRs Welcome](https://camo.githubusercontent.com/25b3e6d0d42c98de74a98cbb4d149a1c09020cf6d1361993b72d7d5b8ffed363/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](http://makeapullrequest.com)[![Code of Conduct](https://camo.githubusercontent.com/6cf3a420df991efb9d5319bcf31f1aec6d12e660e25f13256cb256e76a4399a7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532306f662d636f6e647563742d6666363962342e7376673f7374796c653d666c61742d737175617265)](https://github.com/me-io/appium-driver-codeception/blob/master/CODE_OF_CONDUCT.md)[![Watch on GitHub](https://camo.githubusercontent.com/759363475f6d848e03bd43019810359032b4d69a04efcbf4c53ea9c11f856597/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f77617463686572732f6d652d696f2f61707069756d2d6472697665722d636f646563657074696f6e2e7376673f7374796c653d736f6369616c)](https://github.com/me-io/appium-driver-codeception/watchers)[![Star on GitHub](https://camo.githubusercontent.com/b3b0b8cafc829b2110940e78f1b8b57aec9e06a836ade4d010795072243032e2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6d652d696f2f61707069756d2d6472697665722d636f646563657074696f6e2e7376673f7374796c653d736f6369616c)](https://github.com/me-io/appium-driver-codeception/stargazers)[![Tweet](https://camo.githubusercontent.com/e2da91996f26df0204311fc2810a0160afca6755e17eacbb3974212d17b8f760/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f75726c2f68747470732f6769746875622e636f6d2f6d652d696f2f61707069756d2d6472697665722d636f646563657074696f6e2e7376673f7374796c653d736f6369616c)](https://twitter.com/intent/tweet?text=Check%20out%20appium-driver-codeception!%20https://github.com/me-io/appium-driver-codeception%20%F0%9F%91%8D) Requirement ----------- [](#requirement) 1. PHP >= 7.0 2. [Appium](http://appium.io/) 3. [Inspect App with Appium Desktop](https://medium.com/@eliasnogueira/inspect-an-app-with-the-new-appium-desktop-8ce4dc9aa95c) 4. Devices: - **Android** - [Setup Android SDK on Mac](https://gist.github.com/agrcrobles/165ac477a9ee51198f4a870c723cd441) - **iOS** - Install Xcode from the following [link](https://developer.apple.com/xcode/) or run the following command inside your terminal: ``` xcode-select --install ``` - Install the Carthage dependency manager: ``` brew install carthage ``` Table of Contents ----------------- [](#table-of-contents) - [Install](#install) - [Tests](#tests) - [Writing tests for Android](#writing-tests-for-android) - [Writing tests for iOS](#writing-tests-for-ios) - [Generating Actor classes](#generating-actor-classes) - [Your First Android Test](#your-first-android-test) - [Your First iOS Test](#your-first-ios-test) - [Running tests](#running-tests) Install ------- [](#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 ----- [](#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 [](#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 [](#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 [](#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 [](#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 [](#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 [](#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 -p ``` 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 ](https://shankargarg.wordpress.com/2016/02/25/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 ------------ [](#contributors) A huge thanks to all of our contributors: [![](https://avatars0.githubusercontent.com/u/45731?v=3) **Mohamed Meabed**](https://github.com/Meabed) [💻](https://github.com/me-io/appium-driver-codeception/commits?author=Meabed "Code") [📢](#talk-Meabed "Talks")[![](https://avatars2.githubusercontent.com/u/16267321?v=3) **Zeeshan Ahmad**](https://github.com/ziishaned) [💻](https://github.com/me-io/appium-driver-codeception/commits?author=ziishaned "Code") [🐛](https://github.com/me-io/appium-driver-codeception/issues?q=author%3Aziishaned "Bug reports") [⚠️](https://github.com/me-io/appium-driver-codeception/commits?author=ziishaned "Tests") [📖](https://github.com/me-io/appium-driver-codeception/commits?author=ziishaned "Documentation")License ------- [](#license) The code is available under the [MIT license](LICENSE.md). ### Health Score 44 — FairBetter than 92% of packages Maintenance59 Moderate activity, may be stable Popularity22 Limited adoption so far Community23 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 2873d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7b8248a9c9dbad3765bbedcf2b833dcb0626c2a4ee29c38a792bf9227e7d895c?d=identicon)[tajawalcom](/maintainers/tajawalcom) --- Top Contributors [![ziishaned](https://avatars.githubusercontent.com/u/16267321?v=4)](https://github.com/ziishaned "ziishaned (57 commits)")[![meabed](https://avatars.githubusercontent.com/u/45731?v=4)](https://github.com/meabed "meabed (51 commits)")[![raleerg](https://avatars.githubusercontent.com/u/1305329?v=4)](https://github.com/raleerg "raleerg (9 commits)")[![aheermohsinse](https://avatars.githubusercontent.com/u/26763194?v=4)](https://github.com/aheermohsinse "aheermohsinse (7 commits)")[![walterwhites](https://avatars.githubusercontent.com/u/18416544?v=4)](https://github.com/walterwhites "walterwhites (2 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![adbrvn](https://avatars.githubusercontent.com/u/865164?v=4)](https://github.com/adbrvn "adbrvn (1 commits)") --- Tags appiumappium-driverautomation-testcodeceptioncodeception-appium-drivercodeception-driverphp-appiumunit testingcodeceptionfunctional-testingacceptance-testingBDDTDDappiumautomation testingandroid automationios automationappium driver ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/tajawal-codeception-appium/health.svg) ``` [![Health](https://phpackages.com/badges/tajawal-codeception-appium/health.svg)](https://phpackages.com/packages/tajawal-codeception-appium) ``` ### Alternatives [me-io/appium-driver-codeception appium driver for codeception framework 1910.4k](/packages/me-io-appium-driver-codeception)[codeception/codeception All-in-one PHP Testing Framework 4.9k86.2M2.9k](/packages/codeception-codeception)[phpspec/phpspec Specification-oriented BDD framework for PHP 7.1+ 1.9k36.7M3.1k](/packages/phpspec-phpspec)[codeception/module-phpbrowser Codeception module for testing web application over HTTP 6529.8M508](/packages/codeception-module-phpbrowser)[codeception/module-symfony Codeception module for Symfony framework 949.4M95](/packages/codeception-module-symfony)[codeception/module-webdriver WebDriver module for Codeception 3831.4M245](/packages/codeception-module-webdriver) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)