Fixed #594 - Add tests for on-demand package data collection for cargo

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

minecode/tests/collectors/test_cargo.py

@@ -0,0 +1,57 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# purldb 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/purldb for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+import json
+import os
+
+from django.test import TestCase as DjangoTestCase
+
+from packageurl import PackageURL
+
+import packagedb
+from minecode.collectors import cargo
+from minecode.utils_test import JsonBasedTesting
+
+
+class CargoPriorityQueueTests(JsonBasedTesting, DjangoTestCase):
+    test_data_dir = os.path.join(
+        os.path.dirname(os.path.dirname(__file__)), "testfiles"
+    )
+
+    def setUp(self):
+        super().setUp()
+        self.expected_json_loc = self.get_test_loc("cargo/sam.json")
+        with open(self.expected_json_loc) as f:
+            self.expected_json_contents = json.load(f)
+
+    def test_get_package_json(self):
+        # As certain fields, such as "downloads," "recent_downloads," and
+        # "num_versions," may vary over time when executing
+        # "cargo.get_package_json(name="sam")", we cannot rely on
+        # "assertEqual" for comparison. Instead, we will verify that the
+        # response includes four primary components: crate, version,
+        # keywords, and categories, and the the "id" under crate is "sam"
+        expected_list = ["crate", "versions", "keywords", "categories"]
+        json_contents = cargo.get_package_json(name="sam")
+        keys = json_contents.keys()
+        self.assertListEqual(list(keys), expected_list)
+        self.assertEqual(json_contents["crate"]["id"], "sam")
+
+    def test_map_npm_package(self):
+        package_count = packagedb.models.Package.objects.all().count()
+        self.assertEqual(0, package_count)
+        package_url = PackageURL.from_string("pkg:cargo/[email protected]")
+        cargo.map_cargo_package(package_url, ("test_pipeline"))
+        package_count = packagedb.models.Package.objects.all().count()
+        self.assertEqual(1, package_count)
+        package = packagedb.models.Package.objects.all().first()
+        expected_purl_str = "pkg:cargo/[email protected]"
+        expected_download_url = "https://static.crates.io/crates/sam/sam-0.3.1.crate"
+        self.assertEqual(expected_purl_str, package.purl)
+        self.assertEqual(expected_download_url, package.download_url)

minecode/tests/miners/test_cargo.py

@@ -0,0 +1,43 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# purldb 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/aboutcode-org/purldb for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+
+import json
+import os
+
+from django.test import TestCase as DjangoTestCase
+
+from minecode import miners
+from minecode.tests import FIXTURES_REGEN
+from minecode.utils_test import JsonBasedTesting
+from packageurl import PackageURL
+
+
+class TestCargoMap(JsonBasedTesting, DjangoTestCase):
+    test_data_dir = os.path.join(
+        os.path.dirname(os.path.dirname(__file__)), "testfiles"
+    )
+
+    def test_build_packages_with_no_version(self):
+        with open(self.get_test_loc("cargo/sam.json")) as cargo_meta:
+            metadata = json.load(cargo_meta)
+        package_url = PackageURL.from_string("pkg:cargo/sam")
+        packages = miners.cargo.build_packages(metadata, package_url)
+        packages = [p.to_dict() for p in packages]
+        expected_loc = self.get_test_loc("cargo/expected-sam.json")
+        self.check_expected_results(packages, expected_loc, regen=FIXTURES_REGEN)
+
+    def test_build_packages_with_version(self):
+        with open(self.get_test_loc("cargo/sam.json")) as cargo_meta:
+            metadata = json.load(cargo_meta)
+        package_url = PackageURL.from_string("pkg:cargo/[email protected]")
+        packages = miners.cargo.build_packages(metadata, package_url)
+        packages = [p.to_dict() for p in packages]
+        expected_loc = self.get_test_loc("cargo/expected-sam-0.3.1.json")
+        self.check_expected_results(packages, expected_loc, regen=FIXTURES_REGEN)

minecode/tests/testfiles/cargo/expected-sam-0.3.1.json

@@ -0,0 +1,69 @@
+[
+  {
+    "type": "cargo",
+    "namespace": null,
+    "name": "sam",
+    "version": "0.3.1",
+    "qualifiers": {},
+    "subpath": null,
+    "primary_language": null,
+    "description": "A compile time instruction assembler.",
+    "release_date": null,
+    "parties": [],
+    "keywords": [],
+    "homepage_url": null,
+    "download_url": "https://static.crates.io/crates/sam/sam-0.3.1.crate",
+    "size": 3769,
+    "sha1": null,
+    "md5": null,
+    "sha256": "5fe15167489125b7403c9730d2c1a4c163466a327f7672444643259e8ad22178",
+    "sha512": null,
+    "bug_tracking_url": null,
+    "code_view_url": null,
+    "vcs_url": null,
+    "copyright": null,
+    "holder": null,
+    "declared_license_expression": "mit",
+    "declared_license_expression_spdx": "MIT",
+    "license_detections": [
+      {
+        "license_expression": "mit",
+        "license_expression_spdx": "MIT",
+        "matches": [
+          {
+            "license_expression": "mit",
+            "license_expression_spdx": "MIT",
+            "from_file": null,
+            "start_line": 1,
+            "end_line": 1,
+            "matcher": "1-spdx-id",
+            "score": 100,
+            "matched_length": 1,
+            "match_coverage": 100,
+            "rule_relevance": 100,
+            "rule_identifier": "spdx-license-identifier-mit-5da48780aba670b0860c46d899ed42a0f243ff06",
+            "rule_url": null,
+            "matched_text": "MIT"
+          }
+        ],
+        "identifier": "mit-a822f434-d61f-f2b1-c792-8b8cb9e7b9bf"
+      }
+    ],
+    "other_license_expression": null,
+    "other_license_expression_spdx": null,
+    "other_license_detections": [],
+    "extracted_license_statement": "- MIT\n",
+    "notice_text": null,
+    "source_packages": [],
+    "file_references": [],
+    "is_private": false,
+    "is_virtual": false,
+    "extra_data": {},
+    "dependencies": [],
+    "repository_homepage_url": "https://github.com/ioncodes/sam",
+    "repository_download_url": null,
+    "api_data_url": null,
+    "datasource_id": "cargo_api_metadata",
+    "purl": "pkg:cargo/[email protected]"
+  }
+]