PHPackages walterwhites/appium-module - 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. [Testing & Quality](/categories/testing) 4. / 5. walterwhites/appium-module ActiveLibrary[Testing & Quality](/categories/testing) walterwhites/appium-module ========================== Appium module for codeception 1.1.1(7y ago)11561MITPHPCI failing Since Aug 1Pushed 5y ago1 watchersCompare [ Source](https://github.com/walterwhites/Appium-codeception-module)[ Packagist](https://packagist.org/packages/walterwhites/appium-module)[ RSS](/packages/walterwhites-appium-module/feed)WikiDiscussions master Synced yesterday READMEChangelog (10)Dependencies (1)Versions (14)Used By (0) Appium module for Codeception =============================== [](#--appium-module-for-codeception-) Easy Appium integration, iOS and Android Automation. --- Appium-codeception-module ========================= [](#appium-codeception-module) Table of Contents ----------------- [](#table-of-contents) - [Install](#install) - [Tests](#tests) - [config for iOS](#config-for-ios) - [Generating tester classes](#generating-tester-classes) - [Usage](#usage) - [AppTestCase](#apptestcase) - [ILocatorStrategy interface](#ilocatorstrategy-interface) - [IClassChainSearch interface](#iclasschainsearch-interface) Install ------- [](#install) Just add `walterwhites/appium-module` to your project's composer.json file: ``` { "require": { "walterwhites/appium-module": "dev-master" } } ``` then run `composer install` Tests ----- [](#tests) ### config for iOS [](#config-for-ios) ``` class_name: IosTester modules: enabled: # Enable appium module - \Appium\Appium: - Asserts: config: # Configuration for appium module \Appium\Appium: host: 0.0.0.0 local: true port: 4723 browserName: '' desiredCapabilities: platformName: iOS platformVersion: '13.2' deviceName: iPhone 11 Pro xcodeOrgId: '' xcodeSigningId: iPhone Developer noReset: true fullReset: false clearSystemFiles: true automationName: XCUITest bundleId: %IOS_BUNDLE_ID% #app: %IOS_APP_PATH% #bundleId: bundleId-of-your-app showIOSLog: false ``` ### Generating tester classes [](#generating-tester-classes) To generate actor class for the `AndroidTester`/`IosTester` defined inside `android.suite.yml` and `ios.suite.yml`run the following command: ``` codecept build ``` ### usage [](#usage) Below an example of a classic register method ``` /** * @group register * Tests the sign up * @param User $params */ public function registerByEmail(User $params) { $this->test->clickOnButton('SIGN UP', 400); $this->test->clickOnButton('SIGN UP WITH EMAIL', 400); $this->test->setText('First name', $params->firstName); $this->test->setText('Last name', $params->lastName); $this->test->setText('Email address', $params->email); $this->test->hideKeyboard(); sleep(2); $this->test->touchPositionedButon(2); sleep(2); $this->test->touchPositionedButon(3); $this->test->clickOnButton('SIGN UP', 300); } ``` - clickOnButton clicks on the button with label 'SIGN UP' then 'SIGN UP WITH EMAIL' - setText updates the text field with value 'First name' to $params->firstName - hideKeyboard closes the Keyboard (not working on all iOS devices) - touchPositionedButon taps on a button or checkbox according his position ### AppTestCase [](#apptestcase) ``` protected $locatorStrategy = ILocatorStrategy::class_chain; protected $classChainSearch = IClassChainSearch::label; use Button; use TextField; public function setLocatorStrategy($locatorStrategy) { switch ($locatorStrategy) { case ILocatorStrategy::class_chain: $this->locatorStrategy = ILocatorStrategy::class_chain; break; case ILocatorStrategy::predicate_string: $this->locatorStrategy = ILocatorStrategy::predicate_string; break; case ILocatorStrategy::accessibility_id: $this->locatorStrategy = ILocatorStrategy::accessibility_id; break; } } public function setClassChainSearch($classChainSearch) { switch ($classChainSearch) { case IClassChainSearch::label: $this->locatorStrategy = IClassChainSearch::label; break; case IClassChainSearch::name: $this->locatorStrategy = IClassChainSearch::name; break; case IClassChainSearch::value: $this->locatorStrategy = IClassChainSearch::value; break; } } ``` ### ILocatorStrategy interface [](#ilocatorstrategy-interface) default locatorStrategy is class chain, you can override it with the following statement ``` $this->test->setLocatorStrategy(ILocatorStrategy::accessibility_id); ``` ### IClassChainSearch interface [](#iclasschainsearch-interface) IClassChainSearch is an interface which defines the way to search element in the class chain pattern, for example to search a button ``` public static $button = "**/XCUIElementTypeButton[%s == '%s']"; ``` default value defined in AppTestCase is label, so each time clickOnButton is called, the previous statement becomes ``` public static $button = "**/XCUIElementTypeButton['label' == '%s']"; ``` you can override it with the following statement ``` $this->test->setClassChainSearch(IClassChainSearch::name); OR $this->test->setClassChainSearch(IClassChainSearch::value); ``` full example here ``` $this->test->clickOnButton('SIGN UP', 400); $this->test->setLocatorStrategy("name"); $this->test->clickOnButton('button_name', 400); $this->test->setLocatorStrategy("value"); $this->test->clickOnButton('button_value', 400); ``` - the first clickOnButton clicks on button with label 'SIGN UP' - the second clickOnButton clicks on button with name 'button\_name' - the third clickOnButton clicks on button with value 'button\_value' The second parameter of clickOnButton defines the time in ms before to perform the action ### Health Score 31 — LowBetter than 68% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity13 Limited adoption so far Community8 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure 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 ~5 days Total 12 Last Release 2784d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/da28e41ba5591b36d409e3a4ed6e7405f46a2e42f2630e7bc36368dc9b26130c?d=identicon)[walterwhites](/maintainers/walterwhites) --- Top Contributors [![walterwhites](https://avatars.githubusercontent.com/u/18416544?v=4)](https://github.com/walterwhites "walterwhites (31 commits)") ### Embed Badge ![Health badge](/badges/walterwhites-appium-module/health.svg) ``` [![Health](https://phpackages.com/badges/walterwhites-appium-module/health.svg)](https://phpackages.com/packages/walterwhites-appium-module) ``` ### Alternatives [phpspec/prophecy Highly opinionated mocking framework for PHP 5.3+ 8.5k551.7M682](/packages/phpspec-prophecy)[vimeo/psalm A static analysis tool for finding errors in PHP applications 5.8k77.5M6.7k](/packages/vimeo-psalm)[brianium/paratest Parallel testing for PHP 2.5k118.8M754](/packages/brianium-paratest)[beberlei/assert Thin assertion library for input validation in business models. 2.4k96.9M570](/packages/beberlei-assert)[mikey179/vfsstream Virtual file system to mock the real file system in unit tests. 1.4k108.0M2.7k](/packages/mikey179-vfsstream)[orchestra/testbench Laravel Testing Helper for Packages Development 2.2k39.1M32.1k](/packages/orchestra-testbench) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)