Add the ability to provide SDML Catalog path via an environment variable #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnstonskj
reviewed
Jan 16, 2025
| @@ -21,6 +21,7 @@ sdml-errors = { version = "0.3.1", path = "../sdml-errors" } | |||
| search_path = "0.1.4" | |||
| serde = { version = "1.0.210", features = ["derive"] } | |||
| serde_json = "1.0.128" | |||
| serial_test = "3.2.0" | |||
There was a problem hiding this comment.
Move this down to dev-dependencies
johnstonskj
reviewed
Jan 16, 2025
| @@ -51,6 +52,9 @@ pub const SDML_FILE_EXTENSION_LONG: &str = "sdml"; | |||
| /// The name used for resolver catalog files. | |||
| pub const SDML_CATALOG_FILE_NAME: &str = "sdml-catalog.json"; | |||
|
|
|||
| /// The environment variable used to override resolver catalog file location. | |||
| pub const SDML_CATALOG_FILE_VARIABLE: &str = "SDML_CATALOG"; | |||
There was a problem hiding this comment.
I would make this SDML_CATALOG_FILE, seems easier to understand, and you named the constant SDML_CATALOG_FILE_VARIABLE after all.
johnstonskj
requested changes
Jan 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability to provide the path to SDML catalog via an environment variable. It just changes the implementation of the default resolver, so it either takes path from the environment variable if present or it looks in the current folder (and traverses through the parent folders).
I have added unit test that verifies this behavior. Have added dependency on
serial_testas I need to ensure that the tests touching the environment variables are not running in parallel.Disclaimer: the diff contains also #16 as that allows me to have working tests.