.. _FAQ:

Frequency Asked Questions
=========================

The following Frequency Answer Questions are general and not operating system specific.

#. Configure `PyCharm <https://www.jetbrains.com/pycharm/>`__ to auto-complete Xmera commands and provide
   module variables, see the
   `PyCharm Support <https://www.jetbrains.com/help/pycharm/configuring-project-structure.html>`__ web page.

#. How do I run ``pytest`` to ensure all unit and integrated tests still pass

    The following response assumes you have the Xmera soure code. You need to install the python utility ``pytest`` if this is not available on your system. Instructions are found at :ref:`installOptionalPackages`. Next, navigate to the folder ``Xmera\src`` and run ``pytest`` from there.

#. How can I run ``pytest`` faster?

    One can distribute python tests across multiple processes. This is achieved with the ``pytest-xdist``
    package using::

       pip3 install pytest-xdist

    After installing this package you can now pytest such that it distribute tests across multi-processes.
    ``pytest`` for 8 processes using::

       python3 -m pytest -n 8

    or replace `8` with either the number of processors (virtual or otherwise) of your host machine, or "auto" to use all
    available processors.

#. How can I used ``pytest`` to generate a Xmera validation HTML report?

    You will need to install ``pytest-html`` package, see :ref:`installOptionalPackages`.  Then you
    can do this with::

        python3 -m pytest --report

    This generates an HTML report in a local ``tests/report`` folder.