Merge pull request #189 from JonathonReinhart/ci-updates

Minor CI test update

Author: JonathonReinhart

.github/workflows/build-test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8]
+        python-version: [3.5, 3.6, 3.7, 3.8, 3.9]
       fail-fast: False
 
     steps:

ci/test_setup.sh

@@ -3,8 +3,11 @@ set -e
 
 topdir=$(cd $(dirname $0)/.. && pwd)
 
-# Pull this image ahead of time, so it's there for the unit tests
-docker pull debian:8.2
+# Load test constants
+eval $(cd $topdir && python3 -m tests.const)
+
+# Pull this image ahead of time, so it's there for the tests
+docker pull "$DOCKER_IMAGE"
 
 # Build docker images for local testing
 $topdir/test-docker-images/build_all.sh

run_full_tests.py

@@ -5,6 +5,8 @@
 import tempfile
 import shutil
 
+from tests.const import DOCKER_IMAGE
+
 
 class InTempDir:
     def __init__(self, suffix='', prefix='tmp', delete=True):
@@ -25,7 +27,7 @@ def __exit__(self, *exc_info):
 def test1():
     with InTempDir(prefix='scuba-systest'):
         with open('.scuba.yml', 'w+t') as f:
-            f.write('image: debian:8.2\n')
+            f.write('image: {}\n'.format(DOCKER_IMAGE))
 
         in_data = 'success'
 

tests/const.py

@@ -0,0 +1,22 @@
+# Constants used throughout the test suite
+
+# Main Docker image
+# This image is used for nearly all tests where a "real" docker image is
+# necessary (becuase we're going to actually invoke some docker command).
+#
+# Requirements:
+# - Must contain /bin/bash (TestMain::test_*shell_override*)
+#
+DOCKER_IMAGE = 'debian:10'
+
+# Alternate Docker image
+# This image is used for alternate tests (e.g. pulling) and should be small.
+ALT_DOCKER_IMAGE = 'busybox:latest'
+
+
+# Act as an executable for consumption by non-Python things
+if __name__ == '__main__':
+    for name, val in dict(vars()).items():
+        if name.startswith('_'):
+            continue
+        print('{}="{}"'.format(name, val))

tests/test_config.py

@@ -58,7 +58,7 @@ class TestConfig:
     def test_find_config_cur_dir(self, in_tmp_path):
         '''find_config can find the config in the current directory'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
 
         path, rel, _ = scuba.config.find_config()
         assert_paths_equal(path, in_tmp_path)
@@ -68,7 +68,7 @@ def test_find_config_cur_dir(self, in_tmp_path):
     def test_find_config_parent_dir(self, in_tmp_path):
         '''find_config cuba can find the config in the parent directory'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
 
         os.mkdir('subdir')
         os.chdir('subdir')
@@ -83,7 +83,7 @@ def test_find_config_parent_dir(self, in_tmp_path):
     def test_find_config_way_up(self, in_tmp_path):
         '''find_config can find the config way up the directory hierarchy'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
 
         subdirs = ['foo', 'bar', 'snap', 'crackle', 'pop']
 
@@ -122,37 +122,37 @@ def test_load_config_no_image(self):
     def test_load_unexpected_node(self):
         '''load_config raises ConfigError on unexpected config node'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
             f.write('unexpected_node_123456: value\n')
 
         self._invalid_config()
 
     def test_load_config_minimal(self):
         '''load_config loads a minimal config'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
 
         config = scuba.config.load_config('.scuba.yml')
-        assert config.image == 'busybox'
+        assert config.image == 'bosybux'
 
     def test_load_config_with_aliases(self):
         '''load_config loads a config with aliases'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
             f.write('aliases:\n')
             f.write('  foo: bar\n')
             f.write('  snap: crackle pop\n')
 
         config = scuba.config.load_config('.scuba.yml')
-        assert config.image == 'busybox'
+        assert config.image == 'bosybux'
         assert len(config.aliases) == 2
         assert config.aliases['foo'].script == ['bar']
         assert config.aliases['snap'].script == ['crackle pop']
 
     def test_load_config__no_spaces_in_aliases(self):
         '''load_config refuses spaces in aliases'''
         with open('.scuba.yml', 'w') as f:
-            f.write('image: busybox\n')
+            f.write('image: bosybux\n')
             f.write('aliases:\n')
             f.write('  this has spaces: whatever\n')
 
@@ -161,46 +161,46 @@ def test_load_config__no_spaces_in_aliases(self):
     def test_load_config_image_from_yaml(self):
         '''load_config loads a config using !from_yaml'''
         with open('.gitlab.yml', 'w') as f:
-            f.write('image: debian:8.2\n')
+            f.write('image: dummian:8.2\n')
 
         with open('.scuba.yml', 'w') as f:
             f.write('image: !from_yaml .gitlab.yml image\n')
 
         config = scuba.config.load_config('.scuba.yml')
-        assert config.image == 'debian:8.2'
+        assert config.image == 'dummian:8.2'
 
     def test_load_config_image_from_yaml_nested_keys(self):
         '''load_config loads a config using !from_yaml with nested keys'''
         with open('.gitlab.yml', 'w') as f:
             f.write('somewhere:\n')
             f.write('  down:\n')
-            f.write('    here: debian:8.2\n')
+            f.write('    here: dummian:8.2\n')
 
         with open('.scuba.yml', 'w') as f:
             f.write('image: !from_yaml .gitlab.yml somewhere.down.here\n')
 
         config = scuba.config.load_config('.scuba.yml')
-        assert config.image == 'debian:8.2'
+        assert config.image == 'dummian:8.2'
 
     def test_load_config_image_from_yaml_nested_keys_with_escaped_characters(self):
         '''load_config loads a config using !from_yaml with nested keys containing escaped '.' characters'''
         with open('.gitlab.yml', 'w') as f:
             f.write('.its:\n')
             f.write('  somewhere.down:\n')
-            f.write('    here: debian:8.2\n')
+            f.write('    here: dummian:8.2\n')
 
         with open('.scuba.yml', 'w') as f:
             f.write('image: !from_yaml .gitlab.yml "\\.its.somewhere\\.down.here"\n')
 
         config = scuba.config.load_config('.scuba.yml')
-        assert config.image == 'debian:8.2'
+        assert config.image == 'dummian:8.2'
 
     def test_load_config_from_yaml_cached_file(self):
         '''load_config loads a config using !from_yaml from cached version'''
         with open('.gitlab.yml', 'w') as f:
-            f.write('one: debian:8.2\n')
-            f.write('two: debian:9.3\n')
-            f.write('three: debian:10.1\n')
+            f.write('one: dummian:8.2\n')
+            f.write('two: dummian:9.3\n')
+            f.write('three: dummian:10.1\n')
 
         with open('.scuba.yml', 'w') as f:
             f.write('image: !from_yaml .gitlab.yml one\n')
@@ -254,7 +254,7 @@ def test_load_config_image_from_yaml_unicode_args(self):
     def test_load_config_image_from_yaml_missing_arg(self):
         '''load_config raises ConfigError when !from_yaml has missing args'''
         with open('.gitlab.yml', 'w') as f:
-            f.write('image: debian:8.2\n')
+            f.write('image: dummian:8.2\n')
 
         with open('.scuba.yml', 'w') as f:
             f.write('image: !from_yaml .gitlab.yml\n')

tests/test_dockerutil.py

@@ -3,12 +3,13 @@
 import pytest
 
 import subprocess
+from .const import *
 
 import scuba.dockerutil as uut
 
 def test_get_image_command_success():
     '''get_image_command works'''
-    assert uut.get_image_command('debian:8.2')
+    assert uut.get_image_command(DOCKER_IMAGE)
 
 def test_get_image_command_bad_image():
     '''get_image_command raises an exception for a bad image name'''
@@ -47,23 +48,23 @@ def test_get_images_success__no_images():
 def test_get_images_success__multiple_images():
     '''get_images works when many images are present'''
     output = '''\
-busybox
-busybox:latest
-debian
-debian:buster
-debian:latest
-scuba/scratch
-scuba/scratch:latest
+foo
+foo:latest
+bar
+bar:snap
+bar:latest
+dummy/crackle
+dummy/crackle:pop
 '''
     images = _test_get_images(output)
     assert images == [
-                'busybox',
-                'busybox:latest',
-                'debian',
-                'debian:buster',
-                'debian:latest',
-                'scuba/scratch',
-                'scuba/scratch:latest',
+                'foo',
+                'foo:latest',
+                'bar',
+                'bar:snap',
+                'bar:latest',
+                'dummy/crackle',
+                'dummy/crackle:pop',
             ]
 
 def test_get_images__failure():
@@ -74,7 +75,7 @@ def test_get_images__failure():
 
 def test__get_image_command__pulls_image_if_missing():
     '''get_image_command pulls an image if missing'''
-    image = 'busybox:latest'
+    image = ALT_DOCKER_IMAGE
 
     # First remove the image
     subprocess.call(['docker', 'rmi', image])
@@ -92,7 +93,7 @@ def test_get_image_entrypoint():
 
 def test_get_image_entrypoint__none():
     '''get_image_entrypoint works for image with no entrypoint'''
-    result = uut.get_image_entrypoint('debian')
+    result = uut.get_image_entrypoint(DOCKER_IMAGE)
     assert result is None
 
 

tests/test_main.py

@@ -18,7 +18,8 @@
 import scuba
 import re
 
-DOCKER_IMAGE = 'debian:8.2'
+from .const import DOCKER_IMAGE
+
 SCUBAINIT_EXIT_FAIL = 99
 
 @pytest.mark.usefixtures("in_tmp_path")