Test that additional license plugin works

This test can run only in the CI and use a new pytest marker.
This requires isolation as it installs new license from a new location
plugin.

Co-authored-by: Kevin Ji <kyji1011@gmail.com>
Co-authored-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: 3 people

azure-pipelines.yml

@@ -83,6 +83,17 @@ jobs:
                 venv/bin/pytest -vvs --test-suite=all \
                   tests/licensedcode/test_installed_license_detection.py
 
+              # this test runs in isolation because it modifies the actual
+              # license index with additional licenses provided by a plugin
+              # and we use the special --test-suite=plugins marker for these
+              # tests
+              additional_licenses_plugin: |
+                venv/bin/pip install tests/licensedcode/data/additional_license_location_provider/plugin/licenses_to_install2
+                venv/bin/scancode --reindex-licenses
+                venv/bin/pytest -vvs --test-suite=plugins \
+                  tests/licensedcode/test_additional_license_location_provider.py
+
+
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu18_cpython

conftest.py

@@ -38,6 +38,7 @@
 ################################################################################
 SLOW_TEST = 'scanslow'
 VALIDATION_TEST = 'scanvalidate'
+PLUGINS_TEST = 'scanplugins'
 
 
 def pytest_configure(config):
@@ -53,8 +54,14 @@ def pytest_configure(config):
         ': Mark a ScanCode test as a validation test, super slow, long running test.',
     )
 
+    config.addinivalue_line(
+        'markers',
+        PLUGINS_TEST +
+        ': Mark a ScanCode test as a special CI test to tests installing additional plugins.',
+    )
+
 
-TEST_SUITES = 'standard', 'all', 'validate'
+TEST_SUITES = ('standard', 'all', 'validate', 'plugins',)
 
 
 def pytest_addoption(parser):
@@ -72,9 +79,11 @@ def pytest_addoption(parser):
         help='Select which test suite to run: '
              '"standard" runs the standard test suite designed to run reasonably fast. '
              '"all" runs "standard" and "slow" (long running) tests. '
-             '"validate" runs all the tests. '
+             '"validate" runs all the tests, except the "plugins" tests. '
+             '"plugins" runs special plugins tests. Needs extra setup, and is used only in the CI. '
              'Use the @pytest.mark.scanslow marker to mark a test as "slow" test. '
              'Use the @pytest.mark.scanvalidate marker to mark a test as a "validate" test.'
+             'Use the @pytest.mark.scanplugins marker to mark a test as a "plugins" test.'
         )
 
 ################################################################################
@@ -87,13 +96,19 @@ def pytest_collection_modifyitems(config, items):
     test_suite = config.getvalue('test_suite')
     run_everything = test_suite == 'validate'
     run_slow_test = test_suite in ('all', 'validate')
+    run_only_plugins = test_suite == 'plugins'
 
     tests_to_run = []
     tests_to_skip = []
 
     for item in items:
         is_validate = bool(item.get_closest_marker(VALIDATION_TEST))
         is_slow = bool(item.get_closest_marker(SLOW_TEST))
+        is_plugins = bool(item.get_closest_marker(PLUGINS_TEST))
+
+        if is_plugins and not run_only_plugins:
+            tests_to_skip.append(item)
+            continue
 
         if is_validate and not run_everything:
             tests_to_skip.append(item)

etc/ci/azure-posix-installed-external-license.yml

@@ -4,9 +4,6 @@ parameters:
     python_versions: []
     test_suites: {}
     python_architecture: x64
-    install_packages: |
-        venv/bin/python3 -m pip install --upgrade pip
-        venv/bin/python3 -m pip install tests/licensedcode/data/example_external_licenses/licenses_to_install1
 
 jobs:
     - job: ${{ parameters.job_name }}
@@ -38,8 +35,5 @@ jobs:
                     ./configure --clean && ./configure --dev
                 displayName: '${{ pyver }} - Configure'
 
-              - script: ${{ parameters.install_packages }}
-                displayName: '${{ pyver }} - Install license'
-
               - script: $(test_suite)
                 displayName: '${{ pyver }} - $(test_suite_label) on ${{ parameters.job_name }}'

etc/ci/azure-posix.yml

@@ -0,0 +1,7 @@
+graft src
+graft thirdparty
+
+include setup.*
+include *.rst
+include *LICENSE*
+include *NOTICE*

etc/ci/azure-win-installed-external-license.yml

@@ -0,0 +1,21 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# ScanCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/scancode-toolkit for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+from os.path import abspath
+from os.path import dirname
+
+from licensedcode.additional_license_location_provider import AdditionalLicenseLocationProviderPlugin
+
+
+class LicensesToInstall2Paths(AdditionalLicenseLocationProviderPlugin):
+    def get_locations(self):
+        curr_dir = dirname(abspath(__file__))
+        locations = {
+            'licenses_to_install2': curr_dir,
+        }
+        return locations

tests/licensedcode/data/additional_license_location_provider/plugin/licenses_to_install2/MANIFEST.in

@@ -0,0 +1 @@
+This is a test license EXAMPLE2 that must be installed into ScanCode Toolkit.

tests/licensedcode/data/additional_license_location_provider/plugin/licenses_to_install2/build/lib/licenses_to_install2/__init__.py

@@ -0,0 +1,6 @@
+key: example-installed-2
+short_name: Example Installed License 2
+name: Example Installed License 2
+category: Permissive
+owner: NexB
+spdx_license_key: LicenseRef-scancode-example-installed2

tests/licensedcode/data/additional_license_location_provider/plugin/licenses_to_install2/build/lib/licenses_to_install2/licenses/example-installed-2.LICENSE

@@ -0,0 +1 @@
+This is a test rule EXAMPLE2 that must be installed into ScanCode Toolkit.