More thorough testing with pytest

.travis.yml

@@ -5,12 +5,11 @@ cache: pip
 install:
   - set -e
   - pip install --upgrade pip
-  - pip install pyflakes pytest .
+  - pip install .
+  - pip install -r dev-requirements.txt
 script:
   - chartpress --version
   - chartpress --help
-  - pyflakes .
-  - pytest -v ./tests
 
   # This is a workaround to an issue caused by the existence of a docker
   # registrymirror in our CI environment. Without this fix that removes the
@@ -23,30 +22,4 @@ script:
       sudo systemctl restart docker &&
       echo "Travis docker registry mirroring disabled.\n\n"
 
-  - |-
-      git clone https://github.com/jupyterhub/zero-to-jupyterhub-k8s &&
-      cd zero-to-jupyterhub-k8s &&
-      chartpress &&
-      echo -e "\n\n### realistic run: expecting no rebuilds" &&
-      git --no-pager diff --unified=1
-
-  - |-
-      chartpress --skip-build --tag 1.2.3-test.tag &&
-      echo -e "\n\n### --tag --skip-build: expecting no rebuilds and version 1.2.3-test.tag" &&
-      git --no-pager diff --unified=1
-
-  - |-
-      git tag -a 1.2.3-test.tag -m 1.2.3-test.tag HEAD &&
-      chartpress --skip-build &&
-      echo -e "\n\n### git tag: expecting version 1.2.3-test.tag" &&
-      git --no-pager diff --unified=1
-
-  - |-
-      chartpress --skip-build --long &&
-      echo -e "\n\n### --long: expecting version 1.2.3-test.tag+000.asdf1234" &&
-      git --no-pager diff --unified=1
-
-  - |-
-      chartpress --reset &&
-      echo -e '\n\n### --reset: expecting version "0.0.1+set.by.chartpress"' &&
-      git --no-pager diff --unified=1
+  - pytest --verbose --flakes

README.md

@@ -162,16 +162,17 @@ git:
 
 ## Development
 
-Testing of this python package can be done using [`pyflakes`](https://github.com/PyCQA/pyflakes) and [`pytest`](https://github.com/pytest-dev/pytest). There is also some additional testing that is only run as part of TravisCI, as declared in [`.travis.yml`](.travis.yml).
+Testing of this python package can be done using
+[`pytest`](https://github.com/pytest-dev/pytest). For more details on the
+testing, see [tests/README.md](tests/README.md).
 
-```
+```bash
 # install chartpress locally
 pip install  -e .
 
 # install dev dependencies
-pip install pyflakes pytest
+pip install -r dev-requirements.txt
 
 # run tests
-pyflakes .
-pytest -v
+pytest --verbose --flakes --exitfirst
 ```

chartpress.py

@@ -72,12 +72,17 @@ def latest_tag_or_mod_commit(*paths, **kwargs):
         **kwargs,
     ).decode('utf-8').strip()
 
-    git_describe_head = check_output(
-        [
-            'git', 'describe', '--tags', '--long',
-        ],
-        **kwargs,
-    ).decode('utf-8').strip().rsplit("-", maxsplit=2)
+    try:
+        git_describe_head = check_output(
+            [
+                'git', 'describe', '--tags', '--long',
+            ],
+            **kwargs,
+        ).decode('utf-8').strip().rsplit("-", maxsplit=2)
+    except subprocess.CalledProcessError:
+        # no tags on branch
+        return latest_modification_commit
+
     latest_tag = git_describe_head[0]
     latest_tagged_commit = check_output(
         [
@@ -167,7 +172,6 @@ def image_needs_pushing(image):
         return False
 
 
-@lru_cache()
 def image_needs_building(image):
     """Return whether an image needs building
 
@@ -187,9 +191,11 @@ def image_needs_building(image):
 
     # first, check for locally built image
     try:
+        print(image)
         d.images.get(image)
     except docker.errors.ImageNotFound:
         # image not found, check registry
+        print("not found")
         pass
     else:
         # it exists locally, no need to check remote
@@ -446,7 +452,9 @@ def build_chart(name, version=None, paths=None, long=False):
 
             version = _get_identifier(latest_tag_in_branch, n_commits, chart_commit, long)
 
-    chart['version'] = version
+    if chart['version'] != version:
+        print(f"Updating {chart_file}: version: {version}")
+        chart['version'] = version
 
     with open(chart_file, 'w') as f:
         yaml.dump(chart, f)
@@ -465,6 +473,7 @@ def publish_pages(chart_name, chart_version, chart_repo_github_path, chart_repo_
             git_remote(chart_repo_github_path),
             checkout_dir,
         ],
+        # warning: if echoed, this call could reveal the github token
         echo=False,
     )
     check_call(['git', 'checkout', 'gh-pages'], cwd=checkout_dir)
@@ -519,7 +528,7 @@ def __call__(self, parser, namespace, values, option_string=None):
 
 
 
-def main():
+def main(args=None):
     """Run chartpress"""
     argparser = argparse.ArgumentParser(description=__doc__)
 
@@ -576,7 +585,7 @@ def main():
         help='Deprecated: this flag will be ignored. The new logic to determine if an image needs to be rebuilt does not require this. It will find the time in git history where the image was last in need of a rebuild due to changes, and check if that build exists locally or remotely already.',
     )
 
-    args = argparser.parse_args()
+    args = argparser.parse_args(args)
 
     if args.version:
         print(f"chartpress version {__version__}")

dev-requirements.txt

@@ -0,0 +1,3 @@
+gitpython
+pytest
+pytest-flakes

tests/README.md

@@ -0,0 +1,17 @@
+# Notes about the tests
+
+These tests are [pytest](https://docs.pytest.org) tests.
+
+## Not yet tested
+- `--push`
+- `--publish-chart`
+- `--extra-message`
+
+## References
+- [pytest](https://docs.pytest.org)
+  - Fixture: [capfd](https://docs.pytest.org/en/latest/reference.html#_pytest.capture.capfd)
+  - Fixture: [monkeypatching](https://docs.pytest.org/en/latest/capfd.html)
+- [pytest-flakes](https://github.com/fschulze/pytest-flakes) and
+  [pyflakes](https://github.com/PyCQA/pyflakes) for passive code check tests
+  added to the other pytest tests when using the `--flakes` flag with `pytest`.
+- [GitPython](https://gitpython.readthedocs.io/en/stable/)

tests/conftest.py

@@ -0,0 +1,23 @@
+import os
+import tempfile
+from distutils.dir_util import copy_tree
+
+import git
+import pytest
+
+@pytest.fixture(scope="function")
+def git_repo(monkeypatch):
+    """A temporary git repo with """
+    with tempfile.TemporaryDirectory() as temp_dir:
+        # copy content of tests/data folder to the temp dir
+        copy_tree("tests/data", os.path.join(temp_dir))
+
+        # enter the directory
+        monkeypatch.chdir(temp_dir)
+
+        # initialize the repo and make one initial commit
+        r = git.Repo.init(temp_dir)
+        r.git.add(all=True)
+        r.index.commit("initial commit")
+
+        yield r

tests/data/chartpress.yaml

@@ -0,0 +1,24 @@
+charts:
+  - name: testchart
+    imagePrefix: testchart/
+    resetTag: test-reset-tag
+    resetVersion: 0.0.1-test.reset.version
+    repo:
+      git: jupyterhub/we-are-not-ready-for-this-yet
+      published: https://test.local
+    paths:
+      - testchart/
+      - extra-path.txt
+    images:
+      testimage:
+        buildArgs:
+          TEST_STATIC_BUILD_ARG: "test"
+          TEST_DYNAMIC_BUILD_ARG: "{TAG}-{LAST_COMMIT}"
+        contextPath: .
+        dockerfilePath: image/Dockerfile
+        valuesPath:
+          - image
+          - list.0
+          - list.1.image
+        paths:
+          - extra-path.txt

tests/data/image/Dockerfile

@@ -0,0 +1,7 @@
+FROM scratch
+
+ARG TEST_STATIC_BUILD_ARG
+ARG TEST_DYNAMIC_BUILD_ARG
+
+LABEL test_static_build_arg="$TEST_STATIC_BUILD_ARG"
+LABEL test_dynamic_build_arg="$TEST_DYNAMIC_BUILD_ARG"

tests/data/testchart/Chart.yaml

@@ -0,0 +1,3 @@
+apiVersion: v1
+name: testchart
+version: 0.0.1-test.reset.version

tests/data/testchart/values.yaml

@@ -0,0 +1,4 @@
+image: testchart/testimage:test-reset-tag
+list:
+  - "testchart/testimage:test-reset-tag"
+  - image: "testchart/testimage:test-reset-tag"

tests/test_helpers.py

@@ -0,0 +1,44 @@
+from chartpress import GITHUB_TOKEN_KEY
+
+from chartpress import git_remote
+from chartpress import image_needs_pushing
+from chartpress import latest_tag_or_mod_commit
+from chartpress import _strip_identifiers_build_suffix
+from chartpress import _get_identifier
+
+def test__strip_identifiers_build_suffix():
+    assert _strip_identifiers_build_suffix(identifier="0.1.2-005.asdf1234") == "0.1.2"
+    assert _strip_identifiers_build_suffix(identifier="0.1.2-alpha.1.005.asdf1234") == "0.1.2-alpha.1"
+
+def test__get_identifier():
+    assert _get_identifier(tag="0.1.2",         n_commits="0", commit="asdf123",  long=True)  == "0.1.2-000.asdf123"
+    assert _get_identifier(tag="0.1.2",         n_commits="0", commit="asdf123",  long=False) == "0.1.2"
+    assert _get_identifier(tag="0.1.2",         n_commits="5", commit="asdf123",  long=False) == "0.1.2-005.asdf123"
+    assert _get_identifier(tag="0.1.2-alpha.1", n_commits="0", commit="asdf1234", long=True)  == "0.1.2-alpha.1.000.asdf1234"
+    assert _get_identifier(tag="0.1.2-alpha.1", n_commits="0", commit="asdf1234", long=False) == "0.1.2-alpha.1"
+    assert _get_identifier(tag="0.1.2-alpha.1", n_commits="5", commit="asdf1234", long=False) == "0.1.2-alpha.1.005.asdf1234"
+
+def test_git_remote(monkeypatch):
+    monkeypatch.setenv(GITHUB_TOKEN_KEY, "test-github-token")
+    assert git_remote("jupyterhub/helm-chart") == "https://test-github-token@github.com/jupyterhub/helm-chart"
+
+    monkeypatch.delenv(GITHUB_TOKEN_KEY)
+    assert git_remote("jupyterhub/helm-chart") == "git@github.com:jupyterhub/helm-chart"
+
+def test_image_needs_pushing():
+    assert image_needs_pushing("jupyterhub/image-not-to-be-found:latest")
+    assert not image_needs_pushing("jupyterhub/k8s-hub:0.8.2")
+
+def test_latest_tag_or_mod_commit(git_repo):
+    open('tag-mod.txt', "w").close()
+    git_repo.index.add("tag-mod.txt")
+    tag_commit = git_repo.index.commit("tag commit")
+    git_repo.create_tag("1.0.0", message="1.0.0")
+
+    open('post-tag-mod.txt', "w").close()
+    git_repo.index.add("post-tag-mod.txt")
+    post_tag_commit = git_repo.index.commit("post tag commit")
+
+    assert latest_tag_or_mod_commit("chartpress.yaml")  == tag_commit.hexsha[:7]
+    assert latest_tag_or_mod_commit("tag-mod.txt")      == tag_commit.hexsha[:7]
+    assert latest_tag_or_mod_commit("post-tag-mod.txt") == post_tag_commit.hexsha[:7]