add order of precedence test for config_loader

Author: cognifloyd

st2common/tests/unit/test_config_loader.py

@@ -587,7 +587,7 @@ def test_get_config_dynamic_config_item_under_pattern_properties(self):
         )
 
         ####################
-        # values in objects under an object with additionalProperties
+        # values in objects under an object with patternProperties
         values = {
             "profiles": {
                 "dev": {
@@ -630,6 +630,105 @@ def test_get_config_dynamic_config_item_under_pattern_properties(self):
 
         config_db.delete()
 
+    def test_get_config_dynamic_config_item_properties_order_of_precedence(self):
+        pack_name = "dummy_pack_schema_with_properties_1"
+        loader = ContentPackConfigLoader(pack_name=pack_name)
+
+        encrypted_value = crypto.symmetric_encrypt(
+            KeyValuePairAPI.crypto_key, "v1_encrypted"
+        )
+        KeyValuePair.add_or_update(
+            KeyValuePairDB(name="k1_encrypted", value=encrypted_value, secret=True)
+        )
+        KeyValuePair.add_or_update(
+            KeyValuePairDB(name="k2_encrypted", value=encrypted_value, secret=True)
+        )
+        KeyValuePair.add_or_update(
+            KeyValuePairDB(name="k3_encrypted", value=encrypted_value, secret=True)
+        )
+
+        ####################
+        # values in objects under an object with additionalProperties
+        values = {
+            "profiles": {
+                # properties
+                "foo": {
+                    "domain": "foo.example.com",
+                    "token": "hard-coded-secret",
+                },
+                "bar": {
+                    "domain": "bar.example.com",
+                    "token": "{{st2kv.system.k1_encrypted}}",
+                },
+                # patternProperties start with env-
+                "env-dev": {
+                    "host": "127.0.0.127",
+                    "token": "hard-coded-secret",
+                },
+                "env-prod": {
+                    "host": "127.1.2.7",
+                    "port": 8282,
+                    # encrypted in datastore
+                    "token": "{{st2kv.system.k2_encrypted}}",
+                    # schema declares `secret: true` which triggers auto-decryption.
+                    # If this were not encrypted, it would try to decrypt it and fail.
+                },
+                # additionalProperties
+                "dev": {
+                    "url": "https://example.com",
+                    "token": "hard-coded-secret",
+                },
+                "prod": {
+                    "url": "https://other.example.com",
+                    "port": 2345,
+                    "token": "{{st2kv.system.k3_encrypted}}",
+                },
+            }
+        }
+        config_db = ConfigDB(pack=pack_name, values=values)
+        config_db = Config.add_or_update(config_db)
+
+        config_rendered = loader.get_config()
+
+        self.assertEqual(
+            config_rendered,
+            {
+                "region": "us-east-1",
+                "profiles": {
+                    "foo": {
+                        "domain": "foo.example.com",
+                        "token": "hard-coded-secret",
+                    },
+                    "bar": {
+                        "domain": "bar.example.com",
+                        "token": "v1_encrypted",
+                    },
+                    "env-dev": {
+                        "host": "127.0.0.127",
+                        "port": 8080,
+                        "token": "hard-coded-secret",
+                    },
+                    "env-prod": {
+                        "host": "127.1.2.7",
+                        "port": 8282,
+                        "token": "v1_encrypted",
+                    },
+                    "dev": {
+                        "url": "https://example.com",
+                        "port": 1234,
+                        "token": "hard-coded-secret",
+                    },
+                    "prod": {
+                        "url": "https://other.example.com",
+                        "port": 2345,
+                        "token": "v1_encrypted",
+                    },
+                },
+            },
+        )
+
+        config_db.delete()
+
     def test_get_config_dynamic_config_item_under_additional_items(self):
         pack_name = "dummy_pack_schema_with_additional_items_1"
         loader = ContentPackConfigLoader(pack_name=pack_name)

st2tests/st2tests/fixtures/packs/dummy_pack_schema_with_pattern_and_additional_properties_1/config.schema.yaml

@@ -0,0 +1,61 @@
+---
+  region:
+    type: "string"
+    required: false
+    default: "us-east-1"
+  profiles:
+    type: "object"
+    required: false
+    # order of precedence: properties, patternProperties, additionalProperties
+    properties:
+      foo:
+        type: object
+        properties:
+          domain:
+            type: "string"
+            required: true
+          token:
+            type: "string"
+            required: true
+            secret: true
+      bar:
+        type: object
+        properties:
+          domain:
+            type: "string"
+            required: true
+          token:
+            type: "string"
+            required: true
+            secret: true
+    patternProperties:
+      "^env-\\w+$":
+        type: object
+        additionalProperties: false
+        properties:
+          host:
+            type: "string"
+            required: true
+          port:
+            type: "integer"
+            required: false
+            default: 8080
+          token:
+            type: "string"
+            required: true
+            secret: true
+    additionalProperties:
+      type: object
+      additionalProperties: false
+      properties:
+        url:
+          type: "string"
+          required: true
+        port:
+          type: "integer"
+          required: false
+          default: 1234
+        token:
+          type: "string"
+          required: true
+          secret: true

st2tests/st2tests/fixtures/packs/dummy_pack_schema_with_pattern_and_additional_properties_1/pack.yaml

@@ -0,0 +1,6 @@
+---
+name : dummy_pack_schema_with_pattern_and_additional_properties_1
+description : dummy pack with nested objects under patternProperties and additionalProperties
+version : 0.1.0
+author : st2-dev
+email : [email protected]