Merge branch 'main' of https://github.com/nexB/federatedcode into main

Author: pombredanne

Dockerfile

@@ -6,18 +6,32 @@
 # See https://github.com/nexB/federatedcode for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
-FROM python:3.10
+
+FROM python:3.10-slim
+
+ENV APP_NAME federatedcode
+ENV APP_DIR /opt/$APP_NAME
+
 # Python settings: Force unbuffered stdout and stderr (i.e. they are flushed to terminal immediately)
 ENV PYTHONUNBUFFERED 1
 # Python settings: do not write pyc files
 ENV PYTHONDONTWRITEBYTECODE 1
+# Add the app dir in the Python path for entry points availability
+ENV PYTHONPATH $PYTHONPATH:$APP_DIR
 
-RUN pip install --upgrade pip
+RUN apt-get update \
+ && apt-get install -y --no-install-recommends \
+    wait-for-it \
+    git \
+ && apt-get clean \
+ && rm -rf /tmp/* /var/tmp/*
 
-WORKDIR /federatedcode
+WORKDIR $APP_DIR
 
-COPY requirements.txt pyproject.toml /federatedcode/
+RUN mkdir -p /var/$APP_NAME/static/
 
-RUN pip install -r requirements.txt
+# Keep the dependencies installation before the COPY of the app/ for proper caching
+COPY setup.cfg setup.py requirements.txt pyproject.toml $APP_DIR/
+RUN pip install . -c requirements.txt
 
-COPY . /federatedcode
+COPY . $APP_DIR

README.rst

@@ -9,10 +9,28 @@ security information.
 Quick Installation
 --------------------
 
+Run with Docker
+~~~~~~~~~~~~~~~
+
+
+Clone FederatedCode::
+
+    git clone https://github.com/aboutcode-org/federatedcode.git
+    cd federatedcode
+
+Build and run::
+
+    docker compose build
+    docker compose up
+
+
+Local development installation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 On a Debian system, use this::
 
     sudo apt-get install python3-venv python3-dev postgresql libpq-dev build-essential
-    git clone https://github.com/nexB/federatedcode.git
+    git clone https://github.com/aboutcode-org/federatedcode.git
     cd federatedcode
     make dev envfile postgresdb
     make test
@@ -164,9 +182,3 @@ funding is made available by the Swiss State Secretariat for Education, Research
     :target: https://nlnet.nl/discovery/
     :height: 40
     :alt: NGI Discovery logo
-
-
-
-
-
-

aboutcode/federatedcode/README.rst

@@ -0,0 +1,35 @@
+=======================
+aboutcode.federatedcode
+=======================
+
+|license| |build|
+
+.. |license| image:: https://img.shields.io/badge/License-Apache--2.0-blue.svg?style=for-the-badge
+    :target: https://opensource.org/licenses/Apache-2.0
+
+.. |build| image:: https://img.shields.io/github/actions/workflow/status/aboutcode-org/federatedcode/main.yml?style=for-the-badge&logo=github
+
+This is a library of FederatedCode client utilities to fetch and subscribe package metadata.
+
+
+License
+=======
+
+Copyright (c) nexB Inc. and others. All rights reserved.
+
+SPDX-License-Identifier: Apache-2.0
+
+See https://aboutcode.org for more information about AboutCode OSS projects.
+
+.. code-block:: none
+
+    You may not use this software 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.

aboutcode/federatedcode/client/__init__.py

@@ -0,0 +1,59 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# FederatedCode 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/federatedcode for support or download.
+# See https://aboutcode.org for more information about AboutCode.org OSS projects.
+#
+
+import os
+from typing import Union
+from urllib.parse import urljoin
+
+import requests
+from aboutcode.hashid import get_package_base_dir
+from dotenv import load_dotenv
+from packageurl import PackageURL
+
+load_dotenv()
+
+FEDERATEDCODE_GITHUB_ACCOUNT_NAME = os.getenv("FEDERATEDCODE_GITHUB_ACCOUNT_NAME")
+
+
+class ScanNotAvailableError(Exception):
+    pass
+
+
+def get_package_scan(purl: Union[PackageURL, str]):
+    """Return the package scan result for a PURL from the FederatedCode Git repository."""
+
+    if not FEDERATEDCODE_GITHUB_ACCOUNT_NAME:
+        raise ValueError("Provide ``FEDERATEDCODE_GITHUB_ACCOUNT_NAME`` in .env file.")
+
+    if isinstance(purl, str):
+        purl = PackageURL.from_string(purl)
+
+    if not purl.version:
+        raise ValueError("Missing version in PURL.")
+
+    package_path = get_package_base_dir(purl=purl)
+    package_path_parts = package_path.parts
+
+    repo_name = f"{package_path_parts[0]}/refs/heads/main"
+    package_dir_path = "/".join(package_path_parts[1:])
+    version = purl.version
+    file_name = "scancodeio.json"
+
+    url_parts = [FEDERATEDCODE_GITHUB_ACCOUNT_NAME, repo_name, package_dir_path, version, file_name]
+
+    file_url = urljoin("https://raw.githubusercontent.com", "/".join(url_parts))
+
+    try:
+        response = requests.get(file_url)
+        response.raise_for_status()
+        return response.json()
+    except requests.exceptions.HTTPError as err:
+        if response.status_code == 404:
+            raise ScanNotAvailableError(f"No scan available for {purl!s}")
+        raise err

docker-compose.yml

@@ -1,43 +1,45 @@
 version: '3'
 
 services:
-  federatedcode_db:
-    image: postgres:16
+  db:
+    image: postgres:13
     env_file:
       - docker.env
     volumes:
-      - federatedcode_db_data:/var/lib/postgresql/data/
+      - db_data:/var/lib/postgresql/data/
 
-  federatedcode:
+  web:
     build: .
-    command: /bin/sh -c "
-      apt-get update && apt-get install -y gunicorn &&   
-      python manage.py collectstatic --no-input --verbosity 0 --clear &&
-      python manage.py migrate &&
-      gunicorn federatedcode.wsgi:application -u nobody -g nogroup --bind :8000 --timeout 600 --workers 8"
+    command: wait-for-it --strict --timeout=60 db:5432 -- sh -c "
+        ./manage.py migrate &&
+        ./manage.py collectstatic --no-input --verbosity 0 --clear &&
+        gunicorn federatedcode.wsgi:application --bind :8000 --timeout 600 --workers 8"
     env_file:
       - docker.env
     expose:
       - 8000
-    ports:
-      - "8000:8000"
     volumes:
-      - static:/var/federatedcode/static/
       - /etc/federatedcode/:/etc/federatedcode/
+      - static:/var/federatedcode/static/
+      - workspace:/var/federatedcode/workspace/
     depends_on:
-      - federatedcode_db
+      - db
 
-  federatedcode_nginx:
+  nginx:
     image: nginx
+    ports:
+      - 80:80
+      - 443:443
     env_file:
       - docker.env
     volumes:
-      - ./etc/nginx/conf.d/:/etc/nginx/conf.d
+      - ./etc/nginx/conf.d/:/etc/nginx/conf.d/
+      - static:/var/federatedcode/static/
+      - /var/www/html:/var/www/html
     depends_on:
-      - federatedcode
+      - web
 
 volumes:
-  federatedcode_db_data:
-  federatedcode_static:
-  federatedcode:
-
+  db_data:
+  static:
+  workspace:

docker.env

@@ -1,4 +1,10 @@
-FEDERATEDCODE_WORKSPACE_LOCATION=/var/federatedcode
+POSTGRES_DB=federatedcode
+POSTGRES_USER=federatedcode
+POSTGRES_PASSWORD=federatedcode
+
+FEDERATEDCODE_DB_HOST=db
+FEDERATEDCODE_STATIC_ROOT=/var/federatedcode/static/
+
+FEDERATEDCODE_WORKSPACE_LOCATION=/var/federatedcode/workspace/
 FEDERATEDCODE_CLIENT_ID=""
 FEDERATEDCODE_CLIENT_SECRET=""
-NGINX_PORT=8080

docs/source/conf.py

@@ -16,7 +16,9 @@
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "federatedcode.settings")
 os.environ.setdefault("SECRET_KEY", "dummy secret key for autodoc rtd documentation")
 os.environ.setdefault("FEDERATEDCODE_CLIENT_ID", "dummy secret key for autodoc rtd documentation")
-os.environ.setdefault("FEDERATEDCODE_CLIENT_SECRET", "dummy secret key for autodoc rtd documentation")
+os.environ.setdefault(
+    "FEDERATEDCODE_CLIENT_SECRET", "dummy secret key for autodoc rtd documentation"
+)
 
 sys.path.insert(0, os.path.abspath("../../."))