├── .flake8 ├── .github └── workflows │ └── assess-code.yml ├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE.md ├── README.md ├── _config.yml ├── demoauto ├── __init__.py ├── browsers │ ├── __init__.py │ ├── chrome.py │ ├── firefox.py │ ├── remote.py │ └── safari.py ├── driver │ ├── __init__.py │ ├── driver.py │ └── web_driver.py ├── image │ ├── allure.png │ └── report.png ├── input │ ├── __init__.py │ ├── register.py │ └── sign_on.py ├── locators │ ├── __init__.py │ ├── home.py │ ├── register.py │ └── sing_on.py ├── map │ ├── __init__.py │ ├── conditions.py │ ├── elements.py │ ├── handlers.py │ ├── urls.py │ └── waits.py └── pages │ ├── __init__.py │ ├── base.py │ ├── home.py │ ├── register.py │ └── sing_on.py ├── media ├── icon.png └── usage.gif ├── mypy.ini ├── pyproject.toml ├── pytest.ini ├── requirements-dev.txt ├── requirements.txt ├── run-code-analysis.sh ├── run-tests.sh └── tests ├── __init__.py ├── conftest.py ├── coverage ├── __init__.py ├── functional │ ├── __init__.py │ └── pages │ │ ├── __init__.py │ │ ├── test_home_page.py │ │ └── test_register_page.py ├── markers.py └── unit │ ├── __init__.py │ ├── browsers │ ├── __init__.py │ ├── conftest.py │ └── test_browsers.py │ └── map │ ├── __init__.py │ └── test_urls.py └── plugins ├── __init__.py ├── browser.py ├── handler.py ├── hooks.py ├── input.py ├── locators.py ├── pages.py └── urls.py /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max_complexity = 10 3 | max-line-length = 120 4 | statistics = True 5 | count = True 6 | -------------------------------------------------------------------------------- /.github/workflows/assess-code.yml: -------------------------------------------------------------------------------- 1 | name: Python source code assessment 🐍 2 | on: [push] 3 | jobs: 4 | build: 5 | runs-on: ubuntu-latest 6 | strategy: 7 | max-parallel: 4 8 | matrix: 9 | python-version: 10 | - 3.7 11 | - 3.8 12 | - 3.9 13 | steps: 14 | - uses: actions/checkout@v1 15 | - name: Set up Python ${{ matrix.python-version }} 16 | uses: actions/setup-python@v1 17 | with: 18 | python-version: ${{ matrix.python-version }} 19 | - name: Static code analysis 20 | run: | 21 | pip install pip==20.2.0 22 | pip install -r requirements.txt 23 | pip install -r requirements-dev.txt 24 | ./run-code-analysis.sh -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Pycharm trash 2 | .idea 3 | __pycache__/ 4 | 5 | # virtualenv 6 | .venv 7 | venv/ 8 | venv 9 | 10 | # Distribution 11 | .DS_Store 12 | .cache/ 13 | 14 | # python identifiers 15 | .python-version 16 | 17 | # pytest report 18 | test-report.html 19 | assets/ 20 | .coverage 21 | report/ 22 | 23 | # browser trash 24 | geckodriver.log -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "3.6" 4 | - "3.7" 5 | - "3.8" 6 | - "3.9" 7 | addons: 8 | apt: 9 | update: true 10 | before_install: 11 | # Install dependencies 12 | - sudo apt-get install -y chromium-browser 13 | # Install ChromeDriver (64bits; replace 64 with 32 for 32bits). 14 | - wget -N http://chromedriver.storage.googleapis.com/78.0.3904.105/chromedriver_linux64.zip -P ~/ 15 | - unzip ~/chromedriver_linux64.zip -d ~/ 16 | - rm ~/chromedriver_linux64.zip 17 | - sudo mv -f ~/chromedriver /usr/local/share/ 18 | - sudo chmod +x /usr/local/share/chromedriver 19 | - sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver 20 | install: 21 | - pip install --no-cache-dir --upgrade pip 22 | - pip install -r requirements.txt 23 | - pip install -r requirements-dev.txt 24 | script: 25 | - ./run-code-analysis.sh 26 | after_success: 27 | - coveralls 28 | notifications: 29 | email: false -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | * 0.3.1 2 | * Create demo tests execution 3 | * Move demoaut web site to a new base URL endpoin 4 | * Remove redundant fake project image 5 | * Create github actions 6 | * Fix github docs link 7 | * Add description for development tools 8 | * Install coverage package within CI 9 | * 0.3.0 10 | * Introduce allure integration 11 | * 0.2.0 12 | * Introduce travis CI 13 | * Add static code analysis tools (`black`, `flake8` and `mypy`) along with unittests 14 | * 0.1.0 15 | * Distribute initial version 16 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 2018 Volodymyr Yahello 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Screenshot](media/icon.png) 2 | 3 | [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) 4 | [![Build Status](https://travis-ci.org/vyahello/python-page-object.svg?branch=master)](https://travis-ci.org/vyahello/python-page-object) 5 | [![Coverage Status](https://coveralls.io/repos/github/vyahello/python-page-object/badge.svg?branch=master)](https://coveralls.io/github/vyahello/python-page-object?branch=master) 6 | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) 7 | [![Checked with flake8](https://img.shields.io/badge/flake8-checked-blue)](http://flake8.pycqa.org/) 8 | [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) 9 | [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE.md) 10 | [![CodeFactor](https://www.codefactor.io/repository/github/utestpy/python-page-object/badge)](https://www.codefactor.io/repository/github/utestpy/python-page-object) 11 | [![Docs](https://img.shields.io/badge/docs-github-orange)](https://vyahello.github.io/python-page-object) 12 | [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org) 13 | 14 | # Python page object model (PyPOM) 15 | > Represent most popular OOD pattern for Web UI automation using python programming language (for learning reference only). 16 | > 17 | > Automated tests are demonstrated on http://demo.guru99.com/test/newtours web application. 18 | 19 | ## Tools 20 | 21 | ### Production 22 | - python 3.6, 3.7, 3.8, 3.9 23 | - [pytest](https://pypi.org/project/pytest/) framework 24 | - [selenium](https://selenium.dev/) library 25 | - [pom](https://www.guru99.com/page-object-model-pom-page-factory-in-selenium-ultimate-guide.html) framework 26 | - [allure](https://docs.qameta.io/allure/) reporting 27 | - [travis](https://travis-ci.org/) CI 28 | 29 | ### Development 30 | - [mypy](http://mypy.readthedocs.io/en/latest) static type checker tool 31 | - [black](https://black.readthedocs.io/en/stable/) code formatter tool 32 | - [flake8](http://flake8.pycqa.org/en/latest/) code style tool 33 | 34 | > In addition, a source code is **fully** [type annotated](https://docs.python.org/3/library/typing.html) ⭐ 35 | 36 | ## Usage 37 | ![Usage](media/usage.gif) 38 | 39 | ### Quick start 40 | From the root directory of your shell run following command: 41 | 42 | ```bash 43 | ./run-tests.sh help 44 | 45 | Tool allows to simplify run of automated tests for POM sample project. 46 | 47 | Available actions: 48 | - smoke run automated smoke tests 49 | - unittest run automated unittest tests 50 | - all run all automated tests 51 | - help display help 52 | 53 | Note: help will be provided in case of no input parameters 54 | ``` 55 | 56 | ### Tests (html) report sample 57 | Run a bunch of tests (e.g smoke) via following command: 58 | ```bash 59 | ./run-tests.sh smoke 60 | ``` 61 | 62 | Then please open `test-report.html` file to see detailed testing report e.g: 63 | 64 | ![Screenshot](demoauto/image/report.png) 65 | 66 | ### Generate allure report 67 | Please follow next instruction to generate allure report (mac OS example): 68 | 1. Update java via `brew cask install adoptopenjdk` 69 | 2. Install allure via `brew install allure` 70 | 3. Generate allure project via `allure serve report` 71 | 72 | ![Screenshot](demoauto/image/allure.png) 73 | 74 | ## Development notes 75 | 76 | ### Selenium grid setup 77 | 78 | 1. Install selenium grid from https://www.selenium.dev/downloads 79 | 2. Run in standalone mode 80 | ```bash 81 | java -jar selenium-server-4.0.0-alpha-7.jar standalone --port 9515 82 | pytest 83 | ``` 84 | 3. Run in hub & node mode 85 | ```bash 86 | java -jar selenium-server-4.0.0-alpha-7.jar hub --port 9515 87 | java -jar selenium-server-4.0.0-alpha-7.jar node --port 5555 88 | pytest 89 | ``` 90 | 91 | ### Release History 92 | 93 | Please check [changelog](CHANGELOG.md) file to get more details about actual versions and it's release notes. 94 | 95 | ### Meta 96 | Author – _Volodymyr Yahello_. 97 | 98 | Distributed under the `GPL v3` license. See [license](LICENSE.md) for more information. 99 | 100 | You can reach out me at: 101 | * [vyahello@gmail.com](vyahello@gmail.com) 102 | * [https://github.com/vyahello](https://github.com/vyahello) 103 | * [https://www.linkedin.com/in/volodymyr-yahello-821746127](https://www.linkedin.com/in/volodymyr-yahello-821746127) 104 | 105 | ### Contributing 106 | I would highly appreciate any contribution and support. If you are interested to add your ideas into project please follow next simple steps: 107 | 108 | 1. Clone the repository 109 | 2. Configure `git` for the first time after cloning with your `name` and `email` 110 | 3. `pip install -r requirements.txt` to install all project dependencies 111 | 4. `pip install -r requirements-dev.txt` to install all development project dependencies 112 | 5. Create your feature branch (`git checkout -b feature/fooBar`) 113 | 6. Commit your changes (`git commit -am 'Add some fooBar'`) 114 | 7. Push to the branch (`git push origin feature/fooBar`) 115 | 8. Create a new Pull Request 116 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-cayman -------------------------------------------------------------------------------- /demoauto/__init__.py: -------------------------------------------------------------------------------- 1 | __author__: str = "Volodymyr Yahello" 2 | __email__: str = "vyahello@gmail.com" 3 | -------------------------------------------------------------------------------- /demoauto/browsers/__init__.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from demoauto.driver.driver import Driver 3 | 4 | 5 | class WebBrowser(ABC): 6 | """Abstraction of a web browser.""" 7 | 8 | @abstractmethod 9 | def driver(self) -> Driver: 10 | pass 11 | 12 | @abstractmethod 13 | def name(self) -> str: 14 | pass 15 | 16 | 17 | class WebBrowserError(Exception): 18 | """Represent web browser error.""" 19 | 20 | pass 21 | -------------------------------------------------------------------------------- /demoauto/browsers/chrome.py: -------------------------------------------------------------------------------- 1 | from selenium import webdriver 2 | from selenium.webdriver.chrome.webdriver import WebDriver 3 | from demoauto.browsers import WebBrowser 4 | from demoauto.driver.web_driver import WebDriverOf 5 | from demoauto.driver.driver import Driver 6 | 7 | 8 | class Chrome(WebBrowser): 9 | """Representation of a chrome web browser.""" 10 | 11 | def __init__(self) -> None: 12 | options = webdriver.ChromeOptions() 13 | options.add_argument("--start-maximized") 14 | options.add_argument("--no-sandbox") 15 | self._chrome: WebDriver = webdriver.Chrome( 16 | desired_capabilities=options.to_capabilities() 17 | ) 18 | 19 | def driver(self) -> Driver: 20 | return WebDriverOf(self._chrome) 21 | 22 | def name(self) -> str: 23 | return "Chrome" 24 | -------------------------------------------------------------------------------- /demoauto/browsers/firefox.py: -------------------------------------------------------------------------------- 1 | from selenium import webdriver 2 | from selenium.webdriver.chrome.webdriver import WebDriver 3 | from demoauto.browsers import WebBrowser 4 | from demoauto.driver.web_driver import WebDriverOf 5 | from demoauto.driver.driver import Driver 6 | 7 | 8 | class FireFox(WebBrowser): 9 | """Representation of a firefox web browser.""" 10 | 11 | def __init__(self) -> None: 12 | self._firefox: WebDriver = webdriver.Firefox() 13 | 14 | def driver(self) -> Driver: 15 | return WebDriverOf(self._firefox) 16 | 17 | def name(self) -> str: 18 | return "Firefox" 19 | -------------------------------------------------------------------------------- /demoauto/browsers/remote.py: -------------------------------------------------------------------------------- 1 | from selenium.webdriver import Remote, ChromeOptions 2 | from selenium.webdriver.chrome.webdriver import WebDriver 3 | from demoauto.browsers import WebBrowser 4 | from demoauto.driver.web_driver import WebDriverOf 5 | from demoauto.driver.driver import Driver 6 | 7 | 8 | class RemoteBrowser(WebBrowser): 9 | """Representation of a remote web browser.""" 10 | 11 | def __init__(self, remote_url: str = "localhost:9515") -> None: 12 | self._remote: WebDriver = Remote( 13 | command_executor=remote_url, 14 | options=ChromeOptions(), 15 | ) 16 | 17 | def driver(self) -> Driver: 18 | return WebDriverOf(self._remote) 19 | 20 | def name(self) -> str: 21 | return "Remote" 22 | -------------------------------------------------------------------------------- /demoauto/browsers/safari.py: -------------------------------------------------------------------------------- 1 | from selenium import webdriver 2 | from selenium.webdriver.chrome.webdriver import WebDriver 3 | from demoauto.browsers import WebBrowser 4 | from demoauto.driver.web_driver import WebDriverOf 5 | from demoauto.driver.driver import Driver 6 | 7 | 8 | class Safari(WebBrowser): 9 | """Representation of a safari web browser.""" 10 | 11 | def __init__(self) -> None: 12 | self._safari: WebDriver = webdriver.Safari() 13 | 14 | def driver(self) -> Driver: 15 | return WebDriverOf(self._safari) 16 | 17 | def name(self) -> str: 18 | return "Safari" 19 | -------------------------------------------------------------------------------- /demoauto/driver/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/demoauto/driver/__init__.py -------------------------------------------------------------------------------- /demoauto/driver/driver.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from demoauto.map.elements import Element 3 | 4 | 5 | class Driver(ABC): 6 | """Abstraction of a web driver.""" 7 | 8 | @abstractmethod 9 | def get(self, url: str) -> None: 10 | pass 11 | 12 | @abstractmethod 13 | def set_page_load_timeout(self, time_to_wait: int) -> None: 14 | pass 15 | 16 | @abstractmethod 17 | def implicitly_wait(self, time_to_wait: int) -> None: 18 | pass 19 | 20 | @abstractmethod 21 | def find_element(self, by_: str, value: str) -> Element: 22 | pass 23 | 24 | @abstractmethod 25 | def maximize_window(self) -> None: 26 | pass 27 | 28 | @abstractmethod 29 | def close(self) -> None: 30 | pass 31 | -------------------------------------------------------------------------------- /demoauto/driver/web_driver.py: -------------------------------------------------------------------------------- 1 | from typing import Any 2 | from demoauto.driver.driver import Driver 3 | from demoauto.map.elements import Element, WebElement 4 | 5 | 6 | class WebDriverOf(Driver): 7 | """Represent selenium web driver object.""" 8 | 9 | def __init__(self, driver: Any) -> None: 10 | self._driver = driver 11 | 12 | def get(self, url: str) -> None: 13 | self._driver.get(url) 14 | 15 | def set_page_load_timeout(self, time_to_wait: int) -> None: 16 | self._driver.set_page_load_timeout(time_to_wait) 17 | 18 | def find_element(self, by_: str, locator: str) -> Element: 19 | return WebElement(self._driver.find_element(by_, locator)) 20 | 21 | def implicitly_wait(self, time_to_wait: int) -> None: 22 | self._driver.implicitly_wait(time_to_wait) 23 | 24 | def maximize_window(self) -> None: 25 | self._driver.maximize_window() 26 | 27 | def close(self) -> None: 28 | self._driver.close() 29 | self._driver.quit() 30 | -------------------------------------------------------------------------------- /demoauto/image/allure.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/demoauto/image/allure.png -------------------------------------------------------------------------------- /demoauto/image/report.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/demoauto/image/report.png -------------------------------------------------------------------------------- /demoauto/input/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/demoauto/input/__init__.py -------------------------------------------------------------------------------- /demoauto/input/register.py: -------------------------------------------------------------------------------- 1 | class RegisterPageInput: 2 | """Represent register page input data.""" 3 | 4 | first_name: str = "Volodymyr" 5 | last_name: str = "Yahello" 6 | phone: str = "+709-319-789" 7 | email: str = "fancy_world@gmail.com" 8 | country: str = "UKRAINE" 9 | user_name: str = "vyahello" 10 | password: str = "password" 11 | -------------------------------------------------------------------------------- /demoauto/input/sign_on.py: -------------------------------------------------------------------------------- 1 | class SignOnPageInput: 2 | """Represent sign on page input data.""" 3 | 4 | user_name: str = "vyahello" 5 | password: str = "password" 6 | -------------------------------------------------------------------------------- /demoauto/locators/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/demoauto/locators/__init__.py -------------------------------------------------------------------------------- /demoauto/locators/home.py: -------------------------------------------------------------------------------- 1 | class HomePage: 2 | """Represent home page web element locators.""" 3 | 4 | logo: str = "//img[@alt='Mercury Tours']" 5 | sing_on: str = "//a[contains(text(), 'SIGN-ON')]" 6 | register: str = "//a[contains(text(), 'REGISTER')]" 7 | support: str = "//a[contains(text(), 'SUPPORT')]" 8 | contact: str = "//a[contains(text(), 'CONTACT')]" 9 | -------------------------------------------------------------------------------- /demoauto/locators/register.py: -------------------------------------------------------------------------------- 1 | class RegistrationPage: 2 | """Represent registration page web element locators.""" 3 | 4 | regis_txt: str = "//*[contains(text(), 'basic information')]" 5 | first_name: str = "//input[@name='firstName']" 6 | last_name: str = "//input[@name='lastName']" 7 | phone: str = "//input[@name='phone']" 8 | email: str = "//input[@name='email']" 9 | country: str = "//select[@name='country']" 10 | user_name: str = "//input[@name='userName']" 11 | password: str = "//input[@name='password']" 12 | confirm_password: str = "//input[@name='confirmPassword']" 13 | submit: str = "//input[@name='submit']" 14 | thank_you: str = "//*[contains(text(), 'Thank you for registering')]" 15 | post_user: str = "//*[contains(text(), 'Your user name is')]" 16 | -------------------------------------------------------------------------------- /demoauto/locators/sing_on.py: -------------------------------------------------------------------------------- 1 | class SingOnPage: 2 | """Represent sign on page web element locators.""" 3 | 4 | user_name: str = "//input[@name='userName']" 5 | password: str = "//input[@name='password']" 6 | login: str = "//input[@name='login']" 7 | txt: str = "//*[contains(text(), 'Enter your user')]" 8 | register_link: str = "//*[starts-with(@href, 'mercuryregister.php')]" 9 | -------------------------------------------------------------------------------- /demoauto/map/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/demoauto/map/__init__.py -------------------------------------------------------------------------------- /demoauto/map/conditions.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from selenium.webdriver.support.expected_conditions import ( 3 | presence_of_element_located as PresenceOfElement, 4 | ) 5 | 6 | 7 | class Condition(ABC): 8 | """Abstraction of web element condition.""" 9 | 10 | @abstractmethod 11 | def presence_of_element_located(self) -> PresenceOfElement: 12 | pass 13 | 14 | 15 | class ExpectedCondition(Condition): 16 | """Represent expected condition of a web element.""" 17 | 18 | def __init__(self, *locators: str) -> None: 19 | self._presence_of_element_located: PresenceOfElement = ( 20 | PresenceOfElement(locators) 21 | ) 22 | 23 | def presence_of_element_located(self) -> PresenceOfElement: 24 | return self._presence_of_element_located 25 | -------------------------------------------------------------------------------- /demoauto/map/elements.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from selenium.webdriver.remote import webelement 3 | 4 | 5 | class Element(ABC): 6 | """Abstraction of a web element.""" 7 | 8 | @abstractmethod 9 | def text(self, by: str, value: str) -> str: 10 | pass 11 | 12 | @abstractmethod 13 | def element(self) -> webelement.WebElement: 14 | pass 15 | 16 | @abstractmethod 17 | def is_displayed(self) -> bool: 18 | pass 19 | 20 | @abstractmethod 21 | def clear(self) -> None: 22 | pass 23 | 24 | @abstractmethod 25 | def send_keys(self, value: str) -> None: 26 | pass 27 | 28 | @abstractmethod 29 | def click(self) -> None: 30 | pass 31 | 32 | 33 | class WebElement(Element): 34 | """Represent concrete web element.""" 35 | 36 | def __init__(self, element: webelement.WebElement) -> None: 37 | self._element = element 38 | 39 | def text(self, by: str, value: str) -> str: 40 | return self._element.find_element(by, value).text 41 | 42 | def element(self) -> webelement.WebElement: 43 | return self._element 44 | 45 | def is_displayed(self) -> bool: 46 | return self._element.is_displayed() 47 | 48 | def clear(self) -> None: 49 | self._element.clear() 50 | 51 | def send_keys(self, value: str) -> None: 52 | self._element.send_keys(value) 53 | 54 | def click(self) -> None: 55 | self._element.click() 56 | -------------------------------------------------------------------------------- /demoauto/map/handlers.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from selenium.webdriver.common.by import By 3 | 4 | 5 | class HandlerBy(ABC): 6 | """Abstraction of a handler.""" 7 | 8 | @abstractmethod 9 | def id(self) -> str: 10 | pass 11 | 12 | @abstractmethod 13 | def xpath(self) -> str: 14 | pass 15 | 16 | @abstractmethod 17 | def link_text(self) -> str: 18 | pass 19 | 20 | @abstractmethod 21 | def partial_link_text(self) -> str: 22 | pass 23 | 24 | @abstractmethod 25 | def name(self) -> str: 26 | pass 27 | 28 | @abstractmethod 29 | def tag_name(self) -> str: 30 | pass 31 | 32 | @abstractmethod 33 | def class_name(self) -> str: 34 | pass 35 | 36 | @abstractmethod 37 | def css_selector(self) -> str: 38 | pass 39 | 40 | 41 | class WebHandlerBy(HandlerBy): 42 | """Represent web handler search.""" 43 | 44 | def __init__(self) -> None: 45 | self._by: By = By() 46 | 47 | def id(self) -> str: 48 | return self._by.ID 49 | 50 | def xpath(self) -> str: 51 | return self._by.XPATH 52 | 53 | def link_text(self) -> str: 54 | return self._by.LINK_TEXT 55 | 56 | def partial_link_text(self) -> str: 57 | return self._by.PARTIAL_LINK_TEXT 58 | 59 | def name(self) -> str: 60 | return self._by.NAME 61 | 62 | def tag_name(self) -> str: 63 | return self._by.TAG_NAME 64 | 65 | def class_name(self) -> str: 66 | return self._by.CLASS_NAME 67 | 68 | def css_selector(self) -> str: 69 | return self._by.CSS_SELECTOR 70 | -------------------------------------------------------------------------------- /demoauto/map/urls.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | 3 | 4 | BASE_DEMO_URL = "http://demo.guru99.com/test/newtours" 5 | 6 | 7 | class Url(ABC): 8 | """Abstraction of a page url.""" 9 | 10 | @abstractmethod 11 | def get(self) -> str: 12 | pass 13 | 14 | 15 | class PageUrl(Url): 16 | """Represent web page url.""" 17 | 18 | def __init__(self, url: str) -> None: 19 | self._url: str = url 20 | 21 | def get(self) -> str: 22 | return self._url 23 | 24 | 25 | class HomePageUrl(Url): 26 | """Represent home page url.""" 27 | 28 | def __init__(self) -> None: 29 | self._url: Url = PageUrl(f"{BASE_DEMO_URL}/index.php") 30 | 31 | def get(self) -> str: 32 | return self._url.get() 33 | 34 | 35 | class RegisterPageUrl(Url): 36 | """Represent register page url.""" 37 | 38 | def __init__(self) -> None: 39 | self._url: Url = PageUrl(f"{BASE_DEMO_URL}/register.php") 40 | 41 | def get(self) -> str: 42 | return self._url.get() 43 | 44 | 45 | class SignOnPageUrl(Url): 46 | """Represent sign on page url.""" 47 | 48 | def __init__(self) -> None: 49 | self._url: Url = PageUrl(f"{BASE_DEMO_URL}/login.php") 50 | 51 | def get(self) -> str: 52 | return self._url.get() 53 | -------------------------------------------------------------------------------- /demoauto/map/waits.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from typing import Any 3 | from selenium.webdriver.support.wait import WebDriverWait 4 | from demoauto.map.conditions import Condition 5 | from demoauto.driver.driver import Driver 6 | from demoauto.map.elements import Element 7 | 8 | 9 | class Wait(ABC): 10 | """Wait for element abstraction.""" 11 | 12 | @abstractmethod 13 | def until_presence_of_element_located( 14 | self, method: Condition, message: str = "" 15 | ) -> Element: 16 | pass 17 | 18 | @abstractmethod 19 | def until_not_presence_of_element_located( 20 | self, method: Condition, message: str = "" 21 | ) -> Element: 22 | pass 23 | 24 | 25 | class WebDriverWaitOf(Wait): 26 | """Represent web driver wait object.""" 27 | 28 | def __init__( 29 | self, 30 | driver: Driver, 31 | timeout: int = 10, 32 | poll_freq: float = 0.5, 33 | ign_exc: Any = None, 34 | ) -> None: 35 | self._wait: WebDriverWait = WebDriverWait( 36 | driver, timeout, poll_freq, ign_exc 37 | ) 38 | 39 | def until_presence_of_element_located( 40 | self, method: Condition, message: str = "" 41 | ) -> Element: 42 | return self._wait.until(method.presence_of_element_located(), message) 43 | 44 | def until_not_presence_of_element_located( 45 | self, method: Condition, message: str = "" 46 | ) -> Element: 47 | return self._wait.until_not( 48 | method.presence_of_element_located(), message 49 | ) 50 | -------------------------------------------------------------------------------- /demoauto/pages/__init__.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from demoauto.driver.driver import Driver 3 | from demoauto.map.urls import Url 4 | 5 | 6 | class Page(ABC): 7 | """Abstraction of a web page.""" 8 | 9 | @abstractmethod 10 | def driver(self) -> Driver: 11 | pass 12 | 13 | @abstractmethod 14 | def open(self, url: Url = None) -> None: 15 | pass 16 | 17 | @abstractmethod 18 | def close(self) -> None: 19 | pass 20 | -------------------------------------------------------------------------------- /demoauto/pages/base.py: -------------------------------------------------------------------------------- 1 | from functools import lru_cache 2 | from typing import Callable, Optional 3 | from demoauto.browsers import WebBrowser 4 | from demoauto.driver.driver import Driver 5 | from demoauto.pages import Page 6 | from demoauto.map.urls import Url 7 | 8 | 9 | class BasePage(Page): 10 | """Represent base page.""" 11 | 12 | def __init__(self, browser: WebBrowser, url: Url) -> None: 13 | @lru_cache(maxsize=128) 14 | def _driver() -> Driver: 15 | driver: Driver = browser.driver() 16 | driver.set_page_load_timeout(10) 17 | driver.implicitly_wait(10) 18 | driver.get(url.get()) 19 | return driver 20 | 21 | self._url: Url = url 22 | self._driver: Callable[..., Driver] = _driver 23 | 24 | def driver(self) -> Driver: 25 | return self._driver() 26 | 27 | def open(self, url: Optional[Url] = None) -> None: 28 | if not url: 29 | url = self._url 30 | self._driver().get(url.get()) 31 | 32 | def close(self) -> None: 33 | self._driver().close() 34 | -------------------------------------------------------------------------------- /demoauto/pages/home.py: -------------------------------------------------------------------------------- 1 | from demoauto.browsers import WebBrowser 2 | from demoauto.driver.driver import Driver 3 | from demoauto.map.elements import Element 4 | from demoauto.map.handlers import HandlerBy, WebHandlerBy 5 | from demoauto.locators.home import HomePage as HP_Locators 6 | from demoauto.pages import Page 7 | from demoauto.pages.base import BasePage 8 | from demoauto.map.urls import HomePageUrl, Url 9 | 10 | 11 | class HomePage(Page): 12 | """Represent home page.""" 13 | 14 | def __init__(self, browser: WebBrowser) -> None: 15 | self._by: HandlerBy = WebHandlerBy() 16 | self._hp_locators: HP_Locators = HP_Locators() 17 | self._page: Page = BasePage(browser, HomePageUrl()) 18 | 19 | @property 20 | def driver(self) -> Driver: 21 | return self._page.driver() 22 | 23 | def open(self, url: Url = None) -> None: 24 | self._page.open(url) 25 | 26 | def close(self) -> None: 27 | self._page.close() 28 | 29 | def logo(self) -> Element: 30 | return self.driver.find_element( 31 | self._by.xpath(), self._hp_locators.logo 32 | ) 33 | 34 | def contact(self) -> Element: 35 | return self.driver.find_element( 36 | self._by.xpath(), self._hp_locators.contact 37 | ) 38 | 39 | def sign_on(self) -> Element: 40 | return self.driver.find_element( 41 | self._by.xpath(), self._hp_locators.sing_on 42 | ) 43 | 44 | def support(self) -> Element: 45 | return self.driver.find_element( 46 | self._by.xpath(), self._hp_locators.support 47 | ) 48 | 49 | def register(self) -> Element: 50 | return self.driver.find_element( 51 | self._by.xpath(), self._hp_locators.register 52 | ) 53 | -------------------------------------------------------------------------------- /demoauto/pages/register.py: -------------------------------------------------------------------------------- 1 | from selenium.webdriver.support.select import Select 2 | from demoauto.browsers import WebBrowser 3 | from demoauto.map.conditions import ExpectedCondition 4 | from demoauto.driver.driver import Driver 5 | from demoauto.map.elements import Element 6 | from demoauto.map.handlers import HandlerBy, WebHandlerBy 7 | from demoauto.input.register import RegisterPageInput 8 | from demoauto.locators.register import RegistrationPage as RP_Locators 9 | from demoauto.pages import Page 10 | from demoauto.pages.base import BasePage 11 | from demoauto.map.urls import RegisterPageUrl, Url 12 | from demoauto.map.waits import WebDriverWaitOf 13 | 14 | 15 | class RegisterPage(Page): 16 | """Represent register page.""" 17 | 18 | def __init__(self, browser: WebBrowser) -> None: 19 | self._by: HandlerBy = WebHandlerBy() 20 | self._rp_locators: RP_Locators = RP_Locators() 21 | self._page: Page = BasePage(browser, RegisterPageUrl()) 22 | 23 | @property 24 | def driver(self) -> Driver: 25 | return self._page.driver() 26 | 27 | def open(self, url: Url = None) -> None: 28 | self._page.open(url) 29 | 30 | def close(self) -> None: 31 | self._page.close() 32 | 33 | def register_text(self) -> Element: 34 | return self.driver.find_element( 35 | self._by.xpath(), self._rp_locators.regis_txt 36 | ) 37 | 38 | def set_first_name(self, input_: RegisterPageInput) -> Element: 39 | first_name: Element = self.driver.find_element( 40 | self._by.xpath(), self._rp_locators.first_name 41 | ) 42 | first_name.clear() 43 | first_name.send_keys(input_.first_name) 44 | return first_name 45 | 46 | def set_last_name(self, input_: RegisterPageInput) -> None: 47 | last_name: Element = self.driver.find_element( 48 | self._by.xpath(), self._rp_locators.last_name 49 | ) 50 | last_name.clear() 51 | last_name.send_keys(input_.last_name) 52 | 53 | def set_phone(self, input_: RegisterPageInput) -> None: 54 | phone: Element = self.driver.find_element( 55 | self._by.xpath(), self._rp_locators.phone 56 | ) 57 | phone.clear() 58 | phone.send_keys(input_.phone) 59 | 60 | def set_email(self, input_: RegisterPageInput) -> None: 61 | email: Element = self.driver.find_element( 62 | self._by.xpath(), self._rp_locators.email 63 | ) 64 | email.clear() 65 | email.send_keys(input_.email) 66 | 67 | def set_country(self, input_: RegisterPageInput) -> None: 68 | select = Select( 69 | self.driver.find_element( 70 | self._by.xpath(), self._rp_locators.country 71 | ).element() 72 | ) 73 | select.select_by_visible_text(input_.country) 74 | 75 | def set_user_name(self, input_: RegisterPageInput) -> None: 76 | user_name: Element = self.driver.find_element( 77 | self._by.xpath(), self._rp_locators.user_name 78 | ) 79 | user_name.clear() 80 | user_name.send_keys(input_.user_name) 81 | 82 | def set_password(self, input_: RegisterPageInput) -> None: 83 | password: Element = self.driver.find_element( 84 | self._by.xpath(), self._rp_locators.password 85 | ) 86 | password.clear() 87 | password.send_keys(input_.password) 88 | 89 | def confirm_password(self, input_: RegisterPageInput) -> None: 90 | confirm_password: Element = self.driver.find_element( 91 | self._by.xpath(), self._rp_locators.confirm_password 92 | ) 93 | confirm_password.clear() 94 | confirm_password.send_keys(input_.password) 95 | 96 | def submit(self) -> None: 97 | self.driver.find_element( 98 | self._by.xpath(), self._rp_locators.submit 99 | ).click() 100 | 101 | def confirm_registration(self) -> Element: 102 | return WebDriverWaitOf( 103 | driver=self.driver, timeout=30 104 | ).until_presence_of_element_located( 105 | ExpectedCondition(self._by.xpath(), self._rp_locators.thank_you) 106 | ) 107 | -------------------------------------------------------------------------------- /demoauto/pages/sing_on.py: -------------------------------------------------------------------------------- 1 | from demoauto.browsers import WebBrowser 2 | from demoauto.map.conditions import ExpectedCondition 3 | from demoauto.driver.driver import Driver 4 | from demoauto.map.elements import Element 5 | from demoauto.map.handlers import HandlerBy, WebHandlerBy 6 | from demoauto.input.sign_on import SignOnPageInput 7 | from demoauto.locators.sing_on import SingOnPage as SP_Locators 8 | from demoauto.pages import Page 9 | from demoauto.pages.base import BasePage 10 | from demoauto.map.urls import SignOnPageUrl, Url 11 | from demoauto.map.waits import WebDriverWaitOf 12 | 13 | 14 | class SignOnPage(Page): 15 | """Represent sign-on page.""" 16 | 17 | def __init__(self, browser: WebBrowser) -> None: 18 | self._by: HandlerBy = WebHandlerBy() 19 | self._sp_locators: SP_Locators = SP_Locators() 20 | self._page: Page = BasePage(browser, SignOnPageUrl()) 21 | 22 | @property 23 | def driver(self) -> Driver: 24 | return self._page.driver() 25 | 26 | def open(self, url: Url = None) -> None: 27 | self._page.open(url) 28 | 29 | def close(self) -> None: 30 | self._page.close() 31 | 32 | def user_name(self, input_: SignOnPageInput) -> None: 33 | field: Element = self.driver.find_element( 34 | self._by.xpath(), self._sp_locators.user_name 35 | ) 36 | field.clear() 37 | field.send_keys(input_.user_name) 38 | 39 | def password(self, input_: SignOnPageInput) -> None: 40 | field: Element = self.driver.find_element( 41 | self._by.xpath(), self._sp_locators.password 42 | ) 43 | field.clear() 44 | field.send_keys(input_.password) 45 | 46 | def text(self) -> Element: 47 | return WebDriverWaitOf(self.driver).until_presence_of_element_located( 48 | ExpectedCondition(self._by.xpath(), self._sp_locators.txt) 49 | ) 50 | 51 | def register_link(self) -> Element: 52 | return WebDriverWaitOf(self.driver).until_presence_of_element_located( 53 | ExpectedCondition(self._by.xpath(), self._sp_locators.register_link) 54 | ) 55 | 56 | def login(self) -> None: 57 | self.driver.find_element( 58 | self._by.xpath(), self._sp_locators.login 59 | ).click() 60 | -------------------------------------------------------------------------------- /media/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/media/icon.png -------------------------------------------------------------------------------- /media/usage.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/media/usage.gif -------------------------------------------------------------------------------- /mypy.ini: -------------------------------------------------------------------------------- 1 | [mypy] 2 | python_version = 3.6 3 | ignore_missing_imports = True 4 | disallow_untyped_defs = False 5 | disallow_incomplete_defs = False 6 | disallow_any_generics = True 7 | warn_unused_ignores = True 8 | warn_unused_configs = True 9 | show_column_numbers = True 10 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 80 3 | target-version = ["py36", "py37", "py38"] 4 | exclude = ''' 5 | /( 6 | \.pytest_cache 7 | )/ 8 | ''' 9 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | markers = 3 | smoke: smoke tests marker 4 | unit: unit tests marker 5 | python_files=*.py 6 | python_functions=test_* 7 | addopts = -rsxX 8 | -v 9 | --self-contained-html 10 | --html=test-report.html 11 | --cov=demoauto 12 | --alluredir report -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | black==23.3.0 2 | coveralls==1.8.2 3 | coverage==4.5.4 4 | flake8==3.7.9 5 | mypy==0.790 6 | pdbpp==0.10.2 7 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | selenium==3.141.0 2 | pytest==6.0.1 3 | pytest-cov==2.8.1 4 | pytest-metadata==1.8 5 | pytest-html==2.0.0 6 | pytest-clarity==0.2.0a1 7 | allure-pytest==2.8.6 8 | -------------------------------------------------------------------------------- /run-code-analysis.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | declare -a RESULT 4 | 5 | # specifies a set of variables to declare CLI output color 6 | FAILED_OUT="\033[0;31m" 7 | PASSED_OUT="\033[0;32m" 8 | NONE_OUT="\033[0m" 9 | 10 | # specifies a set of variables to declare files to be used for code assessment 11 | PROJECT_FILES="./" 12 | LIB_FILES="demoauto" 13 | 14 | 15 | function store-failures { 16 | RESULT+=("$1") 17 | } 18 | 19 | 20 | function remove-pycache-trash { 21 | local PYCACHE_DIR="__pycache__" 22 | echo "Removing ${PYCACHE_DIR} directories if present ..." 23 | ( find . -d -name ${PYCACHE_DIR} | xargs rm -r ) || echo -e "No ${PYCACHE_DIR} found" 24 | } 25 | 26 | 27 | function remove-analysis-trash { 28 | local PYTEST_CACHE_DIR='.pytest_cache' 29 | local MYPY_CACHE_DIR='.mypy_cache' 30 | echo "Removing code analysis trash if present ..." 31 | [[ -d "$PYTEST_CACHE_DIR" ]] && rm -rf ${PYTEST_CACHE_DIR} && echo "pytest trash is removed" 32 | [[ -d "$MYPY_CACHE_DIR" ]] && rm -rf ${MYPY_CACHE_DIR} && echo "mypy trash is removed" 33 | } 34 | 35 | 36 | function install-dependencies { 37 | echo "Installing python code analysis packages ..." \ 38 | && ( pip install --no-cache-dir --upgrade pip ) \ 39 | && ( pip install --no-cache-dir -r requirements-dev.txt ) 40 | } 41 | 42 | 43 | function run-unittests { 44 | echo "Running unittests ..." && ( pytest -m unit ) 45 | } 46 | 47 | 48 | function run-black-analysis { 49 | echo "Running black analysis ..." && ( black --check "${PROJECT_FILES}" ) 50 | } 51 | 52 | 53 | function run-flake8-analysis { 54 | echo "Running flake8 analysis ..." && ( flake8 "${PROJECT_FILES}" ) 55 | } 56 | 57 | 58 | function run-mypy-analysis() { 59 | echo "Running mypy analysis ..." && mypy --package "${LIB_FILES}" 60 | } 61 | 62 | 63 | function run-code-analysis { 64 | echo "Running code analysis ..." 65 | remove-pycache-trash 66 | run-unittests || store-failures "Unittests are failed!" 67 | run-black-analysis || store-failures "black analysis is failed!" 68 | run-flake8-analysis || store-failures "flake8 analysis is failed!" 69 | run-mypy-analysis || store-failures "mypy analysis is failed!" 70 | 71 | if [[ ${#RESULT[@]} -ne 0 ]]; 72 | then echo -e "${FAILED_OUT}Some errors occurred while analysing the code quality.${NONE_OUT}" 73 | for failed_item in "${RESULT[@]}"; do 74 | echo -e "${FAILED_OUT}- ${failed_item}${NONE_OUT}" 75 | done 76 | remove-analysis-trash 77 | exit 1 78 | fi 79 | remove-analysis-trash 80 | echo -e "${PASSED_OUT}Code analysis is passed${NONE_OUT}" 81 | } 82 | 83 | 84 | function main() { 85 | if [[ "$1" == "install-dependencies" ]]; 86 | then install-dependencies || store-failures "Python packages installation is failed!"; 87 | fi 88 | run-code-analysis 89 | } 90 | 91 | 92 | main "$@" 93 | -------------------------------------------------------------------------------- /run-tests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # set of constants to colorize output 4 | FAILED_OUT="\033[0;31m" 5 | YELLOW_OUT="\033[1;33m" 6 | NONE_OUT="\033[0m" 7 | 8 | 9 | pretty-output() { 10 | t="$@xxxx" 11 | c=${replace:--} 12 | echo -e ${t//?/$c} 13 | echo -e "$c $@ $c" 14 | echo -e ${t//?/$c} 15 | } 16 | 17 | 18 | helper() { 19 | echo "Tool allows to simplify run of automated tests for POM sample project." 20 | echo "" 21 | echo "Available actions:" 22 | echo -e " - smoke\t\t run automated smoke tests" 23 | echo -e " - unittest\t\t run automated unittest tests" 24 | echo -e " - all\t\t\t run all automated tests" 25 | echo -e " - help\t\t\t display help message" 26 | echo "" 27 | echo -e "Note:\t\t help will be provided in case of no input parameters" 28 | } 29 | 30 | 31 | raise-error-message() { 32 | echo -e "Invalid ${FAILED_OUT}$1${NONE_OUT} parameter is provided!" 33 | echo -e "Please use ${YELLOW_OUT}smoke${NONE_OUT} or ${YELLOW_OUT}unit${NONE_OUT} or ${YELLOW_OUT}help${NONE_OUT} keys as a flag." 34 | exit 1 35 | } 36 | 37 | 38 | clear-trash() { 39 | local trash='.pytest_cache' 40 | [[ -d "$trash" ]] && echo "removing ${trash} testing trash" && rm -rf ${trash} && echo "environment is cleared" 41 | } 42 | 43 | 44 | unit() { 45 | pytest -m unit 46 | } 47 | 48 | 49 | smoke() { 50 | pytest -m smoke 51 | } 52 | 53 | 54 | all() { 55 | pytest 56 | } 57 | 58 | 59 | run-tests() { 60 | local arg=$1 61 | if [[ ${arg} == "smoke" ]] || [[ ${arg} == "unit" ]]; 62 | then pretty-output "Running ${arg} suite" && pytest -m "${arg}"; clear-trash 63 | elif [[ ${arg} == "all" ]] 64 | then pretty-output "Running ${arg} suite" && pytest; clear-trash 65 | elif [[ $# -eq 0 ]] || [[ ${arg} == "help" ]] || [[ ${arg} == "--help" ]] || [[ ${arg} == "-h" ]] 66 | then helper 67 | else raise-error-message "${arg}" 68 | fi 69 | } 70 | 71 | run-tests "$1" 72 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/__init__.py -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | pytest_plugins = ( 2 | "tests.plugins.urls", 3 | "tests.plugins.browser", 4 | "tests.plugins.pages", 5 | "tests.plugins.hooks", 6 | "tests.plugins.input", 7 | "tests.plugins.handler", 8 | "tests.plugins.locators", 9 | ) 10 | -------------------------------------------------------------------------------- /tests/coverage/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/coverage/__init__.py -------------------------------------------------------------------------------- /tests/coverage/functional/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/coverage/functional/__init__.py -------------------------------------------------------------------------------- /tests/coverage/functional/pages/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/coverage/functional/pages/__init__.py -------------------------------------------------------------------------------- /tests/coverage/functional/pages/test_home_page.py: -------------------------------------------------------------------------------- 1 | from tests.coverage.markers import smoke 2 | from demoauto.pages.home import HomePage 3 | 4 | 5 | @smoke 6 | def test_home_page_logo(home_page: HomePage) -> None: 7 | assert home_page.logo().is_displayed() 8 | 9 | 10 | @smoke 11 | def test_home_page_contact(home_page: HomePage) -> None: 12 | assert home_page.contact().is_displayed() 13 | 14 | 15 | @smoke 16 | def test_home_page_sign_on(home_page: HomePage) -> None: 17 | assert home_page.sign_on().is_displayed() 18 | 19 | 20 | @smoke 21 | def test_home_page_support(home_page: HomePage) -> None: 22 | assert home_page.support().is_displayed() 23 | 24 | 25 | @smoke 26 | def test_home_page_register(home_page: HomePage) -> None: 27 | assert home_page.register().is_displayed() 28 | -------------------------------------------------------------------------------- /tests/coverage/functional/pages/test_register_page.py: -------------------------------------------------------------------------------- 1 | from tests.coverage.markers import smoke 2 | from demoauto.input.register import RegisterPageInput 3 | from demoauto.locators.register import RegistrationPage 4 | from demoauto.map.handlers import HandlerBy 5 | from demoauto.pages.register import RegisterPage 6 | 7 | 8 | @smoke 9 | def test_register_page_register_text(register_page: RegisterPage) -> None: 10 | assert register_page.register_text().is_displayed() 11 | 12 | 13 | @smoke 14 | def test_set_first_name( 15 | register_page: RegisterPage, 16 | register_page_input: RegisterPageInput, 17 | register_page_locator: RegistrationPage, 18 | handler_by: HandlerBy, 19 | ) -> None: 20 | assert ( 21 | register_page.set_first_name(register_page_input).text( 22 | handler_by.xpath(), register_page_locator.first_name 23 | ) 24 | == "" 25 | ) 26 | 27 | 28 | @smoke 29 | def test_registration( 30 | register_page: RegisterPage, register_page_input: RegisterPageInput 31 | ) -> None: 32 | register_page.set_first_name(register_page_input) 33 | register_page.set_last_name(register_page_input) 34 | register_page.set_email(register_page_input) 35 | register_page.set_phone(register_page_input) 36 | register_page.set_country(register_page_input) 37 | register_page.set_user_name(register_page_input) 38 | register_page.set_password(register_page_input) 39 | register_page.confirm_password(register_page_input) 40 | register_page.submit() 41 | assert register_page.confirm_registration().is_displayed() 42 | -------------------------------------------------------------------------------- /tests/coverage/markers.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from _pytest.mark import MarkDecorator 3 | 4 | unit: MarkDecorator = pytest.mark.unit 5 | smoke: MarkDecorator = pytest.mark.smoke 6 | -------------------------------------------------------------------------------- /tests/coverage/unit/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/coverage/unit/__init__.py -------------------------------------------------------------------------------- /tests/coverage/unit/browsers/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/coverage/unit/browsers/__init__.py -------------------------------------------------------------------------------- /tests/coverage/unit/browsers/conftest.py: -------------------------------------------------------------------------------- 1 | from typing import Callable 2 | import pytest 3 | from _pytest.fixtures import SubRequest 4 | from demoauto.browsers import WebBrowser, WebBrowserError 5 | from demoauto.browsers.chrome import Chrome 6 | from demoauto.browsers.safari import Safari 7 | from demoauto.browsers.firefox import FireFox 8 | 9 | 10 | @pytest.fixture() 11 | def browser(request: SubRequest) -> Callable[[str], WebBrowser]: 12 | def browser_factory(name: str) -> WebBrowser: 13 | request.addfinalizer(lambda: target.driver().close()) 14 | if name == "Chrome": 15 | target = Chrome() 16 | return target 17 | if name == "Safari": 18 | target = Safari() 19 | return target 20 | if name == "FireFox": 21 | target = FireFox() 22 | return target 23 | raise WebBrowserError(f"Browser {name} is not supported!") 24 | 25 | return browser_factory 26 | -------------------------------------------------------------------------------- /tests/coverage/unit/browsers/test_browsers.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from tests.coverage.markers import unit 3 | from demoauto.browsers import WebBrowserError 4 | 5 | 6 | @unit 7 | def test_browser_error() -> None: 8 | with pytest.raises(WebBrowserError): 9 | raise WebBrowserError("Raised WebBrowserError!") 10 | -------------------------------------------------------------------------------- /tests/coverage/unit/map/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/coverage/unit/map/__init__.py -------------------------------------------------------------------------------- /tests/coverage/unit/map/test_urls.py: -------------------------------------------------------------------------------- 1 | from tests.coverage.markers import unit 2 | from demoauto.map.urls import Url, BASE_DEMO_URL 3 | 4 | _home: str = f"{BASE_DEMO_URL}/index.php" 5 | _register: str = f"{BASE_DEMO_URL}/register.php" 6 | _sign_on: str = f"{BASE_DEMO_URL}/login.php" 7 | 8 | 9 | @unit 10 | def test_home_url(home_url: Url) -> None: 11 | assert home_url.get() == _home 12 | 13 | 14 | @unit 15 | def test_register_url(register_url: Url) -> None: 16 | assert register_url.get() == _register 17 | 18 | 19 | @unit 20 | def test_sign_on_url(sign_on_url: Url) -> None: 21 | assert sign_on_url.get() == _sign_on 22 | -------------------------------------------------------------------------------- /tests/plugins/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/utestpy/python-page-object/63986d3b3f1c104c5a94612dfacacce5e078049e/tests/plugins/__init__.py -------------------------------------------------------------------------------- /tests/plugins/browser.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from demoauto.browsers.chrome import WebBrowser, Chrome 3 | 4 | 5 | @pytest.fixture(scope="session") 6 | def browser() -> WebBrowser: 7 | browser: WebBrowser = Chrome() 8 | yield browser 9 | browser.driver().close() 10 | -------------------------------------------------------------------------------- /tests/plugins/handler.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from demoauto.map.handlers import HandlerBy, WebHandlerBy 3 | 4 | 5 | @pytest.fixture(scope="module") 6 | def handler_by() -> HandlerBy: 7 | return WebHandlerBy() 8 | -------------------------------------------------------------------------------- /tests/plugins/hooks.py: -------------------------------------------------------------------------------- 1 | from typing import List 2 | from _pytest.config import Config 3 | 4 | 5 | def pytest_configure(config: Config): 6 | """Enable verbose and output when running tests. Simulate `-v` and `-s` option in a command line.""" 7 | 8 | config.option.verbose = 1 9 | config.option.capture = "yes" 10 | 11 | 12 | def pytest_report_header(config: Config) -> List[str]: 13 | """Add information to test report header.""" 14 | 15 | if config.option.verbose > 0: 16 | return [ 17 | "Project: Pytest Page Object Model", 18 | "Written by: Volodymyr Yahello", 19 | ] 20 | -------------------------------------------------------------------------------- /tests/plugins/input.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from demoauto.input.register import RegisterPageInput 3 | 4 | 5 | @pytest.fixture(scope="module") 6 | def register_page_input() -> RegisterPageInput: 7 | return RegisterPageInput() 8 | -------------------------------------------------------------------------------- /tests/plugins/locators.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from demoauto.locators.register import RegistrationPage 3 | 4 | 5 | @pytest.fixture(scope="module") 6 | def register_page_locator() -> RegistrationPage: 7 | return RegistrationPage() 8 | -------------------------------------------------------------------------------- /tests/plugins/pages.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from demoauto.browsers import WebBrowser 3 | from demoauto.pages import Page 4 | from demoauto.pages.home import HomePage 5 | from demoauto.pages.register import RegisterPage 6 | 7 | 8 | @pytest.fixture(scope="module") 9 | def home_page(browser: WebBrowser) -> Page: 10 | return HomePage(browser) 11 | 12 | 13 | @pytest.fixture(scope="module") 14 | def register_page(browser: WebBrowser) -> Page: 15 | return RegisterPage(browser) 16 | -------------------------------------------------------------------------------- /tests/plugins/urls.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from demoauto.map.urls import HomePageUrl, RegisterPageUrl, SignOnPageUrl, Url 3 | 4 | 5 | @pytest.fixture(scope="module") 6 | def home_url() -> Url: 7 | return HomePageUrl() 8 | 9 | 10 | @pytest.fixture(scope="module") 11 | def register_url() -> Url: 12 | return RegisterPageUrl() 13 | 14 | 15 | @pytest.fixture(scope="module") 16 | def sign_on_url() -> Url: 17 | return SignOnPageUrl() 18 | --------------------------------------------------------------------------------