{"id":11467,"date":"2019-11-04T05:00:49","date_gmt":"2019-11-04T10:00:49","guid":{"rendered":"https:\/\/qxf2.com\/blog\/?p=11467"},"modified":"2020-07-10T10:16:26","modified_gmt":"2020-07-10T14:16:26","slug":"pytest-command-line-options","status":"publish","type":"post","link":"https:\/\/qxf2.com\/blog\/pytest-command-line-options\/","title":{"rendered":"Exploring pytest command line options"},"content":{"rendered":"

This post will serve as a quick tutorial for using pytest command-line options. Anyone who is new to pytest will benefit from this article.<\/p>\n

Pytest comes with many useful command-line options right out of the box. When I started learning pytest, I had to search through a lot of material available on the official pytest website<\/a> as well as other Internet resources. I hope this tutorial will help any newbie, who wants to start using pytest commands effectively.<\/p>\n

\n

Installation:<\/h3>\n

1<\/strong>. Run the following command in your command line:<\/p>\n

\"\"<\/a><\/p>\n

2<\/strong>. Check the installed version.<\/p>\n

\"\"<\/a><\/p>\n

\n

Pytest command line options<\/h3>\n

Note: Qxf2 Page object model<\/a> has been used to demonstrate the examples in the post.<\/p>\n

1. python -m pytest<\/strong><\/p>\n

You can invoke testing through python interpreter from the command line.<\/p>\n

\"\"<\/a><\/p>\n

2<\/strong>.\u00a0pytest–version<\/strong><\/p>\n

This gives you a version of the pytest module.<\/p>\n

\"\"<\/a><\/p>\n

3<\/strong>. pytest –fixtures<\/strong><\/p>\n

This will give you available fixtures<\/a><\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

4<\/strong>. pytest -h or pytest –help<\/strong><\/p>\n

This shows help on command line and config-line options<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

5<\/strong>. pytest -x<\/strong><\/p>\n

This command stops execution after the first failure.<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

6<\/strong>.\u00a0pytest –maxfail=n<\/strong><\/p>\n

This command stops execution after nth failure. n can be any number such as 1.2.3<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

7<\/strong>. pytest module name<\/strong><\/p>\n

This command helps to run tests by specifying the module name.<\/p>\n

\"\"<\/a><\/p>\n

8<\/strong>. pytest directory_name\/<\/strong><\/p>\n

This command runs the tests from the directory<\/p>\n

\"\"<\/a><\/p>\n

9<\/strong>. pytest -k “keyword expression”<\/strong><\/p>\n

This command runs the test based on the keyword expression. e.g. in the below example, we will be running only API tests not bitcoin tests from our suite.<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

10<\/strong>. Detailed summary report options<\/strong><\/p>\n

The -r flag can be used to display a short summary report at the end of the test. Various options are discussed in the below section.<\/p>\n

10.1<\/strong>\u00a0\u00a0pytest -rA<\/strong><\/p>\n

This gives output of all tests<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

Below is the full list of characters available.<\/p>\n

f- failed<\/p>\n

E- error<\/p>\n

s- skipped<\/p>\n

x- xfailed<\/p>\n

X- xpassed<\/p>\n

p- passed<\/p>\n

P-passed with output<\/p>\n

a- all except pP<\/p>\n

A- all<\/p>\n

More than one character can be used so in the below example failed and skipped tests can be seen after running following command<\/p>\n

10.2<\/strong>\u00a0\u00a0pytest -rfs<\/strong><\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

11<\/strong>. pytest –ignore=ignorepaths during tests<\/strong><\/p>\n

You can specify module, directory or tests to ignore the tests.<\/p>\n

\"\"<\/a><\/p>\n

In the below screen you can see the test has been ignored from the execution.<\/p>\n

\"\"<\/a><\/p>\n

12<\/strong>.\u00a0pytest –collect-only<\/strong><\/p>\n

You can peep into the collections without actually executing the tests.<\/p>\n

\"\"<\/a><\/p>\n

13<\/strong>. pytest -m <markername><\/strong><\/p>\n

Markers<\/a> that have been defined in the test_example_table.py file and pytest module imported in the test file as shown below.<\/p>\n

Only the tests defined by the marker will run after this command.<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

14<\/strong>. pytest –junitxml=”xmlfilename”<\/strong><\/p>\n

After running this command pytest will generate XML report<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

15<\/strong>. py.test -s<\/strong><\/p>\n

Users can influence output capturing mechanisms from the command line, where -s option disables all capturing.<\/p>\n

\"\"<\/a><\/p>\n

16<\/strong>. py.test -E<\/strong><\/p>\n

Users can create custom marker and command-line options before running tests following additions to be done in the conftest.py file and test file<\/p>\n

In the conftest.py file<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

In the test_example_form.py<\/span><\/p>\n

\"\"<\/a><\/p>\n

Then run the test it will give output as shown in the below screen.<\/p>\n

\"\"<\/a><\/p>\n

17. pytest -n NUM<\/strong><\/p>\n

This will speed up tests by sending tests to multiple CPUs. This can be useful in longer running tests or tests requiring a lot of I\/O. This can lead to considerable speedups.<\/p>\n

\"\"<\/a><\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

 <\/p>\n

\n

I hope you have liked the blog. There are many more useful pytest commands that can be used by testers or developers for their testing. This post captures the most commonly used commands in our experience. A complete list of commands will be available at pytest<\/a> documentation.<\/p>\n

\n","protected":false},"excerpt":{"rendered":"

This post will serve as a quick tutorial for using pytest command-line options. Anyone who is new to pytest will benefit from this article. Pytest comes with many useful command-line options right out of the box. When I started learning pytest, I had to search through a lot of material available on the official pytest website as well as other […]<\/p>\n","protected":false},"author":28,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[107],"tags":[],"class_list":["post-11467","post","type-post","status-publish","format-standard","hentry","category-pytest"],"_links":{"self":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11467","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/comments?post=11467"}],"version-history":[{"count":79,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11467\/revisions"}],"predecessor-version":[{"id":11667,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/posts\/11467\/revisions\/11667"}],"wp:attachment":[{"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/media?parent=11467"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/categories?post=11467"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/qxf2.com\/blog\/wp-json\/wp\/v2\/tags?post=11467"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}