patch major bugs with overriding cmd

Author: AvivAbramovich

.gitignore

@@ -3,6 +3,8 @@
 # pycharm
 .idea
 
+Makefile
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

Makefile

@@ -8,11 +8,16 @@
 registered_patchers: typing.List[typing.Callable] = []
 
 
-__version__ = '0.1.1'
+__version__ = '0.1.2'
 
 
-def default_on_error(e: Exception):
-    raise e
+def default_on_error(error: Exception):
+    raise error
+
+
+def _get(d: dict, key: str, default):
+    res = d.get(key, default)
+    return default if res is None else res
 
 
 def register_patcher(
@@ -39,44 +44,44 @@ def patch_image(
         on_patcher_error = default_on_error
 
     orig_config = client.api.inspect_image(image.id)['Config']
-    orig_entrypoint = orig_config['Entrypoint']
-    if not orig_entrypoint:
-        orig_entrypoint = ''
 
     # create a container
-    logger.info(f'Creating container for "{image}"')
-    c: Container = client.containers.run(
+    logger.info('Creating container for "%s"', image)
+    container: Container = client.containers.run(
         image, detach=True, entrypoint='/bin/sh',
         remove=True, tty=True, network_mode='host'
     )
-    logger.info(f'Container: "{c.name}" (id: {c.id})')
+    logger.info('Container: "%s" (id: "%s")', container.name, container.id)
 
     try:
         for patch_func in registered_patchers:
             try:
-                logger.info(f'calling patcher func "{patch_func.__name__}"')
-                patch_func(c)
-            except Exception as e:
-                on_patcher_error(e)
+                logger.info('calling patcher func "%s"', patch_func.__name__)
+                patch_func(container)
+            except Exception as error:
+                on_patcher_error(error)
 
         # commit
         logger.info('Commit container')
-        result_image = c.commit(conf={'Entrypoint': orig_entrypoint})
+        result_image = container.commit(conf={
+            'Entrypoint': _get(orig_config, 'Entrypoint', []),
+            'Cmd': _get(orig_config, 'Cmd', [])
+        })
 
-        logger.info(f'New image id: {result_image.id}')
+        logger.info('New image id: "%s"', result_image.id)
 
         # re-tag
-        logger.info(f'tag new image with {len(image.tags)} tags')
+        logger.info('tag new image with %d tags', len(image.tags))
         for tag in image.tags:
-            logger.info(f'-tag "{tag}"')
+            logger.info('-tag "%s"', tag)
             result_image.tag(tag)
 
         # fetch image again with tags
         return client.images.get(result_image.id)
     finally:
         # fetch the updated container object
-        c = client.containers.get(c.id)
-        if c.status == 'running':
+        container = client.containers.get(container.id)
+        if container.status == 'running':
             # stop container (should be removed)
-            logger.info(f'Stopping container "{c.name}"')
-            c.stop()
+            logger.info('Stopping container "%s"', container.name)
+            container.stop()

docker_patch/__init__.py

@@ -5,7 +5,7 @@
 def test(session):
     session.install('flake8', 'tox')
     session.run('flake8', '--show-source', '--statistics', 'docker_patch')
-    session.run('tox')
+    session.run('tox', '-s')
 
 
 @nox.session(name='build')

noxfile.py

@@ -1,5 +0,0 @@
-import docker
-
-
-def test_cli():
-    client = docker.DockerClient()

tests/__init__.py

@@ -1,3 +1,3 @@
-images = ['alpine:3.12']
+images = ['alpine:3.12', 'ubuntu:20.04', 'debian:buster']
 modules = ['module_1', 'module_2']
 add_paths = ['example_patchers']

tests/data.py

@@ -1,3 +1,5 @@
+import logging
+
 import docker
 import click.testing
 
@@ -6,24 +8,44 @@
 
 
 def test_cli():
+    logger = logging.getLogger('test_cli')
+
     client = docker.DockerClient()
 
     args = []
 
+    logger.info('Add %d images...', len(data.images))
     for image in data.images:
         args.append(image)
-        client.images.pull(image)
+        try:
+            logger.info('Trying remove image first if exists')
+            client.images.remove(image, force=True)
+            logger.info('Image "%s" removed successfully', image)
+        except docker.errors.ImageNotFound:
+            logger.info('Image "%s" does not exists', image)
+
+        logger.info('Pulling "%s"', image)
+        image = client.images.pull(image)
+        logger.info('Pulled "%s" (id: "%s")', image, image.id)
 
     for module in data.modules:
+        logger.info('Add module "%s"', module)
         args += ['-m', module]
     for path in data.add_paths:
+        logger.info('Add path "%s"', path)
         args += ['--add-path', path]
 
+    logger.info('Cli args: "%s"', args)
+
     runner = click.testing.CliRunner()
     result = runner.invoke(docker_patch, args)
+    logger.info('exit code: %d', result.exit_code)
     assert result.exit_code == 0
 
     # test new image
+    logger.info('Test %d images...', len(data.images))
     for image in data.images:
+        logger.info('Test image "%s"', image)
         res = client.containers.run(image, 'cat patched.txt', remove=True)
+        logger.info('Result: "%s"', res)
         assert res

tests/test_cli.py

@@ -0,0 +1,81 @@
+import logging
+import uuid
+
+import docker
+import docker.errors
+
+import pytest
+
+from docker_patch import patch_image, register_patcher
+from . import data
+
+client = docker.DockerClient()
+test_solution = str(uuid.uuid4())
+
+TEST_SOLUTION_FILEPATH = '/test_solution.txt'
+
+logger = logging.getLogger(__name__)
+
+logger.info('test solution: "%s"', test_solution)
+
+
+# register new patcher
+@register_patcher
+def patcher(container):
+    logger.info('Injecting solution "%s" into container "%s"', test_solution, container)
+    r = container.exec_run(f'/bin/sh -c \'echo "{test_solution}" >> {TEST_SOLUTION_FILEPATH}\'')
+    if r.exit_code != 0:
+        assert False
+
+
+def on_error(error):
+    logger.error('patcher raised error: "%s"', str(error))
+    assert False
+
+
+@pytest.mark.parametrize('image_name', data.images)
+def test_package(image_name: str):
+    logger.info('Test image: "%s"', image_name)
+
+    try:
+        logger.info('Trying remove image first if exists')
+        client.images.remove(image_name, force=True)
+        logger.info('Image removed successfully')
+    except docker.errors.ImageNotFound:
+        logger.info('Image does not exists')
+
+    logger.info('Pulling image "%s"', image_name)
+    image = client.images.pull(image_name)
+    logger.info('Pulling result: "%s"', image)
+    assert image
+    logger.info('Image ID: "%s"', image.id)
+
+    # store all images original configs
+    original_configs = client.api.inspect_image(image.id)['Config']
+    logger.info('Original image configs: "%s"', original_configs)
+
+    # patch image
+    logger.info('Patching image...')
+    new_image = patch_image(image, on_patcher_error=on_error)
+    logger.info('New image id: "%s"', new_image.id)
+
+    # test new image
+    # check original config equals to patched config
+    current_configs = client.api.inspect_image(new_image.id)['Config']
+    logger.info('New image configs: "%s"', current_configs)
+
+    def compare_config(key):
+        orig_val = original_configs.get(key)
+        curr_val = current_configs.get(key)
+
+        return orig_val == curr_val or (orig_val is None and curr_val in ['', []])
+
+    for key in ['Cmd', 'Entrypoint']:
+        logger.info('Compare Config.%s', key)
+        assert compare_config(key)
+
+    # check solution exists in image by spawn a new container
+    logger.info('Check solution exists in new image')
+    solution = client.containers.run(new_image, f'cat {TEST_SOLUTION_FILEPATH}',
+                                     remove=True).decode('utf-8').strip()
+    assert test_solution == solution

tests/test_package.py

@@ -7,4 +7,4 @@ deps =
     docker
     -r requirements.txt
 commands =
-    pytest
+    pytest  -o log_cli_level=INFO