Fix Docker integration test

Also:

- Create scripts/ folder to keep the scripts together
- Update make clean target

Author: strboul

.github/workflows/CI.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Get versions
         id: versions
         run: |
-          py_version="$(./get_version.sh __py_version__)"
+          py_version="$(./scripts/get_version.sh __py_version__)"
           echo "::set-output name=py_version::$py_version"
 
   pre_commit:

.github/workflows/integration.yml

@@ -20,8 +20,7 @@ jobs:
 
       - name: Docker container can be run
         run: |
-          ./tests/generate_test_repos.sh && \
-            docker run --rm -t \
-              -v "$(pwd)":/"$(pwd)" \
-              -w "$(pwd)" strboul/git-substatus:test \
-              tests/generated-test-proj-dir
+          docker run --rm \
+            -v "$(pwd)/scripts/docker_test_entrypoint.sh:/docker_test_entrypoint.sh" \
+            --entrypoint "/docker_test_entrypoint.sh" \
+            strboul/git-substatus:test

.github/workflows/release.yml

@@ -22,8 +22,8 @@ jobs:
     - name: Get versions
       id: versions
       run: |
-        version="$(./get_version.sh __version__)"
-        py_version="$(./get_version.sh __py_version__)"
+        version="$(./scripts/get_version.sh __version__)"
+        py_version="$(./scripts/get_version.sh __py_version__)"
         # check the tag ref is the same as package version:
         if [ "v${version}" != "$tag_ref" ]; then
           echo "::error ::fatal! version not matching with tag"
@@ -59,7 +59,7 @@ jobs:
         python -m build --sdist --wheel --outdir dist/
 
     - name: Publish to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1.5.1
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         password: ${{ secrets.PYPI_API_TOKEN }}
 

Dockerfile

@@ -8,7 +8,8 @@ RUN apk add --update --no-cache --no-progress git
 
 ARG INSTALL_PATH="/opt/git-substatus/"
 RUN mkdir -p "$INSTALL_PATH"
-COPY setup.py README.md get_version.sh "$INSTALL_PATH"
+COPY setup.py README.md "$INSTALL_PATH"
+COPY scripts/ "$INSTALL_PATH"/scripts
 COPY git_substatus/ "$INSTALL_PATH"/git_substatus
 RUN cd "$INSTALL_PATH" && \
   python -m pip install --upgrade pip .

Makefile

@@ -13,8 +13,8 @@ define ask_prompt
 endef
 
 
-VERSION := $(shell ./get_version.sh __version__)
-PY_VERSION := $(shell ./get_version.sh __py_version__)
+VERSION := $(shell ./scripts/get_version.sh __version__)
+PY_VERSION := $(shell ./scripts/get_version.sh __py_version__)
 
 
 all: typecheck black test install docker-build clean
@@ -33,7 +33,7 @@ coverage: gentest runcoverage clean
 
 gentest:
 	$(call echo_section,"generate test repos")
-	./tests/generate_test_repos.sh
+	./scripts/generate_test_repos.sh
 
 
 unittest:
@@ -67,11 +67,15 @@ black-apply:
 
 clean:
 	$(call echo_section,"cleaning")
-	find . -depth -name __pycache__ -exec rm -rf {} \; && \
-	find . -depth -name *.pyc -exec rm -rf {} \; && \
-	find . -depth -name *.mypy_cache -exec rm -rf {} \; && \
-	find . -depth -name .coverage -exec rm {} \; && \
-	rm -rf tests/generated-test-proj-dir
+	# directories
+	find . -depth -name __pycache__ -exec rm -rf {} \;
+	find . -depth -name *.pyc -exec rm -rf {} \;
+	find . -depth -name *.mypy_cache -exec rm -rf {} \;
+	find . -depth -name *.egg-info -exec rm -rf {} \;
+	# files
+	find . -depth -name .coverage -exec rm {} \;
+	# absolute path files
+	rm -rf tests/generated-test-proj-dir;
 
 
 tag-create:

README.md

@@ -131,7 +131,7 @@ Upon cloning the repo, set up `pre-commit`:
 ### Add tests
 
 + Write/update unit tests (if relevant). You can start by adding/modifying a
-  case to generator file `tests/generate_test_repos.sh`.
+  case to generator file of `scripts/generate_test_repos.sh`.
 
 ### Run tests && debugging
 

scripts/docker_test_entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+wget https://raw.githubusercontent.com/strboul/git-substatus/master/scripts/generate_test_repos.sh &&\
+  chmod +x generate_test_repos.sh &&\
+  ./generate_test_repos.sh &&\
+  cd tests/generated-test-proj-dir &&\
+  git-substatus

tests/generate_test_repos.sh renamed to scripts/generate_test_repos.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/bin/sh
 # This script creates dummy git repositories, which each of them can represent
 # a different test case. It is meant to be called from the unit tests but it
 # can also be called independently.

get_version.sh renamed to scripts/get_version.sh

@@ -9,21 +9,21 @@ def readme():
 
 
 def get_version(variable):
-    cmd = ["./get_version.sh", variable]
+    cmd = ["./scripts/get_version.sh", variable]
     run = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)
     return run.stdout.decode("utf-8").strip("\n")
 
 
 setup(
     name="git-substatus",
     author="Metin Yazici",
-    version=get_version("version"),
+    version=get_version("__version__"),
     description="Display the 'git status' in sub-directories",
     long_description=readme(),
     long_description_content_type="text/markdown",
     keywords="git sub status fetch directory folder",
     url="https://github.com/strboul/git-substatus",
-    python_requires=f">={get_version('py_version')}",
+    python_requires=f">={get_version('__py_version__')}",
     license="MIT",
     packages=["git_substatus"],
     entry_points={
@@ -39,6 +39,6 @@ def get_version(variable):
         "Operating System :: MacOS",
         "Operating System :: Microsoft :: Windows",
         "Operating System :: POSIX :: Linux",
-        f"Programming Language :: Python :: {get_version('py_version')}+",
+        f"Programming Language :: Python :: {get_version('__py_version__')}",
     ],
 )