├── .github └── workflows │ └── maven.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── LICENSE ├── README.md ├── lombok.config ├── pom.xml ├── src ├── main │ ├── java │ │ └── com │ │ │ └── faisalkhatri │ │ │ └── okhttppoc │ │ │ ├── AuthenticationPojo.java │ │ │ ├── PostData.java │ │ │ └── TestListener.java │ └── resources │ │ └── log4j2.xml └── test │ └── java │ ├── com │ └── faisalkhatri │ │ └── okhttppoc │ │ ├── SetupConfig.java │ │ ├── TestAuthentication.java │ │ ├── TestDeleteRequests.java │ │ ├── TestGetRequestWithRestAssuredConfig.java │ │ ├── TestGetRequests.java │ │ ├── TestPatchRequests.java │ │ ├── TestPostRequest.java │ │ ├── TestPostRequestBuilderExample.java │ │ └── TestPutRequests.java │ └── data │ └── UserData.java └── testng.xml /.github/workflows/maven.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven 3 | 4 | name: Java CI with Maven 5 | 6 | on: 7 | push: 8 | branches: 9 | - master 10 | - issue-* 11 | 12 | permissions: 13 | contents: write 14 | 15 | jobs: 16 | build_and_test: 17 | name: Build and Test 18 | runs-on: ubuntu-latest 19 | 20 | steps: 21 | - name: checkout Git repository 22 | uses: actions/checkout@v4 23 | 24 | - name: Install Java and Maven 25 | uses: actions/setup-java@v4 26 | with: 27 | java-version: '21' 28 | distribution: 'adopt' 29 | cache: maven 30 | 31 | - name: Build the Project and run tests 32 | run: mvn clean install 33 | 34 | - name: Test Report 35 | uses: dorny/test-reporter@v2 36 | if: success() || failure() 37 | with: 38 | name: Test Results 39 | path: ${{ github.workspace }}/target/surefire-reports/TEST-TestSuite.xml 40 | reporter: java-junit -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | !.mvn/wrapper/maven-wrapper.jar 3 | !**/src/main/**/target/ 4 | !**/src/test/**/target/ 5 | test-output/ 6 | 7 | ### IntelliJ IDEA ### 8 | .idea/ 9 | .idea/modules.xml 10 | .idea/jarRepositories.xml 11 | .idea/compiler.xml 12 | .idea/libraries/ 13 | *.iws 14 | *.iml 15 | *.ipr 16 | 17 | ### Eclipse ### 18 | .apt_generated 19 | .classpath 20 | .factorypath 21 | .project 22 | .settings 23 | .springBeans 24 | .sts4-cache 25 | 26 | ### NetBeans ### 27 | /nbproject/private/ 28 | /nbbuild/ 29 | /dist/ 30 | /nbdist/ 31 | /.nb-gradle/ 32 | build/ 33 | !**/src/main/**/build/ 34 | !**/src/test/**/build/ 35 | 36 | ### VS Code ### 37 | .vscode/ 38 | 39 | ### Mac OS ### 40 | .DS_Store -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | mohammadfaisalkhatri@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /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 | 2 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 3 | [![Github Actions Workflow](https://github.com/mfaisalkhatri/OkHttpRestAssuredExamples/actions/workflows/maven.yml/badge.svg)](https://github.com/mfaisalkhatri/OkHttpRestAssuredExamples/actions/workflows/maven.yml) 4 | 5 | ## Don't forget to give a :star: to make the project popular. 6 | 7 | ## :question: What is this Repository about? 8 | 9 | This project is the outcome of my self-learning the API Testing Automation frameworks - Rest-assured and OkHttp. 10 | I heard a lot about Rest-Assured and OkHttp and how it made the QA's life easier by helping them to run all the tedious API tests in an efficient way. 11 | 12 | Hence, I started learning about these frameworks and have documented all my learnings in this repository. 13 | 14 | Checkout my blog [API Testing using RestAssured and OkHttp](https://mfaisalkhatri.github.io/2020/05/29/restassuredokhttp/) where I talk about these frameworks in details 15 | and which one to choose for testing your APIs. 16 | 17 | 18 | ## Details about this Project: 19 | 20 | - This repo contains example codes of API Tests using Rest-Assured and OkHttp. 21 | - Hamcrest Matchers and TestNG asserts are used for assertions. 22 | - TestNG Listeners are used to capture the events in log. 23 | - Log4j is used to capture logs. 24 | - Lombok has been used to generate Getter and Setters automatically for post body requests. 25 | - Rest APIs on https://reqres.in/ have been used for testing. 26 | 27 | ## :writing_hand: Blog Links 28 | 29 | - [What is API Testing?](https://mfaisalkhatri.github.io/2020/08/08/apitesting/) 30 | - [End to End API Testing using Rest-Assured](https://medium.com/@iamfaisalkhatri/end-to-end-api-testing-using-rest-assured-a58c4ea80255) 31 | 32 | ## :movie_camera: Tutorial Video 33 | 34 | [![Watch the video](https://img.youtube.com/vi/xLKpdQE0oKY/hqdefault.jpg)](https://www.youtube.com/watch?v=xLKpdQE0oKY&t=1s) 35 | [![Watch the video](https://img.youtube.com/vi/AFQSolEeu74/hqdefault.jpg)](https://www.youtube.com/live/AFQSolEeu74?si=8WROMbunjUuzqqQj&t=1) 36 | 37 | 38 | ## :question: Need Assistance? 39 | 40 | - Discuss your queries by writing to me @ `mohammadfaisalkhatri@gmail.com` 41 | OR ping me on any of the social media sites using the below link: 42 | - [Linktree](https://linktr.ee/faisalkhatri) 43 | 44 | ## :computer: Paid Trainings 45 | 46 | Contact me for Paid trainings related to Test Automation and Software Testing, 47 | mail me @`mohammadfaisalkhatri@gmail.com` or ping me on [LinkedIn](https://www.linkedin.com/in/faisalkhatri/) 48 | 49 | ## :thought_balloon: Checkout the blogs related to Software Testing and Test Automation on the following links: 50 | - [Medium Blogs](https://medium.com/@iamfaisalkhatri) 51 | - [LambdaTest Blogs](https://www.lambdatest.com/blog/author/mfaisalkhatri/) 52 | - [My Website](https://mfaisalkhatri.github.io) 53 | 54 | ## Subscribe to my [YouTube Channel](https://www.youtube.com/@faisalkhatriqa) -------------------------------------------------------------------------------- /lombok.config: -------------------------------------------------------------------------------- 1 | config.stopBubbling = true 2 | lombok.addLombokGeneratedAnnotation = true -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 4.0.0 7 | 8 | com.faisalkhatri 9 | okhttppoc 10 | 0.0.1-SNAPSHOT 11 | 12 | okhttppoc 13 | https://mfaisalkhatri.github.io 14 | 15 | 16 | 7.11.0 17 | 4.9.3 18 | 5.5.5 19 | 1.3 20 | 2.25.1 21 | 2.25.1 22 | 1.1.1 23 | 1.18.38 24 | 2.19.2 25 | 20250517 26 | 1.0.2 27 | 3.14.0 28 | 3.5.3 29 | -Dfile.encoding=UTF-8 -Xdebug -Xnoagent 30 | 3.8.1 31 | 17 32 | UTF-8 33 | testng.xml 34 | UTF-8 35 | 36 | 37 | 38 | org.testng 39 | testng 40 | ${testng.version} 41 | 42 | 43 | com.squareup.okhttp3 44 | okhttp 45 | ${okhttp3.version} 46 | provided 47 | 48 | 49 | io.rest-assured 50 | rest-assured 51 | ${restassured.version} 52 | 53 | 54 | org.hamcrest 55 | hamcrest-all 56 | ${hamcrest.version} 57 | 58 | 59 | org.apache.logging.log4j 60 | log4j-core 61 | ${log4j.core.version} 62 | 63 | 64 | org.apache.logging.log4j 65 | log4j-api 66 | ${log4j.api.version} 67 | 68 | 69 | com.googlecode.json-simple 70 | json-simple 71 | ${jsonsimple.version} 72 | 73 | 74 | org.projectlombok 75 | lombok 76 | ${lombok.version} 77 | provided 78 | 79 | 80 | com.fasterxml.jackson.core 81 | jackson-databind 82 | ${jackson.databind.version} 83 | 84 | 85 | org.json 86 | json 87 | ${orgjson.version} 88 | 89 | 90 | com.github.javafaker 91 | javafaker 92 | ${javafaker.version} 93 | 94 | 95 | 96 | 97 | 98 | org.apache.maven.plugins 99 | maven-compiler-plugin 100 | ${maven.compiler.version} 101 | 102 | ${java.release.version} 103 | ${maven.source.encoding} 104 | true 105 | 106 | 107 | 108 | org.apache.maven.plugins 109 | maven-surefire-plugin 110 | ${surefire-version} 111 | 112 | 113 | 114 | test 115 | 116 | 117 | 118 | 119 | false 120 | 121 | 122 | usedefaultlisteners 123 | false 124 | 125 | 126 | 127 | ${suite-xml} 128 | 129 | ${argLine} 130 | 131 | 132 | 133 | org.apache.maven.plugins 134 | maven-dependency-plugin 135 | ${maven.dependency.version} 136 | 137 | 138 | copy-dependencies 139 | package 140 | 141 | copy-dependencies 142 | 143 | 144 | lombok 145 | 146 | 147 | 148 | 149 | 150 | 151 | -------------------------------------------------------------------------------- /src/main/java/com/faisalkhatri/okhttppoc/AuthenticationPojo.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import lombok.Data; 20 | 21 | /** 22 | * @author Faisal Khatri 23 | * @since Aug 2, 2020 24 | */ 25 | @Data 26 | public class AuthenticationPojo { 27 | 28 | private String email; 29 | private String password; 30 | 31 | /** 32 | * @param email 33 | * @param password 34 | * 35 | * @author Faisal Khatri 36 | */ 37 | public AuthenticationPojo (String email, String password) { 38 | this.email = email; 39 | this.password = password; 40 | } 41 | } -------------------------------------------------------------------------------- /src/main/java/com/faisalkhatri/okhttppoc/PostData.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import lombok.Getter; 20 | import lombok.Setter; 21 | 22 | /** 23 | * @since Mar 7, 2020 24 | */ 25 | @Getter 26 | @Setter 27 | public class PostData { 28 | 29 | private final String job; 30 | private final String name; 31 | 32 | /** 33 | * @param name 34 | * @param job 35 | * 36 | * @author Faisal Khatri 37 | */ 38 | public PostData (final String name, final String job) { 39 | this.name = name; 40 | this.job = job; 41 | 42 | } 43 | } -------------------------------------------------------------------------------- /src/main/java/com/faisalkhatri/okhttppoc/TestListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static org.apache.commons.lang3.StringUtils.repeat; 20 | 21 | import org.apache.logging.log4j.LogManager; 22 | import org.apache.logging.log4j.Logger; 23 | import org.testng.ITestContext; 24 | import org.testng.ITestListener; 25 | import org.testng.ITestResult; 26 | 27 | /** 28 | * @since Mar 8, 2020 29 | */ 30 | public class TestListener implements ITestListener { 31 | Logger log = LogManager.getLogger (TestListener.class); 32 | 33 | @Override 34 | public void onFinish (final ITestContext context) { 35 | logMessage ("Test Execution Completed Successfully for all tests!!" + context.getSuite () 36 | .getAllMethods ()); 37 | 38 | } 39 | 40 | @Override 41 | public void onTestFailure (final ITestResult result) { 42 | logMessage ("Test Failed!!!!" + result.getName ()); 43 | } 44 | 45 | @Override 46 | public void onTestStart (final ITestResult result) { 47 | logMessage ("Test Execution Started...." + result.getName ()); 48 | } 49 | 50 | @Override 51 | public void onTestSuccess (final ITestResult result) { 52 | logMessage ("Test Passed Successfully." + result.getName ()); 53 | 54 | } 55 | 56 | private void logMessage (final String message) { 57 | this.log.info ("\n"); 58 | this.log.info (repeat ("=", 75)); 59 | this.log.info (message); 60 | this.log.info (repeat ("=", 75)); 61 | this.log.info ("\n"); 62 | } 63 | } -------------------------------------------------------------------------------- /src/main/resources/log4j2.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/SetupConfig.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static org.hamcrest.Matchers.lessThan; 20 | 21 | import io.restassured.RestAssured; 22 | import io.restassured.builder.RequestSpecBuilder; 23 | import io.restassured.builder.ResponseSpecBuilder; 24 | import io.restassured.filter.log.RequestLoggingFilter; 25 | import io.restassured.filter.log.ResponseLoggingFilter; 26 | import io.restassured.specification.RequestSpecification; 27 | import io.restassured.specification.ResponseSpecification; 28 | import org.testng.annotations.BeforeClass; 29 | 30 | public class SetupConfig { 31 | 32 | @BeforeClass 33 | public void setup () { 34 | RestAssured.baseURI = "https://reqres.in/"; 35 | RequestSpecification request = new RequestSpecBuilder ().addHeader ("Content-Type", "application/json") 36 | .addHeader ("Accept", "application/json") 37 | .addFilter (new RequestLoggingFilter ()) 38 | .addFilter (new ResponseLoggingFilter ()) 39 | .build (); 40 | 41 | ResponseSpecification response = new ResponseSpecBuilder ().expectResponseTime (lessThan (5000L)) 42 | .build (); 43 | 44 | RestAssured.requestSpecification = request; 45 | RestAssured.responseSpecification = response; 46 | 47 | } 48 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestAuthentication.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.hamcrest.Matchers.notNullValue; 21 | 22 | import java.util.ArrayList; 23 | import java.util.HashMap; 24 | import java.util.Iterator; 25 | import java.util.List; 26 | import java.util.Map; 27 | 28 | import io.restassured.http.ContentType; 29 | import org.json.JSONObject; 30 | import org.testng.annotations.DataProvider; 31 | import org.testng.annotations.Test; 32 | 33 | /** 34 | * @author Faisal Khatri 35 | * @since Aug 2, 2020 36 | */ 37 | public class TestAuthentication { 38 | 39 | private static final String URL = "https://reqres.in"; 40 | 41 | /** 42 | * @param email 43 | * @param password 44 | * 45 | * @return auth details 46 | * 47 | * @author Faisal Khatri 48 | * @since Aug 2, 2020 49 | */ 50 | public static Map getToken (String email, String password) { 51 | final AuthenticationPojo requestBody = new AuthenticationPojo (email, password); 52 | final String response = given ().contentType (ContentType.JSON) 53 | .header ("x-api-key", "reqres-free-v1") 54 | .body (requestBody) 55 | .when () 56 | .log () 57 | .all () 58 | .post (URL + "/api/register") 59 | .then () 60 | .assertThat () 61 | .statusCode (200) 62 | .log () 63 | .all () 64 | .body ("id", notNullValue ()) 65 | .and () 66 | .body ("token", notNullValue ()) 67 | .and () 68 | .extract () 69 | .response () 70 | .asString (); 71 | 72 | final JSONObject responseObject = new JSONObject (response); 73 | final Map responseMap = new HashMap<> (); 74 | responseMap.put ("id", responseObject.getInt ("id")); 75 | responseMap.put ("token", responseObject.getString ("token")); 76 | return responseMap; 77 | } 78 | 79 | /** 80 | * @return test data 81 | * 82 | * @author Faisal Khatri 83 | * @since Aug 2, 2020 84 | */ 85 | @DataProvider 86 | public Iterator getAuthenticationData () { 87 | final List getTestData = new ArrayList<> (); 88 | getTestData.add (new Object[] { "eve.holt@reqres.in", "pistol" }); 89 | return getTestData.iterator (); 90 | } 91 | 92 | /** 93 | * @param email 94 | * @param password 95 | * 96 | * @author Faisal Khatri 97 | * @since Aug 2, 2020 98 | */ 99 | @Test (dataProvider = "getAuthenticationData") 100 | public void testAuthToken (String email, String password) { 101 | System.out.println ("Token is" + getToken (email, password).get ("token") 102 | .toString ()); 103 | 104 | } 105 | 106 | /** 107 | * @param email 108 | * @param password 109 | * 110 | * @author Faisal Khatri 111 | * @since Aug 2, 2020 112 | */ 113 | @Test (dataProvider = "getAuthenticationData") 114 | public void testAuthenticationToken (String email, String password) { 115 | final AuthenticationPojo requestBody = new AuthenticationPojo (email, password); 116 | 117 | given ().contentType (ContentType.JSON) 118 | .header ("x-api-key", "reqres-free-v1") 119 | .body (requestBody) 120 | .when () 121 | .log () 122 | .all () 123 | .post (URL + "/api/register") 124 | .then () 125 | .assertThat () 126 | .statusCode (200) 127 | .log () 128 | .all () 129 | .body ("id", notNullValue ()) 130 | .and () 131 | .body ("token", notNullValue ()); 132 | 133 | } 134 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestDeleteRequests.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.testng.Assert.assertEquals; 21 | 22 | import java.io.IOException; 23 | import java.util.ArrayList; 24 | import java.util.Iterator; 25 | import java.util.List; 26 | 27 | import okhttp3.OkHttpClient; 28 | import okhttp3.Request; 29 | import okhttp3.Response; 30 | import org.testng.annotations.DataProvider; 31 | import org.testng.annotations.Test; 32 | 33 | /** 34 | * @since Mar 8, 2020 35 | */ 36 | public class TestDeleteRequests { 37 | 38 | private static final String URL = "https://reqres.in/api/users/"; 39 | 40 | /** 41 | * @return deleteUserData using rest assured 42 | * 43 | * @since Mar 8, 2020 44 | */ 45 | @DataProvider (name = "deleteUserRestAssured") 46 | public Iterator deleteRestUsers () { 47 | final List deleteData = new ArrayList<> (); 48 | deleteData.add (new Object[] { 2 }); 49 | return deleteData.iterator (); 50 | } 51 | 52 | /** 53 | * @return deleteUserData using okhttp 54 | * 55 | * @since Mar 8, 2020 56 | */ 57 | @DataProvider (name = "deleteUserOkHttp") 58 | public Iterator deleteokHttpUsers () { 59 | final List deleteData = new ArrayList<> (); 60 | deleteData.add (new Object[] { 8 }); 61 | return deleteData.iterator (); 62 | } 63 | 64 | /** 65 | * Executing delete requests using Rest-assured 66 | * 67 | * @param userId 68 | * 69 | * @since Mar 08, 2020 70 | */ 71 | @Test (dataProvider = "deleteUserRestAssured", groups = "DeleteTests") 72 | public void testDeleUsingRestAsured (final int userId) { 73 | given ().when () 74 | .header ("x-api-key", "reqres-free-v1") 75 | .delete (URL + userId) 76 | .then () 77 | .assertThat () 78 | .statusCode (204); 79 | } 80 | 81 | /** 82 | * Executing delete request using okhttp 83 | * 84 | * @param userId 85 | * 86 | * @throws IOException 87 | * @since Mar 8, 2020 88 | */ 89 | @Test (dataProvider = "deleteUserOkHttp", groups = "DeleteTests") 90 | public void testDeleteUsingOkHttp (final int userId) throws IOException { 91 | final OkHttpClient client = new OkHttpClient (); 92 | final Request request = new Request.Builder ().url (URL + userId) 93 | .header ("x-api-key", "reqres-free-v1") 94 | .delete () 95 | .build (); 96 | 97 | final Response response = client.newCall (request) 98 | .execute (); 99 | final int statusCode = response.code (); 100 | assertEquals (statusCode, 204); 101 | } 102 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestGetRequestWithRestAssuredConfig.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import org.testng.annotations.Test; 20 | 21 | import static io.restassured.RestAssured.given; 22 | import static org.hamcrest.Matchers.equalTo; 23 | 24 | public class TestGetRequestWithRestAssuredConfig extends SetupConfig { 25 | 26 | @Test(groups = "GetTests") 27 | public void testGetRequestwithRestAssured() { 28 | given() 29 | .header ("x-api-key", "reqres-free-v1") 30 | .when() 31 | .get("/api/users/2") 32 | .then() 33 | .statusCode(200) 34 | .and() 35 | .assertThat() 36 | .body("data.first_name", equalTo("Janet")); 37 | } 38 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestGetRequests.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.hamcrest.Matchers.equalTo; 21 | import static org.junit.Assert.assertThat; 22 | import static org.testng.Assert.assertEquals; 23 | 24 | import java.io.IOException; 25 | import java.util.ArrayList; 26 | import java.util.Iterator; 27 | import java.util.List; 28 | 29 | import okhttp3.HttpUrl; 30 | import okhttp3.OkHttpClient; 31 | import okhttp3.Request; 32 | import okhttp3.Response; 33 | import org.apache.logging.log4j.LogManager; 34 | import org.apache.logging.log4j.Logger; 35 | import org.json.JSONObject; 36 | import org.testng.annotations.DataProvider; 37 | import org.testng.annotations.Test; 38 | 39 | /** 40 | * @since Mar 7, 2020 41 | */ 42 | public class TestGetRequests { 43 | 44 | private static final String URL = "https://reqres.in/api/users/"; 45 | Logger log = LogManager.getLogger (TestGetRequests.class); 46 | 47 | /** 48 | * @return getUserData 49 | * 50 | * @since Mar 7, 2020 51 | */ 52 | @DataProvider (name = "getUserData") 53 | public Iterator getUsers () { 54 | final List getData = new ArrayList<> (); 55 | getData.add (new Object[] { 2 }); 56 | return getData.iterator (); 57 | } 58 | 59 | /** 60 | * Executing get request using okhttp 61 | * 62 | * @param userId 63 | * 64 | * @throws IOException 65 | * @since Mar 7, 2020 66 | */ 67 | @Test (dataProvider = "getUserData", groups = "GetTests") 68 | public void testGetRequestWithOkHttp (final int userId) throws IOException { 69 | final OkHttpClient client = new OkHttpClient (); 70 | final Request request = new Request.Builder ().url (URL + userId) 71 | .header ("x-api-key", "reqres-free-v1") 72 | .get () 73 | .build (); 74 | 75 | final Response response = client.newCall (request) 76 | .execute (); 77 | final String responseBody = response.body () 78 | .string (); 79 | final int statusCode = response.code (); 80 | this.log.info (responseBody); 81 | 82 | assertEquals (statusCode, 200); 83 | 84 | final JSONObject jsonResponse = new JSONObject (responseBody); 85 | final int id = jsonResponse.getJSONObject ("data") 86 | .getInt ("id"); 87 | assertThat (id, equalTo (userId)); 88 | } 89 | 90 | /** 91 | * @param userPage 92 | * 93 | * @throws IOException 94 | * @since Mar 7, 2020 95 | */ 96 | @Test (dataProvider = "getUserData", groups = "GetTests") 97 | public void testGetRequestWithQueryParamOkHttp (final int userPage) throws IOException { 98 | final OkHttpClient client = new OkHttpClient (); 99 | final HttpUrl.Builder urlBuilder = HttpUrl.parse (URL) 100 | .newBuilder (); 101 | urlBuilder.addQueryParameter ("page", String.valueOf (userPage)); 102 | 103 | final String currentUrl = urlBuilder.build () 104 | .toString (); 105 | final Request request = new Request.Builder ().url (currentUrl).header ("x-api-key", "reqres-free-v1") 106 | .build (); 107 | final Response response = client.newCall (request) 108 | .execute (); 109 | final String responseBody = response.body () 110 | .string (); 111 | final int statusCode = response.code (); 112 | this.log.info (statusCode); 113 | this.log.info (responseBody); 114 | assertEquals (statusCode, 200); 115 | final JSONObject jsonResponse = new JSONObject (responseBody); 116 | assertThat (jsonResponse.getInt ("page"), equalTo (userPage)); 117 | final String firstName = jsonResponse.getJSONArray ("data") 118 | .getJSONObject (0) 119 | .getString ("first_name"); 120 | assertThat (firstName, equalTo ("Michael")); 121 | 122 | } 123 | 124 | /** 125 | * @param userPage 126 | * 127 | * @since Mar 7, 2020 128 | */ 129 | @Test (dataProvider = "getUserData", groups = "GetTests") 130 | public void testGetRequestWithQueryParamWithRestAssured (final int userPage) { 131 | given ().when () 132 | .header ("x-api-key", "reqres-free-v1") 133 | .queryParam ("page", userPage) 134 | .get (URL) 135 | .then () 136 | .statusCode (200) 137 | .and () 138 | .assertThat () 139 | .body ("page", equalTo (userPage)); 140 | 141 | final String responseBody = given ().when () 142 | .queryParam ("page", userPage) 143 | .get (URL) 144 | .getBody () 145 | .asString (); 146 | this.log.info (responseBody); 147 | } 148 | 149 | /** 150 | * Executing get requests using Rest-assured 151 | * 152 | * @param userId 153 | * 154 | * @since Mar 7, 2020 155 | */ 156 | @Test (dataProvider = "getUserData", groups = "GetTests") 157 | public void testGetRequestWithRestAssured (final int userId) { 158 | given ().when () 159 | .header ("x-api-key", "reqres-free-v1") 160 | .get (URL + userId) 161 | .then () 162 | .statusCode (200) 163 | .and () 164 | .assertThat () 165 | .body ("data.id", equalTo (userId)); 166 | 167 | final int statusCode = given ().when () 168 | .get (URL + userId) 169 | .statusCode (); 170 | this.log.info (statusCode); 171 | 172 | final String responseBody = given ().when () 173 | .get (URL + userId) 174 | .getBody () 175 | .asString (); 176 | this.log.info (responseBody); 177 | } 178 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestPatchRequests.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.hamcrest.Matchers.equalTo; 21 | import static org.junit.Assert.assertThat; 22 | import static org.testng.Assert.assertEquals; 23 | 24 | import java.io.IOException; 25 | import java.util.ArrayList; 26 | import java.util.Iterator; 27 | import java.util.List; 28 | 29 | import io.restassured.http.ContentType; 30 | import okhttp3.MediaType; 31 | import okhttp3.OkHttpClient; 32 | import okhttp3.Request; 33 | import okhttp3.RequestBody; 34 | import okhttp3.Response; 35 | import org.apache.logging.log4j.LogManager; 36 | import org.apache.logging.log4j.Logger; 37 | import org.json.JSONObject; 38 | import org.testng.annotations.DataProvider; 39 | import org.testng.annotations.Test; 40 | 41 | /** 42 | * @since Mar 8, 2020 43 | */ 44 | public class TestPatchRequests { 45 | 46 | private static final String URL = "https://reqres.in"; 47 | Logger log = LogManager.getLogger (TestPatchRequests.class); 48 | 49 | /** 50 | * @return putData 51 | * 52 | * @since Mar 8, 2020 53 | */ 54 | @DataProvider (name = "patchData") 55 | public Iterator patchData () { 56 | final List patchData = new ArrayList<> (); 57 | patchData.add (new Object[] { 2, "Michael", "QA Lead" }); 58 | patchData.add (new Object[] { 958, "Yuan", "Project Architect" }); 59 | return patchData.iterator (); 60 | } 61 | 62 | /** 63 | * Executing Put Request using OkHttp 64 | * 65 | * @param id 66 | * @param name 67 | * @param job 68 | * 69 | * @throws IOException 70 | * @since Mar 8, 2020 71 | */ 72 | @Test (dataProvider = "patchData", groups = "PatchTests") 73 | public void testPatchWithOkHttp (final int id, final String name, final String job) throws IOException { 74 | final MediaType JSON = MediaType.parse ("application/json; charset=utf-8"); 75 | final PostData postData = new PostData (name, job); 76 | 77 | final OkHttpClient client = new OkHttpClient (); 78 | 79 | final JSONObject json = new JSONObject (postData); 80 | final RequestBody requestBody = RequestBody.create (json.toString (), JSON); 81 | 82 | final Request request = new Request.Builder ().url (URL + "/api/users/" + id) 83 | .addHeader ("Content-Type", "application/json;charset=utf-8") 84 | .header ("x-api-key", "reqres-free-v1") 85 | .patch (requestBody) 86 | .build (); 87 | 88 | final Response response = client.newCall (request) 89 | .execute (); 90 | 91 | final int statusCode = response.code (); 92 | this.log.info (statusCode); 93 | 94 | final String responseBody = response.body () 95 | .string (); 96 | 97 | this.log.info (responseBody); 98 | 99 | final JSONObject jsonResponse = new JSONObject (responseBody); 100 | assertEquals (statusCode, 200); 101 | assertThat (jsonResponse.getString ("name"), equalTo (name)); 102 | assertThat (jsonResponse.getString ("job"), equalTo (job)); 103 | } 104 | 105 | /** 106 | * Executing Put Request using Rest Assured. 107 | * 108 | * @param id 109 | * @param name 110 | * @param job 111 | * 112 | * @since Mar 8, 2020 113 | */ 114 | @Test (dataProvider = "patchData", groups = "PatchTests") 115 | public void testPatchWithRestAssured (final int id, final String name, final String job) { 116 | 117 | final PostData postData = new PostData (name, job); 118 | final String response = given ().contentType (ContentType.JSON) 119 | .header ("x-api-key", "reqres-free-v1") 120 | .body (postData) 121 | .when () 122 | .patch (URL + "/api/users/" + id) 123 | .then () 124 | .assertThat () 125 | .statusCode (200) 126 | .and () 127 | .assertThat () 128 | .body ("name", equalTo (name)) 129 | .and () 130 | .assertThat () 131 | .body ("job", equalTo (job)) 132 | .and () 133 | .extract () 134 | .response () 135 | .body () 136 | .asString (); 137 | 138 | this.log.info (response); 139 | 140 | } 141 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestPostRequest.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.hamcrest.Matchers.equalTo; 21 | import static org.hamcrest.Matchers.notNullValue; 22 | import static org.junit.Assert.assertThat; 23 | import static org.testng.Assert.assertEquals; 24 | 25 | import java.io.IOException; 26 | import java.util.ArrayList; 27 | import java.util.Iterator; 28 | import java.util.List; 29 | 30 | import io.restassured.http.ContentType; 31 | import okhttp3.FormBody; 32 | import okhttp3.MediaType; 33 | import okhttp3.OkHttpClient; 34 | import okhttp3.Request; 35 | import okhttp3.RequestBody; 36 | import okhttp3.Response; 37 | import org.apache.logging.log4j.LogManager; 38 | import org.apache.logging.log4j.Logger; 39 | import org.json.JSONObject; 40 | import org.testng.annotations.DataProvider; 41 | import org.testng.annotations.Test; 42 | 43 | /** 44 | * @since Mar 7, 2020 45 | */ 46 | public class TestPostRequest { 47 | 48 | private static final String URL = "https://reqres.in"; 49 | Logger log = LogManager.getLogger (TestPostRequest.class); 50 | 51 | /** 52 | * @return postData 53 | * 54 | * @since Mar 7, 2020 55 | */ 56 | @DataProvider (name = "postData") 57 | public Iterator postData () { 58 | final List postData = new ArrayList<> (); 59 | postData.add (new Object[] { "Rahul", "QA" }); 60 | postData.add (new Object[] { "Jane", "Sr.Dev" }); 61 | postData.add (new Object[] { "Albert", "Dev" }); 62 | postData.add (new Object[] { "Johnny", "Project Manager" }); 63 | return postData.iterator (); 64 | } 65 | 66 | /** 67 | * @param name 68 | * @param job 69 | * 70 | * @throws IOException 71 | * @since Mar 7, 2020 72 | */ 73 | @Test (dataProvider = "postData", groups = "PostTests") 74 | public void testPostWithOkHttp (final String name, final String job) throws IOException { 75 | final MediaType JSON = MediaType.parse ("application/json; charset=utf-8"); 76 | final PostData postData = new PostData (name, job); 77 | 78 | final OkHttpClient client = new OkHttpClient (); 79 | 80 | final JSONObject json = new JSONObject (postData); 81 | final RequestBody requestBody = RequestBody.create (json.toString (), JSON); 82 | 83 | final Request request = new Request.Builder ().url (URL + "/api/users") 84 | .addHeader ("Content-Type", "application/json;charset=utf-8") 85 | .header ("x-api-key", "reqres-free-v1") 86 | .post (requestBody) 87 | .build (); 88 | 89 | final Response response = client.newCall (request) 90 | .execute (); 91 | 92 | final int statusCode = response.code (); 93 | this.log.info (statusCode); 94 | 95 | final String responseBody = response.body () 96 | .string (); 97 | 98 | this.log.info (responseBody); 99 | 100 | final JSONObject jsonResponse = new JSONObject (responseBody); 101 | assertEquals (statusCode, 201); 102 | assertThat (jsonResponse.getString ("name"), equalTo (name)); 103 | assertThat (jsonResponse.getString ("job"), equalTo (job)); 104 | assertThat (jsonResponse.getString ("id"), notNullValue ()); 105 | 106 | } 107 | 108 | /** 109 | * @param name 110 | * @param job 111 | * 112 | * @since Mar 7, 2020 113 | */ 114 | @Test (dataProvider = "postData", groups = "PostTests") 115 | public void testPostWithRestAssured (final String name, final String job) { 116 | final PostData postData = new PostData (name, job); 117 | final String response = given ().contentType (ContentType.JSON) 118 | .header ("x-api-key", "reqres-free-v1") 119 | .body (postData) 120 | .when () 121 | .post (URL + "/api/users") 122 | .then () 123 | .assertThat () 124 | .statusCode (201) 125 | .and () 126 | .assertThat () 127 | .body ("name", equalTo (name)) 128 | .and () 129 | .assertThat () 130 | .body ("job", equalTo (job)) 131 | .and () 132 | .assertThat () 133 | .body ("id", notNullValue ()) 134 | .and () 135 | .extract () 136 | .response () 137 | .body () 138 | .asString (); 139 | 140 | this.log.info (response); 141 | 142 | } 143 | 144 | /** 145 | * @param name 146 | * @param job 147 | * 148 | * @throws IOException 149 | * @since Mar 7, 2020 150 | */ 151 | @Test (dataProvider = "postData", groups = "PostTests") 152 | public void testPostwithOkHttpForm (final String name, final String job) throws IOException { 153 | final OkHttpClient client = new OkHttpClient (); 154 | final RequestBody formBody = new FormBody.Builder ().add ("name", name) 155 | .add ("job", job) 156 | .build (); 157 | final Request request = new Request.Builder ().url (URL + "/api/users") 158 | .header ("x-api-key", "reqres-free-v1") 159 | .post (formBody) 160 | .build (); 161 | 162 | final Response response = client.newCall (request) 163 | .execute (); 164 | 165 | final int statusCode = response.code (); 166 | this.log.info (statusCode); 167 | 168 | final String responseBody = response.body () 169 | .string (); 170 | 171 | this.log.info (responseBody); 172 | 173 | final JSONObject jsonResponse = new JSONObject (responseBody); 174 | assertEquals (statusCode, 201); 175 | assertThat (jsonResponse.getString ("name"), equalTo (name)); 176 | assertThat (jsonResponse.getString ("job"), equalTo (job)); 177 | assertThat (jsonResponse.getString ("id"), notNullValue ()); 178 | 179 | } 180 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestPostRequestBuilderExample.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.hamcrest.Matchers.equalTo; 21 | 22 | import com.github.javafaker.Faker; 23 | import data.UserData; 24 | import org.testng.annotations.Test; 25 | 26 | public class TestPostRequestBuilderExample extends SetupConfig { 27 | 28 | @Test 29 | public void postUsingBuilderPatternWithRestAssured () { 30 | 31 | UserData userData = userDataBuilder (); 32 | given () 33 | .header ("x-api-key", "reqres-free-v1") 34 | .body (userData) 35 | .when () 36 | .post ("/api/users") 37 | .then () 38 | .statusCode (201) 39 | .and () 40 | .assertThat () 41 | .body ("name", equalTo (userData.getName ())) 42 | .body ("job", equalTo (userData.getJob ())); 43 | 44 | } 45 | 46 | private UserData userDataBuilder () { 47 | Faker faker = Faker.instance (); 48 | return UserData.builder () 49 | .name (faker.name () 50 | .firstName ()) 51 | .job (faker.company () 52 | .profession ()) 53 | .build (); 54 | } 55 | 56 | } -------------------------------------------------------------------------------- /src/test/java/com/faisalkhatri/okhttppoc/TestPutRequests.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.faisalkhatri.okhttppoc; 18 | 19 | import static io.restassured.RestAssured.given; 20 | import static org.hamcrest.Matchers.equalTo; 21 | import static org.junit.Assert.assertThat; 22 | import static org.testng.Assert.assertEquals; 23 | 24 | import java.io.IOException; 25 | import java.util.ArrayList; 26 | import java.util.Iterator; 27 | import java.util.List; 28 | 29 | import io.restassured.http.ContentType; 30 | import okhttp3.MediaType; 31 | import okhttp3.OkHttpClient; 32 | import okhttp3.Request; 33 | import okhttp3.RequestBody; 34 | import okhttp3.Response; 35 | import org.apache.logging.log4j.LogManager; 36 | import org.apache.logging.log4j.Logger; 37 | import org.json.JSONObject; 38 | import org.testng.annotations.DataProvider; 39 | import org.testng.annotations.Test; 40 | 41 | /** 42 | * @since Mar 8, 2020 43 | */ 44 | public class TestPutRequests { 45 | 46 | private static final String URL = "https://reqres.in"; 47 | Logger log = LogManager.getLogger (TestPutRequests.class); 48 | 49 | /** 50 | * @return putData 51 | * 52 | * @since Mar 8, 2020 53 | */ 54 | @DataProvider (name = "putData") 55 | public Iterator putData () { 56 | final List putData = new ArrayList<> (); 57 | putData.add (new Object[] { 2, "Michael", "QA Lead" }); 58 | putData.add (new Object[] { 958, "Yuan", "Project Architect" }); 59 | return putData.iterator (); 60 | } 61 | 62 | /** 63 | * Executing Put Request using OkHttp 64 | * 65 | * @param id 66 | * @param name 67 | * @param job 68 | * 69 | * @throws IOException 70 | * @since Mar 8, 2020 71 | */ 72 | @Test (dataProvider = "putData", groups = "PutTests") 73 | public void testPutWithOkHttp (final int id, final String name, final String job) throws IOException { 74 | final MediaType JSON = MediaType.parse ("application/json; charset=utf-8"); 75 | final PostData postData = new PostData (name, job); 76 | 77 | final OkHttpClient client = new OkHttpClient (); 78 | 79 | final JSONObject json = new JSONObject (postData); 80 | final RequestBody requestBody = RequestBody.create (json.toString (), JSON); 81 | 82 | final Request request = new Request.Builder ().url (URL + "/api/users/" + id) 83 | .addHeader ("Content-Type", "application/json;charset=utf-8") 84 | .header ("x-api-key", "reqres-free-v1") 85 | .put (requestBody) 86 | .build (); 87 | 88 | final Response response = client.newCall (request) 89 | .execute (); 90 | 91 | final int statusCode = response.code (); 92 | this.log.info (statusCode); 93 | 94 | final String responseBody = response.body () 95 | .string (); 96 | 97 | this.log.info (responseBody); 98 | 99 | final JSONObject jsonResponse = new JSONObject (responseBody); 100 | assertEquals (statusCode, 200); 101 | assertThat (jsonResponse.getString ("name"), equalTo (name)); 102 | assertThat (jsonResponse.getString ("job"), equalTo (job)); 103 | 104 | } 105 | 106 | /** 107 | * Executing Put Request using Rest Assured. 108 | * 109 | * @param id 110 | * @param name 111 | * @param job 112 | * 113 | * @since Mar 8, 2020 114 | */ 115 | @Test (dataProvider = "putData", groups = "PutTests") 116 | public void testPutWithRestAssured (final int id, final String name, final String job) { 117 | 118 | final PostData postData = new PostData (name, job); 119 | final String response = given ().contentType (ContentType.JSON) 120 | .header ("x-api-key", "reqres-free-v1") 121 | .body (postData) 122 | .when () 123 | .put (URL + "/api/users/" + id) 124 | .then () 125 | .assertThat () 126 | .statusCode (200) 127 | .and () 128 | .assertThat () 129 | .body ("name", equalTo (name)) 130 | .and () 131 | .assertThat () 132 | .body ("job", equalTo (job)) 133 | .and () 134 | .extract () 135 | .response () 136 | .body () 137 | .asString (); 138 | 139 | this.log.info (response); 140 | 141 | } 142 | 143 | } -------------------------------------------------------------------------------- /src/test/java/data/UserData.java: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2022 Mohammad Faisal Khatri 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package data; 18 | 19 | import lombok.Builder; 20 | import lombok.Data; 21 | 22 | @Data 23 | @Builder 24 | public class UserData { 25 | 26 | private String job; 27 | private String name; 28 | } -------------------------------------------------------------------------------- /testng.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | --------------------------------------------------------------------------------