5b36e303a7
* Render commands markdown using YML * Made directory 'commands-yml' which contains: * .babelrc to transpile the scripts * parse.js which renders the markdown * template.md which is a handlebars template that the yml gets passed to * validator.js which validates the yml data * The rendering works by translating the yml to js, validating the js and then passing the data to template.md (which uses handlebars) * The directory `/commands-yml/commands` gets rendered and then copied to `/docs/en/commands` as markdown * Uses babel-node to run the script * Uses validatejs to validate the javascript * Template.yml is just a sample * Infers the platform and appium support range from driver * For example, if you put in 'xcuitest: true' it will infer that platform support is 9.3+ and Appium Version is 1.6.0
Appium
Appium is an open source, cross-platform test automation tool for native, hybrid and mobile web and desktop apps. We support simulators (iOS), emulators (Android), and real devices (iOS, Android, Windows, Mac).
Want to skip straight to the action? Check out our getting started doc.
Supported Platforms
Appium supports app automation across a variety of platforms, like iOS, Android, and Windows. Each platform is supported by one or more "drivers", which know how to automate that particular platform. Choose a driver below for specific information about how that driver works and how to set it up:
- iOS
- The XCUITest Driver
- (DEPRECATED) The UIAutomation Driver
- Android
- (BETA) The Espresso Driver
- The UiAutomator2 Driver
- (DEPRECATED) The UiAutomator Driver
- (DEPRECATED) The Selendroid Driver
- The Windows Driver (for Windows Desktop apps)
- The Mac Driver (for Mac Desktop apps)
Why Appium?
- You don't have to recompile your app or modify it in any way, due to use of standard automation APIs on all platforms.
- You can write tests with your favorite dev tools using any WebDriver-compatible language such as Java, Objective-C, JavaScript (Node), PHP, Python, Ruby, C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries.
- You can use any testing framework.
- Appium has built-in mobile web and hybrid app support. Within the same script you can switch seamlessly between native app automation and webview automation, all using the WebDriver model that's already the standard for web automation.
Investing in the WebDriver protocol means you are betting on a single, free and open protocol for testing that has become a web standard. Don't lock yourself into a proprietary stack.
For example, if you use Apple's XCUITest library without Appium you can only write tests using Obj-C/Swift, and you can only run tests through Xcode. Similarly, with Google's UiAutomator or Espresso you can only write tests in Java. Appium opens up the possibility of true cross-platform native app automation, for mobile and beyond. Finally!
If you're new to Appium, or want a fuller description of what this is all about, please read our Introduction to Appium Concepts.
Requirements
Your environment needs to be set up for the particular platforms that you want to run tests on. Each of the drivers above documents the requirements for their particular brand of automation. At a minimum, you will need to be able to run Node.js 6+.
Get Started
Check out our Getting Started guide to get going with Appium.
There is also a repository that contains many examples of tests in a variety of different languages!
Documentation
For prettily-rendered docs, please visit appium.io. You can always find the full list of Appium doc pages at Appium's GitHub Repo as well.
Contributing
Please take a look at our contribution documentation for instructions on how to build, test and run Appium from source.
Roadmap
Interested in where Appium is heading in the future? Check out the Roadmap
Project History, Credits & Inspiration
User Forums
Announcements and debates often take place on the Discussion Group, be sure to sign up!
Troubleshooting
We put together a troubleshooting guide. Please have a look here first if you run into any problems. It contains instructions for checking a lot of common errors and how to get in touch with the community if you're stumped.
License
