Make the Dockerfile work #2554 #2762

The dockerfile is now updated with the latest approach and is tested to
work.

Reference: #2762
Reference: #2554
Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

.dockerignore

@@ -11,4 +11,16 @@ Dockerfile
 # Ignore other directories that are not required in the image
 tests/
 docs/
-samples/
+samples/
+venv/
+tmp/
+.cache/
+.pytest_cache/
+.settings/
+docs/
+build/
+dist/
+
+# generated files
+**/*.pyc
+src/licensedcode/data/cache/license_index/index_cache

Dockerfile

@@ -7,28 +7,43 @@
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
-FROM python:3.8-slim-buster 
+FROM --platform=linux/amd64 python:3.8-slim-buster
 
-# Requirements as per https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html
+# 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
+
+# OS requirements as per
+# https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html
 RUN apt-get update \
- && apt-get install -y bzip2 xz-utils zlib1g libxml2-dev libxslt1-dev libgomp1 libpopt0\
+ && apt-get install -y --no-install-recommends \
+       bzip2 \
+       xz-utils \
+       zlib1g \
+       libxml2-dev \
+       libxslt1-dev \
+       libgomp1 \
+       libsqlite3-0 \
+       libgcrypt20 \
+       libpopt0 \
+       libzstd1 \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 # Create directory for scancode sources
-RUN mkdir scancode-toolkit
+WORKDIR /scancode-toolkit
 
 # Copy sources into docker container
-COPY . scancode-toolkit
-
-# Set workdir
-WORKDIR scancode-toolkit
+COPY . /scancode-toolkit
 
-# Run scancode once for initial configuration, with --reindex-licenses to create the base license index
+# Run scancode once for initial configuration, with 
+# --reindex-licenses to create the base license index
 RUN ./scancode --reindex-licenses
 
 # Add scancode to path
-ENV PATH=$HOME/scancode-toolkit:$PATH
+ENV PATH=/scancode-toolkit:$PATH
 
-# Set entrypoint to be the scancode command, allows to run the generated docker image directly with the scancode arguments: `docker run (...) <containername> <scancode arguments>`
+# Set entrypoint to be the scancode command, allows to run the generated docker
+# image directly with the scancode arguments: `docker run (...) <containername> <scancode arguments>`
 ENTRYPOINT ["./scancode"]

docs/source/getting-started/install.rst

@@ -54,7 +54,7 @@ System Requirements
     #. Mac: on recent x86 64-bit macOS (10.15 and up, including 11 and 12),
        Use the X86 emulation mode on Apple ARM M1 CPUs.
     #. Windows: on Windows 10 and up,
-    #. FreeBSD,
+    #. FreeBSD.
 
 
 .. _install_prerequisites:
@@ -98,7 +98,6 @@ ScanCode needs a Python 3.7+ interpreter; We support all Python versions from
     Alternativelu you can download and install Python 3.8 from https://www.python.org/
 
 
-
 - **On Windows**:
 
     Download and install Python 3.8 from https://www.python.org/
@@ -230,20 +229,17 @@ The prerequisite is a working `docker installation <https://docs.docker.com/engi
 Download the ScanCode-Toolkit Source Code
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- Either download the Source Code for one of the releases ( :ref:`app_install` )
-  and unzip it.
-- Or ``git clone https://github.com/nexB/scancode-toolkit`` to get the latest
-  ( :ref:`source_code_install` ) Source Code.
+- ``git clone https://github.com/nexB/scancode-toolkit`` to get the latest
+  ( :ref:`source_code_install` ) source code.
 
 
 Build the Docker image
 ^^^^^^^^^^^^^^^^^^^^^^
 
-The ``docker build`` command needs to run in the directory of the source code,
-make sure to ``cd`` into the correct directory.::
+Run the ``docker build`` source code checkout directory.::
 
     cd scancode-toolkit
-    docker build -t scancode-toolkit .
+    docker build --tag scancode-toolkit --tag scancode-toolkit:$(git describe --tags) .
 
 
 Run using Docker
@@ -255,9 +251,10 @@ Display help::
 
     docker run scancode-toolkit --help
 
-Mount current working directory and run scan on this mounted folder::
+Mount current working directory as "/project" and run a scan on a file name apache-2.0.LICENSE directory.
+The JSON results will be in scan-result.json::
 
-    docker run -v $PWD/:/project scancode-toolkit -clipeu --json-pp /project/result.json /project
+    docker run -v $PWD/:/project scancode-toolkit -clipeu --json-pp /project/scan-result.json /project/apache-2.0.LICENSE
 
 This will mount your current working from the host into ``/project`` in the container
 and then scan the contents. The output ``result.json`` will be written back to your