Add region to !cf_output tag (#56)

Co-authored-by: plinio.menarin <[email protected]>

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Changed
+
+- Update yaml tag `tags.output_stack.OutputStackTag` to work with custom aws region. [issue-54](https://github.com/lucasvieirasilva/aws-ssm-secrets-cli/issues/54)
+
 ## [2.2.0] - 2023-08-21
 
 ### Nonfunctional

README.md

@@ -100,7 +100,7 @@ For naming convention, you should give the environment name for the file name (e
 ```yaml
 kms:
   arn: KMS_KEY_ARN (String) #Required
-encryption_sdk: 'aws_encryption_sdk'
+encryption_sdk: "aws_encryption_sdk"
 parameters:
   - name: myparametername
     value: "MySecretValueHere"
@@ -115,7 +115,7 @@ or AWS Secrets manager with object
 ```yaml
 kms:
   arn: KMS_KEY_ARN (String) #Required
-encryption_sdk: 'aws_encryption_sdk'
+encryption_sdk: "aws_encryption_sdk"
 parameters:
   - name: myparametername
     value: "MySecretValueHere"
@@ -186,7 +186,7 @@ aws-secrets decrypt -e dev.yaml --output dev.yaml --profile myprofile --region e
 ```yaml
 kms:
   arn: KMS_KEY_ARN
-encryption_sdk: 'aws_encryption_sdk'
+encryption_sdk: "aws_encryption_sdk"
 parameters:
   - name: myparametername
     value: "MySecretValueHere"
@@ -389,11 +389,11 @@ This resolver is designed to load a file content to the SSM Parameter or Secrets
 Example:
 
 ```yaml
-...
+
+---
 secrets:
   - name: mysecret
     value: !file myfile.txt
-...
 ```
 
 ##### !cf_output
@@ -411,6 +411,15 @@ parameters:
     value: !cf_output "mystack.MyOutputKey"
 ```
 
+```yaml
+kms:
+  arn: !cf_output "mystack.MyOutputKey.us-east-1"
+parameters:
+  - name: myparameter-name
+    type: String
+    value: !cf_output "mystack.MyOutputKey.us-east-1"
+```
+
 ##### !cmd
 
 This resolver can be used in `parameters[*].value` and `secrets[*].value` properties.

aws_secrets/miscellaneous/cloudformation.py

@@ -1,6 +1,7 @@
-from aws_secrets.helpers.catch_exceptions import CLIError
 from botocore.session import Session
 
+from aws_secrets.helpers.catch_exceptions import CLIError
+
 
 def get_output_value(
     session: Session,

aws_secrets/tags/output_stack.py

@@ -1,6 +1,7 @@
 import yaml
 from yaml.dumper import SafeDumper
 from yaml.nodes import ScalarNode
+
 from aws_secrets.helpers.catch_exceptions import CLIError
 from aws_secrets.miscellaneous import cloudformation
 from aws_secrets.miscellaneous.session import session
@@ -13,6 +14,7 @@ class OutputStackTag(yaml.YAMLObject):
 
         Examples:
             >>> !cf_output <stack>.<output-name>
+            >>> !cf_output <stack>.<output-name>.<aws-region>
             value: <stack-output-value>
 
         Args:
@@ -34,13 +36,22 @@ def __repr__(self) -> str:
                 `str`: stack output value
         """
         stack_args = self.stack.split('.')
-        if len(stack_args) != 2:
+        if len(stack_args) < 2 or len(stack_args) > 3:
             raise CLIError(
-                f'value {self.stack} is invalid, the correct way to ' +
-                'fill this information is <stack-name>.<output-name>')
-
+                (
+                    f'value {self.stack} is invalid, the correct way to '
+                    'fill this information is <stack-name>.<output-name> '
+                    'or <stack-name>.<output-name>.<aws_region>'
+                )
+            )
+        region = None
         stack_name = stack_args[0]
         output_name = stack_args[1]
+        try:
+            region = stack_args[2]
+            session.aws_region = region
+        except IndexError:
+            pass
 
         return cloudformation.get_output_value(session(), stack_name, output_name)
 

tests/tags/test_output_stack.py

@@ -2,6 +2,7 @@
 
 import pytest
 import yaml
+
 from aws_secrets.helpers.catch_exceptions import CLIError
 from aws_secrets.tags.output_stack import OutputStackTag
 
@@ -29,6 +30,29 @@ def test_cf_output_yaml_tag(
     mock_get_output_value.assert_called_once_with(ANY, 'stack', 'output')
 
 
+@patch('aws_secrets.miscellaneous.cloudformation.get_output_value')
+def test_cf_output_yaml_tag_with_region(
+    mock_get_output_value
+):
+    """
+        Should resolve the cloudformation stack output value
+    """
+    output = 'myvalue'
+
+    mock_get_output_value.return_value = output
+
+    yaml.SafeLoader.add_constructor('!cf_output', OutputStackTag.from_yaml)
+    yaml.SafeDumper.add_multi_representer(
+        OutputStackTag, OutputStackTag.to_yaml)
+
+    data = yaml.safe_load("""
+key: !cf_output stack.output.region
+""")
+
+    assert str(data['key']) == output
+    mock_get_output_value.assert_called_once_with(ANY, 'stack', 'output')
+
+
 @patch('aws_secrets.miscellaneous.cloudformation.get_output_value')
 def test_cf_output_yaml_tag_invalid_format(
     mock_get_output_value
@@ -51,8 +75,11 @@ def test_cf_output_yaml_tag_invalid_format(
     with pytest.raises(CLIError) as error:
         print(str(data['key']))
 
-    assert 'value stack is invalid, the correct way to ' + \
-        'fill this information is <stack-name>.<output-name>' == str(error.value)
+    assert (
+        'value stack is invalid, the correct way to '
+        'fill this information is <stack-name>.<output-name> '
+        'or <stack-name>.<output-name>.<aws_region>'
+    ) == str(error.value)
     mock_get_output_value.assert_not_called()