├── .gitignore ├── LICENSE ├── README.md ├── cucumbers.py ├── pytest.ini ├── requirements.txt └── tests ├── features ├── cucumbers.feature ├── service.feature └── web.feature └── step_defs ├── __init__.py ├── conftest.py ├── test_cucumbers_steps.py ├── test_service_steps.py └── test_web_steps.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | 106 | # IDEs 107 | .idea 108 | *.iml 109 | 110 | # VS Code files 111 | .vscode 112 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tau-pytest-bdd 2 | 3 | This repository contains example code for the 4 | *Behavior-Driven Python with pytest-bdd* course 5 | from [Test Automation University](https://testautomationu.applitools.com/). 6 | There is a branch for each chapter of the course showing the state of the code at the completion of the chapter. 7 | 8 | 9 | ## Repository Purpose 10 | 11 | The best way to learn pytest is through hands-on coding. 12 | In the first lesson of the course, you will create a new Python project for test cases. 13 | (That project will *not* be the same as this repository.) 14 | Each chapter then introduces new concepts and provides coding instructions for your project. 15 | If you code along with each chapter, 16 | then you will have a complete, functioning test automation project by the end of the course. 17 | 18 | This repository provides all example code for the project. 19 | If you get stuck while building your own project, 20 | compare your code to the example code in this repository. 21 | However, try to avoid blindly copying code from the repository into your project. 22 | Take the time to learn the concepts and code presented in each chapter. 23 | 24 | 25 | ## Repository Branches 26 | 27 | * Each `chapter/*` branch contains the state of the code for each chapter 28 | * The `main` branch contains the final state of the code at the end of the course 29 | 30 | 31 | ## Python Setup 32 | 33 | Python setup can be complicated. 34 | This section documents how to set up your machine for Python test automation development. 35 | 36 | ### Python Installation and Tools 37 | 38 | You can complete this course using any OS: Windows, macOS, Linux, etc. 39 | 40 | This course requires Python 3. 41 | You can download the latest Python version from [Python.org](https://www.python.org/downloads/). 42 | Follow the appropriate installation instructions for your operating system. 43 | 44 | You should have basic Python programming skills before attempting this course. 45 | Learning the language is always a prerequisite for learning automation. 46 | If you need help learning Python, check out this article: 47 | [How Do I Start Learning Python?](https://automationpanda.com/2020/02/18/how-do-i-start-learning-python/) 48 | 49 | You should also have a good Python editor/IDE. 50 | Good choices include [PyCharm](https://www.jetbrains.com/pycharm/) 51 | and [Visual Studio Code](https://code.visualstudio.com/docs/languages/python). 52 | 53 | You will also need [Git](https://git-scm.com/) if you want to clone this repository locally. 54 | If you are new to Git, [try learning the basics](https://try.github.io/). 55 | 56 | For Web UI tests, install the appropriate browser and WebDriver executable. 57 | These tests use Firefox and [geckodriver](https://github.com/mozilla/geckodriver/releases). 58 | 59 | 60 | ### Python Installation Troubleshooting 61 | 62 | Unfortunately, installing Python properly can be complicated, 63 | especially if Python was previously installed on your machine. 64 | To verify your Python installation, enter `python --version` at the command line. 65 | You should see the proper version printed. 66 | 67 | If the `python` command doesn't work or doesn’t print the expected version number, 68 | then try using the `python3` command instead. 69 | If that still doesn't work, 70 | then the correct Python installation might not be included in your system path. 71 | Find the directory into which Python was installed, 72 | manually add it to the system path, 73 | relaunch the command line, 74 | and try running Python again. 75 | 76 | * [System Path Instructions for Windows](https://geek-university.com/python/add-python-to-the-windows-path/) 77 | * [System Path Instructions for macOS](https://www.educative.io/edpresso/how-to-add-python-to-the-path-variable-in-mac) 78 | * [System Path Instructions for Linux](https://www.computerhope.com/issues/ch001647.htm) 79 | 80 | ### Python Packages 81 | 82 | This course will use a handful of third-party packages that are *not* part of the Python Standard Library. 83 | They must be installed separately using `pip`, the standard Python package installer. 84 | You can install them all before you create your test project, 85 | or you can install them as you complete each chapter in the course. 86 | 87 | To install each package, enter `pip install ` at the command line. 88 | For example: `pip install pytest`. 89 | If you already have a package installed but need to upgrade its version, 90 | run `pip install --upgrade `. 91 | 92 | Please note that if you need to use the `python3` command to run Python, 93 | then you might also need to use the `pip3` command in lieu of `pip`. 94 | 95 | ### Virtual Environments 96 | 97 | Running `pip install` will install the pytest package globally for the whole system. 98 | Installing Python packages globally is okay for this course, 99 | but it typically isn't a best practice in the "read world." 100 | Instead, each project should manage its own dependencies locally using a virtual environment. 101 | Virtual environments let projects avoid unnecessary dependencies and version mismatches. 102 | 103 | For simplicity, this course will not use or teach virtual environments. 104 | If you would like to learn virtual environments on your own, then RealPython's article 105 | [Python Virtual Environments: A Primer](https://realpython.com/python-virtual-environments-a-primer/) 106 | is an excellent place to start. 107 | 108 | ### Package Versions 109 | 110 | The [`requirements.txt`](requirements.txt) file contains the versions for each package used in this course. 111 | 112 | 113 | ## Running Tests 114 | 115 | To run the example tests from the command line, run `python -m pytest` from the project root directory. 116 | This command will discover and run all tests in the project. 117 | 118 | You can also run tests using the shorter `pytest` command. 119 | However, I recommend always using the lengthier `python -m pytest` command. 120 | The lengthier command automatically adds the current directory to `sys.path` 121 | so that all modules in the project can be discovered. 122 | 123 | The pytest command has several command line options. 124 | Course material will cover many of them. 125 | Check out the [Usage and Invocations](https://docs.pytest.org/en/stable/usage.html) page 126 | for complete documentation. 127 | 128 | *Warning:* 129 | If you attempt to run tests from this example project, 130 | make sure to checkout the correct branch first! 131 | 132 | 133 | ## Additional Resources 134 | 135 | Python links: 136 | 137 | * [Python.org](https://www.python.org/) 138 | * [pytest.org](https://docs.pytest.org/) 139 | * [How Do I Start Learning Python?](https://automationpanda.com/2020/02/18/how-do-i-start-learning-python/) 140 | * [Python Virtual Environments: A Primer](https://realpython.com/python-virtual-environments-a-primer/) 141 | * [Effective Python Testing with Pytest](https://realpython.com/pytest-python-testing/) 142 | * [Automation Panda's Python Page](https://automationpanda.com/python/) 143 | 144 | Books: 145 | 146 | * [Python Testing with pytest](https://pragprog.com/titles/bopytest/) by Brian Okken 147 | * [pytest Quick Start Guide](https://www.packtpub.com/web-development/pytest-quick-start-guide) by Bruno Oliveira 148 | * [Test-Driven Development with Python](https://www.obeythetestinggoat.com/) by Harry J.W. Percival 149 | 150 | Related TAU courses: 151 | 152 | * [Python Programming](https://testautomationu.applitools.com/python-tutorial/) 153 | * [Introduction to pytest](https://testautomationu.applitools.com/pytest-tutorial/) 154 | * [Selenium WebDriver with Python](https://testautomationu.applitools.com/selenium-webdriver-python-tutorial/) 155 | * [Automated Visual Testing with Python](https://testautomationu.applitools.com/visual-testing-python/) 156 | 157 | 158 | ## About the Author 159 | 160 | This course was written and delivered by **Andrew Knight** (aka *Pandy*), the "Automation Panda". 161 | Andy is a Pythonista who specializes in testing and automation. 162 | 163 | * Blog: [AutomationPanda.com](https://automationpanda.com/) 164 | * Twitter: [@AutomationPanda](https://twitter.com/AutomationPanda) 165 | * LinkedIn: [andrew-leland-knight](https://www.linkedin.com/in/andrew-leland-knight/) 166 | -------------------------------------------------------------------------------- /cucumbers.py: -------------------------------------------------------------------------------- 1 | """ 2 | This module contains a simple class modeling a cucumber basket. 3 | Cucumbers may be added or removed from the basket. 4 | The basket has a maximum size, however. 5 | """ 6 | 7 | 8 | class CucumberBasket: 9 | 10 | def __init__(self, initial_count=0, max_count=10): 11 | if initial_count < 0: 12 | raise ValueError("Initial cucumber basket count must not be negative") 13 | if max_count < 0: 14 | raise ValueError("Max cucumber basket count must not be negative") 15 | 16 | self._count = initial_count 17 | self._max_count = max_count 18 | 19 | @property 20 | def count(self): 21 | return self._count 22 | 23 | @property 24 | def full(self): 25 | return self.count == self.max_count 26 | 27 | @property 28 | def empty(self): 29 | return self.count == 0 30 | 31 | @property 32 | def max_count(self): 33 | return self._max_count 34 | 35 | def add(self, count=1): 36 | new_count = self.count + count 37 | if new_count > self.max_count: 38 | raise ValueError("Attempted to add too many cucumbers") 39 | self._count = new_count 40 | 41 | def remove(self, count=1): 42 | new_count = self.count - count 43 | if new_count < 0: 44 | raise ValueError("Attempted to remove too many cucumbers") 45 | self._count = new_count 46 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | markers = 3 | add 4 | cucumber-basket 5 | duckduckgo 6 | remove 7 | service 8 | web 9 | testpaths = tests -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pytest==7.4.0 2 | pytest-bdd==6.1.1 3 | requests==2.31.0 4 | selenium==4.10.0 5 | -------------------------------------------------------------------------------- /tests/features/cucumbers.feature: -------------------------------------------------------------------------------- 1 | @cucumber-basket 2 | Feature: Cucumber Basket 3 | As a gardener, 4 | I want to carry cucumbers in a basket, 5 | So that I don't drop them all. 6 | 7 | 8 | @add 9 | Scenario Outline: Add cucumbers to a basket 10 | Given the basket has "" cucumbers 11 | When "" cucumbers are added to the basket 12 | Then the basket contains "" cucumbers 13 | 14 | Examples: 15 | | initial | some | total | 16 | | 0 | 3 | 3 | 17 | | 2 | 4 | 6 | 18 | | 5 | 5 | 10 | 19 | 20 | 21 | @remove 22 | Scenario Outline: Remove cucumbers from the basket 23 | Given the basket has "" cucumbers 24 | When "" cucumbers are removed from the basket 25 | Then the basket contains "" cucumbers 26 | 27 | Examples: 28 | | initial | some | total | 29 | | 8 | 3 | 5 | 30 | | 10 | 4 | 6 | 31 | | 7 | 0 | 7 | -------------------------------------------------------------------------------- /tests/features/service.feature: -------------------------------------------------------------------------------- 1 | @service @duckduckgo 2 | Feature: DuckDuckGo Instant Answer API 3 | As an application developer, 4 | I want to get instant answers for search terms via a REST API, 5 | So that my app can get answers anywhere. 6 | 7 | 8 | Scenario Outline: Basic DuckDuckGo API Query 9 | Given the DuckDuckGo API is queried with "" 10 | Then the response status code is "200" 11 | And the response contains results for "" 12 | 13 | Examples: Animals 14 | | phrase | 15 | | panda | 16 | | python | 17 | | platypus | 18 | 19 | Examples: Fruits 20 | | phrase | 21 | | peach | 22 | | pineapple | 23 | | papaya | -------------------------------------------------------------------------------- /tests/features/web.feature: -------------------------------------------------------------------------------- 1 | @web @duckduckgo 2 | Feature: DuckDuckGo Web Browsing 3 | As a web surfer, 4 | I want to find information online, 5 | So I can learn new things and get tasks done. 6 | 7 | 8 | Background: 9 | Given the DuckDuckGo home page is displayed 10 | 11 | 12 | Scenario: Basic DuckDuckGo Search 13 | When the user searches for "panda" 14 | Then results are shown for "panda" 15 | 16 | 17 | Scenario: Lengthy DuckDuckGo Search 18 | When the user searches for the phrase: 19 | """ 20 | When in the Course of human events, it becomes necessary for one people 21 | to dissolve the political bands which have connected them with another, 22 | and to assume among the powers of the earth, the separate and equal 23 | station to which the Laws of Nature and of Nature's God entitle them, 24 | a decent respect to the opinions of mankind requires that they should 25 | declare the causes which impel them to the separation. 26 | """ 27 | Then one of the results contains "Declaration of Independence" 28 | -------------------------------------------------------------------------------- /tests/step_defs/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AutomationPanda/tau-pytest-bdd/a8f8ee6bc57b75dd70b01ddf5b66b107ff1805e8/tests/step_defs/__init__.py -------------------------------------------------------------------------------- /tests/step_defs/conftest.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | 3 | from pytest_bdd import given 4 | from selenium import webdriver 5 | 6 | 7 | # Constants 8 | 9 | DUCKDUCKGO_HOME = 'https://duckduckgo.com/' 10 | 11 | 12 | # Hooks 13 | 14 | def pytest_bdd_step_error(request, feature, scenario, step, step_func, step_func_args, exception): 15 | print(f'Step failed: {step}') 16 | 17 | 18 | # Fixtures 19 | 20 | @pytest.fixture 21 | def browser(): 22 | # For this example, we will use Firefox 23 | # You can change this fixture to use other browsers, too. 24 | # A better practice would be to get browser choice from a config file. 25 | b = webdriver.Firefox() 26 | b.implicitly_wait(10) 27 | yield b 28 | b.quit() 29 | 30 | 31 | # Shared Given Steps 32 | 33 | @given('the DuckDuckGo home page is displayed', target_fixture='ddg_home') 34 | def ddg_home(browser): 35 | browser.get(DUCKDUCKGO_HOME) -------------------------------------------------------------------------------- /tests/step_defs/test_cucumbers_steps.py: -------------------------------------------------------------------------------- 1 | from pytest_bdd import scenarios, parsers, given, when, then 2 | 3 | from cucumbers import CucumberBasket 4 | 5 | 6 | scenarios('../features/cucumbers.feature') 7 | 8 | 9 | CONVERTERS = { 10 | 'initial': int, 11 | 'some': int, 12 | 'total': int, 13 | } 14 | 15 | 16 | @given( 17 | parsers.parse('the basket has "{initial}" cucumbers'), 18 | target_fixture='basket', 19 | converters=CONVERTERS) 20 | def basket(initial): 21 | return CucumberBasket(initial_count=initial) 22 | 23 | 24 | @when( 25 | parsers.parse('"{some}" cucumbers are added to the basket'), 26 | converters=CONVERTERS) 27 | def add_cucumbers(basket, some): 28 | basket.add(some) 29 | 30 | 31 | @when( 32 | parsers.parse('"{some}" cucumbers are removed from the basket'), 33 | converters=CONVERTERS) 34 | def remove_cucumbers(basket, some): 35 | basket.remove(some) 36 | 37 | 38 | @then( 39 | parsers.parse('the basket contains "{total}" cucumbers'), 40 | converters=CONVERTERS) 41 | def basket_has_total(basket, total): 42 | assert basket.count == total 43 | -------------------------------------------------------------------------------- /tests/step_defs/test_service_steps.py: -------------------------------------------------------------------------------- 1 | """ 2 | This module contains step definitions for service.feature. 3 | It uses the requests package: 4 | http://docs.python-requests.org/ 5 | """ 6 | 7 | import requests 8 | 9 | from pytest_bdd import scenarios, given, then, parsers 10 | 11 | 12 | # Shared Variables 13 | 14 | DUCKDUCKGO_API = 'https://api.duckduckgo.com/' 15 | 16 | 17 | # Scenarios 18 | 19 | 20 | scenarios('../features/service.feature') 21 | 22 | CONVERTERS = { 23 | 'code': int, 24 | 'phrase': str, 25 | } 26 | 27 | 28 | # Given Steps 29 | 30 | @given( 31 | parsers.parse('the DuckDuckGo API is queried with "{phrase}"'), 32 | target_fixture='ddg_response', 33 | converters=CONVERTERS) 34 | def ddg_response(phrase): 35 | params = {'q': phrase, 'format': 'json'} 36 | response = requests.get(DUCKDUCKGO_API, params=params) 37 | return response 38 | 39 | 40 | # Then Steps 41 | 42 | @then( 43 | parsers.parse('the response contains results for "{phrase}"'), 44 | converters=CONVERTERS) 45 | def ddg_response_contents(ddg_response, phrase): 46 | # A more comprehensive test would check 'RelatedTopics' for matching phrases 47 | assert phrase.lower() == ddg_response.json()['Heading'].lower() 48 | 49 | 50 | @then( 51 | parsers.parse('the response status code is "{code}"'), 52 | converters=CONVERTERS) 53 | def ddg_response_code(ddg_response, code): 54 | assert ddg_response.status_code == code 55 | -------------------------------------------------------------------------------- /tests/step_defs/test_web_steps.py: -------------------------------------------------------------------------------- 1 | """ 2 | This module contains step definitions for web.feature. 3 | It uses Selenium WebDriver for browser interactions: 4 | https://www.seleniumhq.org/projects/webdriver/ 5 | Setup and cleanup are handled using hooks. 6 | For a real test automation project, 7 | use Page Object Model or Screenplay Pattern to model web interactions. 8 | 9 | Prerequisites: 10 | - Firefox must be installed. 11 | - geckodriver must be installed and accessible on the system path. 12 | """ 13 | 14 | from pytest_bdd import scenarios, when, then, parsers 15 | from selenium.webdriver.common.by import By 16 | from selenium.webdriver.common.keys import Keys 17 | 18 | 19 | # Scenarios 20 | 21 | scenarios('../features/web.feature') 22 | 23 | 24 | # When Steps 25 | 26 | @when(parsers.parse('the user searches for "{text}"')) 27 | @when(parsers.parse('the user searches for the phrase:\n{text}')) 28 | def search_phrase(browser, text): 29 | search_input = browser.find_element(By.NAME, 'q') 30 | search_input.send_keys(text + Keys.RETURN) 31 | 32 | 33 | # Then Steps 34 | 35 | @then(parsers.parse('one of the results contains "{phrase}"')) 36 | def results_have_one(browser, phrase): 37 | xpath = "//*[@data-testid='result']//*[contains(text(), '%s')]" % phrase 38 | results = browser.find_elements(By.XPATH, xpath) 39 | assert len(results) > 0 40 | 41 | 42 | @then(parsers.parse('results are shown for "{phrase}"')) 43 | def search_results(browser, phrase): 44 | # Check search result list 45 | # (A more comprehensive test would check results for matching phrases) 46 | # (Check the list before the search phrase for correct implicit waiting) 47 | assert len(browser.find_elements(By.CSS_SELECTOR, '[data-testid="result"]')) > 0 48 | # Check search phrase 49 | search_input = browser.find_element(By.NAME, 'q') 50 | assert search_input.get_attribute('value') == phrase 51 | --------------------------------------------------------------------------------