Author: vibssingh

vibssingh

Introduction to Rest Assured

Last Updated On

HOME

In this tutorial, I’ll explain about API & Rest Assured.

Table of Contents

  1. What is API?
    1. What is API Testing?
    2. What is Rest API?
  2. REST API Testing with Rest Assured
    1. What is Rest Assured?
    2. HTTP Methods for REST API Automation Testing
    3. HTTP Status Codes
    4. Advantages of Rest Assured

What is API?

API stands for Application Programming Interface. It comprises a set of functions that can be accessed and executed by another software system.  Thus, it serves as an interface between different software systems and establishes their interaction and data exchange. APIs can be used in various contexts, including web development, mobile app development, and software integration. For example, web APIs allow websites to interact with external services, such as third-party payment services or storing the information in a database.

What is API Testing?

API testing is a type of software testing that focuses on verifying the functionality, reliability, performance, and security of Application Programming Interfaces (APIs).

Testing the API’s functionality involves verifying that the API behaves as expected according to its specifications. This includes testing different API methods, parameters, headers, and payloads to ensure they produce the correct responses.

In the modern development world, many web applications are designed based on a three-tier architecture model. These are 

  1. Presentation Tier – User Interface (UI) 
  2. Logic Tier – Business logic is written in this tier. It is also called Business Tier. (API) 
  3. Data Tier – Here information and data are stored and retrieved from a Database. (DB) Ideally, these three layers (tiers) should not know anything about the platform, technology, and structure of each other.

 We can test UI with GUI testing tools, and we can test logic tier (API) with API testing tools. The logic tier comprises all the business logic, and it has more complexity than the other tiers the test executed on this tier is called API Testing. API Testing tests the logic tier directly and checks expected functionality, reliability, performance, and security.

What is Rest API?

REST is an architectural style that uses simple HTTP calls for inter-machine communication. REST does not contain an additional messaging layer and focuses on design rules for creating stateless services. A client can access the resource using the unique URI and a representation of the resource is returned. With each new resource representation, the client is said to transfer state. While accessing RESTful resources with HTTP protocol, the URL of the resource serves as the resource identifier, and GET, PUT, DELETE, POST and HEAD are the standard HTTP operations to be performed on that resource.

REST API Testing with Rest Assured

What is Rest Assured?

REST Assured is a Java DSL for simplifying the testing of REST-based services built on top of HTTP Builder. It supports POST, GET, PUT, DELETE, OPTIONS, PATCH, and HEAD requests and can be used to validate and verify the response of these requests.

Rest-Assured library also provides the ability to validate the HTTP Responses received from the server. For e.g. we can verify the Status code, Status message, Headers, and even the Body of the response. This makes Rest-Assured a very flexible library that can be used for testing.

REST Assured can be used to test XML as well as JSON-based web services. REST Assured can be integrated with JUnit and TestNG frameworks for writing test cases for our application.

HTTP Methods for REST API Automation Testing

REST API uses five HTTP methods to request a command:

GET: To retrieve the information at a particular URL.

PUT: To update the previous resource or create new information at a particular URL.

PATCH: For partial updates.

POST: It is used to develop a new entity. Moreover, it is also used to send information to the server, such as uploading a file, customer information, etc.

DELETE: To delete all current representations at a specific URL.

HTTP Status Codes

Status codes are the responses given by a server to a client’s request. They are classified into five categories:

  1. 1xx (100 – 199): The response is informational
  2. 2xx (200 – 299): Assures successful response
  3. 3xx (300 – 399): You are required to take further action to fulfill the request
  4. 4xx (400 – 499): There’s a bad syntax and the request cannot be completed
  5. 5xx (500 – 599): The server entirely fails to complete the request

Advantages of Rest Assured

  1. It is an Open source Tool i.e. free.
  2. It requires less coding compared to Apache Http Client.
  3. Easy parsing and validation of response in JSON and XML.
  4. The extraction of values and asserting is quite easy using inbuilt Hemcrest Matchers.
  5. It follows BDD keywords like given(), when(), then() which makes code readable and supports clean coding. This feature is available from version 2.0.
  6. It supports quick assertion for status code and response time.
  7. It supports assertion to Status Code, Response Time, Headers, cookies, Content-Type, etc.
  8. It has a powerful logging mechanism.
  9. It can be easily integrated with other Java libraries like TestNG, JUnit as Test Framework and Extent Report, and Allure Report for reporting purposes.
  10. It provides quite good support for different authentication mechanisms for APIs.
  11. It can be integrated with Selenium-Java to achieve End-to-end automation.
  12. It supports JSONPath and XmlPath which helps in parsing JSON and XML response. Rest Assured integrates both by default.
  13. It can be used to verify JSON Schema using JSON Schema Validation library and XML schema validation
  14. It can be integrated with Build Tools like Maven or Gradle and supports CI/CD also.
  15. It supports multi-part form data and Spring Mock Mvc, Spring Web Test Client, Scala and Kotlin.

vibssingh

Polymorphism in Java

HOME

In this tutorial, I’ll explain about Polymorphism in Java. It is one of the four concepts of OOPs. It is a concept where we can perform a single action in multiple ways. Poly means many and morphs means form. Polymorphism allows us to define one interface and have multiple implementations. An example of polymorphism is that there are different forms of communication like calls, SMS, picture messages, etc.

There are 2 types of polymorphism:-

  1. Method Overloading in Java – This is an example of compile time (or static polymorphism)
  2. Method Overriding in Java – This is an example of runtime time (or dynamic polymorphism)

Complie Time Polymorphism

It is also known as static polymorphism. Method Overloading is an example of static polymorphism. It is a feature that allows a class to have more than one method having the same name if their argument lists are different. Error if any occur, resolved during compile time.

Below is an example of static polymorphism.

Calculation

public class Calculation {

	void sum(int a, int b) {
		System.out.println("Sum of 2 numbers :" + (a + b));
	}

	void sum(int x, int y, int z) {
		System.out.println("Sum of 3 numbers :" + (x + y + z));
	}

}

PolymorphismTest

public class PolymorphismTest {

	public static void main(String[] args) {

		Calculation cal = new Calculation();
		cal.sum(10, 5);
		cal.sum(2, 6, 4);

	}
}

The output of the above program is

Dynamic Polymorphism

It is also known as Dynamic Method Dispatch. In this, the call to the overridden method happens at the runtime. This type of polymorphism is achieved by Method Overriding. Declaring a method in sub class that is already present in the parent class is known as method overriding. 

Below is an example of dynamic polymorphism

Parent Class

public class Bank {

	 //Overridden method
	public void getRateOfInterest() {

		System.out.println("getRateOfInterest() method of parent class");
		System.out.println("Interest Rate of Bank :" + 0);

	}
}

Child 1 Class

public class BOI extends Bank {

    // Overriding method
	public void getRateOfInterest() {

		System.out.println("getRateOfInterest() method of child 1 class");
		System.out.println("Interest Rate of BOI Bank :" + 4.1);

	}

}

Child 2 Class

public class BoFA extends Bank {

    // Overriding method
	public void getRateOfInterest() {

		System.out.println("getRateOfInterest() method of child 2 class");
		System.out.println("Interest Rate of BofA Bank :" + 3.2);

	}

}

Child 3 Class

public class SBI extends Bank {

	// Overriding method
	public void getRateOfInterest() {

		System.out.println("getRateOfInterest() method of child 3 class");
		System.out.println("Interest Rate of SBI Bank :" + 5.3);

	}
}

Test Class

public class StaticPolTest {

	public static void main(String[] args) {

		Bank bank1 = new Bank();
		bank1.getRateOfInterest();

		BOI bank2 = new BOI();
		bank2.getRateOfInterest();

		BofA bank3 = new BofA();
		bank3.getRateOfInterest();

		SBI bank4 = new SBI();
		bank4.getRateOfInterest();
	}

}

The output of the above program is

Points to note for Method Overriding:-

  1. The argument list of the overriding method (method of subclass) must match the overridden method (the method of parent class). The data types of the arguments and their sequence should exactly match.
  2. The access Modifier of the overriding method (method of a subclass) cannot be more restrictive than the overridden method of the parent class. 

Suppose, I have changed the access modifier of SBI class from public to protected and then run the StaticPolTest program. In that case, I’ll get a compile-time error.

getRateOfInterest() method of parent class
Interest Rate of Bank :0
getRateOfInterest() method of child 1 class
Interest Rate of BOI Bank :4.1
getRateOfInterest() method of child 2 class
Interest Rate of BofA Bank :3.2
Exception in thread "main" java.lang.Error: Unresolved compilation problem: 
	Cannot reduce the visibility of the inherited method from Bank

	at JavaDemo.Polymorphism.SBI.getRateOfInterest(SBI.java:6)
	at JavaDemo.Polymorphism.StaticPolTest.main(StaticPolTest.java:17)
vibssingh

Static Keyword – Static Variable and Static Method in Java

HOME

The static variable in Java is used for memory management mostly. We can use static keywords with variables, methods, and nested classes. This tutorial will discuss Static Variable and Static Methods.

What is a Static Variable?

If any variable is, declared static, then it is called a static variable. The static variable gets memory only once in the class area at the time of class loading.

Static variables belong to the class itself, they can be accessed directly using the class name without creating an object/instance of that class.

Assume in a college, there are 250 students. Each student has a unique name & roll no, so when the objects are created all the instance data members will get the memory. However, the college name is the same for all the students. Then we do not need to allocate memory 250 times for the students. Therefore, it is advisable to make the college static variable, which means the variable is created once and used by all students.

Below is an example of a static variable.

public class Student {

    int rollNo;
    String name;
    static String college = "Trinity"; // Static Variable

    Student(int r, String n) // Constructor
    {
        rollNo = r;
        name = n;
    }

    void displayInformation() {
        System.out.println("Roll_No: " + rollNo + ", Name: " + name + ", College: " + college);
    }

    public static void main(String[] args) {

        Student S1 = new Student(111, "Tom");
        Student S2 = new Student(222, "Terry");
        S1.displayInformation();
        S2.displayInformation();
    }
}

The output of the above program is

What is the Static Method

If any method is declared static, then it is called a static method. A static method belongs to the class not to the object of the class. 

A static method can be accessed without creating the object of the class.

The static method can access data members and can change their value of it.

public class Student {

    int rollNo;
    String name;
    static String college = "Trinity"; // Static Variable

    Student(int r, String n) // Constructor
    {
        rollNo = r;
        name = n;
    }

    static void change() {
        college = "CITM";
    }


    void displayInformation() {
        System.out.println("Roll_No: " + rollNo + ", Name: " + name + ", College: " + college);
    }

    public static void main(String[] args) {
        change();    // Calling Static method
        Student S1 = new Student(111, "Tom");
        Student S2 = new Student(222, "Terry");
        S1.displayInformation();
        S2.displayInformation();
    }

The output of the above program is

In the above example, change() is a static method, and it is accessed without creating the object.

vibssingh

How to generate HTML Report in PyTest Framework

Last Updated On

HOME

In this tutorial, we will create a HTML Report in PyTest Framework. pytest-html is a plugin for pytest that generates a HTML report for test results.

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.

Implementation Steps

Step 1 – Install pytest

pip install -U pytest

Step 2 – Install pytest-html

pip install pytest-html

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

Step 4 – Go to the project folder and create a new python file – sample_test.py.

Step 5 – Add pytest-html package to the PyCharms

Go to File->Settings ->Project: PyTest_Framework->Python Interpreter.

Click on the “+” sign and enter allure-r in the search bar. It will show a list of packages. Select the “pytest-html” package and click on the “Install Package”.

Once the package is installed, we will see the message that the package is installed successfully.

Step 6 – Create the test.

import pytest


def test_addition():
    a = 6
    b = 5
    c = 11

    assert a + b == 11, "Sum is not 11"
    assert a + b == c, "Sum of a and b is not equal to c"


def test_subtraction():
    x = 15
    y = 4
    z = 10

    assert x - y == z, "Subtract y from x is equal to z"


def test_multiplication():
    a = 6
    b = 5
    c = 30

    assert a * b == c, "Product of 5 and 6 is not 30"


def test_division():
    a = 16
    b = 2
    c = 8

    assert a / b == c, "Division of 2 by 6 is not 3"

Step 7 – To run this test, use the below command:

pytest --html=report.html

The output of the above execution is

The report.html report will be generated in the root directory.

Step 8 – Generating HTML report

Right-click and open with Web Browser.

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

vibssingh

What is conftest.py in PyTest?

HOME

In this tutorial, we are discussing the use of conftest.py in PyTest.

What is conftest.py in PyTest?

The conftest.py file serves as a means of providing fixtures for an entire directory. Fixtures defined in a conftest.py can be used by any test in that package without needing to import them (pytest will automatically discover them). To know more about the fixtures in PyTest, please refer to this tutorial – What is Fixture in PyTest?

We can have multiple nested directories/packages containing the tests, and each directory can have its own conftest.py with its own fixtures, adding on to the ones provided by the conftest.py files in parent directories.

Below is the sample code for conftest.py.

import pytest


@pytest.fixture
def shared_fixture():
    print("This will be executed before any test")

In test_demo1.py and test_demo2.py, we have used the shared fixture:

test_demo1.py

def test_fixture1(shared_fixture):
    print("This is the fixture main method1 for demo1 class")
    print("Good Morning")


def test_fixture2(shared_fixture):
    print("This is the fixture main method2 for demo1 class")
    print("Good AfterNoon")

test_demo2.py

def test_fixture(shared_fixture):
    print("This is the fixture main method for demo2 class")
    print("Good Evening")

Execute both the files using the below command:

pytest test_demo1.py test_demo2.py -s

The output of the above program is

In the above file – test_demo1.py, we have 2 methods and shared_fixture is called in both the methods. If we don’t want to pass shared_fixture multiple times. We can define a class and assign the fixture method to that class – @pytest.mark.usefixtures(“shared_fixture”). In that case, we don’t need to assign a fixture method to each and every method present in the class.

conftest.py

import pytest


@pytest.fixture
def shared_fixture():
    print("This will be executed before any test")
    yield
    print("This will be executed after any test")

TestExample1.py

import pytest


@pytest.mark.usefixtures("shared_fixture")
class TestExample1:

    def test_fixture1(self):
        print("This is the fixture main method1 for demo1 class")
        print("Good Morning")

    def test_fixture2(self):
        print("This is the fixture main method2 for demo1 class")
        print("Good AfterNoon")

TestExample2.py

import pytest


@pytest.mark.usefixtures("shared_fixture")
class TestExample2:

    def test_fixture(self):
        print("This is the fixture main method for demo2 class")
        print("Good Evening")

Execute both the files using the below command:

pytest -s

The output of the above program is

In the above example, we can see that before and after statement is printed for each test.

Suppose we want to run the fixture method once before the start and once at the end of the class. We need to add the below command:

import pytest


@pytest.fixture(scope="class")
def shared_fixture():
    print("This will be executed before any test")
    yield
    print("This will be executed after any test")

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

What is Fixture in PyTest?

HOME

In this tutorial, we will understand the use of Fixtures in the PyTest Framework.

What is a Fixture?

Fixtures define the steps and data that constitute the arranged phase of a test. In PyTest, they are functions we define that serve this purpose. They can also be used to define a test’s act phase; this is a powerful technique for designing more complex tests.

Fixture can be used to set up and tear down resources, such as establishing database connections, creating temporary files, initializing objects, or any other operations needed to prepare the environment for your tests.

Fixtures in pytest are created using the @pytest.fixture decorator.

Below is an example of a fixture.

import pytest

@pytest.fixture()
def setup():
    print("This will be executed before any test")


def test_fixture(setup):
    print("This is the fixture main method")

In this example, the setup fixture is defined using the @pytest.fixture decorator. It will be executed before any test. The test function (test_fixture) use this fixture as an argument.

The output of the above program is

What is yield in PyTest?

The yield statement is used in fixtures to create a setup and teardown mechanism for test resources. When a fixture contains a yield statement, the code before the yield acts as the setup code (code executed before the test), and the code after the yield acts as the teardown code (code executed after the test).

Below is an example of yield.

import pytest


@pytest.fixture()
def setup():
    print("This will be executed before any test")
    yield
    print("This will be executed after any test")


def test_fixture(setup):
    print("This is the fixture main method")

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

PyTest Framework

Last Updated On

HOME

PyTest is a testing framework that allows users to write test codes using Python programming language. PyTest is a mature, full-featured Python testing tool that helps you write better programs.

PyTest Basics and Core Concepts

Chapter 1 What is PyTest Framework?
Chapter 2 What is fixture in PyTest?
Chapter 3 What is conftest.py in PyTest?
Chapter 4 How to skip tests in PyTest – skip, skipIf, xfail
Chapter 6 Parameterizing test with multiple data sets using Fixtures in PyTest

Test Reporting & Logging

Chapter 1 How to generate HTML report in PyTest Framework?
Chapter 2 PyTest Logging to print to console
Chapter 3 PyTest Logging to print to a file
Chapter 4 Integration of Allure Report with PyTest

Selenium with PyTest

Chapter 1 Page Object Model Implementation of Python with Selenium – PyTest
Chapter 2 Cross Browser Testing in PyTest

API Testing

Chapter 1 How to handle HTTP Query Parameters in Python
Chapter 2 How to Use Pytest for REST API Testing

Behavior Driven Development (BDD) with PyTest

Chapter 1 PyTest – BDD (Behavioural Driven Development) with Selenium
Chapter 2 Scenario Outline in PyTest – BDD
Chapter 3 Filtering by tags in PyTest-BDD

CI/CD and Automation Integration

Chapter 1 How to run PyTest Framework in GitHub Actions
Chapter 2 How to run Python Selenium tests in Jenkins

Multiple Choice Questions

Pytest Multiple Choice Questions – MCQ1 – NEW
Pytest Multiple Choice Questions – MCQ2 – NEW

vibssingh

Configure Selenium with Python

HOME

In this tutorial, we will configure Selenium with Python and create Selenium tests in Python.

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

Installation of Python Requests Module

Step 1 – Install Python

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

Step 2 – Install PyCharm

PyCharm is an Integrated Development Environment (IDE) specifically designed for the Python programming language. It is developed by JetBrains.

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

Step 3 – Install the Selenium library

Execute the below command using pip.

pip install -U selenium

Step 4 – Create a new project

Create a new project and open it in PyCharm – SeleniumPython_Demo.

Step 5 – Create a new directory

Create a new directory – TestCases that will contain all the tests.

Step 6 – Create a test file

Create a new Python file, naming it “LoginTest.py”.

Step 7 – Add the Selenium package to the PyCharm

Go to File->Settings ->Project:SeleniumPython_Demo ->Python Interpreter.

Click on the “+” sign and enter selenium in the search bar. It will show a list of packages. Select the “selenium” package and click on the “Install Package”.

Once the package is installed, it can be seen under the package list as shown below:

Step 8 – Create the test

from selenium import webdriver
from selenium.webdriver.common.by import By

driver = webdriver.Chrome()
driver.maximize_window()
driver.implicitly_wait(2)
driver.get("https://opensource-demo.orangehrmlive.com/")

driver.find_element(By.NAME, "username").send_keys("Admin")
driver.find_element(By.NAME, "password").send_keys("admin123")
driver.find_element(By.XPATH, "//*[@class='oxd-form']/div[3]/button").click()

homePageTitle = driver.find_element(By.XPATH,"//*[@class='oxd-topbar-header-breadcrumb']/h6").text
print("Heading of DashBoard Page: ", homePageTitle)
driver.quit()

Importing necessary modules:

from selenium import webdriver
from selenium.webdriver.common.by import By

webdriver is used to automate the web browser. By is imported to specify the mechanism used to locate elements on a web page.

Setting up the web driver:

driver = webdriver.Chrome()

This line creates an instance of the Chrome WebDriver, which will be used to automate the Chrome browser.

Maximizing the browser window:

driver.maximize_window()

This line maximizes the browser window.

Implicitly waiting for elements:

driver.implicitly_wait(2)

This sets an implicit wait, meaning the WebDriver will wait up to 2 seconds for elements to be located before throwing an exception.

Navigating to a URL:

driver.get("https://opensource-demo.orangehrmlive.com/")

The script navigates the browser to the specified URL, which is the login page of an HR management system.

Enter the Credentials

driver.find_element(By.NAME, "username").send_keys("Admin")
driver.find_element(By.NAME, "password").send_keys("admin123")
driver.find_element(By.XPATH, "//*[@class='oxd-form']/div[3]/button").click()


In the method mentioned above, we can inspect and find the HTML element with which you want to interact. The script locates the username and password input fields on the page by their names and enters the credentials. The script locates the login button using an XPath expression and clicks it.

Fetching and printing the heading of the dashboard page:

homePageTitle = driver.find_element(By.XPATH,"//*[@class='oxd-topbar-header-breadcrumb']/h6").text
print("Heading of DashBoard Page: ", homePageTitle)

The script locates an element on the dashboard page (specifically an h6 element within a breadcrumb) and prints its text, which is assumed to be the heading of the dashboard page.

Quitting the browser:

driver.quit()

Finally, the script closes the browser window and ends the WebDriver session.

Step 9 – Execute the Tests

We need to move to the folder where the Python Tests are placed. In this case, we need to go to the TestCases folder.

To run the tests, use the below command:

pytest LoginTest.py -s

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

What is PyTest Framework?

Last Updated On

HOME

In this tutorial, we will discuss the Pytest Framework.

Table of Contents

  1. What is Pytest Framework?
    1. Key features of PyTest include:
  2. How to install PyTest?
    1. Create a PyTest test
    2. How PyTest Identifies the Test Files and Test Methods

What is Pytest Framework?

PyTest is a popular testing framework for Python. It is widely used for writing and executing unit tests, functional tests, and even complex functional testing scenarios.

pytest requires: Python 3.7+ or PyPy3.

Key features of PyTest include:

1. Fixture Support: pytest supports fixtures, which are functions that can set up and tear down resources needed for testing. This makes it easy to share setup code among multiple tests.

2. Powerful Test Discovery: pytest automatically discovers and runs test functions based on naming conventions. We don’t need to explicitly list your tests; instead, the framework discovers and executes them.

3. Parameterized Testing: We can easily perform parameterized testing using pytest, allowing us to run the same test logic with multiple sets of input data.

4. Integration with Other Tools: pytest integrates well with other tools and libraries, such as Selenium for web testing, Django for web application testing, integrate report generation and more.

5. Assertions: pytest allows us to use the standard Python assert for verifying expectations and values in Python tests. 

6. Advanced Test Execution: pytest provides rich features for executing tests, including parallel test execution, selective test execution, and rerunning failed tests.

How to install PyTest?

We need to make sure that Python is already installed. If not, then 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.

To install pytest, use the below command:

pip install pytest

Create a PyTest test

Create a new project folder and open it in PyCharm.

Go to the project folder and Create a new Python file, name it “sample_test.py”.

Create tests in the Python file.

def test_addition():
    a = 6
    b = 5
    c = 11

    assert a + b == 11, "Sum is not 11"
    assert a + b == c, "Sum of a and b is not equal to c"


def test_subtraction():
    x = 15
    y = 4
    z = 18

    assert x - y == z, "Subtract y from x is equal to z"

To run the tests, use the below command:

pytest

This command will run all the test file which has *test* in its name. Here, we have 1 Python file named as Sample_test.py. This file has 2 test, one of the test passes and another one fails. In the failures section, we can see the failed method(s) and the line of failure. Here x-y=z means 15-4=10 which is false.

The output of the above execution is

How PyTest Identifies the Test Files and Test Methods

By default pytest only identifies the file names starting with test_ or ending with _test as the test files. We can explicitly mention other filenames though (explained later). Pytest requires the test method names to start with “test.” All other method names will be ignored even if we explicitly ask to run those methods.

See some examples of valid and invalid pytest file names

test_sample - valid
sample_test - valid
sample_tests - invalid
testsample - invalid
sampletest - invalid

 We can explicitly ask pytest to pick sample_tests.py, testsample.py and sampletest.py.

vibssingh

How to add environment details to Python Allure Report

HOME

In this tutorial, we will add environment details to the Python Allure Report.

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.

If you need to know the steps to generate an Allure Report, please refer to this tutorial – How to create Python Allure Report for Rest API.

For the main page of the report, you can collect various information about the environment in which the tests were executed.

For example, it is a good idea to use this to remember the OS version and Python version. This may help the future reader investigate bugs that are reproducible only in some environments.

os_platform = windows 11
os_release = 10.2
python_version = Python 3.12.1
environment = uat
release_no = 10
author = vibha singh

To provide environment information, put a file named environment.properties into the allure-results directory after running the tests. 

In our case, we have the AllureReport directory that will contain the files in JSON format needed to generate the Allure Report.

Below is an example of Allure Report with environment details.

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