Skip to content

fix: log a warning on invalid schema validation #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 11, 2018
Merged

fix: log a warning on invalid schema validation #466

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion samtranslator/parser/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from samtranslator.validator.validator import SamTemplateValidator
from samtranslator.model import ResourceTypeResolver, sam_resources
from samtranslator.plugins import LifeCycleEvents
import logging
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This uses the root logger, which will log in any one using SAM to translate without a way to turn it off.

logging should be done by adding a __name__.

logger = logging.getLogger(__name__) and then log by doing logger.warning("Logging a Warning")

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you send a PR? How do other consumers then turn that off?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://stackoverflow.com/a/35325280

Should magically work. You can also manipulate the libraries logger too. For example, SAM CLI could then turn the SAM Translators logging on for a given level if they so wanted to.

Copy link

@fatbasstard fatbasstard Jun 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on https://stackoverflow.com/questions/24750523/disable-output-of-root-logger we're handling it like this now:

https://github.com/awslabs/cfn-python-lint/pull/117/files#diff-6d7631d1ad3e87ab0c24664abb771bc4R79 (Work In Progress)


class Parser:
def __init__(self):
Expand All @@ -25,4 +26,11 @@ def _validate(self, sam_template, parameter_values):
raise InvalidDocumentException(
[InvalidTemplateException("'Resources' section is required")])

SamTemplateValidator.validate(sam_template)
validation_errors = SamTemplateValidator.validate(sam_template)
has_errors = len(validation_errors)

if has_errors:
# NOTE: eventually we will throw on invalid schema
# raise InvalidDocumentException([InvalidTemplateException(validation_errors)])
logging.warning(
"JSON_VALIDATION_WARNING: {0}".format(validation_errors))