Skip to content

Latest commit

 

History

History
252 lines (166 loc) · 11.3 KB

README.md

File metadata and controls

252 lines (166 loc) · 11.3 KB
Raw

Tests

This project uses unit, smoke and integration tests with Python files and notebooks:

  • In the unit tests we just make sure the utilities and notebooks run.

  • In the smoke tests, we run them with a small dataset or a small number of epochs to make sure that, apart from running, they provide reasonable metrics.

  • In the integration tests we use a bigger dataset for more epochs and we test that the metrics are what we expect.

For more information, see a quick introduction to unit, smoke and integration tests. To manually execute the unit tests in the different environments, first make sure you are in the correct environment as described in the SETUP.md.

AzureML is also used to run the existing unit, smoke and integration tests as-is. AzureML benefits include managing the compute environment by automatically turning it on/off, scaling, automatic logging of artifacts from test runs and more. Azure DevOps is used as a control plane to provide information to scripts to configure and run the tests as-is on AzureML. A separate set of pipelines was created to run the tests on AzureML and parameters to configure AzureML are defined in the pipeline yml files. There are two scripts used with each pipeline:

  • submit_azureml_pytest.py - this script uses parameters in the pipeline yml to set up the AzureML environment for testing using the AzureML SDK .
  • run_pytest.py - this script uses pytest to run tests on utilities or runs papermill to execute tests on notebooks. This script runs in an AzureML workspace with the environment created by the script above. The same tests and testmarkers are used as described below.

Note: Spark tests are not currently run on AzureML and may be set up in the future.

Test execution

Click on the following menus to see more details on how to execute the unit, smoke and integration tests:

Unit tests

Unit tests ensure that each class or function behaves as it should. Every time a developer makes a pull request to staging or main branch, a battery of unit tests is executed.

Note that the next instructions execute the tests from the root folder.

For executing the Python unit tests for the utilities:

pytest tests/unit -m "not notebooks and not spark and not gpu" --durations 0

For executing the Python unit tests for the notebooks:

pytest tests/unit -m "notebooks and not spark and not gpu" --durations 0

For executing the Python GPU unit tests for the utilities:

pytest tests/unit -m "not notebooks and not spark and gpu" --durations 0

For executing the Python GPU unit tests for the notebooks:

pytest tests/unit -m "notebooks and not spark and gpu" --durations 0

For executing the PySpark unit tests for the utilities:

pytest tests/unit -m "not notebooks and spark and not gpu" --durations 0

For executing the PySpark unit tests for the notebooks:

pytest tests/unit -m "notebooks and spark and not gpu" --durations 0
Smoke tests

Smoke tests make sure that the system works and are executed just before the integration tests every night.

Note that the next instructions execute the tests from the root folder.

For executing the Python smoke tests:

pytest tests/smoke -m "smoke and not spark and not gpu" --durations 0

For executing the Python GPU smoke tests:

pytest tests/smoke -m "smoke and not spark and gpu" --durations 0

For executing the PySpark smoke tests:

pytest tests/smoke -m "smoke and spark and not gpu" --durations 0

NOTE: Adding --durations 0 shows the computation time of all tests.

NOTE: Adding --disable-warnings will disable the warning messages.

Integration tests

Integration tests make sure that the program results are acceptable.

Note that the next instructions execute the tests from the root folder.

For executing the Python integration tests:

pytest tests/integration -m "integration and not spark and not gpu" --durations 0

For executing the Python GPU integration tests:

pytest tests/integration -m "integration and not spark and gpu" --durations 0

For executing the PySpark integration tests:

pytest tests/integration -m "integration and spark and not gpu" --durations 0

NOTE: Adding --durations 0 shows the computation time of all tests.

Current Skipped Tests

Several of the tests are skipped for various reasons which are noted below.

Test Module Test Test Environment Reason
unit/recommenders/datasets/test_wikidata * Linux Wikidata API is unstable
integration/recommenders/datasets/test_notebooks_python test_wikidata Linux Wikidata API is unstable
*/test_notebooks_python test_vw* Linux VW pip package has installation incompatibilities
*/test_notebooks_python test_nni* Linux NNI pip package has installation incompatibilities
integration/examples/test_notebooks_python test_xlearn* Linux xLearn pip package has installation incompatibilities

In order to skip a test because there is an OS or upstream issue which cannot be resolved you can use pytest annotations.

Example:

@pytest.mark.skip(reason="<INSERT VALID REASON>")
@pytest.mark.skipif(sys.platform == 'win32', reason="Not implemented on Windows")
def test_to_skip():
    assert False

Test execution with tox

Tox is a great tool for both virtual environment management and test execution. Tox acts like a front-end for our CI workflows. Our existing CI pipelines in GitHub is leveraging it to orchestrate the build. This way we can provide a parity in both local and remote execution environments if both run tox. Run tox and no more "tests run fine in my dev box but fail in the remote build"!

  1. If you haven't, pip install tox

  2. To run static analysis: tox -e flake8

  3. To run any of our test suites: tox -e {TOX_ENV} -- {PYTEST_PARAM}

    where

    • TOX_ENV can be cpu|gpu|spark|all, each env maps to the "extra" dependency, for example recommenders[gpu], and recommenders[spark]. It can also be any of the default envs: py|pyNM
    • PYTEST_PARAM are any standard parameters to supply to pytest cli.

    For example:

    1. tox -e cpu -- tests/unit -m "not notebook and not spark and not gpu (runs the unit tests with recommenders[dev,example] dependencies)
    2. tox -e gpu -- tests/unit -m "gpu and notebook" (runs the gpu notebook tests with recommenders[dev,example,gpu] dependencies)
    3. tox -e spark -- tests/unit -m "spark and notebook" (runs the spark notebook tests with recommenders[dev,example,spark] dependencies)
    4. tox -e all -- tests/unit (to run all of the unit tests with recommenders[all] dependencies)
    5. tox -e py -- tests/unit (runs the unit tests under the default python interpreter with recommenders[all])
    6. tox -e py37 -- tests/unit (runs the unit tests under Python3.7 with recommenders[all] )

How to create tests on notebooks with Papermill

In the notebooks of this repo, we use Papermill in unit, smoke and integration tests. Papermill is a tool that enables you to parameterize notebooks, execute and collect metrics across the notebooks, and summarize collections of notebooks.

Developing unit tests with Papermill

Executing a notebook with Papermill is easy, this is what we mostly do in the unit tests. Next we show just one of the tests that we have in tests/unit/test_notebooks_python.py.

import pytest
import papermill as pm

@pytest.mark.notebooks
def test_sar_single_node_runs(notebooks, output_notebook, kernel_name):
    notebook_path = notebooks["sar_single_node"]
    pm.execute_notebook(notebook_path, output_notebook, kernel_name=kernel_name)

Notice that the input of the function is a fixture defined in conftest.py. For more information, please see the definition of fixtures in PyTest.

For executing this test, first make sure you are in the correct environment as described in the SETUP.md:

Note that the next instruction executes the tests from the root folder.

pytest tests/unit/test_notebooks_python.py::test_sar_single_node_runs

Developing smoke and integration tests with Papermill

A more advanced option is used in the smoke and integration tests, where we not only execute the notebook, but inject parameters and recover the computed metrics.

The first step is to tag the parameters that we are going to inject. For it we need to modify the notebook. We will add a tag with the name parameters. To add a tag, go the the notebook menu, View, Cell Toolbar and Tags. A tag field will appear on every cell. The variables in the cell tagged with parameters can be injected. The typical variables that we inject are MOVIELENS_DATA_SIZE, EPOCHS and other configuration variables for our algorithms.

The way papermill works to inject parameters is very simple, it generates a copy of the notebook (in our code we call it OUTPUT_NOTEBOOK), and creates a new cell with the injected variables.

The second modification that we need to do to the notebook is to record the metrics we want to test using sb.glue("output_variable", python_variable_name). We normally use the last cell of the notebook to record all the metrics. These are the metrics that we are going to control to in the smoke and integration tests.

This is an example on how we do a smoke test. The complete code can be found in tests/smoke/test_notebooks_python.py:

import pytest
import papermill as pm

TOL = 0.05

@pytest.mark.smoke
def test_sar_single_node_smoke(notebooks, output_notebook, kernel_name):
    notebook_path = notebooks["sar_single_node"]
    pm.execute_notebook(
        notebook_path,
        output_notebook,
        kernel_name=kernel_name,
        parameters=dict(TOP_K=10, MOVIELENS_DATA_SIZE="100k"),
    )
    results = pm.read_notebook(output_notebook).dataframe.set_index("name")["value"]
    assert results["precision"] == pytest.approx(0.326617179, TOL)
    assert results["recall"] == pytest.approx(0.175956743, TOL)

As it can be seen in the code, we are injecting the dataset size and the top k and we are recovering the precision and recall at k.

For executing this test, first make sure you are in the correct environment as described in the SETUP.md:

Note that the next instructions execute the tests from the root folder.

pytest tests/smoke/test_notebooks_python.py::test_sar_single_node_smoke

More details on how to integrate Papermill with notebooks can be found in their repo.