separate ENTRYPOINT and CMD operations in Dockerfiles fixes #29

Author: newtmitch

Dockerfile.sonarscanner-3.0.3-alpine

@@ -23,6 +23,8 @@ COPY sonar-runner.properties /usr/lib/sonar-scanner/conf/sonar-scanner.propertie
 #   ensure Sonar uses the provided Java for musl instead of a borked glibc one
 RUN sed -i 's/use_embedded_jre=true/use_embedded_jre=false/g' /usr/lib/sonar-scanner/bin/sonar-scanner
 
-# Use bash if you want to run the environment from inside the shell, otherwise use the command that actually runs the underlying stuff
-#CMD /bin/bash
-CMD sonar-scanner -Dsonar.projectBaseDir=/usr/src
+# Separating ENTRYPOINT and CMD operations allows for core execution variables to
+# be easily overridden by passing them in as part of the `docker run` command.
+# This allows the default /usr/src base dir to be overridden by users as-needed.
+ENTRYPOINT ["sonar-scanner"] 
+CMD ["-Dsonar.projectBaseDir=/usr/src"]

Dockerfile.sonarscanner-3.0.3-full

@@ -25,6 +25,8 @@ ENV SONAR_RUNNER_HOME=/usr/lib/sonar-scanner
 
 COPY sonar-runner.properties /usr/lib/sonar-scanner/conf/sonar-scanner.properties
 
-# Use bash if you want to run the environment from inside the shell, otherwise use the command that actually runs the underlying stuff
-#CMD /bin/bash
-CMD sonar-scanner -Dsonar.projectBaseDir=/usr/src
+# Separating ENTRYPOINT and CMD operations allows for core execution variables to
+# be easily overridden by passing them in as part of the `docker run` command.
+# This allows the default /usr/src base dir to be overridden by users as-needed.
+ENTRYPOINT ["sonar-scanner"] 
+CMD ["-Dsonar.projectBaseDir=/usr/src"]

Dockerfile.sonarscanner-3.2.0-alpine

@@ -23,6 +23,8 @@ COPY sonar-runner.properties ./sonar-scanner/conf/sonar-scanner.properties
 #   ensure Sonar uses the provided Java for musl instead of a borked glibc one
 RUN sed -i 's/use_embedded_jre=true/use_embedded_jre=false/g' /usr/lib/sonar-scanner/bin/sonar-scanner
 
-# Use bash if you want to run the environment from inside the shell, otherwise use the command that actually runs the underlying stuff
-#CMD /bin/bash
-CMD sonar-scanner -Dsonar.projectBaseDir=/usr/src
+# Separating ENTRYPOINT and CMD operations allows for core execution variables to
+# be easily overridden by passing them in as part of the `docker run` command.
+# This allows the default /usr/src base dir to be overridden by users as-needed.
+ENTRYPOINT ["sonar-scanner"] 
+CMD ["-Dsonar.projectBaseDir=/usr/src"]

Dockerfile.sonarscanner-3.2.0-full

@@ -25,6 +25,8 @@ ENV SONAR_RUNNER_HOME=/usr/lib/sonar-scanner
 
 COPY sonar-runner.properties /usr/lib/sonar-scanner/conf/sonar-scanner.properties
 
-# Use bash if you want to run the environment from inside the shell, otherwise use the command that actually runs the underlying stuff
-#CMD /bin/bash
-CMD sonar-scanner -Dsonar.projectBaseDir=/usr/src
+# Separating ENTRYPOINT and CMD operations allows for core execution variables to
+# be easily overridden by passing them in as part of the `docker run` command.
+# This allows the default /usr/src base dir to be overridden by users as-needed.
+ENTRYPOINT ["sonar-scanner"] 
+CMD ["-Dsonar.projectBaseDir=/usr/src"]

Dockerfile.sonarscanner-3.3.0-alpine

@@ -23,6 +23,8 @@ COPY sonar-runner.properties /usr/lib/sonar-scanner/conf/sonar-scanner.propertie
 #   ensure Sonar uses the provided Java for musl instead of a borked glibc one
 RUN sed -i 's/use_embedded_jre=true/use_embedded_jre=false/g' /usr/lib/sonar-scanner/bin/sonar-scanner
 
-# Use bash if you want to run the environment from inside the shell, otherwise use the command that actually runs the underlying stuff
-#CMD /bin/bash
-CMD sonar-scanner -Dsonar.projectBaseDir=/usr/src
+# Separating ENTRYPOINT and CMD operations allows for core execution variables to
+# be easily overridden by passing them in as part of the `docker run` command.
+# This allows the default /usr/src base dir to be overridden by users as-needed.
+ENTRYPOINT ["sonar-scanner"] 
+CMD ["-Dsonar.projectBaseDir=/usr/src"]

Dockerfile.sonarscanner-3.3.0-full

@@ -25,6 +25,8 @@ ENV SONAR_RUNNER_HOME=/usr/lib/sonar-scanner
 
 COPY sonar-runner.properties /usr/lib/sonar-scanner/conf/sonar-scanner.properties
 
-# Use bash if you want to run the environment from inside the shell, otherwise use the command that actually runs the underlying stuff
-#CMD /bin/bash
-CMD sonar-scanner -Dsonar.projectBaseDir=/usr/src
+# Separating ENTRYPOINT and CMD operations allows for core execution variables to
+# be easily overridden by passing them in as part of the `docker run` command.
+# This allows the default /usr/src base dir to be overridden by users as-needed.
+ENTRYPOINT ["sonar-scanner"] 
+CMD ["-Dsonar.projectBaseDir=/usr/src"]

README.md

@@ -46,6 +46,9 @@ docker run -ti -v $(pwd):/usr/src newtmitch/sonar-scanner
 
 # Change Log
 
+### 2019-05-16
+* Separated Dockerfile command into ENTRYPOINT and CMD operations to better follow Dockerfile best practices (see https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#entrypoint). (issue #29)
+
 ### 2019-05-13
 * Commented out `sonar.exclusions` from the `sonar-runner.properties` file included in the image by default (issue #25)
 * Removed the use of the `/root` directory as part of the image build. Using `/usr/lib`, `/usr/bin`, and `/usr/src` now (issue #26)
@@ -105,6 +108,11 @@ Replace "$(pwd)" with the absolute path of the top-level source directly you're
 interested in if you're not running the docker image from the top level project
 directory. It will scan everything under that directory when it starts up.
 
+If you need to use a different directory as the project base directory, you can 
+pass that in as part of the docker run command to override that default:
+
+    docker run -ti -v $(pwd):/usr/src --link sonarqube newtmitch/sonar-scanner -Dsonar.projectBaseDir=/my/project/base/dir
+
 The supplied sonar-runner.properties file points to http://192.168.99.100 as the
 Qube server. If you need to change that or any other of the variables that Scanner needs to run, you can pass them in with the command itself to override them: