Add tox/CI test for license file

johnthagen · johnthagen · commit 77d0887fba18 · 2020-01-25T14:20:06.000-05:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -75,6 +75,8 @@ jobs:
             toxenv: py38-tests
           - name: 3.8
             toxenv: py38-tests_nongpl
+          - name: 3.8
+            toxenv: check-package-license-file
         exclude:
           # Building on Windows isn't supported, and 3.5/PyPy on Windows
           # seem to fail with silent obscure errors.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ _static
 _templates
 
 TODO
+license_report.json
diff --git a/test_license.py b/test_license.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+
+"""Test that this package's license file is properly detected by pip-licenses.
+
+This file assumes that pip-licenses has already been run (in a tox env) and
+generated license_report.json.
+"""
+
+import json
+from pathlib import Path
+
+
+def main():
+    packages = json.loads(
+        (Path(__file__).resolve().parent / 'license_report.json').read_text())
+    for package in packages:
+        if package['Name'] == 'jsonschema':
+            assert package['LicenseFile'] != 'UNKNOWN'
+
+
+if __name__ == '__main__':
+    main()
diff --git a/tox.ini b/tox.ini
@@ -126,3 +126,12 @@ commands =
     {envpython} -m coverage run --rcfile={toxinidir}/.coveragerc -m twisted.trial jsonschema
     {envpython} -m coverage xml -o {envtmpdir}/coverage.xml
     codecov --required --disable gcov --file {envtmpdir}/coverage.xml
+
+[testenv:check-package-license-file]
+recreate = True
+deps =
+    pip-licenses
+commands =
+    pip install {toxinidir}
+    pip-licenses --from=mixed --with-license-file --format=json --output-file={toxinidir}/license_report.json
+    {envpython} {toxinidir}/test_license.py

Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,4 @@ _static`
`3`	`3`	`_templates`
`4`	`4`
`5`	`5`	`TODO`
	`6`	`+license_report.json`