├── LICENSE ├── README.md └── tests └── test_unittest.py /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Appium Web tests for AWS Device Farm 2 | This test demonstrates how to test a web application using AWS Device Farm and Appium Python. You can use these tests as a reference for your own AWS Device Farm Appium Python tests. 3 | 4 | # Background 5 | What Is Appium Python? 6 | 7 | Appium is an open-source tool for automating native, mobile web, and hybrid applications on platforms such as Android and iOS. For more information, see [About Appium](http://appium.io/slate/en/master/?ruby#about-appium). 8 | 9 | # Getting started 10 | 1. Follow the [official Appium getting started guide](http://appium.io/slate/en/tutorial/android.html?java#getting-started-with-appium) and install the Appium server and dependencies. 11 | 12 | AWS Device Farm supports Appium version 1.4.10. Using a different version locally may cause unexpected results when running Appium tests on AWS Device Farm. 13 | 14 | 2. In order to use 1.4.10, download Appium through NPM with this command: 15 | ```shell 16 | npm install -g appium@1.4.10 17 | ``` 18 | 3. Verify that you have Appium installed with this command: appium -v You should get "1.4.10" as the output 19 | 20 | ## Steps to package your tests 21 | The Appium Python test packages you upload to Device Farm must be in .zip format and contain all the dependencies of your test. The following instructions show you how to meet these requirements. 22 | 23 | Note: The instructions below are based for Linux x86_64 and Mac. In the current scheme of things Device Farm requires that the packaging of your Appium Python Tests be done on Linux x86_64 if your tests contain non-universal wheels dependencies. The reason for this is that Python wheel gathers the dependencies, your .whl files under the wheelhouse/ folder, for the platform on which you execute the command. Executing the python wheel command on any platform other than Linux x86_64 would gather the flavor of a non-univesral wheel dependency for that particular platform and may cause undesired effects which most likely will lead to errors while executing your tests on Device Farm 24 | 25 | 1. It is highly recommended that you set up [Python virtualenv](https://pypi.python.org/pypi/virtualenv) for developing and packaging tests so that the unnecessary dependencies are not included in your test package. 26 | 27 | - Do not create a Python virtualenv with ‘--system-site-packages’ option because it will inherit packages from /usr/lib/pythonx.x/site-packages or wherever your global site-packages directory is. This can lead to you including dependencies in your virtual environment that are not needed by your tests. 28 | - You should also verify that your tests do not use dependencies that are dependent on native libraries as these native libraries may or may not be present on the instance where these tests run. 29 | - Install py.test in your virtual environment 30 | 31 | An example flow of creating a virtual environment using Python virtualenv would look like: 32 | ```shell 33 | $ virtualenv workspace 34 | $ cd workspace 35 | $ source bin/activate 36 | $ pip install pytest 37 | ``` 38 | 39 | 2. Store all python test scripts under the tests/ folder in your work space. 40 | ```shell 41 | - workspace 42 | | 43 | - tests/ (your tests go here) 44 | ``` 45 | 46 | Make sure you have py.test installed in your virtual environment and test cases are discoverable by the following command which you should run from your virtual environment ‘workspace' folder. Make sure the output of py.test command below shows you the tests that you want to execute on Device Farm 47 | ```shell 48 | $ py.test --collect-only tests/ 49 | ``` 50 | 51 | 3. Go to your work space and run the following command to generate the requirements.txt file. 52 | ```shell 53 | $ pip freeze > requirements.txt 54 | ``` 55 | 56 | 4. Go to your work space and run the following command to generate the wheelhouse/ folder: 57 | ```shell 58 | $ pip wheel --wheel-dir wheelhouse -r requirements.txt 59 | ``` 60 | 61 | 5. You can clean all cached files under your tests/ folder with the following commands: 62 | ```shell 63 | $ find . -name '__pycache__' -type d -exec rm -r {} + 64 | $ find . -name '*.pyc' -exec rm -f {} + 65 | $ find . -name '*.pyo' -exec rm -f {} + 66 | $ find . -name '*~' -exec rm -f {} + 67 | ``` 68 | 69 | 6. Zip the tests/ folder, wheelhouse/ folder, and the requirements.txt file into a single archive: 70 | ```shell 71 | $ zip -r test_bundle.zip tests/ wheelhouse/ requirements.txt 72 | ``` 73 | 74 | 7. Your workspace would eventually look like: 75 | ```shell 76 | - workspace 77 | | 78 | - tests/ 79 | | 80 | - test_bundle.zip 81 | | 82 | - requirements.txt 83 | | 84 | - wheelhouse/ 85 | ``` 86 | 87 | ## Upload and Run your Web Application Appium Python Tests 88 | Use the Device Farm console to upload your tests: 89 | 90 | 1. [Sign in to the Device Farm console.](https://console.aws.amazon.com/devicefarm) 91 | 92 | 2. If you see the AWS Device Farm console home page, choose Get started. 93 | 94 | 3. If you already have a project, you can upload your tests to an existing project or choose Create a new project. 95 | 96 | 4. If the Create a new run button is displayed, then choose it. 97 | 98 | 5. On the Choose your application page, choose Web Application (the HTML5 button) 99 | 100 | 6. Provide a name for your run in the Run name field. 101 | 102 | 7. Configure your test by choosing Appium Python. 103 | 104 | 8. Next, choose Upload to upload your .zip file. Device Farm processes your .zip file before continuing. 105 | 106 | 9. Choose Next step, and then complete the remaining on-screen instructions to select devices and start the run. 107 | -------------------------------------------------------------------------------- /tests/test_unittest.py: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 | # 4 | # Licensed under the Apache License, Version 2.0 (the "License"). 5 | # You may not use this file except in compliance with the License. 6 | # A copy of the License is located at 7 | # 8 | # http://aws.amazon.com/apache2.0 9 | # 10 | # or in the "license" file accompanying this file. This file is distributed 11 | # on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 12 | # express or implied. See the License for the specific language governing 13 | # permissions and limitations under the License. 14 | # 15 | 16 | import os 17 | import unittest 18 | from appium import webdriver 19 | from time import sleep 20 | 21 | 22 | class DeviceFarmAppiumWebTests(unittest.TestCase): 23 | 24 | def setUp(self): 25 | desired_caps = {} 26 | self.driver = webdriver.Remote( 27 | 'http://127.0.0.1:4723/wd/hub', desired_caps) 28 | 29 | def tearDown(self): 30 | self.driver.quit() 31 | 32 | def test_devicefarm(self): 33 | self.driver.get( 34 | 'http://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html') 35 | sleep(5) 36 | screenshot_folder = os.getenv('SCREENSHOT_PATH', '/tmp') 37 | self.driver.save_screenshot(screenshot_folder + '/devicefarm.png') 38 | sleep(5) 39 | 40 | # Start of script 41 | if __name__ == '__main__': 42 | suite = unittest.TestLoader().loadTestsFromTestCase(DeviceFarmAppiumWebTests) 43 | unittest.TextTestRunner(verbosity=2).run(suite) 44 | --------------------------------------------------------------------------------