added unit testing framework (#175)

* added unit testing framework * added missing newline * moved around files * fixed folder name * added tests * readded fairgbm * clean up * formatting changes * more cleanup * added more tests * updated readme
dssg · Apr 3, 2024 · 12996a4 · 12996a4
1 parent 10a7d11
commit 12996a4
Show file tree

Hide file tree

Showing 42 changed files with 484 additions and 140 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,10 @@ __pycache__/
 
 .envrc
 .manage
+.venv
+.coverage
+.vscode
+cov.xml
 
 *.DS_Store*
 

diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,2 @@
+[pytest]
+addopts = --cov=aequitas
diff --git a/requirements/cli.txt b/requirements/cli.txt
@@ -1,5 +1,5 @@
 SQLAlchemy>=1.1.1
 tabulate==0.8.2
-xhtml2pdf==0.2.2
+xhtml2pdf==0.2.15
 ohio>=0.2.0
 markdown2==2.3.5
diff --git a/requirements/main.txt b/requirements/main.txt
@@ -12,4 +12,5 @@ fairlearn>=0.8.0
 hydra-core>=1.3.0
 validators>=0.22.0
 hyperparameter-tuning>=0.3.1
-numpy==1.23.5
+numpy==1.23.5
+fastparquet==2024.2.0
diff --git a/run_tests.sh b/run_tests.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# Create a virtual environment
+python3 -m venv .venv
+
+# Activate the virtual environment
+source .venv/bin/activate
+
+# Install the required packages
+pip install -r ./requirements/main.txt -r ./requirements/cli.txt -r ./requirements/webapp.txt
+pip install -e .
+
+pip install pytest pytest-cov
+
+# Run the tests
+coverage run -m pytest --cov-report xml:cov.xml --cov-report term
+
+# Deactivate the virtual environment
+deactivate
diff --git a/src/tests/README.rst b/src/tests/README.rst
diff --git a/src/tests/test_bias_report.py b/src/tests/test_bias_report.py
diff --git a/tests/README.md b/tests/README.md
@@ -0,0 +1,13 @@
+# Unit Testing in Aequitas
+
+To run unittests locally, you need to run the following commands from the base folder of the project.
+
+The below commans only needs to be run once to give the testing script necessary permission to run
+
+`chmod +x run_tests.sh`
+
+The testing script itself can be run using the following commans 
+
+`./run_tests.sh`
+
+The script will run all defined tests in a virtual environment and output the coverage report in the terminal. It will also add an xml file of the coverage report `cov.xml` to the base folder.
diff --git a/src/tests/expected_output_bias_test_1.csv → ...as_report/expected_output_bias_test_1.csv b/src/tests/expected_output_bias_test_1.csv → ...as_report/expected_output_bias_test_1.csv
diff --git a/...tests/expected_output_fairness_test_1.csv → ...eport/expected_output_fairness_test_1.csv b/...tests/expected_output_fairness_test_1.csv → ...eport/expected_output_fairness_test_1.csv
diff --git a/src/tests/expected_output_group_test_1.csv → ...s_report/expected_output_group_test_1.csv b/src/tests/expected_output_group_test_1.csv → ...s_report/expected_output_group_test_1.csv
diff --git a/src/tests/expected_output_test_1.csv → ...st_bias_report/expected_output_test_1.csv b/src/tests/expected_output_test_1.csv → ...st_bias_report/expected_output_test_1.csv
diff --git a/src/tests/expected_output_test_10.csv → ...t_bias_report/expected_output_test_10.csv b/src/tests/expected_output_test_10.csv → ...t_bias_report/expected_output_test_10.csv
diff --git a/src/tests/expected_output_test_2.csv → ...st_bias_report/expected_output_test_2.csv b/src/tests/expected_output_test_2.csv → ...st_bias_report/expected_output_test_2.csv
diff --git a/src/tests/expected_output_test_3.csv → ...st_bias_report/expected_output_test_3.csv b/src/tests/expected_output_test_3.csv → ...st_bias_report/expected_output_test_3.csv
diff --git a/src/tests/expected_output_test_4.csv → ...st_bias_report/expected_output_test_4.csv b/src/tests/expected_output_test_4.csv → ...st_bias_report/expected_output_test_4.csv
diff --git a/src/tests/expected_output_test_5.csv → ...st_bias_report/expected_output_test_5.csv b/src/tests/expected_output_test_5.csv → ...st_bias_report/expected_output_test_5.csv
diff --git a/src/tests/expected_output_test_6.csv → ...st_bias_report/expected_output_test_6.csv b/src/tests/expected_output_test_6.csv → ...st_bias_report/expected_output_test_6.csv
diff --git a/src/tests/expected_output_test_7.csv → ...st_bias_report/expected_output_test_7.csv b/src/tests/expected_output_test_7.csv → ...st_bias_report/expected_output_test_7.csv
diff --git a/src/tests/expected_output_test_8.csv → ...st_bias_report/expected_output_test_8.csv b/src/tests/expected_output_test_8.csv → ...st_bias_report/expected_output_test_8.csv
diff --git a/src/tests/test_1.csv → ...est_artifacts/test_bias_report/test_1.csv b/src/tests/test_1.csv → ...est_artifacts/test_bias_report/test_1.csv
diff --git a/src/tests/test_1.yaml → ...st_artifacts/test_bias_report/test_1.yaml b/src/tests/test_1.yaml → ...st_artifacts/test_bias_report/test_1.yaml
diff --git a/src/tests/test_10.csv → ...st_artifacts/test_bias_report/test_10.csv b/src/tests/test_10.csv → ...st_artifacts/test_bias_report/test_10.csv
diff --git a/...tests/test_1_aequitas_20180501-114554.csv → ...eport/test_1_aequitas_20180501-114554.csv b/...tests/test_1_aequitas_20180501-114554.csv → ...eport/test_1_aequitas_20180501-114554.csv
diff --git a/src/tests/test_2.csv → ...est_artifacts/test_bias_report/test_2.csv b/src/tests/test_2.csv → ...est_artifacts/test_bias_report/test_2.csv
diff --git a/src/tests/test_2.yaml → ...st_artifacts/test_bias_report/test_2.yaml b/src/tests/test_2.yaml → ...st_artifacts/test_bias_report/test_2.yaml
diff --git a/src/tests/test_3.csv → ...est_artifacts/test_bias_report/test_3.csv b/src/tests/test_3.csv → ...est_artifacts/test_bias_report/test_3.csv
diff --git a/src/tests/test_3.yaml → ...st_artifacts/test_bias_report/test_3.yaml b/src/tests/test_3.yaml → ...st_artifacts/test_bias_report/test_3.yaml
diff --git a/src/tests/test_4.csv → ...est_artifacts/test_bias_report/test_4.csv b/src/tests/test_4.csv → ...est_artifacts/test_bias_report/test_4.csv
diff --git a/src/tests/test_4.yaml → ...st_artifacts/test_bias_report/test_4.yaml b/src/tests/test_4.yaml → ...st_artifacts/test_bias_report/test_4.yaml
diff --git a/src/tests/test_5.csv → ...est_artifacts/test_bias_report/test_5.csv b/src/tests/test_5.csv → ...est_artifacts/test_bias_report/test_5.csv
diff --git a/src/tests/test_6.csv → ...est_artifacts/test_bias_report/test_6.csv b/src/tests/test_6.csv → ...est_artifacts/test_bias_report/test_6.csv
diff --git a/src/tests/test_7.csv → ...est_artifacts/test_bias_report/test_7.csv b/src/tests/test_7.csv → ...est_artifacts/test_bias_report/test_7.csv
diff --git a/src/tests/test_8.csv → ...est_artifacts/test_bias_report/test_8.csv b/src/tests/test_8.csv → ...est_artifacts/test_bias_report/test_8.csv
diff --git a/src/tests/test_9.csv → ...est_artifacts/test_bias_report/test_9.csv b/src/tests/test_9.csv → ...est_artifacts/test_bias_report/test_9.csv
diff --git a/tests/test_artifacts/test_generic/data.csv b/tests/test_artifacts/test_generic/data.csv
@@ -0,0 +1,11 @@
+label,sensitive,feature1,feature2
+1,A,0.5,0.1
+0,B,0.2,0.4
+1,C,0.7,0.6
+0,B,0.3,0.8
+1,A,0.9,0.3
+1,A,0.5,0.5
+0,A,0.2,0.2
+1,C,0.7,0.7
+0,B,0.3,0.3
+1,A,0.9,0.9
diff --git a/tests/test_artifacts/test_generic/data.parquet b/tests/test_artifacts/test_generic/data.parquet
diff --git a/tests/test_artifacts/test_generic/data_test.csv b/tests/test_artifacts/test_generic/data_test.csv
@@ -0,0 +1,2 @@
+label,sensitive,feature1,feature2
+1,A,0.9,0.9
diff --git a/tests/test_artifacts/test_generic/data_train.csv b/tests/test_artifacts/test_generic/data_train.csv
@@ -0,0 +1,8 @@
+label,sensitive,feature1,feature2
+1,A,0.5,0.1
+0,B,0.2,0.4
+1,C,0.7,0.6
+0,B,0.3,0.8
+1,A,0.9,0.3
+1,A,0.5,0.5
+0,A,0.2,0.2
diff --git a/tests/test_artifacts/test_generic/data_validation.csv b/tests/test_artifacts/test_generic/data_validation.csv
@@ -0,0 +1,3 @@
+label,sensitive,feature1,feature2
+1,C,0.7,0.7
+0,B,0.3,0.3