Github

This page describes configuration details for Github.

See also GitHub contribution workflow.

Testing and Continuous Integration

The configuration is in .github/workflows/tests.yml

There are two (potential) sets of tests:

python -c "from amads.ci import run_main_tests; run_main_tests()"

which is actually run, and the following which is commented out:

python -c "from amads.ci import run_ci_group_tests;
run_ci_group_tests('tests_melsim')"

We had problems with melsim, probably related to its dependency on R.

run_main_tests

run_main_tests()

Run main tests with coverage. Tests are discovered following repo's pytest.ini file which says run tests in amads and tests named test_, _test, with classes Test and function test_. Assumes that the working directory is the root of the repository.

Source code in amads/ci.py

def run_main_tests():
    """
    Run main tests with coverage.
    Tests are discovered following repo's pytest.ini file which says
    run tests in amads and tests named test_*, *_test, with classes
    Test* and function test_*.
    Assumes that the working directory is the root of the repository.
    """
    pytest_args = coverage_args
    sys.exit(pytest.main(pytest_args))