Python

vibssingh

How to run Python Rest API tests with GitHub Actions

Last Updated On

HOME

This tutorial explains the steps to create a GitHub Action for the Rest API tests built in Python and execute the tests in that workflow.

Table of Contents

  1. Why GitHub?
  2. Implementation Steps
    1. Create GitHub Actions and Workflows
    2. Select the type of Actions
    3. Generation of Sample pipeline
    4. Commit the changes
    5. Verify that the workflow is running
    6. Verify the execution status

Why GitHub?

GitHub Actions are automated tasks, or workflows, that you can set up in your repository to build, test, package, release, and deploy any project on GitHub. With GitHub Actions, you can orchestrate any workflow, based on nearly any event, while GitHub manages the execution, provides rich feedback, and secures every step along the way.

Why should you care? Well, imagine merging your code into the main branch, only to realize later that it broke your build. With GitHub Actions, you can automate your unit tests to run on every push or pull request, thereby catching bugs before they creep into your production code. This means less time debugging and more time developing!

Implementation Steps

Step 1 – Create GitHub Actions and Workflows

I have a repository available in GitHub – RestAPITesting_Python as shown in the below image. Go to the “Actions” tab.  Click on the “Actions” tab.

Step 2 – Select the type of Actions

You will see that GitHub recommends Actions depending on the project. In our case, it is recommending actions suitable for a Python project. I have selected the “Python application” option.

Step 3 – Generation of Sample pipeline

If you choose an existing option, it will automatically generate a .yaml for the project as shown below.

We will replace the current workflow with the following yml file as shown below:

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Python application

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

permissions:
  contents: read

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.12.1
      uses: actions/setup-python@v3
      with:
        python-version: "3.12.1"
   
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pytest
        pip install requests
       
    - name: Test with pytest
      run: |
        cd TestCases
        pytest  --verbose --capture=no

Step 4 – Commit the changes

After the changes, hit the “Start Commit” button.

This will give the option to add a description for the commit. It will also enable the user to commit either to the main branch or commit to any other branch that exists in the project. Click on the “Commit new file” button to set up the workflow file.

It will create a python-app.yml file as shown below in the project.

Step 5 – Verify that the workflow is running

Next, head over to the “Actions” tab, and you will see your YAML workflow file present under the tab. The yellow sign represents that the job is in the queue.

In Progress – When the job starts building and running, you will see the status change from “Queued” to “in progress”.

Passed – If the build is successful, you will see a green tick mark. 

Step 6 – Verify the execution status

Below is the execution log.

Click on the workflow and the below screen is displayed. It shows the status of the run of the workflow, the total time taken to run the workflow, and the name of the .yml file.

Below shows all the steps of the workflow.

The complete code can be found here on GitHub – vibssingh/RestAPITesting_Python.

Congratulations! We just created our CI workflow for running our Rest API test cases for Python.

vibssingh

How to pass basic authentication token in Python Requests

HOME

An authentication token is a piece of data, often a string, that is used to represent the authenticated user. Instead of sending the username and password with each request, a token is sent, usually in the request headers.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

The syntax for basic authentication in Python Request is

 headers = {'Authorization': 'Basic dXNlcjpwYXNz'}

In this scenario, all you need to do is to embed the basic auth token as Authorization header while making the API call. A sample basic auth token would look like this auth param and the get() method in requests will take care of the basic authorization for us.

Below is the example of basic authentication token.

import requests

endpoint = 'https://httpbin.org/basic-auth/user/pass'
token = 'Basic dXNlcjpwYXNz'


def test_auth_token():

    headers = {'Authorization': token}

    response = requests.get(endpoint, headers=headers)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["authenticated"] == True
    assert response_body["user"] == "user"

Save above file as Authentication_test.py and run using the below command:

pytest Authentication_test.py -s

Note: -s is shortcut for –capture=no

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!

vibssingh

How to pass basic authentication credentials in Python Requests

Last Updated On

HOME

Basic Authentication is a simple authentication scheme that is often used in HTTP (Hypertext Transfer Protocol) to provide a way for a client to send a username and password to a server for verification. It is a part of the HTTP protocol and involves sending the credentials (username and password) in the request headers.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or another Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

The syntax for basic authentication in Python Request is

response = requests.get(endpoint, auth=(username, password))

We can directly embed a basic auth username and password in the request by passing the username and password as a tuple to the auth param and the get() method in requests will take care of the basic authorization for us.

Below is an example of basic authentication in Postman.

Below is an example of basic authentication.

import requests

endpoint = 'https://httpbin.org/basic-auth/user/pass'
credentials = ('user', 'pass')


def test_basic_auth():

    response = requests.get(endpoint, auth=credentials)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["authenticated"] == True
    assert response_body["user"] == "user"

Save above file as BasicAuth_test.py and run using the below command:

pytest BasicAuth_test.py -s

Note: -s is shortcut for –capture=no

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!

vibssingh

How to test response time in Request using Python Requests

HOME

In Python, the requests library is commonly employed for retrieving content from a specific resource URI. When a request is made to a designated URI using Python, it yields a response object. This response object is then utilized to access various attributes, including content and headers. This article focuses on demonstrating how to examine the response.elapsed attribute within a response object.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

In Python, response.elapsed is an attribute of the Response object from the requests library, which is commonly used for making HTTP requests. The elapsed attribute represents the time elapsed between sending the request and receiving the response.

Below is the example of response.elapsed.

import requests

endpoint = 'https://reqres.in/api/users'


def test_response():
    payload = {
        "name": "Vibha",
        "Job": "CEO"
    }

    response = requests.post(endpoint, payload)
    response_body = response.json()
    print("Response :", response_body)
    assert response.status_code == 201
    print("Elapsed Time :", response.elapsed.total_seconds())

Save above file as ResponseTime_test.py and run using the below command:

pytest ResponseTime_test.py -s

Note: -s is shortcut for –capture=no

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!

vibssingh

How to add header to Python Requests

Last Updated On

HOME

In this tutorial, we will add header to the Python Request.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

What are HTTP headers?

HTTP headers let the client and the server pass additional information with an HTTP request or response. All the headers are case-insensitive, headers fields are separated by colon, key-value pairs in clear-text string format.

Headers = { “Authorization” : ”our_unique_secret_token” }

Below is the example of POST Request with header.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PostRequest.py”.

Step 5 – Create the test

Import the required packages.

The POST method is used to get the resource from the server and returns 201 for successful call.

import requests

ENDPOINT = 'https://reqres.in/api/users'


def test_add_header():
    request_body = {
        "name": "Vibha",
        "Job": "CEO"
    }

    header = {"Content-Type":  "application/json; charset=utf-8"}

    response = requests.post(ENDPOINT, request_body, header)
    print(response.json())
    print("Request Header", response.request.headers)
    print("Response Header", response.headers)
    assert response.status_code == 201
    assert response.headers["Content-Type"] == "application/json; charset=utf-8"

requests.post(url, data=data, header=header) – function sends a POST request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the POST request payload. You can modify it based on the requirements of the API we are working with. The header dictionary also contains the key-value pair.

The response object contains information about the response, including the status code and the response content.

We can assert the header of the response also as shown below:

assert response.headers["Content-Type"] == "application/json; charset=utf-8"

Step 6 – To run the test through command line, use the below command:

pytest PostRequest_test.py -s

The output of the above program is

That’s it! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test PATCH Request Using Python Requests

HOME

In this tutorial, we will test PATCH Request in Python.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of PATCH Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PatchRequest.py”.

Step 5 – Create the test

Import the required packages.

The PATCH method is used to apply partial modifications to a resource.

import requests

ENDPOINT = 'https://reqres.in/api/users/2'


def test_partiallyupdate_user():
    request_body = {
        "Job": "CFO"
    }

    response = requests.patch(ENDPOINT, request_body)
    print(response.text)
    assert response.status_code == 200
    response_body = response.json()
    assert response_body["Job"] == "CFO"

requests.patch(url,data=data) – function sends a PATCH request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the PATCH request payload. You can modify it based on the requirements of the API we are working with.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test DELETE Request Using Python Requests

HOME

In this tutorial, we will test DELETE Request in Python.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of DELETE Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “DeleteRequest.py”.

Step 5 – Create the test

Import the required packages.

The DELETE method is typically used to request that a resource be removed or deleted.

import requests

ENDPOINT = 'https://reqres.in/api/users/2'


def test_delete_user():

    response = requests.delete(ENDPOINT)
    assert response.status_code == 204

requests.delete(url) – function sends a DELETE request to the specified URL.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

That’s it! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test PUT Request Using Python Requests

Last Updated On

HOME

In this tutorial, we will test PUT Request in Python.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of PUT Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PuttRequest.py”.

Step 5 – Create the test

Import the required packages.

The PUT method is typically used to update or create a resource on the server and returns 200 for successful call.

import requests

ENDPOINT = 'https://reqres.in/api/users/2'


def test_update_user():
    request_body = {
        "name": "Vibha",
        "Job": "CTO"
    }

    response = requests.put(ENDPOINT, request_body)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["Job"] == "CTO"

requests.put(url, data=data) – function sends a PUT request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the PUT request payload. You can modify it based on the requirements of the API we are working with.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

The complete code can be found in GitHub – vibssingh/RestAPITesting_Python

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test POST Request Using Python Requests

HOME

In this tutorial, we will test POST Request in Python using Requests.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of POST Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PostRequest.py”.

Step 5 – Create the test

Import the required packages.

The POST method is used to get the resource from the server and returns 201 for successful call.

import requests

ENDPOINT = 'https://reqres.in/api/users'


def test_create_user():

    response = requests.post(ENDPOINT, {"name": "Vibha", "job": "CTO"})
    response_body = response.json()
    print(response_body)
    assert response.status_code == 201
    assert response_body["name"] == "Vibha"
    assert response_body["job"] == "CTO"

requests.post(url, data=data) – function sends a POST request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the POST request payload. You can modify it based on the requirements of the API we are working with.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

In the above example, we have passed the request body in the requests.post(). In the below example, will define a variable and assign the request body to it.

def test_create_user1():
    payload = {
        "name": "Vibha",
        "job": "CTO"
    }

    response = requests.post(ENDPOINT, payload)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 201
    assert response_body["name"] == "Vibha"
    assert response_body["job"] == "CTO"

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

Python Tutorials

Last Updated On

HOME

Python is a high-level, general-purpose programming language. Its design philosophy emphasizes code readability with the use of significant indentation. Python is dynamically typed and garbage-collected. It supports multiple programming paradigms, including structured, object-oriented, and functional programming.

Robot Framework

Configure Selenium with Python

Python Requests

PyTest Framework

Excel Manipulation in Python

Chapter 1 Reading Excel Data in Python using openpyxl
Chapter 2 Create and Format Excel Files with Python Openpyxl – Tutorial
Chapter 3 Appending Data to Excel with Python using openpyxl – NEW