Align configuration with SCIO

pombredanne · pombredanne · commit 496f7f3630f2 · 2022-04-07T15:00:32.000+02:00
Also bump version. Use Djnago settings by default.

Signed-off-by: Philippe Ombredanne &lt;pombredanne@nexb.com&gt;
diff --git a/.dockerignore b/.dockerignore
@@ -1,4 +1,27 @@
-.git
-.github
-
-venv
+**/.git
+**/.gitignore
+**/.github
+**/.vscode
+**/.idea
+**/coverage
+**/.aws
+**/.ssh
+**/.DS_Store
+**/.aof
+**/venv
+**/env
+**/bin
+**/docs
+**/dist
+**/etc
+**/lib
+**/var
+**/*.egg-info
+.dockerignore
+.readthedocs.yaml
+docker.env
+CHANGELOG.rst
+Dockerfile
+README.rst
+docker-compose.yml
+pyvenv.cfg
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,6 @@ __pycache__/
 build/
 develop-eggs/
 dist/
-downloads/
 eggs/
 .eggs/
 lib/
@@ -24,26 +23,20 @@ wheels/
 .installed.cfg
 *.egg
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
 
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
+pip-selfcheck.json
 
 # Unit test / coverage reports
 htmlcov/
 .tox/
 .coverage
 .coverage.*
 .cache
-nosetests.xml
 coverage.xml
 *.cover
-.hypothesis/
 
 # Translations
 *.mo
@@ -53,13 +46,6 @@ coverage.xml
 *.log
 local_settings.py
 
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
 # Sphinx documentation
 docs/_build/
 
@@ -69,17 +55,10 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# pyenv
+# pyenv and pip
 .python-version
 pyvenv.cfg
 bin/
-pip-selfcheck.json
-
-# celery beat schedule file
-celerybeat-schedule
-
-# SageMath parsed files
-*.sage.py
 
 # Environments
 .env
@@ -88,21 +67,10 @@ env/
 venv/
 ENV/
 
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
 
 # mypy
 .mypy_cache/
 
-# PyCharm
-.idea/
 
 # Database
 *.sqlite3*
@@ -118,13 +86,13 @@ share
 Pipfile
 
 # editors
-.vscode/
+.vscode
+# PyCharm
+.idea/
 
 # pytest
 .pytest_cache
 
-# VSCode
-.vscode
 
 # Various junk and temp files
 .DS_Store
diff --git a/Dockerfile b/Dockerfile
@@ -1,11 +1,25 @@
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# VulnerableCode is a trademark of nexB Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# See https://github.com/nexB/vulnerablecode for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects
+
 FROM python:3.8
 
-# Force unbuffered stdout and stderr (i.e. they are flushed to terminal immediately)
+
+WORKDIR /app
+
+# 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
+
+RUN mkdir -p /var/vulnerablecode/static
+
+# Keep the dependencies installation before the COPY of the app/ for proper caching
+COPY setup.cfg setup.py requirements.txt pyproject.toml /app/
+RUN pip install .
 
-RUN mkdir /opt/vulnerablecode && \
-    mkdir -p /var/vulnerablecode/static/
-WORKDIR /opt/vulnerablecode
-COPY . .
-RUN python -m pip install --upgrade pip && \
-    pip install -r requirements.txt
+COPY . /app
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,41 +1,45 @@
-version: '3'
+version: "3"
 
 services:
   db:
-    image: postgres
+    image: postgres:13
     env_file:
       - docker.env
     volumes:
       - db_data:/var/lib/postgresql/data/
 
-  vulnerablecode:
+  web:
     build: .
     command: /bin/sh -c "
-      ./manage.py migrate &&
-      ./manage.py collectstatic --no-input --clear &&
-      gunicorn vulnerablecode.wsgi:application -u nobody -g nogroup --bind :8000 --timeout 600 --workers 2"
+        ./manage.py migrate &&
+        ./manage.py collectstatic --no-input --verbosity 0 --clear &&
+        gunicorn vulnerablecode.wsgi:application -u nobody -g nogroup --bind :8000 --timeout 600 --workers 8"
     env_file:
       - docker.env
+    expose:
+      - 8000
     volumes:
+      - /etc/vulnerablecode/:/etc/vulnerablecode/
       - static:/var/vulnerablecode/static/
     restart: on-failure
     depends_on:
       - db
 
   nginx:
     image: nginx
+    ports:
+      - 80:80
+      - 443:443
     env_file:
       - docker.env
     volumes:
+      - ./etc/nginx/conf.d/:/etc/nginx/conf.d/
       - static:/var/vulnerablecode/static/
-      - ./etc/nginx/templates/:/etc/nginx/templates/
-    ports:
-      - ${NGINX_PORT:-8000}:80
     depends_on:
-      - vulnerablecode
+      - web
 
 
 volumes:
-  static:
   db_data:
+  static:
 
diff --git a/docker.env b/docker.env
@@ -2,8 +2,5 @@ POSTGRES_DB=vulnerablecode
 POSTGRES_USER=vulnerablecode
 POSTGRES_PASSWORD=vulnerablecode
 
-DJANGO_SETTINGS_MODULE=vulnerablecode.settings
 VULNERABLECODE_DB_HOST=db
 VULNERABLECODE_STATIC_ROOT=/var/vulnerablecode/static/
-
-GUNICORN_SERVER=vulnerablecode
diff --git a/etc/nginx/conf.d/default.conf b/etc/nginx/conf.d/default.conf
@@ -1,5 +1,5 @@
 upstream gunicorn_app {
-    server vulnerablecode:8000;
+    server web:8000;
 }
 
 server {
diff --git a/vulnerablecode/__init__.py b/vulnerablecode/__init__.py
@@ -0,0 +1,39 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# http://nexb.com and https://github.com/nexB/vulnerablecode/
+# The VulnerableCode software is licensed under the Apache License version 2.0.
+# Data generated with VulnerableCode require an acknowledgment.
+#
+# 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.
+#
+# When you publish or redistribute any data created with VulnerableCode or any VulnerableCode
+# derivative work, you must accompany this data with the following acknowledgment:
+#
+#  Generated with VulnerableCode and provided on an 'AS IS' BASIS, WITHOUT WARRANTIES
+#  OR CONDITIONS OF ANY KIND, either express or implied. No content created from
+#  VulnerableCode should be considered or used as legal advice. Consult an Attorney
+#  for any legal advice.
+#  VulnerableCode is a free software from nexB Inc. and others.
+#  Visit https://github.com/nexB/vulnerablecode/ for support and download.
+
+import os
+import sys
+import warnings
+from pathlib import Path
+
+__version__ = "30.0.0"
+
+
+def command_line():
+    """
+    Command line entry point.
+    """
+    from django.core.management import execute_from_command_line
+
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "vulnerablecode.settings")
+    execute_from_command_line(sys.argv)
diff --git a/vulnerablecode/wsgi.py b/vulnerablecode/wsgi.py
@@ -1,10 +1,33 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# http://nexb.com and https://github.com/nexB/vulnerablecode/
+# The VulnerableCode software is licensed under the Apache License version 2.0.
+# Data generated with VulnerableCode require an acknowledgment.
+#
+# 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.
+#
+# When you publish or redistribute any data created with VulnerableCode or any VulnerableCode
+# derivative work, you must accompany this data with the following acknowledgment:
+#
+#  Generated with VulnerableCode and provided on an 'AS IS' BASIS, WITHOUT WARRANTIES
+#  OR CONDITIONS OF ANY KIND, either express or implied. No content created from
+#  VulnerableCode should be considered or used as legal advice. Consult an Attorney
+#  for any legal advice.
+#  VulnerableCode is a free software from nexB Inc. and others.
+#  Visit https://github.com/nexB/vulnerablecode/ for support and download.
+
 """
-WSGI config for hola project.
+WSGI config for VulnerableCode project.
 
 It exposes the WSGI callable as a module-level variable named ``application``.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/
+https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/
 """
 
 import os

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`upstream gunicorn_app {`
`2`		`- server vulnerablecode:8000;`
	`2`	`+ server web:8000;`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`server {`