feat: allow passing CLI args to Python app

Author: David-Lor

Dockerfile

@@ -18,7 +18,8 @@ USER ${USERNAME}
 WORKDIR /home/${USERNAME}
 
 # Copy scripts
-COPY scripts/* ./scripts/
+COPY --chown=${USERNAME}:${USERNAME} scripts/* ./scripts/
+RUN chmod +x ./scripts/entrypoint.sh
 
 # Run entrypoint as default command
-CMD ["sh", "scripts/entrypoint.sh"]
+ENTRYPOINT ["./scripts/entrypoint.sh"]

README.md

@@ -50,6 +50,13 @@ docker run -it --rm -e GIT_REPOSITORY="https://github.com/David-Lor/Python-Hello
 Only required variable is (ENV) `GIT_REPOSITORY`.
 The variables marked with (ARG) are [build-args](https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg), used on image build.
 
+If your Python script/app is CLI-based and requires to be called with arguments (for example `python . worker --instances=10`), you can provide them as Docker command arguments, like following:
+
+```bash
+docker run -it --rm -e GIT_REPOSITORY="https://github.com/David-Lor/Python-HelloWorld.git" -e GIT_BRANCH="args" davidlor/python-git-app worker --instances=10
+# This command will clone an existing branch on the example repository, and print out the custom commands provided
+```
+
 ## Available tags
 
 - The tags available for the image are a limited selection of tags used in base images, such as the [official Python images](https://hub.docker.com/_/python/).

scripts/entrypoint.sh

@@ -3,4 +3,4 @@
 set -ex
 
 python -u ~/scripts/setup_app.py
-python -u ${APP_NAME}
+python -u "$APP_NAME" "$@"

scripts/setup_app.py

@@ -25,10 +25,10 @@ def __init__(self):
         self.app_dir = self.join_home(self.app_name)
         self.requirements_file = self.join_app(self.REQUIREMENTS_FILENAME)
         self.git_branch = os.getenv("GIT_BRANCH")
-    
+
     def join_home(self, path):
         return os.path.join(self.base_dir, path)
-    
+
     def join_app(self, path):
         return os.path.join(self.app_dir, path)
 

tools/tests/test_build.py

@@ -3,59 +3,44 @@
 
 
 class TestBuild(BaseTest):
-    """Test building the image
-    """
+    """Test building the image"""
 
     def test_build_default(self):
-        """Test building the image with default parameters, then running the container, thus running the app
-        """
+        """Test building the image with default parameters, then running the container, thus running the app"""
         image, output = self.build_image()
         assert image in output
 
         output = self.run_container(image=image)
         assert OUTPUT_SUCCESS in output
 
     def test_build_username(self):
-        """Test building the image changing the username
-        """
+        """Test building the image changing the username"""
         image, output = self.build_image(user=USERNAME)
         assert image in output
 
-        output = self.run_container(image=image, final_args=["pwd"])
+        output = self.run_container(image=image, args=["--entrypoint", "pwd"])
         assert "/home/{}".format(USERNAME) in output
 
     def test_build_from_alpine(self):
-        """Test building the image using the 'python:alpine' base image
-        """
+        """Test building the image using the 'python:alpine' base image"""
         image, output = self.build_image(from_image="python:alpine")
         assert image in output
 
         output = self.run_container(image=image, args=["--entrypoint", "which"], final_args=["apk"])
         assert "/sbin/apk" in output
 
-    def test_build_from_python27(self):
-        """Test building the image using the 'python:2.7-alpine' base image
-        """
-        image, output = self.build_image(from_image="python:2.7-alpine")
-        assert image in output
-
-        output = self.run_container(image=image, final_args=["python", "-V"])
-        assert output.startswith("Python 2.7")
-
     def test_build_from_pyston(self):
-        """Test building the image using the 'pyston/pyston' base image
-        """
+        """Test building the image using the 'pyston/pyston' base image"""
         image, output = self.build_image(from_image="pyston/pyston")
         assert image in output
 
-        output = self.run_container(image=image, final_args=["python", "-V"])
+        output = self.run_container(image=image, args=["--entrypoint", "python"], final_args=["-V"])
         assert "[Pyston " in output
 
     def test_build_from_pypy(self):
-        """Test building the image using the 'pypy' base image
-        """
+        """Test building the image using the 'pypy' base image"""
         image, output = self.build_image(from_image="pypy")
         assert image in output
 
-        output = self.run_container(image=image, final_args=["python", "-V"])
+        output = self.run_container(image=image, args=["--entrypoint", "python"], final_args=["-V"])
         assert "[PyPy " in output

tools/tests/test_clone.py

@@ -3,31 +3,32 @@
 
 
 class TestClone(BaseTest):
-    """Test the repository cloning, thus running the app
-    """
+    """Test the repository cloning, thus running the app"""
 
     def test_clone_existing_repository(self):
-        """Test cloning from an existing repository
-        """
+        """Test cloning from an existing repository"""
         output = self.run_container()
         assert OUTPUT_SUCCESS in output
 
     def test_clone_unexisting_repository(self):
-        """Test cloning from a repository that does not exist
-        """
+        """Test cloning from a repository that does not exist"""
         output = self.run_container(repository=UNEXISTING_REPOSITORY)
         assert GIT_CLONE_FAILED_ERROR in output
 
     def test_clone_existing_branch_fail_pip_install(self):
         """Test cloning from an existing repository, an existing branch
-        (the requirements-fail branch, that will fail pip install)
-        """
+        (the requirements-fail branch, that will fail pip install)"""
         # TODO Create another branch on Python-HelloWorld repository that won't fail but output something different
         output = self.run_container(branch=REQUIREMENTS_FAIL_BRANCH)
         assert PIP_INSTALL_FAILED_ERROR in output
 
     def test_clone_unexisting_branch(self):
-        """Test cloning from an existing repository, a branch that does not exist
-        """
+        """Test cloning from an existing repository, a branch that does not exist"""
         output = self.run_container(branch="non-existing-branch")
         assert GIT_CLONE_FAILED_ERROR in output
+
+    def test_clone_run_args(self):
+        """Test cloning from an existing repository, using custom args when running the Python app"""
+        args = ["--foo", "bar", "-baz", "0"]
+        output = self.run_container(branch="args", final_args=args)
+        assert f"Called with args: {str(args)}" in output