Use pytest command instead of py.test

Author: philpep

README.rst

@@ -59,7 +59,7 @@ Write your first tests file to `test_myinfra.py`:
 
 And run it::
 
-    $ py.test -v test_myinfra.py
+    $ pytest -v test_myinfra.py
 
 
     ====================== test session starts ======================

doc/source/backends.rst

@@ -77,7 +77,7 @@ This is the default backend when no hosts are provided (either via
 ``--hosts`` or in modules). Commands are run locally in a subprocess under
 the current user::
 
-    $ py.test --sudo test_myinfra.py
+    $ pytest --sudo test_myinfra.py
 
 
 paramiko
@@ -91,7 +91,7 @@ able to connect without password (using passwordless keys or using
 
 You can provide an alternate ssh-config::
 
-    $ py.test --ssh-config=/path/to/ssh_config --hosts=server
+    $ pytest --ssh-config=/path/to/ssh_config --hosts=server
 
 
 docker
@@ -100,7 +100,7 @@ docker
 The Docker backend can be used to test *running* Docker containers. It uses the
 `docker exec <https://docs.docker.com/reference/commandline/exec/>`_ command::
 
-    $ py.test --hosts='docker://[user@]container_id_or_name'
+    $ pytest --hosts='docker://[user@]container_id_or_name'
 
 See also the :ref:`Test docker images` example.
 
@@ -111,19 +111,19 @@ podman
 The Podman backend can be used to test *running* Podman containers. It uses the
 `podman exec <https://github.com/containers/libpod/blob/master/docs/source/markdown/podman.1.md>`_ command::
 
-    $ py.test --hosts='podman://[user@]container_id_or_name'
+    $ pytest --hosts='podman://[user@]container_id_or_name'
 
 
 ssh
 ~~~
 
 This is a pure SSH backend using the ``ssh`` command. Example::
 
-    $ py.test --hosts='ssh://server'
-    $ py.test --ssh-config=/path/to/ssh_config --hosts='ssh://server'
-    $ py.test --ssh-identity-file=/path/to/key --hosts='ssh://server'
-    $ py.test --hosts='ssh://server?timeout=60&controlpersist=120'
-    $ py.test --hosts='ssh://server' --ssh-extra-args='-o StrictHostKeyChecking=no'
+    $ pytest --hosts='ssh://server'
+    $ pytest --ssh-config=/path/to/ssh_config --hosts='ssh://server'
+    $ pytest --ssh-identity-file=/path/to/key --hosts='ssh://server'
+    $ pytest --hosts='ssh://server?timeout=60&controlpersist=120'
+    $ pytest --hosts='ssh://server' --ssh-extra-args='-o StrictHostKeyChecking=no'
 
 By default timeout is set to 10 seconds and ControlPersist is set to 60 seconds.
 You can disable persistent connection by passing `controlpersist=0` to the options.
@@ -135,10 +135,10 @@ salt
 The salt backend uses the `salt Python client API
 <https://docs.saltstack.com/en/latest/ref/clients/>`_ and can be used from the salt-master server::
 
-    $ py.test --hosts='salt://*'
-    $ py.test --hosts='salt://minion1,salt://minion2'
-    $ py.test --hosts='salt://web*'
-    $ py.test --hosts='salt://G@os:Debian'
+    $ pytest --hosts='salt://*'
+    $ pytest --hosts='salt://minion1,salt://minion2'
+    $ pytest --hosts='salt://web*'
+    $ pytest --hosts='salt://G@os:Debian'
 
 Testinfra will use the salt connection channel to run commands.
 
@@ -156,9 +156,9 @@ and how to connect them, using Testinfra's Ansible backend.
 
 To use the Ansible backend, prefix the ``--hosts`` option with ``ansible://`` e.g::
 
-    $ py.test --hosts='ansible://all' # tests all inventory hosts
-    $ py.test --hosts='ansible://host1,ansible://host2'
-    $ py.test --hosts='ansible://web*'
+    $ pytest --hosts='ansible://all' # tests all inventory hosts
+    $ pytest --hosts='ansible://host1,ansible://host2'
+    $ pytest --hosts='ansible://web*'
 
 An inventory may be specified with the ``--ansible-inventory`` option, otherwise
 the default (``/etc/ansible/hosts``) is used.
@@ -169,8 +169,8 @@ are supported values. Other connections (or if you are using the ``--force-ansib
 option) will result in testinfra running all commands via Ansible itself,
 which is substantially slower than the other backends::
 
-    $ py.test --force-ansible --hosts='ansible://all'
-    $ py.test --hosts='ansible://host?force_ansible=True'
+    $ pytest --force-ansible --hosts='ansible://all'
+    $ pytest --hosts='ansible://host?force_ansible=True'
 
 By default, the Ansible connection backend will first try to use
 ``ansible_ssh_private_key_file`` and ``ansible_private_key_file`` to authenticate,
@@ -203,14 +203,14 @@ support connecting to a given container name within a pod and using a given
 namespace::
 
     # will use the default namespace and default container
-    $ py.test --hosts='kubectl://mypod-a1b2c3'
+    $ pytest --hosts='kubectl://mypod-a1b2c3'
     # specify container name and namespace
-    $ py.test --hosts='kubectl://somepod-2536ab?container=nginx&namespace=web'
+    $ pytest --hosts='kubectl://somepod-2536ab?container=nginx&namespace=web'
     # specify the kubeconfig context to use
-    $ py.test --hosts='kubectl://somepod-2536ab?context=k8s-cluster-a&container=nginx'
+    $ pytest --hosts='kubectl://somepod-2536ab?context=k8s-cluster-a&container=nginx'
     # you can specify kubeconfig either from KUBECONFIG environment variable
     # or when working with multiple configuration with the "kubeconfig" option
-    $ py.test --hosts='kubectl://somepod-123?kubeconfig=/path/kubeconfig,kubectl://otherpod-123?kubeconfig=/other/kubeconfig'
+    $ pytest --hosts='kubectl://somepod-123?kubeconfig=/path/kubeconfig,kubectl://otherpod-123?kubeconfig=/other/kubeconfig'
 
 openshift
 ~~~~~~~~~
@@ -221,30 +221,30 @@ support connecting to a given container name within a pod and using a given
 namespace::
 
     # will use the default namespace and default container
-    $ py.test --hosts='openshift://mypod-a1b2c3'
+    $ pytest --hosts='openshift://mypod-a1b2c3'
     # specify container name and namespace
-    $ py.test --hosts='openshift://somepod-2536ab?container=nginx&namespace=web'
+    $ pytest --hosts='openshift://somepod-2536ab?container=nginx&namespace=web'
     # you can specify kubeconfig either from KUBECONFIG environment variable
     # or when working with multiple configuration with the "kubeconfig" option
-    $ py.test --hosts='openshift://somepod-123?kubeconfig=/path/kubeconfig,openshift://otherpod-123?kubeconfig=/other/kubeconfig'
+    $ pytest --hosts='openshift://somepod-123?kubeconfig=/path/kubeconfig,openshift://otherpod-123?kubeconfig=/other/kubeconfig'
 
 winrm
 ~~~~~
 
 The winrm backend uses `pywinrm <https://pypi.python.org/pypi/pywinrm>`_::
 
-    $ py.test --hosts='winrm://Administrator:[email protected]'
-    $ py.test --hosts='winrm://[email protected]:2200?no_ssl=true&no_verify_ssl=true'
+    $ pytest --hosts='winrm://Administrator:[email protected]'
+    $ pytest --hosts='winrm://[email protected]:2200?no_ssl=true&no_verify_ssl=true'
 
 pywinrm's default read and operation timeout can be overridden using query
 arguments ``read_timeout_sec`` and ``operation_timeout_sec``::
 
-    $ py.test --hosts='winrm://[email protected]:2200?read_timeout_sec=120&operation_timeout_sec=100'
+    $ pytest --hosts='winrm://[email protected]:2200?read_timeout_sec=120&operation_timeout_sec=100'
 
 LXC/LXD
 ~~~~~~~
 
 The LXC backend can be used to test *running* LXC or LXD containers. It uses the
 `lxc exec <https://linuxcontainers.org/lxd/getting-started-cli/>`_ command::
 
-    $ py.test --hosts='lxc://container_name'
+    $ pytest --hosts='lxc://container_name'

doc/source/examples.rst

@@ -18,7 +18,7 @@ Pytest support `test parametrization <https://pytest.org/latest/parametrize.html
 
 
     # GOOD: Each package is tested
-    # $ py.test -v test.py
+    # $ pytest -v test.py
     # [...]
     # test.py::test_package[local-nginx-1.6] PASSED
     # test.py::test_package[local-python-2.7] PASSED
@@ -86,7 +86,7 @@ When your Vagrant machine is up and running, you can easily run your testinfra
 test suite on it::
 
     vagrant ssh-config > .vagrant/ssh-config
-    py.test --hosts=default --ssh-config=.vagrant/ssh-config tests.py
+    pytest --hosts=default --ssh-config=.vagrant/ssh-config tests.py
 
 
 Integration with Jenkins
@@ -101,7 +101,7 @@ If your Jenkins slave can run Vagrant, your build scripts can be like::
     pip install pytest-testinfra paramiko
     vagrant up
     vagrant ssh-config > .vagrant/ssh-config
-    py.test --hosts=default --ssh-config=.vagrant/ssh-config --junit-xml junit.xml tests.py
+    pytest --hosts=default --ssh-config=.vagrant/ssh-config --junit-xml junit.xml tests.py
 
 
 Then configure Jenkins to get tests results from the `junit.xml` file.
@@ -117,12 +117,12 @@ This kind of tests are close to monitoring checks, so let's push them to
 The Testinfra option `--nagios` enables a behavior compatible with a nagios plugin::
 
 
-    $ py.test -qq --nagios --tb line test_ok.py; echo $?
+    $ pytest -qq --nagios --tb line test_ok.py; echo $?
     TESTINFRA OK - 2 passed, 0 failed, 0 skipped in 2.30 seconds
     ..
     0
 
-    $ py.test -qq --nagios --tb line test_fail.py; echo $?
+    $ pytest -qq --nagios --tb line test_fail.py; echo $?
     TESTINFRA CRITICAL - 1 passed, 1 failed, 0 skipped in 2.24 seconds
     .F
     /usr/lib/python3/dist-packages/example/example.py:95: error: [Errno 111] error msg
@@ -142,7 +142,7 @@ additionally (on your host machine, not in the VM handled by kitchen) ::
 
     verifier:
       name: shell
-      command: py.test --hosts="paramiko://${KITCHEN_USERNAME}@${KITCHEN_HOSTNAME}:${KITCHEN_PORT}?ssh_identity_file=${KITCHEN_SSH_KEY}" --junit-xml "junit-${KITCHEN_INSTANCE}.xml" "test/integration/${KITCHEN_SUITE}"
+      command: pytest --hosts="paramiko://${KITCHEN_USERNAME}@${KITCHEN_HOSTNAME}:${KITCHEN_PORT}?ssh_identity_file=${KITCHEN_SSH_KEY}" --junit-xml "junit-${KITCHEN_INSTANCE}.xml" "test/integration/${KITCHEN_SUITE}"
 
 
 .. _test docker images:

doc/source/invocation.rst

@@ -10,7 +10,7 @@ test remotes systems using `paramiko <https://www.paramiko.org>`_ (a
 ssh implementation in python)::
 
     $ pip install paramiko
-    $ py.test -v --hosts=localhost,root@webserver:2222 test_myinfra.py
+    $ pytest -v --hosts=localhost,root@webserver:2222 test_myinfra.py
 
     ====================== test session starts ======================
     platform linux -- Python 2.7.3 -- py-1.4.26 -- pytest-2.6.4
@@ -45,7 +45,7 @@ If you have a lot of tests, you can use the pytest-xdist_ plugin to run tests us
     $ pip install pytest-xdist
 
     # Launch tests using 3 processes
-    $ py.test -n 3 -v --host=web1,web2,web3,web4,web5,web6 test_myinfra.py
+    $ pytest -n 3 -v --host=web1,web2,web3,web4,web5,web6 test_myinfra.py
 
 
 Advanced invocation
@@ -54,10 +54,10 @@ Advanced invocation
 ::
 
     # Test recursively all test files (starting with `test_`) in current directory
-    $ py.test
+    $ pytest
 
     # Filter function/hosts with pytest -k option
-    $ py.test --hosts=webserver,dnsserver -k webserver -k nginx
+    $ pytest --hosts=webserver,dnsserver -k webserver -k nginx
 
 
 For more usages and features, see the Pytest_ documentation.

testinfra/main.py

@@ -16,5 +16,5 @@
 
 
 def main() -> int:
-    warnings.warn("calling testinfra is deprecated, call py.test instead", stacklevel=1)
+    warnings.warn("calling testinfra is deprecated, call pytest instead", stacklevel=1)
     return pytest.main()