The workflow which was being used to run the tests and create the coverage report was causing the issue described in #71, as it was attempting to run sudo apt-get update || true, which is a linux command, on jobs running macos.
To fix this, I have made the following changes:
Created a new workflow from scratch which has the same functionality as the original workflow. The new workflow does the following:
Define a matrix of jobs for all the provided python versions and os's to test;
Sets up a python installation with the job's designated python version;
Installs the project dependencies and the dependencies required to run the tests (which are stored in a new file in tests/requirements.txt);
Runs the tests with pytest and the extensions xdist and pytest-cov, which were both also used in the original workflow;
The tests are ran using a certain number of cpu cores, defined in the pytest_cpus environment variable inside the workflow file;
The directory which is checked for the coverage report is defined in the pytest_cov_dir environment variable inside the workflow file;
Shows a coverage report in the job's console;
Uploads a coverage report to Codecov;
I've added this step because it was also present in the original workflow and so I assumed there was some sort of configuration for this already in place. However, if this isn't the case, it might be best to remove this step;
Created a new file in test/requirements.txt where the requirements for running the tests are stored, these requirements being pytest, the used extensions pytest-xdist and pytest-cov and coverage;
Added code to the beginning of the test scripts to add the path to the source to sys.path;
This is required so that you can actually do import dgmr to run the tests;
How Has This Been Tested?
I've tested this action on my fork of the repository.
If you navigate to the actions page you can see that the action runs successfully and that the tests are run correctly.
Pull Request
Description
The workflow which was being used to run the tests and create the coverage report was causing the issue described in #71, as it was attempting to run
sudo apt-get update || true, which is a linux command, on jobs running macos.To fix this, I have made the following changes:
The new workflow does the following:
tests/requirements.txt);pytest_cpusenvironment variable inside the workflow file;pytest_cov_direnvironment variable inside the workflow file;test/requirements.txtwhere the requirements for running the tests are stored, these requirements beingpytest, the used extensionspytest-xdistandpytest-covandcoverage;sys.path;import dgmrto run the tests;How Has This Been Tested?
I've tested this action on my fork of the repository. If you navigate to the actions page you can see that the action runs successfully and that the tests are run correctly.
Checklist: