populate_purldb.py

# SPDX-License-Identifier: Apache-2.0
#
# http://nexb.com and https://github.com/nexB/scancode.io
# The ScanCode.io software is licensed under the Apache License version 2.0.
# Data generated with ScanCode.io is provided as-is without warranties.
# ScanCode is a trademark of nexB Inc.
#
# You may not use this software except in compliance with the License.
# You may obtain a copy of the License at: http://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.
#
# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES
# OR CONDITIONS OF ANY KIND, either express or implied. No content created from
# ScanCode.io should be considered or used as legal advice. Consult an Attorney
# for any legal advice.
#
# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
# Visit https://github.com/nexB/scancode.io for support and download.

from scanpipe.pipelines import Pipeline
from scanpipe.pipes import purldb
from scanpipe.pipes import scancode


class PopulatePurlDB(Pipeline):
    """Populate PurlDB with project discovered packages and dependencies."""

    @classmethod
    def steps(cls):
        return (
            cls.populate_purldb_with_discovered_packages,
            cls.populate_purldb_with_discovered_dependencies,
            cls.populate_purldb_with_detected_purls,
        )

    def populate_purldb_with_discovered_packages(self):
        """Add DiscoveredPackage to PurlDB."""
        purldb.populate_purldb_with_discovered_packages(
            project=self.project, logger=self.log
        )

    def populate_purldb_with_discovered_dependencies(self):
        """Add DiscoveredDependency to PurlDB."""
        purldb.populate_purldb_with_discovered_dependencies(
            project=self.project, logger=self.log
        )

    def populate_purldb_with_detected_purls(self):
        """Add DiscoveredPackage to PurlDB."""
        no_packages_and_no_dependencies = all(
            [
                not self.project.discoveredpackages.exists(),
                not self.project.discovereddependencies.exists(),
            ]
        )
        # Even when there are no packages/dependencies, resource level
        # package data could be detected (i.e. when we detect packages,
        # but skip the assembly step that creates
        # package/dependency instances)
        if no_packages_and_no_dependencies:
            packages = scancode.get_packages_with_purl_from_resources(self.project)
            purls = [{"purl": package.purl} for package in packages]

            self.log(f"Populating PurlDB with {len(purls):,d} " "detected PURLs"),
            purldb.feed_purldb(
                packages=purls,
                chunk_size=100,
                logger=self.log,
            )