Merge pull request #196 from cloudblue/LITE-26441-fix-bump-error-backport

LITE-26441: Fixed bump cmd.

Author: ffaraone

connect/cli/plugins/project/extension/helpers.py

@@ -176,22 +176,68 @@ def validate_extension_project(config, project_dir):  # noqa: CCR001
         console.secho(f'Extension Project {project_dir} has been successfully validated.', fg='green')
 
 
-def bump_runner_extension_project(project_dir: str):
+def _update_docker_file_runner_from(dockerfile: str, latest_version: str):
+    to_be_replaced = False
+    last_runner = f'cloudblueconnect/connect-extension-runner:{latest_version}'
+    lines = []
+    with open(dockerfile, 'r') as f:
+        for line in f.readlines():
+            content = line.split()
+            if (
+                content[0] == 'FROM'
+                and content[1].startswith(
+                    'cloudblueconnect/connect-extension-runner:',
+                )
+                and content[1].strip() != last_runner
+            ):
+                lines.append(line.replace(content[1], last_runner))
+                to_be_replaced = True
+            else:
+                lines.append(line)
+    if to_be_replaced:
+        with open(dockerfile, 'w') as f:
+            f.writelines(lines)
+    return to_be_replaced
+
+
+def bump_runner_extension_project(project_dir: str):  # noqa: CCR001
     console.secho(f'Bumping runner version on project {project_dir}...\n', fg='blue')
 
+    updated_files = set()
     latest_version = get_pypi_runner_version()
+    latest_runner_version = f'cloudblueconnect/connect-extension-runner:{latest_version}'
     docker_compose_file = os.path.join(project_dir, 'docker-compose.yml')
     if not os.path.isfile(docker_compose_file):
         raise ClickException(f'Mandatory `docker-compose.yml` file on directory `{project_dir}` is missing.')
     try:
         with open(docker_compose_file, 'r') as file_reader:
             data = yaml.load(file_reader, Loader=yaml.FullLoader)
             for service in data['services']:
-                if 'image' in data['services'][service]:
+                if (
+                    'image' in data['services'][service]
+                    and data['services'][service]['image'].startswith(
+                        'cloudblueconnect/connect-extension-runner:',
+                    )
+                    and data['services'][service]['image'] != latest_runner_version
+                ):
                     runner_image = data['services'][service]['image']
                     runner_version = runner_image.split(':')[-1]
                     updated_image = runner_image.replace(runner_version, latest_version)
                     data['services'][service]['image'] = updated_image
+                    updated_files.add(docker_compose_file)
+                elif 'build' in data['services'][service]:
+                    dockerfile = data['services'][service]['build'].get('dockerfile', 'Dockerfile')
+                    dockerfile_path = os.path.join(project_dir, dockerfile)
+                    if not os.path.isfile(dockerfile_path):
+                        raise ClickException(
+                            f'The expected dockerfile `{dockerfile_path}` specified in '
+                            f'{docker_compose_file} is missing.',
+                        )
+                    if (
+                        dockerfile_path not in updated_files
+                        and _update_docker_file_runner_from(dockerfile_path, latest_version)
+                    ):
+                        updated_files.add(dockerfile_path)
         with open(docker_compose_file, 'w') as file_writer:
             yaml.dump(data, file_writer, sort_keys=False)
     except yaml.YAMLError as error:
@@ -200,4 +246,11 @@ def bump_runner_extension_project(project_dir: str):
             f'Error: {error}',
         )
 
-    console.secho(f'Runner version has been successfully updated to {latest_version}', fg='green')
+    if updated_files:
+        console.secho(
+            f'Runner version has been successfully updated to {latest_version}. The following '
+            f'files have been updated:\n{",".join(updated_files)}',
+            fg='green',
+        )
+    else:
+        console.secho(f'Nothing to update to {latest_version}', fg='yellow')

tests/plugins/project/test_extension_helpers.py

@@ -681,21 +681,80 @@ def test_bootstrap_extension_project_if_destination_exists(mocker):
 
 
 def test_bump_runner_version(mocker, capsys):
+    _mock_pypi_version(mocker)
+    with tempfile.TemporaryDirectory() as tmp_data:
+        project_dir = f'{tmp_data}/project'
+        os.mkdir(project_dir)
+        docker_compose = {
+            'services': {
+                'dev': {'container_name': 'ext_dev', 'image': 'cloudblueconnect/connect-extension-runner:0.5'},
+                'test': {'container_name': 'ext_test', 'image': 'cloudblueconnect/connect-extension-runner:0.5'},
+                'si': {'container_name': 'ext_si', 'build': {'dockerfile': f'{project_dir}/OtherDockerfile'}},
+                'prod': {'container_name': 'ext_prod', 'build': {'context': '.'}},
+            },
+        }
+        with open(f'{project_dir}/docker-compose.yml', 'w') as fp:
+            yaml.dump(docker_compose, fp)
+        with open(f'{project_dir}/Dockerfile', 'w') as fp:
+            fp.write('FROM cloudblueconnect/connect-extension-runner:0.5')
+        with open(f'{project_dir}/OtherDockerfile', 'w') as fp:
+            fp.write('FROM cloudblueconnect/connect-extension-runner:0.5')
+        bump_runner_extension_project(project_dir)
+        captured = capsys.readouterr()
+        assert 'Runner version has been successfully updated to 1.0' in captured.out
+        assert f'{os.path.join(project_dir, "docker-compose.yml")}' in captured.out
+        assert f'{os.path.join(project_dir, "OtherDockerfile")}' in captured.out
+        assert f'{os.path.join(project_dir, "Dockerfile")}' in captured.out
+
+
+def test_bump_runner_version_no_update_required(mocker, capsys):
+    _mock_pypi_version(mocker)
+    with tempfile.TemporaryDirectory() as tmp_data:
+        project_dir = f'{tmp_data}/project'
+        os.mkdir(project_dir)
+        docker_compose = {
+            'services': {
+                'dev': {'container_name': 'ext_dev', 'image': 'cloudblueconnect/connect-extension-runner:1.0'},
+                'test': {'container_name': 'ext_test', 'image': 'cloudblueconnect/connect-extension-runner:1.0'},
+                'si': {'container_name': 'ext_si', 'build': {'dockerfile': f'{project_dir}/OtherDockerfile'}},
+                'prod': {'container_name': 'ext_prod', 'build': {}},
+            },
+        }
+        with open(f'{project_dir}/docker-compose.yml', 'w') as dc:
+            yaml.dump(docker_compose, dc)
+        with open(f'{project_dir}/Dockerfile', 'w') as df:
+            df.write('FROM cloudblueconnect/connect-extension-runner:1.0')
+            df.write('\n')
+        with open(f'{project_dir}/OtherDockerfile', 'w') as df2:
+            df2.write('FROM cloudblueconnect/connect-extension-runner:1.0')
+            df2.write('\n')
+        bump_runner_extension_project(project_dir)
+        captured = capsys.readouterr()
+        assert 'Nothing to update to 1.0' in captured.out
+
+
+def test_bump_runner_version_invalid_dockerfile(mocker):
     _mock_pypi_version(mocker)
     docker_compose = {
         'services': {
-            'dev': {'container_name': 'ext_dev', 'image': 'runner:0.5'},
-            'test': {'container_name': 'ext_test', 'image': 'runner:0.5'},
+            'dev': {
+                'container_name': 'ext_dev',
+                'build': {'dockerfile': 'invalidfile'},
+            },
         },
     }
     with tempfile.TemporaryDirectory() as tmp_data:
         project_dir = f'{tmp_data}/project'
         os.mkdir(project_dir)
-        with open(f'{project_dir}/docker-compose.yml', 'w') as fp:
+        dc = f'{project_dir}/docker-compose.yml'
+        with open(dc, 'w') as fp:
             yaml.dump(docker_compose, fp)
-        bump_runner_extension_project(project_dir)
-        captured = capsys.readouterr()
-        assert 'Runner version has been successfully updated' in captured.out
+        with pytest.raises(ClickException) as exc:
+            bump_runner_extension_project(project_dir)
+        assert (
+            f'The expected dockerfile `{project_dir}/invalidfile` specified in '
+            f'{dc} is missing.'
+        ) in str(exc)
 
 
 def test_bump_runner_docker_compose_not_found(mocker):