Merge pull request #2265 from daniel-eder/feature/dockerfile

Add Dockerfile to build docker image from ScanCode sources

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

.dockerignore

@@ -0,0 +1,14 @@
+# Ignore the Docker files themselves to avoid that all layers are invalidated if the Docker files are changed during development.
+.dockerignore
+Dockerfile
+
+# Ignore the Git directory and files and github directory.
+.git/
+.github/
+.gitattributes
+.gitignore 
+
+# Ignore other directories that are not required in the image
+tests/
+docs/
+samples/

AUTHORS.rst

@@ -21,4 +21,4 @@ The following organizations or individuals have contributed to ScanCode:
 - Gaurang Rao @Gaupeng
 - Tushar Goel @TG1999
 - Richard Menzies @WizardOhio24
-
+- Daniel Eder @daniel-eder

CHANGELOG.rst

@@ -8,7 +8,7 @@ v3.2.2rc3 (2020-09-21)
 Internal code changes:
 
  - Ensure commoncode ccan become a standalone package #2233
- - 
+ - Add Dockerfile to build docker image from ScanCode sources #2265
 
 
 v3.2.1rc2 (2020-09-11)

Dockerfile

@@ -0,0 +1,46 @@
+#
+# Copyright (c) 2018 nexB Inc. and others. All rights reserved.
+# http://nexb.com and https://github.com/nexB/scancode-toolkit/
+# The ScanCode software is licensed under the Apache License version 2.0.
+# Data generated with ScanCode require an acknowledgment.
+# 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.
+#
+# When you publish or redistribute any data created with ScanCode or any ScanCode
+# derivative work, you must accompany this data with the following acknowledgment:
+#
+#  Generated with ScanCode and provided on an "AS IS" BASIS, WITHOUT WARRANTIES
+#  OR CONDITIONS OF ANY KIND, either express or implied. No content created from
+#  ScanCode should be considered or used as legal advice. Consult an Attorney
+#  for any legal advice.
+#  ScanCode is a free software code scanning tool from nexB Inc. and others.
+#  Visit https://github.com/nexB/scancode-toolkit/ for support and download.
+
+FROM python:3.6 
+
+# Requirements as per https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html
+RUN apt-get update && apt-get install bzip2 xz-utils zlib1g libxml2-dev libxslt1-dev
+
+# Create directory for scancode sources
+RUN mkdir scancode-toolkit
+
+# Copy sources into docker container
+COPY . scancode-toolkit
+
+# Set workdir
+WORKDIR scancode-toolkit
+
+# 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
+
+# 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"]

README.rst

@@ -94,6 +94,7 @@ refers to installing the required Python interpreter (Python 3.6 is recommended)
 There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
 
 - `Installation as an Application: Downloading Releases <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_ *(Recommended)*
+- `Installation via Docker: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker>`_
 - `Installation from Source Code: Git Clone <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
 - `Installation as a library: via pip <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
 

docs/source/getting-started/install.rst

@@ -1,14 +1,20 @@
 Comprehensive Installation
 ==========================
 
-There are 3 main ways you can install ScanCode.
+There are 4 main ways you can install ScanCode.
 
 - :ref:`app_install`
 
     The recommended method for installing ScanCode is Downloading the latest release as an
     application and then configure and use directly. This is easy because no knowledge of pip/git
     or other developer tools is necessary.
 
+- :ref:`docker_install`
+
+    An alternative to installing the latest Scancode Toolkit release natively is to build
+    a Docker image from the included Dockerfile. This is easy because the only prerequisite
+    is a working Docker installation.
+
 - :ref:`source_code_install`
 
     You can download/clone the source code repository via git/GitHub and then run a configure script
@@ -234,6 +240,51 @@ Un-installation
 
 ----
 
+.. _docker_install:
+
+Installation via Docker:
+------------------------
+
+You can install Scancode Toolkit by building a Docker image from the included Dockerfile.
+
+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 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.
+
+    cd scancode-toolkit
+    docker build -t scancode-toolkit .
+
+Run using Docker
+^^^^^^^^^^^^^^^^
+
+The docker image will forward all arguments it receives directly to the ``scancode`` command.
+
+Display help:
+
+    docker run scancode-toolkit --help
+
+Mount current working directory and run scan on mounted folder:
+
+    docker run -v $PWD/:/project scancode-toolkit -clpeui --json-pp /project/result.json /project
+
+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
+corrent working directory on the host.
+
+Note that the parameters *before* ``scancode-toolkit`` are used for docker,
+those after will be forwarded to scancode.
+
+----
+
 .. _source_code_install:
 
 Installation from Source Code: Git Clone