Add logging for canary auto generation and refactor canarySettings #1078
Conversation
This file contains hidden or 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
marc-1010
commented
Jun 27, 2024
| self._plugin = load_plugin(raw_settings["language"]) | ||
| self.settings = raw_settings.get("settings", {}) | ||
| self.canary_settings = raw_settings.get("canarySettings", {}) | ||
| if raw_settings.get("canarySettings", False) is False: |
Contributor
Author
There was a problem hiding this comment.
A has_canary_settings was added here to avoid having canary_settings being either an object or boolean.
marc-1010
commented
Jun 27, 2024
| ) | ||
| bootstrap_file = stack_template_root / CANARY_DEPENDENCY_FILE_NAME | ||
| if dependencies_file.exists(): | ||
| LOG.debug("Writing: %s", bootstrap_file) |
Contributor
Author
There was a problem hiding this comment.
logs for writing files are set at debug level. this is consistent with other write operations in this file.
marc-1010
commented
Jun 27, 2024
| return | ||
| LOG.info("Starting Canary Auto-Generation...") | ||
| if self.file_generation_enabled and self.canary_settings == {}: | ||
| LOG.warning( |
Contributor
Author
There was a problem hiding this comment.
this log is set at warning level to make the user aware of empty settings resulting in default generation.
marc-1010
changed the title
AidenAtSea
approved these changes
Jul 1, 2024
rajdnp
approved these changes
Jul 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Issue #, if available:
Description of changes:
file_generation_enabledfromcanarySettings. If the canarySettings field is provided with an empty object, canaries will be generated withcontract_test_file_names: [input1.json]default. If canarySettings are removed from .rpdk-config, no canary generation will occur.canarySettingsare provided but emptyinfolevel for skipping, starting, and finishing canary autogenerationdebuglevel for loading contract test inputs and writing canary file outputs.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.