{"id":536,"date":"2021-06-06T11:50:40","date_gmt":"2021-06-06T11:50:40","guid":{"rendered":"https:\/\/rahulshettyacademy.com\/blog\/?p=536"},"modified":"2021-07-25T17:03:00","modified_gmt":"2021-07-25T17:03:00","slug":"how-to-create-a-robust-automation-framework-in-python-using-pytest","status":"publish","type":"post","link":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/2021\/06\/06\/how-to-create-a-robust-automation-framework-in-python-using-pytest\/","title":{"rendered":"How to Create a Robust Automation framework in Python using PyTest"},"content":{"rendered":"

What is Pytest Testing Framework?<\/b><\/h3>\n

The Pytest testing framework is used to create a robust automation framework in Python. Just like TestNG and Junit frameworks in Java, the Pytest framework gives a lot of features.<\/p>\n

First of all we shall install Pytest in our machine. To install we have to run the command pip install pytest<\/b> from the command line to configure Pytest in the Python virtual environment. Once done, we can confirm Pytest successful installation by running the command pytest \u2013version <\/b>command.<\/p>\n

 \"\"<\/p>\n

The Pytest version that gets installed shall be displayed.<\/p>\n

Now let us create a new package for our Pytest framework then create a Python file inside that package. As a Pytest convention, the test file should have a name starting with test_ <\/b>or ending <\/b>with _test <\/b>keyword to consider it under the Pytest test framework.<\/p>\n

As per Pytest framework standards all the test cases should be written inside a method and the method name should start with test_<\/b> keyword.<\/p>\n

Conclusion: Thus we have seen what is a Pytest and its installation. For more details, you can refer to the link:<\/p>\n

https:\/\/courses.rahulshettyacademy.com\/courses\/learn-selenium-automation-in-easy-python-language\/lectures\/13248476<\/a><\/p>\n

In the next section we shall discuss how to execute a Pytest file from the PyCharm editor.<\/p>\n

To run Pytest file from PyCharm editor<\/b><\/h3>\n

In the PyCharm editor, click on Edit Configurations<\/b>, Run\/Debug configurations window shall open. Then click on + button.<\/p>\n

\"\"<\/p>\n

After selecting pytest<\/b> from Python tests<\/b>, browse the path of the Pytest file we have just created under the Target<\/b> field and then click on Apply<\/b>.<\/p>\n

\"\"<\/p>\n

Now the Pytest test runner will be ready and we can run it by clicking on the green<\/b> icon.<\/p>\n

\"\"<\/p>\n

Let us write our first code following Pytest framework standards.<\/p>\n

def test_p():<\/b><\/p>\n

    print(“Hello”)<\/b><\/p>\n

Output:<\/strong><\/p>\n

\"\"<\/p>\n

The output has Hello<\/b> printed along with test coverage of 100%<\/b> and test result as PASSED<\/b>.<\/p>\n

Conclusion: <\/strong>Thus we have seen how to run Pytest from PyCharm editor. For more details, you can refer to the link:<\/p>\n

https:\/\/courses.rahulshettyacademy.com\/courses\/learn-selenium-automation-in-easy-python-language\/lectures\/13248476<\/a><\/p>\n

In the next section, we shall discuss how to execute a Pytest file from Terminal with different flags.<\/p>\n

To run Pytest file from command line<\/b><\/h3>\n

For running the Pytest file from the command line, we should first copy the path of the Pytest file and navigate to that path and then run the command py.test.<\/b> This command shall execute all the Pytest files that are created under that package following the Pytest framework standards.<\/p>\n

\"\"<\/p>\n

Here, we don\u2019t find much of the information as we get in the console. To get more details we shall run the command py.test \u2013v, <\/b>the letter v stands for metadata information.<\/p>\n

\"\"<\/p>\n

The output shows the test coverage of 100%<\/b>, test result as PASSED<\/b>, cached directory information and so on. However it does not still show the console logs.<\/p>\n

To get the console logs we shall run the command py.test \u2013v \u2013s, <\/b>the letter s stands for logs in output.<\/p>\n

\"\"<\/p>\n

The output has Hello<\/b> printed along with the test result as PASSED.<\/b><\/p>\n

Let us add one test method in the test_p.py file.<\/p>\n

# test method 1<\/b><\/p>\n

def test_p():<\/b><\/p>\n

    print(“Hello”)<\/b><\/p>\n

# test method 2<\/b><\/p>\n

def test_p():<\/b><\/p>\n

    print(“Good Morning”)<\/b><\/p>\n

Let us create another test_p1.py file and add the below code.<\/p>\n

# test method<\/b><\/p>\n

def test_p():<\/b><\/p>\n

    msg “Hello”<\/b><\/p>\n

    # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

Let us execute three test methods inside two Pytest files with the command py.test \u2013v \u2013s.<\/b><\/p>\n

\"\"<\/p>\n

The output shows two test cases got executed but there are actually three test cases. This is because the test_p.py file contains two methods having the same name as test_p<\/b>. As per Pytest framework, multiple methods should not have the same name<\/b>. If there are multiple methods with the same name, then the previous result gets overridden<\/b>.<\/p>\n

Now let us rename the methods in the test_p.py Pytest file.<\/p>\n

# test method 1<\/b><\/p>\n

def test_p():<\/b><\/p>\n

    print(“Hello”)<\/b><\/p>\n

# test method 2 with different name<\/b><\/p>\n

def test_project():<\/b><\/p>\n

    print(“Good Morning”)<\/b><\/p>\n

The test_p1.py file contains the below code.<\/p>\n

 # test method<\/b><\/p>\n

def test_p():<\/b><\/p>\n

    msg “Hello”<\/b><\/p>\n

    # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

Let us again execute three test methods inside two Pytest files with the command py.test \u2013v \u2013s.<\/b><\/p>\n

\"\"<\/p>\n

The output now shows three test cases got executed along with the console output. Thus all the test cases within the same package got executed in one short.<\/p>\n

Conclusion: <\/strong>Thus we have seen how to execute Pytest files from Terminal with different flags. For more details, you can refer to the link:<\/p>\n

https:\/\/courses.rahulshettyacademy.com\/courses\/learn-selenium-automation-in-easy-python-language\/lectures\/13248478<\/a><\/p>\n

In the next section we shall discuss how to execute selected Pytest files from the set of Tests.<\/p>\n

To run selected test files using Pytest<\/b><\/h3>\n

Let us add one more test method in the test_p1.py file.<\/b><\/p>\n

           # test method 1<\/b><\/p>\n

def test_p():<\/b><\/p>\n

    msg “Hello”<\/b><\/p>\n

    # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

           # test method 2<\/b><\/p>\n

def test_secondp():<\/b><\/p>\n

    a = 2<\/b><\/p>\n

    # assertion validation<\/b><\/p>\n

    assert a+2 == 4, “Addition pass”<\/b><\/p>\n

Now if we want to run a specific file we have to mention that file name. The command is py.test <filename>.<\/b> So here we should run the command py.test test_p1.py \u2013v \u2013s.<\/b><\/p>\n

\"\"<\/p>\n

The output shows two test cases got executed along with the console output.<\/p>\n

Now let us consider that our Pytest files contain test cases belonging to a particular module called CreditCard and accordingly we will give meaningful names to the corresponding test methods.<\/p>\n

The test_p1.py file <\/b>now contains the below methods.<\/p>\n

           # test method 1<\/b><\/p>\n

def test_firstprogram():<\/b><\/p>\n

    msg “Hello”<\/b><\/p>\n

    # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

# test method 2 belong to Credit Card module<\/b><\/p>\n

def test_secondpCreditCard():<\/b><\/p>\n

    a = 2<\/b><\/p>\n

    assert a+2 == 4, “Addition pass”<\/b><\/p>\n

The test_p.py file <\/b>contains the below methods.<\/p>\n

           # test method 1<\/b><\/p>\n

def test_firstprogram():<\/b><\/p>\n

    print(“Hello”)<\/b><\/p>\n

# test method 2 belong to Credit Card module<\/b><\/p>\n

def test_projectCreditCard():<\/b><\/p>\n

    print(“Good Morning”)<\/b><\/p>\n

To trigger the test cases on CreditCard from both the files, we have to run the command py.test \u2013k CreditCard \u2013v \u2013s, <\/b>the letter k stands for method name execution.<\/p>\n

\"\"<\/p>\n

The output shows two test cases having method names containing CreditCard<\/b> got executed along with the console output. Also, it tells that the two test cases are deselected. Thus we can run only selected test methods from multiple files.<\/p>\n

Conclusion:<\/strong> Thus we have seen how to execute selected Pytest files from the set of Tests. For more details, you can refer to the link:<\/p>\n

https:\/\/courses.rahulshettyacademy.com\/courses\/learn-selenium-automation-in-easy-python-language\/lectures\/13248482<\/a><\/p>\n

In the next section we shall discuss how to group Pytest files to run a selected group of test cases.<\/p>\n

To group tests and run selected groups using Pytest<\/b><\/h3>\n

We can group tests and run them with the help of keyword custom mark<\/b> in the Pytest framework. We have to use the expression @pytest.mark.smoke <\/b>if we want to group a test method with name smoke<\/b>. Moreover, we have to include the import pytest<\/b> package in our code.<\/p>\n

Let us now add a mark to our existing files.<\/p>\n

The test_p1.py file <\/b>having method with mark.<\/p>\n

            import pytest<\/b><\/p>\n

            # marking test method with smoke group<\/b><\/p>\n

@pytest.mark.smoke<\/b><\/p>\n

# test method 1 belonging to smoke group<\/b><\/p>\n

def test_firstprogram():<\/b><\/p>\n

                msg “Hello”<\/b><\/p>\n

            # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

# test method 2<\/b><\/p>\n

def test_secondpCreditCard():<\/b><\/p>\n

    a = 2<\/b><\/p>\n

    assert a+2 == 4, “Addition pass”<\/b><\/p>\n

The test_p.py file <\/b>having method with mark.<\/p>\n

import pytest<\/b><\/p>\n

# test method 1 with smoke group<\/b><\/p>\n

@pytest.mark.smoke<\/b><\/p>\n

# test method 1 with smoke group<\/b><\/p>\n

<\/b><\/p>\n

def test_firstprogram():<\/b><\/p>\n

    print(“Hello”)<\/b><\/p>\n

# test method 2<\/b><\/p>\n

def test_projectCreditCard():<\/b><\/p>\n

    print(“Good Morning”)<\/b><\/p>\n

To trigger the test methods having the mark name smoke<\/b> from both the files, we have to run the command py.test \u2013m smoke \u2013v \u2013s, <\/b>the letter m stands for marking a test.<\/p>\n

\"\"<\/p>\n

The output shows two test methods with name test_firstprogram<\/b> having mark smoke<\/b> got executed along with the console output. Also, it tells that the two test cases are deselected. Thus we can run only a selected group of test methods from multiple Pytest files.<\/p>\n

We can skip tests with the keyword skip<\/b> in the Pytest framework. We have to use the expression @pytest.mark.skip <\/b>if we want to skip a test method from execution. Moreover, we have to include the import pytest<\/b> package in our code.<\/p>\n

Let us now skip a test method from test_p1.py file.<\/p>\n

            import pytest<\/b><\/p>\n

            # test method 1 with smoke and skip mark <\/b><\/p>\n

@pytest.mark.smoke<\/b><\/p>\n

@pytest.mark.skip<\/b><\/p>\n

def test_firstprogram():<\/b><\/p>\n

                msg “Hello”<\/b><\/p>\n

           # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

# test method 2<\/b><\/p>\n

def test_secondpCreditCard():<\/b><\/p>\n

    a = 2<\/b><\/p>\n

# assertion validation<\/b><\/p>\n

    assert a+2 == 4, “Addition pass”<\/b><\/p>\n

Implementation of test_p.py file.<\/p>\n

import pytest<\/span><\/b><\/p>\n

# test method 1 with smoke mark<\/b><\/span><\/p>\n

@pytest.mark.smoke<\/b><\/span><\/p>\n

def test_firstprogram():<\/b><\/span><\/p>\n

    print(“Hello”)<\/b><\/span><\/p>\n

# test method 2<\/b><\/span><\/p>\n

def test_projectCreditCard():<\/b><\/span><\/p>\n

    print(“Good Morning”)<\/span><\/b><\/p>\n

Let us execute all test methods inside test_p.py and test_p1.py files with the command py.test \u2013v \u2013s.<\/b><\/p>\n

\"\"<\/p>\n

The output shows three test cases got executed. Also it displays the SKIPPED for the test method test_firstprogram<\/b>.<\/p>\n

We can exclude a test from test reporting with the keyword xfail<\/b> in Pytest framework. We have to use the expression @pytest.mark.xfail <\/b>if we want to execute a test method but don\u2019t want it to be a part of the test result. Moreover, we have to include the import pytest<\/b> package in our code.<\/p>\n

Let us now exclude a test method from reporting in the test_p.py file.<\/p>\n

import pytest<\/span><\/b><\/p>\n

           # test method 1 with smoke mark<\/b><\/span><\/p>\n

           @pytest.mark.smoke<\/b><\/span><\/p>\n

def test_firstprogram():<\/b><\/span><\/p>\n

    print(“Hello”)<\/b><\/span><\/p>\n

# test method 2 with xfail mark<\/b><\/span><\/p>\n

@pytest.mark.xfail<\/b><\/span><\/p>\n

def test_projectCreditCard():<\/b><\/span><\/p>\n

    print(“Good Morning”)<\/span><\/b><\/p>\n

Implementation of test_p1.py file.<\/p>\n

import pytest<\/b><\/p>\n

# test method 1 with smoke and skip mark<\/b><\/p>\n

@pytest.mark.smoke<\/b><\/p>\n

@pytest.mark.skip<\/b><\/p>\n

def test_firstprogram():<\/b><\/p>\n

                msg “Hello”<\/b><\/p>\n

           # assertion validation<\/b><\/p>\n

    assert msg == “Tests fail because did not string match”<\/b><\/p>\n

# test method 2<\/b><\/p>\n

def test_secondpCreditCard():<\/b><\/p>\n

    a = 2<\/b><\/p>\n

    assert a+2 == 4, “Addition pass”<\/b><\/p>\n

Let us execute all test methods inside test_p.py and test_p1.py files with the command py.test \u2013v \u2013s.<\/b><\/p>\n

\"\"<\/p>\n

The output shows two test cases got executed and one test case got skipped. Also it displays the XPASS for the test method test_projectCreditCard<\/b> having xfail. That particular method got executed but it is not a part of the test execution result.<\/p>\n

Conclusion: <\/strong>Thus we have seen how to group Pytest files to run a selected group of test cases. For more details, you can refer to the link:<\/p>\n

https:\/\/courses.rahulshettyacademy.com\/courses\/learn-selenium-automation-in-easy-python-language\/lectures\/13248484<\/a><\/p>\n

In the next post, we shall discuss how to use fixtures in Pytest.<\/p>\n","protected":false},"excerpt":{"rendered":"

What is Pytest Testing Framework? The Pytest testing framework is used to create a robust automation framework in Python. Just like TestNG and Junit frameworks in Java, the Pytest framework gives a lot of features. First of all we shall install Pytest in our machine. To install we have to run the command pip install […]<\/p>\n","protected":false},"author":1,"featured_media":877,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[23],"tags":[],"class_list":["post-536","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-python-automation","post-wrapper","thrv_wrapper"],"_links":{"self":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/536","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/comments?post=536"}],"version-history":[{"count":7,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/536\/revisions"}],"predecessor-version":[{"id":555,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/536\/revisions\/555"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/media\/877"}],"wp:attachment":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/media?parent=536"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/categories?post=536"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/tags?post=536"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}