├── .github └── workflows │ └── pytest-html-report.yml ├── LICENSE ├── README.md └── tests ├── .env ├── .gitignore ├── conftest.py ├── data ├── post_payload_1.json ├── post_payload_2.json ├── put_payload_1.json └── put_payload_2.json ├── features └── sample.feature ├── lib └── terminal_report.py ├── pytest.ini ├── requirements.txt ├── step_definitions ├── test_assertions.py ├── test_common.py └── test_sample.py └── utils ├── __init__.py ├── custom_exceptions.py ├── logger_config.py └── utils.py /.github/workflows/pytest-html-report.yml: -------------------------------------------------------------------------------- 1 | # The name of the workflow as it will appear in the "Actions" tab of the GitHub repository 2 | name: Run pytest and upload HTML report 3 | 4 | # Specifies the trigger for this workflow 5 | on: 6 | # Allows you to run this workflow manually from the "Actions" tab of the GitHub repository 7 | workflow_dispatch: 8 | inputs: 9 | tags: 10 | description: Test scenario tags 11 | required: true 12 | default: smoke 13 | 14 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 15 | jobs: 16 | # This workflow contains a single job called "run_automated_tests" 17 | run_automated_tests: 18 | # Configures the job to run on the latest version of an Ubuntu Linux runner 19 | runs-on: ubuntu-latest 20 | 21 | # Set the default shell and working directory 22 | defaults: 23 | run: 24 | shell: bash 25 | working-directory: ./tests 26 | 27 | # "steps" represent a sequence of tasks that will be executed as part of the job 28 | steps: 29 | # This action checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it 30 | - name: Checkout repo 31 | uses: actions/checkout@v3 32 | 33 | # Set up GitHub Actions workflow with a specific version of Python 34 | - name: Set up Python 35 | uses: actions/setup-python@v4 36 | with: 37 | python-version: 3.8 38 | 39 | # Setup dependencies by running requirements.txt 40 | - name: Install dependencies 41 | run: | 42 | python3 -m pip install --upgrade pip 43 | python3 -m pip install -r requirements.txt --use-pep517 44 | 45 | # GitHub Action to read .env file and add variables to GITHUB_ENV 46 | - name: Load .env file 47 | uses: xom9ikk/dotenv@v2 48 | with: 49 | path: ./tests/ 50 | 51 | # Execute tests 52 | - name: Run pytest with HTML report 53 | run: > 54 | python3 -m pytest -v --gherkin-terminal-reporter --reruns 1 --reruns-delay 1 55 | --tags="${{ github.event.inputs.tags }}" -s --color=yes --html=reports/test-report.html 56 | continue-on-error: true 57 | 58 | # Upload html report as artifact 59 | - name: Upload HTML report 60 | uses: actions/upload-artifact@v3 61 | with: 62 | name: test-report 63 | path: tests/reports/test-report.html 64 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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) 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 | # **API Automation Framework** 2 | 3 | [![Actions Status](https://github.com/ashikkumar23/bdd-gherkin-api-test-automation-framework/workflows/Run%20tests/badge.svg)](https://github.com/ashikkumar23/bdd-gherkin-api-test-automation-framework/actions/workflows/ci.yml) 4 | 5 | API Automation Framework using `pytest` and `pytest-bdd` 6 | 7 | ## 🚀 Description: 8 | 9 | Automated CRUD (i.e., `POST`, `GET`, `PUT`, `DELETE`) operations using `pytest` and `pytest-bdd` 10 | 11 | ## 🚀 Prerequisites: 12 | 13 | `requests` `pytest` `pytest-bdd` 14 | 15 | ## 🚀 Installation Steps: 16 | 17 | In order to get the tests to run locally, you need to install the following pieces of software. 18 | 19 | ###### NOTE: All commands shall be executed from Automation Project root directory: `../[PROJECT_DIR]/tests/` 20 | 21 | #### MacOS 22 | 23 | - Install [Homebrew](https://brew.sh/) with `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` 24 | - Install [Pyenv](https://formulae.brew.sh/formula/pyenv) with `brew install pyenv`, this is a python version manager. 25 | - Add the following to `~/.bash_profile` 26 | 27 | ``` 28 | export PYENV_ROOT="$HOME/.pyenv" 29 | export PATH="$PYENV_ROOT/bin:$PATH" 30 | export PATH="$PYENV_ROOT/shims:$PATH" 31 | export PATH="$PYENV_ROOT/completions/pyenv.bash:$PATH" 32 | ``` 33 | 34 | - Install python 3.8.13 with `pyenv install 3.8.13` 35 | - Set python version 3.8.13 to be used globally with `pyenv global 3.8.13` 36 | - Install [virtualenv](https://virtualenv.pypa.io/en/16.7.9/installation.html) with `python3 -m pip install --user virtualenv` 37 | - Create new virtual env with `python3 -m virtualenv .venv` 38 | - Activate new virtual env with `source ./.venv/bin/activate` 39 | - Install all project dependencies with `pip install -r requirements.txt --use-pep517` 40 | - Check the python version used with `which python`, which shall be `[PROJECT_DIR]/tests/.venv/bin/python`. 41 | 42 | #### Windows / Linux 43 | 44 | - Install [GitBash](https://git-scm.com/downloads) 45 | - Uninstall any previous python version 46 | - Install [python 3.8.13](https://www.python.org/downloads/release/python-3813/) using the official installation file 47 | - Install all project dependencies with `pip install -r requirements.txt --use-pep517` 48 | 49 | ## 🚀 Project Structure: 50 | 51 | ``` 52 | bdd-gherkin-test-automation-framework/ 53 | ├─ .github/ 54 | │ ├─ workflows/ 55 | │ │ ├─ ci.yml 56 | ├─ tests/ 57 | │ ├─ data/ 58 | │ │ ├─ post_payload_1.json 59 | │ │ ├─ post_payload_2.json 60 | │ │ ├─ put_payload_1.json 61 | │ │ ├─ put_payload_2.json 62 | │ ├─ features/ 63 | │ │ ├─ sample.feature 64 | │ ├─ lib/ 65 | │ │ ├─ terminal_report.py 66 | │ ├─ step_definitions/ 67 | │ │ ├─ test_assertions.py 68 | │ │ ├─ test_common.py 69 | │ │ ├─ test_sample.py 70 | │ ├─ utils/ 71 | │ │ ├─ __init__.py 72 | │ │ ├─ custom_exceptions.py 73 | │ │ ├─ logger_config.py 74 | │ │ ├─ utils.py 75 | │ ├─ .env 76 | │ ├─ .gitignore 77 | │ ├─ conftest.py 78 | │ ├─ pytest.ini 79 | │ ├─ requirements.txt 80 | ├─ LICENSE 81 | ├─ README.md 82 | ``` 83 | 84 | ## 🚀 Test Execution: 85 | 86 | - [Fork](https://github.com/ashikkumar23/gherkin-bdd-api-test-framework/fork) the repository `bdd-gherkin-api-test-automation-framework` 87 | - Clone the repository via HTTPS `git clone https://github.com//bdd-gherkin-api-test-automation-framework.git` or via SSH `git clone git@github.com:/bdd-gherkin-api-test-automation-framework.git` 88 | - Open [Pycharm](https://www.jetbrains.com/pycharm/) (or any IDE) > File > Open > Open the project where the repository is located (i.e., `../bdd-gherkin-test-automation-framework/tests`) 89 | - Run the command: `python -m pytest -v --gherkin-terminal-reporter --reruns 1 --reruns-delay 1 --tags="automated" -s --color="yes"` in `Terminal` 90 | 91 | ## 🚀 Pycharm Edit Configuration: 92 | 93 | - Go to `Edit Configurations...` 94 | - Add `New Configuration` (`+` sign) > `Python tests` > `pytest` 95 | - Provide `Target Script path` and `Working directory` (i.e., `../bdd-gherkin-test-automation-framework/tests`) 96 | - Select the required `Python interpreter` 97 | - And, `Additional Arguments`: `-v --gherkin-terminal-reporter --reruns 1 --reruns-delay 1 --tags="automated" --color="yes"` 98 | -------------------------------------------------------------------------------- /tests/.env: -------------------------------------------------------------------------------- 1 | BASE_URL=http://jsonplaceholder.typicode.com -------------------------------------------------------------------------------- /tests/.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | ../.pytest_cache/ 6 | ../.DS_Store 7 | ../.idea/ 8 | .DS_Store 9 | tests/.DS_Store 10 | 11 | # C extensions 12 | *.so 13 | 14 | # Distribution / packaging 15 | .Python 16 | build/ 17 | develop-eggs/ 18 | dist/ 19 | downloads/ 20 | eggs/ 21 | .eggs/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | *.egg-info/ 28 | .installed.cfg 29 | *.egg 30 | MANIFEST 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .coverage 46 | .coverage.* 47 | .cache 48 | nosetests.xml 49 | coverage.xml 50 | *.cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | 63 | # Flask stuff: 64 | instance/ 65 | .webassets-cache 66 | 67 | # Scrapy stuff: 68 | .scrapy 69 | 70 | # Sphinx documentation 71 | docs/_build/ 72 | 73 | # PyBuilder 74 | target/ 75 | 76 | # Jupyter Notebook 77 | .ipynb_checkpoints 78 | 79 | # pyenv 80 | .python-version 81 | 82 | # celery beat schedule file 83 | celerybeat-schedule 84 | 85 | # SageMath parsed files 86 | *.sage.py 87 | 88 | # Environments 89 | .local.env 90 | .venv 91 | env/ 92 | venv/ 93 | ENV/ 94 | env.bak/ 95 | venv.bak/ 96 | 97 | # Spyder project settings 98 | .spyderproject 99 | .spyproject 100 | 101 | # Rope project settings 102 | .ropeproject 103 | 104 | # mkdocs documentation 105 | /site 106 | 107 | # mypy 108 | .mypy_cache/ 109 | 110 | #ADF 111 | test_bundle.zip 112 | wheelhouse/ 113 | 114 | #Selenium_drivers 115 | /selenium_drivers 116 | 117 | #Sensitive data 118 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from cucumber_tag_expressions import parse 4 | from dotenv import load_dotenv, find_dotenv 5 | 6 | from step_definitions.test_common import * 7 | from step_definitions.test_assertions import * 8 | 9 | from lib.terminal_report import pytest_terminal_summary 10 | 11 | load_dotenv(find_dotenv()) 12 | 13 | 14 | def pytest_configure(config): 15 | config.option.keyword = "automated" 16 | config.option.markexpr = "not not_in_scope" 17 | 18 | 19 | def pytest_addoption(parser): 20 | parser.addoption("--tags", metavar="str", help="Will filter tests by given tags") 21 | 22 | 23 | def pytest_collection_modifyitems(config, items): 24 | raw_tags = config.option.tags 25 | if raw_tags is not None: 26 | for item in items: 27 | item_tags = [marker.name for marker in item.own_markers] 28 | if not parse(raw_tags).evaluate(item_tags): 29 | item.add_marker(pytest.mark.not_in_scope) 30 | 31 | 32 | @pytest.fixture(scope="session") 33 | def context(): 34 | return {} 35 | 36 | 37 | @pytest.fixture(scope="session") 38 | def base_url(): 39 | """Fixture to set the Base URL from environment variable""" 40 | return os.environ.get("BASE_URL") 41 | -------------------------------------------------------------------------------- /tests/data/post_payload_1.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "foo", 3 | "body": "bar", 4 | "userId": 1 5 | } 6 | -------------------------------------------------------------------------------- /tests/data/post_payload_2.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "bar", 3 | "body": "foo", 4 | "userId": 2 5 | } 6 | -------------------------------------------------------------------------------- /tests/data/put_payload_1.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": 1, 3 | "title": "abc", 4 | "body": "xyz", 5 | "userId": 1 6 | } 7 | -------------------------------------------------------------------------------- /tests/data/put_payload_2.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": 1, 3 | "title": "testing", 4 | "body": "testing", 5 | "userId": 1 6 | } 7 | -------------------------------------------------------------------------------- /tests/features/sample.feature: -------------------------------------------------------------------------------- 1 | @automated 2 | Feature: Test CRUD HTTP methods 3 | As a user 4 | I will send POST, GET, UPDATE, and DELETE requests 5 | I want to be able to see the expected response 6 | 7 | Background: 8 | Given I set sample rest_api_base_url 9 | And I set the header param request content type as "application/json" 10 | 11 | @smoke 12 | Scenario Outline: POST route 13 | Given I set the POST endpoint to "/posts" for creating posts 14 | When I send a POST HTTP request with 15 | Then I expect the HTTP response code of "POST" to be "201" 16 | And I expect the response body of "POST" to be non-empty 17 | Examples: 18 | | payload | 19 | | post_payload_1.json | 20 | | post_payload_2.json | 21 | 22 | @smoke 23 | Scenario: GET route 24 | Given I set the GET endpoint to "/posts" for fetching posts 25 | When I send a GET HTTP request 26 | Then I expect the HTTP response code of "GET" to be "200" 27 | And I expect the response body of "GET" to be non-empty 28 | 29 | @smoke 30 | Scenario Outline: UPDATE route 31 | Given I set the UPDATE endpoint to "/posts/1" for updating posts 32 | When I send a PUT HTTP request with 33 | Then I expect the HTTP response code of "PUT" to be "200" 34 | And I expect the response body of "PUT" to be non-empty 35 | Examples: 36 | | payload | 37 | | put_payload_1.json | 38 | | put_payload_2.json | 39 | 40 | @smoke 41 | Scenario: DELETE route 42 | Given I set the DELETE endpoint to "/posts/1" for deleting posts 43 | When I send a DELETE HTTP request 44 | Then I expect the HTTP response code of "DELETE" to be "200" 45 | And I expect the response body of "DELETE" to be empty 46 | -------------------------------------------------------------------------------- /tests/lib/terminal_report.py: -------------------------------------------------------------------------------- 1 | import time 2 | from functools import partial 3 | 4 | import pytest 5 | from _pytest.terminal import TerminalReporter 6 | 7 | __all__ = ["pytest_terminal_summary"] 8 | 9 | 10 | def _custom_short_summary(terminalreporter: TerminalReporter): 11 | """Create a custom short summary for the test report.""" 12 | stats = terminalreporter.stats 13 | total_count = sum(len(value) for value in stats.values()) 14 | deselected_cases = stats.get("deselected", []) 15 | failed_cases = stats.get("failed", []) 16 | passed_cases = stats.get("passed", []) 17 | total_duration = time.time() - terminalreporter._sessionstarttime 18 | 19 | failed = bool(failed_cases) 20 | 21 | write_sep = terminalreporter.write_sep 22 | write = terminalreporter.write 23 | 24 | write_sep("=", "Test Report Summary", red=failed, green=(not failed), bold=True) 25 | 26 | write(f"Total Test Duration: {total_duration:.2f} seconds", bold=True) 27 | write(f"\nTotal Tests Collected: {total_count}", bold=True) 28 | write(f"\nDeselected Tests: {len(deselected_cases)}", bold=True) 29 | write(f"\nPassed Count: {len(passed_cases)}", bold=True) 30 | write(f"\nFailed Count: {len(failed_cases)}", bold=True) 31 | write("\n") 32 | 33 | for failed_test in failed_cases: 34 | write(f"\tFailed test: {failed_test.nodeid}\n", yellow=True) 35 | 36 | write_sep( 37 | "=", "End of Test Report Summary", red=failed, green=(not failed), bold=True 38 | ) 39 | 40 | 41 | @pytest.hookimpl(hookwrapper=True) 42 | def pytest_terminal_summary(terminalreporter: TerminalReporter): 43 | """Pytest hook implementation to add custom short summary to the report.""" 44 | yield 45 | terminalreporter.short_test_summary = partial( 46 | _custom_short_summary, terminalreporter 47 | ) 48 | -------------------------------------------------------------------------------- /tests/pytest.ini: -------------------------------------------------------------------------------- 1 | # content of pytest.ini 2 | [pytest] 3 | filterwarnings = ignore:PytestUnknownMarkWarning 4 | log_level = INFO 5 | log_format = %(asctime)s %(levelname)s %(message)s 6 | log_date_format = %Y-%m-%d %H:%M:%S 7 | bdd_features_base_dir = features/ 8 | markers = 9 | automated: mark the test as an automated test 10 | smoke: mark the test as a smoke test 11 | not_in_scope: mark the test as a not_in_scope 12 | -------------------------------------------------------------------------------- /tests/requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.32.0 2 | pytest==5.4.2 3 | pytest-bdd==4.0.2 4 | assertpy==1.0 5 | cucumber-tag-expressions==4.1.0 6 | python-dotenv==0.13.0 7 | pylint==2.7.4 8 | pytest-rerunfailures==9.0 9 | gherkin-official==4.1.3 10 | pytest-html==3.2.0 11 | -------------------------------------------------------------------------------- /tests/step_definitions/test_assertions.py: -------------------------------------------------------------------------------- 1 | from assertpy import assert_that 2 | from pytest_bdd import then, parsers 3 | 4 | 5 | @then( 6 | parsers.parse( 7 | 'I expect the HTTP response code of "{request_type}" to be "{status_code}"' 8 | ) 9 | ) 10 | def validate_status_code(context, request_type, status_code): 11 | if request_type == "POST": 12 | assert_that(context["post_status_code"]).is_equal_to(int(status_code)) 13 | elif request_type == "GET": 14 | assert_that(context["get_status_code"]).is_equal_to(int(status_code)) 15 | elif request_type == "PUT": 16 | assert_that(context["put_status_code"]).is_equal_to(int(status_code)) 17 | elif request_type == "DELETE": 18 | assert_that(context["delete_status_code"]).is_equal_to(int(status_code)) 19 | 20 | 21 | @then(parsers.parse('I expect the response body of "{request_type}" to be empty')) 22 | @then(parsers.parse('I expect the response body of "{request_type}" to be non-empty')) 23 | def validate_response_body(context, request_type): 24 | if request_type == "POST": 25 | assert_that(context["post_response"]).is_not_equal_to(None) 26 | elif request_type == "GET": 27 | assert_that(context["get_response"]).is_not_equal_to(None) 28 | elif request_type == "PUT": 29 | assert_that(context["put_response"]).is_not_equal_to(None) 30 | elif request_type == "DELETE": 31 | assert_that(context["delete_response"]).is_empty() 32 | -------------------------------------------------------------------------------- /tests/step_definitions/test_common.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from pytest_bdd import given, parsers 3 | 4 | 5 | @pytest.fixture 6 | @given("I set sample rest_api_base_url") 7 | def set_rest_api_base_url(base_url): 8 | return base_url 9 | 10 | 11 | @pytest.fixture 12 | @given( 13 | parsers.parse( 14 | 'I set the header param request content type as "{header_content_type}"' 15 | ) 16 | ) 17 | def set_headers(header_content_type): 18 | return {"Content-type": f"{header_content_type}; charset=UTF-8"} 19 | 20 | 21 | @pytest.fixture 22 | @given( 23 | parsers.parse('I set the DELETE endpoint to "{endpoint_url}" for deleting posts') 24 | ) 25 | @given( 26 | parsers.parse('I set the UPDATE endpoint to "{endpoint_url}" for updating posts') 27 | ) 28 | @given(parsers.parse('I set the GET endpoint to "{endpoint_url}" for fetching posts')) 29 | @given(parsers.parse('I set the POST endpoint to "{endpoint_url}" for creating posts')) 30 | def set_api_endpoint(set_rest_api_base_url, endpoint_url): 31 | api_endpoint = set_rest_api_base_url + endpoint_url 32 | return api_endpoint 33 | -------------------------------------------------------------------------------- /tests/step_definitions/test_sample.py: -------------------------------------------------------------------------------- 1 | from pytest_bdd import when, scenarios 2 | 3 | from utils.utils import ( 4 | post_request, 5 | get_request, 6 | put_request, 7 | delete_request, 8 | read_file, 9 | ) 10 | 11 | scenarios("sample.feature") 12 | 13 | 14 | @when("I send a POST HTTP request with ") 15 | def send_post_request(context, payload, set_headers, set_api_endpoint): 16 | request_body = read_file(payload) 17 | post_response = post_request( 18 | api_endpoint=set_api_endpoint, payload=request_body, headers=set_headers 19 | ) 20 | context["post_response"] = post_response.json() 21 | context["post_status_code"] = post_response.status_code 22 | 23 | 24 | @when("I send a GET HTTP request") 25 | def send_get_request(context, set_headers, set_api_endpoint): 26 | get_response = get_request(api_endpoint=set_api_endpoint, headers=set_headers) 27 | context["get_response"] = get_response.json() 28 | context["get_status_code"] = get_response.status_code 29 | 30 | 31 | @when("I send a PUT HTTP request with ") 32 | def send_put_request(context, payload, set_headers, set_api_endpoint): 33 | request_body = read_file(payload) 34 | put_response = put_request( 35 | api_endpoint=set_api_endpoint, payload=request_body, headers=set_headers 36 | ) 37 | context["put_response"] = put_response.json() 38 | context["put_status_code"] = put_response.status_code 39 | 40 | 41 | @when("I send a DELETE HTTP request") 42 | def send_delete_request(context, set_headers, set_api_endpoint): 43 | delete_response = delete_request(api_endpoint=set_api_endpoint, headers=set_headers) 44 | context["delete_response"] = delete_response.json() 45 | context["delete_status_code"] = delete_response.status_code 46 | -------------------------------------------------------------------------------- /tests/utils/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ashikkumar23/gherkin-bdd-api-test-framework/03fd6c89551805bbf54f2ccda833a8f6af792908/tests/utils/__init__.py -------------------------------------------------------------------------------- /tests/utils/custom_exceptions.py: -------------------------------------------------------------------------------- 1 | class GeneralException(Exception): 2 | """Base class for other exceptions. 3 | 4 | This class serves as a base class for creating custom exceptions. It takes 5 | an optional `exception_type` argument and an optional `msg` argument. If 6 | `exception_type` is not provided, it defaults to "GENERAL_EXCEPTION". If 7 | `msg` is not provided, it defaults to "General exception". 8 | """ 9 | 10 | def __init__(self, exception_type=None, msg=None): 11 | self.exception_type = exception_type or "GENERAL_EXCEPTION" 12 | self.message = ( 13 | f"[EXCEPTION: {self.exception_type}] {msg or 'General exception'}" 14 | ) 15 | super().__init__(self.message) 16 | 17 | 18 | class FileNotFoundException(GeneralException): 19 | """Exception raised when the file is missing. 20 | 21 | This exception is raised when a file that is expected to be present is not 22 | found. It takes an optional `msg` argument to provide more information 23 | about the error. 24 | """ 25 | 26 | def __init__(self, msg=None): 27 | super().__init__("FILE_NOT_FOUND", msg) 28 | 29 | 30 | class InvalidFileFormatException(GeneralException): 31 | """Exception raised when the file format is invalid. 32 | 33 | This exception is raised when the format of a file is not as expected. It 34 | takes an optional `msg` argument to provide more information about the 35 | error. 36 | """ 37 | 38 | def __init__(self, msg=None): 39 | super().__init__("INVALID_FILE_FORMAT", msg) 40 | -------------------------------------------------------------------------------- /tests/utils/logger_config.py: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | logger = logging.getLogger(__name__) 4 | logging.basicConfig(level=logging.DEBUG, format="%(message)s") 5 | -------------------------------------------------------------------------------- /tests/utils/utils.py: -------------------------------------------------------------------------------- 1 | import json 2 | from pathlib import Path 3 | from typing import Dict 4 | 5 | import requests 6 | 7 | from utils.custom_exceptions import InvalidFileFormatException, FileNotFoundException 8 | from utils.logger_config import logger 9 | 10 | session = requests.Session() 11 | 12 | 13 | def read_file(file_name: str) -> Dict: 14 | """Read the given file and return its content as a dictionary.""" 15 | file_path = get_file_path(file_name) 16 | if not file_path.suffix == ".json": 17 | raise InvalidFileFormatException(f"Invalid file format '{file_path.suffix}'") 18 | with open(file_path, "r", encoding="utf-8") as file: 19 | return json.load(file) 20 | 21 | 22 | def get_file_path(file_name: str) -> Path: 23 | """Get the full path of the given file name.""" 24 | file_path = Path("data") / file_name 25 | if not file_path.exists(): 26 | raise FileNotFoundException( 27 | f"File '{file_name}' not found in '{file_path.parent}'" 28 | ) 29 | return file_path 30 | 31 | 32 | def make_request( 33 | method: str, api_endpoint: str, headers: Dict = None, payload: Dict = None 34 | ) -> requests.Response: 35 | """Make a request using the given method and log the request & response details.""" 36 | response = session.request(method, api_endpoint, headers=headers, json=payload) 37 | log_details = "\n".join( 38 | [ 39 | f"Request Method: {method.upper()}", 40 | f"Request URI: {api_endpoint}", 41 | f"Request Headers: {headers}", 42 | f"Request Payload: {payload}", 43 | f"Response Status Code: {response.status_code}", 44 | f"Response Headers: {response.headers}", 45 | f"Response Body: {response.json()}", 46 | ] 47 | ) 48 | logger.debug(log_details) 49 | return response 50 | 51 | 52 | def get_request(api_endpoint: str = None, headers: Dict = None) -> requests.Response: 53 | """Make a GET request.""" 54 | return make_request("GET", api_endpoint=api_endpoint, headers=headers) 55 | 56 | 57 | def post_request( 58 | api_endpoint: str = None, headers: Dict = None, payload: Dict = None 59 | ) -> requests.Response: 60 | """Make a POST request.""" 61 | return make_request( 62 | "POST", api_endpoint=api_endpoint, headers=headers, payload=payload 63 | ) 64 | 65 | 66 | def put_request( 67 | api_endpoint: str = None, headers: Dict = None, payload: Dict = None 68 | ) -> requests.Response: 69 | """Make a PUT request.""" 70 | return make_request( 71 | "PUT", api_endpoint=api_endpoint, headers=headers, payload=payload 72 | ) 73 | 74 | 75 | def delete_request(api_endpoint: str = None, headers: Dict = None) -> requests.Response: 76 | """Make a DELETE request.""" 77 | return make_request("DELETE", api_endpoint=api_endpoint, headers=headers) 78 | --------------------------------------------------------------------------------