toml-combine 0.1.7__tar.gz → 0.1.9__tar.gz

{toml_combine-0.1.7 → toml_combine-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: toml-combine
-Version: 0.1.7
+Version: 0.1.9
 Summary: A tool for combining complex configurations in TOML format.
 Author-email: Joachim Jablon <ewjoachim@gmail.com>
 License-Expression: MIT
@@ -146,6 +146,41 @@ This example is simple because `name` is a natural choice for the key. In some c
 the choice is less natural, but you can always decide to name the elements of your
 list and use that name as a key. Also, yes, you'll loose ordering.
 
+### CLI
+
+```console
+$ toml-combine {path/to/config.toml}
+```
+
+Generates all the outputs described by the given TOML config.
+
+Note that you can restrict generation to some dimension values by passing
+`--{dimension}={value}`
+
+## Lib
+
+```python
+import toml_combine
+
+
+result = toml_combine.combine(
+        config_file=config_file,
+        environment=["production", "staging"],
+        type="job",
+        job=["manage", "special-command"],
+    )
+
+print(result)
+{
+  "production-job-manage": {...},
+  "production-job-special-command": {...},
+  "staging-job-manage": {...},
+  "staging-job-special-command": {...},
+}
+```
+
+You can pass either `config` (TOML string or dict) or `config_file` (`pathlib.Path` or string path) to `combine()`. Additional `kwargs` restrict the output.
+
 ### A bigger example
 
 ```toml
@@ -181,39 +216,90 @@ container.port = 8080
 name = "service-dev"
 when.environment = "dev"
 container.env.DEBUG = true
-```
-
-### CLI
 
-```console
-$ toml-combine {path/to/config.toml}
+[[override]]
+when.environment = ["staging", "dev"]
+when.service = "backend"
+container.env.ENABLE_EXPENSIVE_MONITORING = false
 ```
 
-Generates all the outputs described by the given TOML config.
-
-Note that you can restrict generation to some dimension values by passing
-`--{dimension}={value}`
+This produces the following configs:
 
-## Lib
-
-```python
-import toml_combine
-
-
-result = toml_combine.combine(
-        config_file=config_file,
-        environment=["production", "staging"],
-        type="job",
-        job=["manage", "special-command"],
-    )
-
-print(result)
+```json
 {
-  "production-job-manage": {...},
-  "production-job-special-command": {...},
-  "staging-job-manage": {...},
-  "staging-job-special-command": {...},
+  "production-frontend-eu": {
+    "dimensions": {
+      "environment": "production",
+      "service": "frontend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-frontend",
+    "container": {
+      "image_name": "my-image-frontend"
+    }
+  },
+  "production-backend-eu": {
+    "dimensions": {
+      "environment": "production",
+      "service": "backend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-backend",
+    "container": {
+      "image_name": "my-image-backend",
+      "port": 8080
+    }
+  },
+  "staging-frontend-eu": {
+    "dimensions": {
+      "environment": "staging",
+      "service": "frontend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-frontend",
+    "container": {
+      "image_name": "my-image-frontend"
+    }
+  },
+  "staging-backend-eu": {
+    "dimensions": {
+      "environment": "staging",
+      "service": "backend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-backend",
+    "container": {
+      "image_name": "my-image-backend",
+      "port": 8080,
+      "env": {
+        "ENABLE_EXPENSIVE_MONITORING": false
+      }
+    }
+  },
+  "dev-backend": {
+    "dimensions": {
+      "environment": "dev",
+      "service": "backend"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-backend",
+    "container": {
+      "env": {
+        "DEBUG": true,
+        "ENABLE_EXPENSIVE_MONITORING": false
+      },
+      "image_name": "my-image-backend",
+      "port": 8080
+    }
+  }
 }
 ```
-
-You can pass either `config` (TOML string or dict) or `config_file` (`pathlib.Path` or string path) to `combine()`. Additional `kwargs` restrict the output.

{toml_combine-0.1.7 → toml_combine-0.1.9}/README.md

@@ -127,6 +127,41 @@ This example is simple because `name` is a natural choice for the key. In some c
 the choice is less natural, but you can always decide to name the elements of your
 list and use that name as a key. Also, yes, you'll loose ordering.
 
+### CLI
+
+```console
+$ toml-combine {path/to/config.toml}
+```
+
+Generates all the outputs described by the given TOML config.
+
+Note that you can restrict generation to some dimension values by passing
+`--{dimension}={value}`
+
+## Lib
+
+```python
+import toml_combine
+
+
+result = toml_combine.combine(
+        config_file=config_file,
+        environment=["production", "staging"],
+        type="job",
+        job=["manage", "special-command"],
+    )
+
+print(result)
+{
+  "production-job-manage": {...},
+  "production-job-special-command": {...},
+  "staging-job-manage": {...},
+  "staging-job-special-command": {...},
+}
+```
+
+You can pass either `config` (TOML string or dict) or `config_file` (`pathlib.Path` or string path) to `combine()`. Additional `kwargs` restrict the output.
+
 ### A bigger example
 
 ```toml
@@ -162,39 +197,90 @@ container.port = 8080
 name = "service-dev"
 when.environment = "dev"
 container.env.DEBUG = true
-```
-
-### CLI
 
-```console
-$ toml-combine {path/to/config.toml}
+[[override]]
+when.environment = ["staging", "dev"]
+when.service = "backend"
+container.env.ENABLE_EXPENSIVE_MONITORING = false
 ```
 
-Generates all the outputs described by the given TOML config.
-
-Note that you can restrict generation to some dimension values by passing
-`--{dimension}={value}`
+This produces the following configs:
 
-## Lib
-
-```python
-import toml_combine
-
-
-result = toml_combine.combine(
-        config_file=config_file,
-        environment=["production", "staging"],
-        type="job",
-        job=["manage", "special-command"],
-    )
-
-print(result)
+```json
 {
-  "production-job-manage": {...},
-  "production-job-special-command": {...},
-  "staging-job-manage": {...},
-  "staging-job-special-command": {...},
+  "production-frontend-eu": {
+    "dimensions": {
+      "environment": "production",
+      "service": "frontend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-frontend",
+    "container": {
+      "image_name": "my-image-frontend"
+    }
+  },
+  "production-backend-eu": {
+    "dimensions": {
+      "environment": "production",
+      "service": "backend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-backend",
+    "container": {
+      "image_name": "my-image-backend",
+      "port": 8080
+    }
+  },
+  "staging-frontend-eu": {
+    "dimensions": {
+      "environment": "staging",
+      "service": "frontend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-frontend",
+    "container": {
+      "image_name": "my-image-frontend"
+    }
+  },
+  "staging-backend-eu": {
+    "dimensions": {
+      "environment": "staging",
+      "service": "backend",
+      "region": "eu"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-backend",
+    "container": {
+      "image_name": "my-image-backend",
+      "port": 8080,
+      "env": {
+        "ENABLE_EXPENSIVE_MONITORING": false
+      }
+    }
+  },
+  "dev-backend": {
+    "dimensions": {
+      "environment": "dev",
+      "service": "backend"
+    },
+    "registry": "gcr.io/my-project/",
+    "service_account": "my-service-account",
+    "name": "service-backend",
+    "container": {
+      "env": {
+        "DEBUG": true,
+        "ENABLE_EXPENSIVE_MONITORING": false
+      },
+      "image_name": "my-image-backend",
+      "port": 8080
+    }
+  }
 }
 ```
-
-You can pass either `config` (TOML string or dict) or `config_file` (`pathlib.Path` or string path) to `combine()`. Additional `kwargs` restrict the output.

{toml_combine-0.1.7 → toml_combine-0.1.9}/tests/test.toml

@@ -6,62 +6,21 @@ service = ["api", "admin"]
 job = ["manage", "special-command"]
 
 [[output]]
-environment = "staging"
-stack = "next"
-type = "service"
-
-[[output]]
-environment = "staging"
-stack = "django"
-type = "service"
-service = "api"
-
-[[output]]
-environment = "staging"
-stack = "django"
-type = "service"
-service = "admin"
-
-[[output]]
-environment = "staging"
-stack = "django"
-type = "job"
-job = "manage"
-
-[[output]]
-environment = "staging"
-stack = "django"
-type = "job"
-job = "special-command"
-
-[[output]]
-environment = "production"
+environment = ["staging", "production"]
 stack = "next"
 type = "service"
 
 [[output]]
-environment = "production"
-stack = "django"
-type = "service"
-service = "api"
-
-[[output]]
-environment = "production"
+environment = ["staging", "production"]
 stack = "django"
 type = "service"
-service = "admin"
-
-[[output]]
-environment = "production"
-stack = "django"
-type = "job"
-job = "manage"
+service = ["api", "admin"]
 
 [[output]]
-environment = "production"
+environment = ["staging", "production"]
 stack = "django"
 type = "job"
-job = "special-command"
+job = ["manage", "special-command"]
 
 [default]
 registry.region = "us"
@@ -107,7 +66,9 @@ cloudsql_instance = "staging-postgres"
 containers.app.env.APP_FOO = "qux"
 
 [[override]]
-when.service = "admin"
+# The following line defines when in an array. It's not useful, as there's only one
+# value,  but we want to test that arrays work too.
+when.service = ["admin"]
 containers.app.name = "admin"
 containers.app.env.APP_ADMIN_ENABLED = true
 containers.app.env.APP_ID = 1234

{toml_combine-0.1.7 → toml_combine-0.1.9}/tests/test_combiner.py

@@ -118,7 +118,7 @@ def test_generate_output(output: combiner.Output, expected: dict[str, int]):
 
     overrides = [
         combiner.Override(
-            when={"env": "prod"},
+            when={"env": ["prod"]},
             config={
                 "a": 10,
                 "c": 30,
@@ -127,7 +127,7 @@ def test_generate_output(output: combiner.Output, expected: dict[str, int]):
             },
         ),
         combiner.Override(
-            when={"env": "staging"},
+            when={"env": ["staging"]},
             config={
                 "b": 200,
                 "c": 300,
@@ -136,7 +136,7 @@ def test_generate_output(output: combiner.Output, expected: dict[str, int]):
             },
         ),
         combiner.Override(
-            when={"env": "staging", "region": "us"},
+            when={"env": ["staging"], "region": ["us"]},
             config={"f": 5000, "g": 6000},
         ),
     ]
@@ -149,6 +149,46 @@ def test_generate_output(output: combiner.Output, expected: dict[str, int]):
     assert result == expected
 
 
+@pytest.mark.parametrize(
+    "output, override, expected",
+    [
+        (
+            combiner.Output(dimensions={"env": "dev"}),
+            combiner.Override(when={"env": ["dev"]}, config={}),
+            True,
+        ),
+        (
+            combiner.Output(dimensions={"env": "dev"}),
+            combiner.Override(when={"env": ["staging"]}, config={}),
+            False,
+        ),
+        (
+            combiner.Output(dimensions={"env": "dev"}),
+            combiner.Override(when={"env": ["dev", "staging"]}, config={}),
+            True,
+        ),
+        (
+            combiner.Output(dimensions={"env": "staging"}),
+            combiner.Override(when={"region": ["us"]}, config={}),
+            False,
+        ),
+        (
+            combiner.Output(dimensions={"env": "dev"}),
+            combiner.Override(when={"env": ["dev"], "region": ["us"]}, config={}),
+            False,
+        ),
+        (
+            combiner.Output(dimensions={"env": "dev", "region": "us"}),
+            combiner.Override(when={"env": ["dev"]}, config={}),
+            True,
+        ),
+    ],
+)
+def test_output_matches_override(output, override, expected):
+    result = combiner.output_matches_override(output=output, override=override)
+    assert result == expected
+
+
 def test_build_config():
     raw_config = """
     [dimensions]
@@ -195,7 +235,7 @@ def test_build_config():
                 config={"foo": "baz"},
             ),
             combiner.Override(
-                when={"env": "prod"},
+                when={"env": ["prod"]},
                 config={"foo": "qux"},
             ),
         ],

{toml_combine-0.1.7 → toml_combine-0.1.9}/toml_combine/combiner.py

@@ -5,7 +5,7 @@ import dataclasses
 import itertools
 from collections.abc import Mapping, Sequence
 from functools import partial
-from typing import Any
+from typing import Any, TypeVar, Union
 
 from . import exceptions
 
@@ -24,7 +24,7 @@ class Output:
 
 @dataclasses.dataclass()
 class Override:
-    when: Mapping[str, str | list[str]]
+    when: Mapping[str, list[str]]
     config: Mapping[str, Any]
 
     def __str__(self) -> str:
@@ -48,9 +48,12 @@ def wrap_in_list(value: str | list[str]) -> list[str]:
     return value
 
 
+T = TypeVar("T", bound=Union[str, list[str]])
+
+
 def clean_dimensions_dict(
-    to_sort: Mapping[str, str | list[str]], clean: dict[str, list[str]], type: str
-) -> dict[str, str]:
+    to_sort: Mapping[str, T], clean: dict[str, list[str]], type: str
+) -> dict[str, T]:
     """
     Recreate a dictionary of dimension values with the same order as the
     dimensions list.
@@ -148,7 +151,9 @@ def build_config(config: dict[str, Any]) -> Config:
         except KeyError:
             raise exceptions.MissingOverrideCondition(id=override)
 
-        conditions = tuple((k, tuple(wrap_in_list(v))) for k, v in when.items())
+        when = {k: wrap_in_list(v) for k, v in when.items()}
+
+        conditions = tuple((k, tuple(v)) for k, v in when.items())
         if conditions in seen_conditions:
             raise exceptions.DuplicateError(type="override", id=when)
 
@@ -176,7 +181,6 @@ def build_config(config: dict[str, Any]) -> Config:
             output[key] = wrap_in_list(output[key])
 
         for cartesian_product in itertools.product(*output.values()):
-            # Create a dictionary with the same keys as when
             single_output = dict(zip(output.keys(), cartesian_product))
 
             conditions = tuple(single_output.items())
@@ -200,6 +204,20 @@ def build_config(config: dict[str, Any]) -> Config:
     )
 
 
+def output_matches_override(output: Output, override: Override) -> bool:
+    """
+    Check if the values in the override match the output dimensions.
+    """
+    for dim, values in override.when.items():
+        if dim not in output.dimensions:
+            return False
+
+        if output.dimensions[dim] not in values:
+            return False
+
+    return True
+
+
 def generate_output(
     default: Mapping[str, Any], overrides: Sequence[Override], output: Output
 ) -> dict[str, Any]:
@@ -207,10 +225,8 @@ def generate_output(
     # Apply each matching override
     for override in overrides:
         # Check if all dimension values in the override match
-        if all(
-            override.when.get(dim) == output.dimensions.get(dim)
-            for dim in override.when.keys()
-        ):
+
+        if output_matches_override(output=output, override=override):
             result = merge_configs(result, override.config)
 
     return {"dimensions": output.dimensions, **result}