Add unit test for scancode-evaluate.py and improve analysis of scancode results

tools/test/travis-ci/scancode_evaluate_test.py

@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+# Copyright (c) 2020 Arm Limited and Contributors. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+import importlib
+import os
+import json
+from unittest import TestCase
+
+# TODO: fix scancode to match python naming conventROOTi
+SCANCODE_EVALUATE = importlib.import_module("scancode-evaluate")
+license_check = SCANCODE_EVALUATE.license_check
+
+ROOT = os.path.abspath(
+    os.path.join(os.path.dirname(__file__))
+)
+
+# path to stub files
+stub_path = ROOT + "/scancode_test/"
+
+# template copyright notices
+invalid_header_1 = "/* Copyright (C) Arm Limited, Inc - All Rights Reserved\
+ * Unauthorized copying of this. file, via any medium is strictly prohibited\
+ * Proprietary and confidential\
+ */"
+
+invalid_header_2 = "/* mbed Microcontroller Library\
+ * Copyright (c) 2006-2013 ARM Limited\
+ *\
+ * Licensed under the Apache License, Version 2.0 (the \"License\");\
+ * you may not use this file except in compliance with the License.\
+ * You may obtain a copy of the License at\
+ *\
+ *     http://www.apache.org/licenses/LICENSE-2.0\
+ *\
+ * Unless required by applicable law or agreed to in writing, software\
+ * distributed under the License is distributed on an \"AS IS\" BASIS,\
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\
+ * See the License for the specific language governing permissions and\
+ * limitations under the License.\
+ */"
+
+
+# implement test class
+class TestScancodeEvaluate(TestCase):
+    """ Test scancode evaluation script """
+
+    def test_scancode_case_1(self):
+        """ Test Case 1 -- faulty json file
+            @inputs scancode_test_1.json
+            @outputs -1 if any error in file licenses found
+        """
+        # generate scancode_test_1.json
+        with open(ROOT + "/scancode_test/scancode_test_1.json", 'w') as f:
+            json.dump({"headers": {"tool name": "scancode test fail"}}, f)
+
+        self.assertEqual(-1, license_check(ROOT, ROOT + "/scancode_test/scancode_test_1.json"))
+        os.remove(ROOT + "/scancode_test/scancode_test_1.json")
+
+    def test_scancode_case_2(self):
+        """ Test Case 2 -- no errors in license headers, try multiple types i.e Apache-2.0, BSD3
+            @inputs scancode_test_2.json [4 Apache-2.0, 4 BSD-3.0]
+            @outputs 0
+        """
+        self.assertEqual(0, license_check(ROOT, ROOT + "/scancode_test/scancode_test_2.json"), "False Negative(s)")
+
+    def test_scancode_case_3(self):
+        """ Test Case 3 -- all files containing errors [2 files without a header, 2 files non-permissive + missing SPDX,
+             1 missing SPDX]
+            @inputs scancode_test_3.json
+            @output 7
+        """
+        # create stub files with a non-permissive license and missing spdx
+        for i in range(3, 6):
+            with open(stub_path + "test" + str(i) + ".h", "w") as file:
+                if i == 5:
+                    file.write(invalid_header_2)
+                else:
+                    file.write(invalid_header_1)
+
+        self.assertEqual(7, license_check(ROOT, ROOT + "/scancode_test/scancode_test_3.json"), "False Positive(s)")
+        # delete stub files
+        os.remove(stub_path + "test3.h")
+        os.remove(stub_path + "test4.h")
+        os.remove(stub_path + "test5.h")
+
+    def test_scancode_case_4(self):
+        """ Test Case 4 -- license header permissive and "non-permissive license" false positive
+            @inputs scancode_test_4.json
+            @outputs 0
+        """
+        self.assertEqual(0, license_check(ROOT, ROOT + "/scancode_test/scancode_test_4.json"), "Non-Permissive Header False Positive")