uktrade · shehzadashiq · Aug 23, 2023 · Aug 22, 2023 · Aug 23, 2023 · WillGibson
diff --git a/commands/jinja2_tags.py b/commands/jinja2_tags.py
@@ -0,0 +1,20 @@
+import datetime
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version
+
+from jinja2_simple_tags import StandaloneTag
+
+
+class VersionTag(StandaloneTag):
+    tags = {"version_info"}
+
+    def _get_version(self):
+        try:
+            return version("dbt-copilot-tools")
+        except PackageNotFoundError:
+            return "UNKNOWN"
+
+    def render(self):
+        format = "%Y-%m-%d %H:%M:%S"
+        time = datetime.datetime.now().strftime(format)
+        return f"Generated by copilot-helper {self._get_version()} / {time}"
diff --git a/commands/templates/addons/env/addons.parameters.yml b/commands/templates/addons/env/addons.parameters.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 # At present, this may include parameters which are not used in your application's addons.
 # If you get a "parse environment addons: template does not require the parameter "{parameter_name}" in parameters file" error,
 # just delete the offending parameter from this file.

diff --git a/commands/templates/addons/env/aurora-postgres.yml b/commands/templates/addons/env/aurora-postgres.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/commands/templates/addons/env/opensearch.yml b/commands/templates/addons/env/opensearch.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/commands/templates/addons/env/rds-postgres.yml b/commands/templates/addons/env/rds-postgres.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/commands/templates/addons/env/redis-cluster.yml b/commands/templates/addons/env/redis-cluster.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/commands/templates/addons/env/s3.yml b/commands/templates/addons/env/s3.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/commands/templates/addons/svc/appconfig-ipfilter.yml b/commands/templates/addons/svc/appconfig-ipfilter.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Parameters:
   App:
     Type: String

diff --git a/commands/templates/addons/svc/s3-policy.yml b/commands/templates/addons/svc/s3-policy.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 Metadata:
   cfn-lint:
     config:

diff --git a/commands/templates/env/manifest.yml b/commands/templates/env/manifest.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 # The manifest for the "{{ name }}" environment.
 # Read the full specification for the "Environment" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/environment/

diff --git a/commands/templates/svc/manifest-backend.yml b/commands/templates/svc/manifest-backend.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 # The manifest for the "{{ name }}" service.
 # Read the full specification for the "Backend Service" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/backend-service/

diff --git a/commands/templates/svc/manifest-public.yml b/commands/templates/svc/manifest-public.yml
@@ -1,3 +1,4 @@
+# {% version_info %}
 # The manifest for the "{{ name }}" service.
 # Read the full specification for the "Load Balanced Web Service" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/lb-web-service/

diff --git a/commands/utils.py b/commands/utils.py
@@ -7,6 +7,7 @@
 import jinja2
 
 from commands.exceptions import ValidationException
+from commands.jinja2_tags import VersionTag
 
 SSM_BASE_PATH = "/copilot/{app}/{env}/secrets/"
 SSM_PATH = "/copilot/{app}/{env}/secrets/{name}"
@@ -128,6 +129,7 @@ def setup_templates():
     Path(__file__).parent.parent / Path("templates")
     templateLoader = jinja2.PackageLoader("commands")
     templateEnv = jinja2.Environment(loader=templateLoader, keep_trailing_newline=True)
+    templateEnv.add_extension(VersionTag)
 
     return templateEnv
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,6 +32,7 @@ cfn-flip = "1.3.0"
 aiohttp = "^3.8.4"
 certifi = "^2023.07.22"
 cryptography = "^41.0.3"
+jinja2-simple-tags = "^0.5.0"
 
 [tool.poetry.group.dev.dependencies]
 cfn-lint = "^0.77.7"

diff --git a/tests/fixtures/make_addons/config/copilot/environments/development/manifest.yml b/tests/fixtures/make_addons/config/copilot/environments/development/manifest.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 # The manifest for the "development" environment.
 # Read the full specification for the "Environment" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/environment/

diff --git a/tests/fixtures/make_addons/config/copilot/web/manifest.yml b/tests/fixtures/make_addons/config/copilot/web/manifest.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 # The manifest for the "web" service.
 # Read the full specification for the "Load Balanced Web Service" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/lb-web-service/

diff --git a/tests/fixtures/make_addons/expected/environments/addons/addons.parameters.yml b/tests/fixtures/make_addons/expected/environments/addons/addons.parameters.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 # At present, this may include parameters which are not used in your application's addons.
 # If you get a "parse environment addons: template does not require the parameter "{parameter_name}" in parameters file" error,
 # just delete the offending parameter from this file.

diff --git a/tests/fixtures/make_addons/expected/environments/addons/my-aurora-db.yml b/tests/fixtures/make_addons/expected/environments/addons/my-aurora-db.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/tests/fixtures/make_addons/expected/environments/addons/my-opensearch.yml b/tests/fixtures/make_addons/expected/environments/addons/my-opensearch.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/tests/fixtures/make_addons/expected/environments/addons/my-rds-db.yml b/tests/fixtures/make_addons/expected/environments/addons/my-rds-db.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/tests/fixtures/make_addons/expected/environments/addons/my-redis.yml b/tests/fixtures/make_addons/expected/environments/addons/my-redis.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/tests/fixtures/make_addons/expected/environments/addons/my-s3-bucket.yml b/tests/fixtures/make_addons/expected/environments/addons/my-s3-bucket.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Parameters:
   # Copilot required Parameters...
   App:

diff --git a/tests/fixtures/make_addons/expected/web/addons/appconfig-ipfilter.yml b/tests/fixtures/make_addons/expected/web/addons/appconfig-ipfilter.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Parameters:
   App:
     Type: String

diff --git a/tests/fixtures/make_addons/expected/web/addons/my-s3-bucket-bucket-access.yml b/tests/fixtures/make_addons/expected/web/addons/my-s3-bucket-bucket-access.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Metadata:
   cfn-lint:
     config:

diff --git a/tests/fixtures/make_addons/expected/web/addons/my-s3-bucket.yml b/tests/fixtures/make_addons/expected/web/addons/my-s3-bucket.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 Metadata:
   cfn-lint:
     config:

diff --git a/tests/fixtures/production_environment_manifest.yml b/tests/fixtures/production_environment_manifest.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 # The manifest for the "production" environment.
 # Read the full specification for the "Environment" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/environment/

diff --git a/tests/fixtures/test_environment_manifest.yml b/tests/fixtures/test_environment_manifest.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 # The manifest for the "test" environment.
 # Read the full specification for the "Environment" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/environment/

diff --git a/tests/fixtures/test_service_manifest.yml b/tests/fixtures/test_service_manifest.yml
@@ -1,3 +1,4 @@
+# Generated by copilot-helper v0.1-TEST / 2023-08-22 16:00:00
 # The manifest for the "test-service" service.
 # Read the full specification for the "Load Balanced Web Service" type at:
 #  https://aws.github.io/copilot-cli/docs/manifest/lb-web-service/

diff --git a/tests/test_bootstrap_cli.py b/tests/test_bootstrap_cli.py
@@ -2,6 +2,7 @@
 import shutil
 from pathlib import Path
 from unittest.mock import MagicMock
+from unittest.mock import Mock
 from unittest.mock import call
 from unittest.mock import patch
 
@@ -10,6 +11,7 @@
 import yaml
 from click.testing import CliRunner
 from cloudfoundry_client.common_objects import JsonObject
+from freezegun import freeze_time
 from moto import mock_ssm
 from moto import mock_sts
 from schema import SchemaError
@@ -88,6 +90,8 @@ def test_load_and_validate_config_invalid_file():
     )
 
 
+@freeze_time("2023-08-22 16:00:00")
+@patch("commands.jinja2_tags.version", new=Mock(return_value="v0.1-TEST"))
 def test_make_config(tmp_path):
     """Test that make_config generates the expected directories and file
     contents."""

diff --git a/tests/test_copilot_cli.py b/tests/test_copilot_cli.py
@@ -1,10 +1,13 @@
 import os
 import shutil
 from pathlib import Path
+from unittest.mock import Mock
+from unittest.mock import patch
 
 import boto3
 import pytest
 from click.testing import CliRunner
+from freezegun import freeze_time
 from moto import mock_ssm
 
 from commands.copilot_cli import copilot as cli
@@ -83,6 +86,8 @@ class TestMakeAddonCommand:
             ("aurora_addons.yml", ["my-aurora-db.yml", "addons.parameters.yml"], ["appconfig-ipfilter.yml"], True),
         ],
     )
+    @freeze_time("2023-08-22 16:00:00")
+    @patch("commands.jinja2_tags.version", new=Mock(return_value="v0.1-TEST"))
     def test_make_addons_success(
         self, tmp_path, addon_file, expected_env_addons, expected_service_addons, expect_db_warning
     ):