Merge branch 'refs/heads/ossf_api_template' into scorecard_integration

scancodeio/settings.py

@@ -414,3 +414,7 @@
 MATCHCODEIO_USER = env.str("MATCHCODEIO_USER", default="")
 MATCHCODEIO_PASSWORD = env.str("MATCHCODEIO_PASSWORD", default="")
 MATCHCODEIO_API_KEY = env.str("MATCHCODEIO_API_KEY", default="")
+
+# OpenSSF ScoreCard Integration
+
+SCORECARD_URL = env.str('SCORECARD_URL', default="")

scanpipe/pipes/ScoreCode.py

@@ -0,0 +1,60 @@
+# 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.
+
+import logging
+
+from django.conf import settings
+
+import requests
+
+label = "ScoreCode"
+logger = logging.getLogger(__name__)
+session = requests.Session()
+
+
+# Only SCORECARD_URL can be provided through setting
+SCORECARD_API_URL = None
+SCORECARD_URL = settings.SCORECARD_URL
+if SCORECARD_URL:
+    SCORECARD_API_URL = f'{SCORECARD_URL.rstrip("/")}/projects/'
+
+
+def is_configured():
+    """Return True if the required Scorecard settings have been set."""
+    if SCORECARD_API_URL:
+        return True
+    return False
+
+
+def is_available():
+    """Return True if the configured Scorecard server is available."""
+    if not is_configured():
+        return False
+
+    try:
+        response = session.head(SCORECARD_API_URL)
+        response.raise_for_status()
+    except requests.exceptions.RequestException as request_exception:
+        logger.debug(f"{label} is_available() error: {request_exception}")
+        return False
+
+    return response.status_code == requests.codes.ok