brickvar 0.0.1__tar.gz

brickvar-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Amida Technology Solutions
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

brickvar-0.0.1/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: brickvar
+Version: 0.0.1
+Summary: Resolve Databricks config variables from literals, environment variables, and Azure Key Vault secrets, and substitute them into JSON config files.
+Author-email: Afsin Ustundag <afsin@amida.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/amida-tech/brickvar
+Project-URL: Repository, https://github.com/amida-tech/brickvar
+Project-URL: Issues, https://github.com/amida-tech/brickvar/issues
+Keywords: databricks,config,configuration,secrets,azure,key-vault
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# brickvar
+
+Resolve configuration variables for Databricks jobs from literals, environment
+variables, and Azure Key Vault secrets, and substitute them into JSON config files.
+
+`brickvar` reads a JSON "variables" file in which each entry is one of:
+
+- a **literal** string (which may reference other variables with `${VAR}`),
+- an **environment variable** reference — `{"env": "NAME"}`, or
+- a **Databricks / Azure Key Vault secret** — `{"scope": ..., "key": ..., "base"?: ...}`,
+  read through the Databricks `dbutils.secrets` API.
+
+Resolution is two-pass, so a secret's `scope`/`key` can themselves reference
+already-resolved literal or environment values. It can also substitute `${VAR}`
+placeholders into any JSON file, leaving unknown placeholders intact.
+
+## Install
+
+```bash
+pip install brickvar
+```
+
+## Usage
+
+```python
+from brickvar import ConfigManager
+
+# dbutils is provided by the Databricks runtime; required only when a
+# variables file contains Key Vault secret entries.
+cfg = ConfigManager(dbutils=dbutils)
+
+# Resolve a variables file to a dict.
+variables = cfg.read_variables("variables.json")
+
+# Read a JSON file and substitute its ${VAR} placeholders from a variables file.
+spec = cfg.read_json("spec.json", "variables.json")
+```
+
+Example `variables.json`:
+
+```json
+{
+  "SECRET_SCOPE": { "env": "SECRET_SCOPE" },
+  "HOST": "example.documents.azure.us",
+  "CLIENT_ID": { "scope": "${SECRET_SCOPE}", "key": "SP-CLIENT-ID" },
+  "STORAGE": { "scope": "kv", "key": "ACCOUNT", "base": "abfss://data@{}/curated" }
+}
+```
+
+- `HOST` is a literal.
+- `SECRET_SCOPE` comes from the `SECRET_SCOPE` environment variable.
+- `CLIENT_ID` is a secret whose scope is filled from the resolved `SECRET_SCOPE`.
+- `STORAGE` is a secret wrapped by its `base` format string.
+
+## Development
+
+```bash
+python -m venv venv && source venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+[Apache-2.0](LICENSE)

brickvar-0.0.1/README.md

@@ -0,0 +1,65 @@
+# brickvar
+
+Resolve configuration variables for Databricks jobs from literals, environment
+variables, and Azure Key Vault secrets, and substitute them into JSON config files.
+
+`brickvar` reads a JSON "variables" file in which each entry is one of:
+
+- a **literal** string (which may reference other variables with `${VAR}`),
+- an **environment variable** reference — `{"env": "NAME"}`, or
+- a **Databricks / Azure Key Vault secret** — `{"scope": ..., "key": ..., "base"?: ...}`,
+  read through the Databricks `dbutils.secrets` API.
+
+Resolution is two-pass, so a secret's `scope`/`key` can themselves reference
+already-resolved literal or environment values. It can also substitute `${VAR}`
+placeholders into any JSON file, leaving unknown placeholders intact.
+
+## Install
+
+```bash
+pip install brickvar
+```
+
+## Usage
+
+```python
+from brickvar import ConfigManager
+
+# dbutils is provided by the Databricks runtime; required only when a
+# variables file contains Key Vault secret entries.
+cfg = ConfigManager(dbutils=dbutils)
+
+# Resolve a variables file to a dict.
+variables = cfg.read_variables("variables.json")
+
+# Read a JSON file and substitute its ${VAR} placeholders from a variables file.
+spec = cfg.read_json("spec.json", "variables.json")
+```
+
+Example `variables.json`:
+
+```json
+{
+  "SECRET_SCOPE": { "env": "SECRET_SCOPE" },
+  "HOST": "example.documents.azure.us",
+  "CLIENT_ID": { "scope": "${SECRET_SCOPE}", "key": "SP-CLIENT-ID" },
+  "STORAGE": { "scope": "kv", "key": "ACCOUNT", "base": "abfss://data@{}/curated" }
+}
+```
+
+- `HOST` is a literal.
+- `SECRET_SCOPE` comes from the `SECRET_SCOPE` environment variable.
+- `CLIENT_ID` is a secret whose scope is filled from the resolved `SECRET_SCOPE`.
+- `STORAGE` is a secret wrapped by its `base` format string.
+
+## Development
+
+```bash
+python -m venv venv && source venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+[Apache-2.0](LICENSE)

brickvar-0.0.1/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=77.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "brickvar"
+version = "0.0.1"
+description = "Resolve Databricks config variables from literals, environment variables, and Azure Key Vault secrets, and substitute them into JSON config files."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Afsin Ustundag", email = "afsin@amida.com" }]
+keywords = ["databricks", "config", "configuration", "secrets", "azure", "key-vault"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+]
+# No runtime dependencies: dbutils is supplied by the Databricks host at call time.
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-mock", "pytest-cov", "black", "pylint", "build", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/amida-tech/brickvar"
+Repository = "https://github.com/amida-tech/brickvar"
+Issues = "https://github.com/amida-tech/brickvar/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 120
+target-version = ["py39"]
+
+[tool.pylint.format]
+max-line-length = 120
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

brickvar-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

brickvar-0.0.1/src/brickvar/__init__.py

@@ -0,0 +1,6 @@
+"""brickvar: resolve Databricks config variables and substitute them into JSON files."""
+
+from brickvar.config import ConfigManager
+
+__all__ = ["ConfigManager"]
+__version__ = "0.0.1"

brickvar-0.0.1/src/brickvar/config.py

@@ -0,0 +1,94 @@
+"""Read JSON config files and resolve their variables.
+
+Variables come from literals, environment variables, and Azure Key Vault secrets
+(read through the Databricks ``dbutils.secrets`` API), and are substituted into the
+``${VAR}`` placeholders of arbitrary JSON files.
+"""
+
+import os
+import json
+import logging
+from string import Template
+
+logger = logging.getLogger(__name__)
+
+
+def unresolved_variables(content, provided):
+    """Variable names referenced as $name/${name} in content that provided does not supply."""
+    referenced = {match.group("named") or match.group("braced") for match in Template.pattern.finditer(content)}
+    referenced.discard(None)  # escaped ($$) and invalid ($) matches contribute None
+    return sorted(referenced - set(provided))
+
+
+class ConfigManager:  # pylint: disable=too-few-public-methods
+    """Reads JSON files and substitutes their ${VAR} placeholders from a variables file."""
+
+    def __init__(self, dbutils=None):
+        """Initialize ConfigManager with the Databricks utilities used to read secrets.
+
+        ``dbutils`` is only required when a variables file contains Key Vault secret
+        entries; literal- and environment-only files resolve without it.
+        """
+        self.dbutils = dbutils
+
+    def read_variables(self, filepath: str) -> dict:
+        """Read configuration variables from a JSON file.
+
+        Each entry maps a name to a value given in one of three forms: a literal string; an
+        environment-variable reference ``{"env": "NAME"}`` resolved from os.environ; or an Azure
+        Key Vault secret ``{"scope": ..., "key": ..., "base"?: ...}`` read via dbutils.
+
+        Resolution is two-pass so entries can reference each other: the first pass resolves the
+        literal and environment values, and the second resolves the secrets, substituting any
+        ``${VAR}`` in their scope/key/base from the already-resolved first-pass values (e.g. a
+        secret whose scope comes from an environment variable). Unknown ``${VAR}`` are left intact,
+        so plain literal scopes are unaffected.
+        """
+        with open(filepath, encoding="utf-8") as f:
+            content = json.load(f)
+        result = {}
+
+        # First pass: literal and environment values, which secret entries may reference.
+        for var_name, var_spec in content.items():
+            if isinstance(var_spec, str):
+                result[var_name] = Template(var_spec).safe_substitute(**result)
+            elif isinstance(var_spec, dict) and "env" in var_spec:
+                extra = set(var_spec) - {"env"}
+                if extra:
+                    logger.error("Variable %r: env entry has unexpected key(s): %s", var_name, ", ".join(sorted(extra)))
+                result[var_name] = os.environ[var_spec["env"]]
+
+        # Second pass: Key Vault secrets, whose scope/key/base may reference first-pass values.
+        for var_name, var_spec in content.items():
+            if not isinstance(var_spec, dict) or "env" in var_spec:
+                continue
+            extra = set(var_spec) - {"scope", "key", "base"}
+            if extra:
+                logger.error("Variable %r: secret entry has unexpected key(s): %s", var_name, ", ".join(sorted(extra)))
+            if ("scope" in var_spec) != ("key" in var_spec):
+                logger.error("Variable %r: secret entry needs both 'scope' and 'key'; one is missing", var_name)
+            scope = var_spec.get("scope")
+            key = var_spec.get("key")
+            if scope and key:
+                value = self.dbutils.secrets.get(
+                    Template(scope).safe_substitute(**result),
+                    Template(key).safe_substitute(**result),
+                )
+                base = var_spec.get("base")
+                result[var_name] = base.format(value) if base else value
+        return result
+
+    def read_json(self, filepath: str, var_filepath: str = None) -> dict:
+        """Read a JSON file, substituting ${VAR} placeholders from var_filepath when given.
+
+        Any placeholder the variables file does not supply is left intact and logged as a warning.
+        """
+        with open(filepath, encoding="utf-8") as f:
+            content = f.read()
+        if var_filepath is not None:
+            variables = self.read_variables(var_filepath)
+            unresolved = unresolved_variables(content, variables)
+            if unresolved:
+                logger.warning("Unresolved variable(s) in %s: %s", filepath, ", ".join(unresolved))
+            content = Template(content).safe_substitute(**variables)
+        return json.loads(content)

brickvar-0.0.1/src/brickvar.egg-info/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: brickvar
+Version: 0.0.1
+Summary: Resolve Databricks config variables from literals, environment variables, and Azure Key Vault secrets, and substitute them into JSON config files.
+Author-email: Afsin Ustundag <afsin@amida.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/amida-tech/brickvar
+Project-URL: Repository, https://github.com/amida-tech/brickvar
+Project-URL: Issues, https://github.com/amida-tech/brickvar/issues
+Keywords: databricks,config,configuration,secrets,azure,key-vault
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# brickvar
+
+Resolve configuration variables for Databricks jobs from literals, environment
+variables, and Azure Key Vault secrets, and substitute them into JSON config files.
+
+`brickvar` reads a JSON "variables" file in which each entry is one of:
+
+- a **literal** string (which may reference other variables with `${VAR}`),
+- an **environment variable** reference — `{"env": "NAME"}`, or
+- a **Databricks / Azure Key Vault secret** — `{"scope": ..., "key": ..., "base"?: ...}`,
+  read through the Databricks `dbutils.secrets` API.
+
+Resolution is two-pass, so a secret's `scope`/`key` can themselves reference
+already-resolved literal or environment values. It can also substitute `${VAR}`
+placeholders into any JSON file, leaving unknown placeholders intact.
+
+## Install
+
+```bash
+pip install brickvar
+```
+
+## Usage
+
+```python
+from brickvar import ConfigManager
+
+# dbutils is provided by the Databricks runtime; required only when a
+# variables file contains Key Vault secret entries.
+cfg = ConfigManager(dbutils=dbutils)
+
+# Resolve a variables file to a dict.
+variables = cfg.read_variables("variables.json")
+
+# Read a JSON file and substitute its ${VAR} placeholders from a variables file.
+spec = cfg.read_json("spec.json", "variables.json")
+```
+
+Example `variables.json`:
+
+```json
+{
+  "SECRET_SCOPE": { "env": "SECRET_SCOPE" },
+  "HOST": "example.documents.azure.us",
+  "CLIENT_ID": { "scope": "${SECRET_SCOPE}", "key": "SP-CLIENT-ID" },
+  "STORAGE": { "scope": "kv", "key": "ACCOUNT", "base": "abfss://data@{}/curated" }
+}
+```
+
+- `HOST` is a literal.
+- `SECRET_SCOPE` comes from the `SECRET_SCOPE` environment variable.
+- `CLIENT_ID` is a secret whose scope is filled from the resolved `SECRET_SCOPE`.
+- `STORAGE` is a secret wrapped by its `base` format string.
+
+## Development
+
+```bash
+python -m venv venv && source venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+[Apache-2.0](LICENSE)

brickvar-0.0.1/src/brickvar.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/brickvar/__init__.py
+src/brickvar/config.py
+src/brickvar.egg-info/PKG-INFO
+src/brickvar.egg-info/SOURCES.txt
+src/brickvar.egg-info/dependency_links.txt
+src/brickvar.egg-info/requires.txt
+src/brickvar.egg-info/top_level.txt
+tests/test_config.py

brickvar-0.0.1/src/brickvar.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

brickvar-0.0.1/src/brickvar.egg-info/requires.txt

@@ -0,0 +1,9 @@
+
+[dev]
+pytest
+pytest-mock
+pytest-cov
+black
+pylint
+build
+twine

brickvar-0.0.1/src/brickvar.egg-info/top_level.txt

@@ -0,0 +1 @@
+brickvar

brickvar-0.0.1/tests/test_config.py

@@ -0,0 +1,169 @@
+"""Tests for brickvar.config.ConfigManager."""
+
+from brickvar import ConfigManager
+from brickvar.config import unresolved_variables
+
+
+def test_read_variables_literal_and_cross_reference(mock_dbutils, write_json):
+    """Literal entries resolve as-is, and a later literal may reference an earlier one."""
+    var_path = write_json("vars.json", {"BASE": "root", "CHILD": "${BASE}/child"})
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    assert result == {"BASE": "root", "CHILD": "root/child"}
+
+
+def test_read_variables_from_environment(mock_dbutils, monkeypatch, write_json):
+    """An {"env": NAME} entry resolves from an environment variable."""
+    monkeypatch.setenv("VASRD_PATH", "abfss://vasrd@account/current")
+    var_path = write_json("vars.json", {"VASRD_PATH": {"env": "VASRD_PATH"}})
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    assert result == {"VASRD_PATH": "abfss://vasrd@account/current"}
+
+
+def test_read_variables_secret_with_base(mock_dbutils, write_json):
+    """A secret entry reads via dbutils and applies the optional base format string."""
+    var_path = write_json(
+        "vars.json",
+        {
+            "PLAIN": {"scope": "s", "key": "k"},
+            "WRAPPED": {"scope": "s", "key": "k", "base": "abfss://ci@{}/zero"},
+        },
+    )
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    mock_dbutils.secrets.get.assert_any_call("s", "k")
+    assert result["PLAIN"] == "s_k_value"
+    assert result["WRAPPED"] == "abfss://ci@s_k_value/zero"
+
+
+def test_read_variables_secret_scope_from_environment(mock_dbutils, monkeypatch, write_json):
+    """A secret entry's scope can reference an env-backed variable (two-pass resolution).
+
+    SCOPE is declared after the secret that uses it, confirming resolution is order-independent.
+    """
+    monkeypatch.setenv("SECRET_SCOPE", "NeoSecretScope")
+    var_path = write_json(
+        "vars.json",
+        {
+            "URL": {"scope": "${SCOPE}", "key": "STORAGE-URL"},
+            "SCOPE": {"env": "SECRET_SCOPE"},
+        },
+    )
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    # The scope ${SCOPE} resolved to the env value before the secret was fetched.
+    mock_dbutils.secrets.get.assert_any_call("NeoSecretScope", "STORAGE-URL")
+    assert result["URL"] == "NeoSecretScope_STORAGE-URL_value"
+    assert result["SCOPE"] == "NeoSecretScope"
+
+
+def test_read_variables_skips_incomplete_secret(mock_dbutils, write_json):
+    """A dict missing scope or key is not treated as a secret and is left out of the result."""
+    var_path = write_json(
+        "vars.json",
+        {"NO_KEY": {"scope": "s"}, "NO_SCOPE": {"key": "k"}, "GOOD": "literal"},
+    )
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    assert result == {"GOOD": "literal"}
+    mock_dbutils.secrets.get.assert_not_called()
+
+
+def test_read_variables_logs_error_for_env_entry_with_extra_key(mock_dbutils, monkeypatch, write_json, mocker):
+    """An env entry with any key beyond 'env' logs an error but still resolves from the environment."""
+    monkeypatch.setenv("HOST", "example.com")
+    var_path = write_json("vars.json", {"HOST": {"env": "HOST", "scope": "oops"}})
+    error = mocker.patch("brickvar.config.logger.error")
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    assert result == {"HOST": "example.com"}
+    error.assert_called_once()
+    assert "scope" in error.call_args.args[-1]
+
+
+def test_read_variables_logs_error_for_secret_entry_with_unexpected_key(mock_dbutils, write_json, mocker):
+    """A secret entry with keys outside scope/key/base logs an error but still resolves."""
+    var_path = write_json("vars.json", {"S": {"scope": "s", "key": "k", "bogus": 1}})
+    error = mocker.patch("brickvar.config.logger.error")
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    assert result["S"] == "s_k_value"
+    error.assert_called_once()
+    assert "bogus" in error.call_args.args[-1]
+
+
+def test_read_variables_logs_error_for_unpaired_scope_or_key(mock_dbutils, write_json, mocker):
+    """A secret entry with only one of scope/key logs an error and is not fetched."""
+    var_path = write_json("vars.json", {"NO_KEY": {"scope": "s"}, "NO_SCOPE": {"key": "k"}})
+    error = mocker.patch("brickvar.config.logger.error")
+
+    result = ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    assert result == {}
+    assert error.call_count == 2
+    mock_dbutils.secrets.get.assert_not_called()
+
+
+def test_read_variables_logs_no_error_for_valid_entries(mock_dbutils, write_json, mocker):
+    """Well-formed literal, env, and secret (with optional base) entries produce no error logs."""
+    var_path = write_json(
+        "vars.json",
+        {
+            "LIT": "x",
+            "PLAIN": {"scope": "s", "key": "k"},
+            "WRAPPED": {"scope": "s", "key": "k", "base": "ci@{}"},
+        },
+    )
+    error = mocker.patch("brickvar.config.logger.error")
+
+    ConfigManager(dbutils=mock_dbutils).read_variables(var_path)
+
+    error.assert_not_called()
+
+
+def test_read_json_substitutes_variables(mock_dbutils, write_json):
+    """read_json substitutes ${VAR} placeholders from the variables file."""
+    var_path = write_json("vars.json", {"HOST": "example.com", "DB": "grads"})
+    doc_path = write_json("doc.json", {"endpoint": "https://${HOST}", "database": "${DB}"})
+
+    result = ConfigManager(dbutils=mock_dbutils).read_json(doc_path, var_path)
+
+    assert result == {"endpoint": "https://example.com", "database": "grads"}
+
+
+def test_read_json_without_variables(mock_dbutils, write_json):
+    """read_json with no variables file returns the JSON unchanged."""
+    doc_path = write_json("doc.json", {"a": 1, "b": "${UNTOUCHED}"})
+
+    result = ConfigManager(dbutils=mock_dbutils).read_json(doc_path)
+
+    assert result == {"a": 1, "b": "${UNTOUCHED}"}
+
+
+def test_read_json_warns_on_unresolved_variable(mock_dbutils, write_json, mocker):
+    """A ${VAR} the variables file does not supply is left intact and logged as a warning."""
+    var_path = write_json("vars.json", {"PROVIDED": "ok"})
+    doc_path = write_json("doc.json", {"path": "${PROVIDED}", "extra": "${MISSING}"})
+    warning = mocker.patch("brickvar.config.logger.warning")
+
+    result = ConfigManager(dbutils=mock_dbutils).read_json(doc_path, var_path)
+
+    assert result == {"path": "ok", "extra": "${MISSING}"}
+    warning.assert_called_once()
+    # The warning names the unresolved variable, not the resolved one.
+    assert "MISSING" in warning.call_args.args[-1]
+    assert "PROVIDED" not in warning.call_args.args[-1]
+
+
+def test_unresolved_variables_helper():
+    """unresolved_variables reports referenced names absent from provided, ignoring escapes."""
+    content = "${A} and $B and $$C and ${D}"
+    assert unresolved_variables(content, {"A": 1}) == ["B", "D"]