Skip to content
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.

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

Skip EnsureRenderedStringPattern preprocessor if parameter has verbatim directives #19

Merged
merged 2 commits into from
Jan 8, 2019

Conversation

hyungoos
Copy link
Contributor

@hyungoos hyungoos commented Jan 8, 2019

  • Log warning message instead

@hyungoos
Copy link
Contributor Author

hyungoos commented Jan 8, 2019

Patch for #4

Copy link
Member

@mchalek mchalek left a comment

Choose a reason for hiding this comment

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

Hey @hyungoos thanks for contributing this fix! I had a minor request that I think will make this a little more generalizable to include some cases I had been considering for future work. If you wouldn't mind updating the PR, we can merge ASAP.

@@ -110,6 +110,14 @@ def process_arg(self, arg, node, raw_args):
regex.pattern)
return arg

VERBATIM_REGEX = '<<item_name>>|<<item.name>>|<<item.value>>'
Copy link
Member

Choose a reason for hiding this comment

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

Hey so one feature that I would like to support is the ability to actually require that the argument be a (or contain a) verbatim string... For example, there are some operators that take methods as arguments, and the only way we can support those right now is for the parameter passed to the operator to be a lambda (at the moment we do not enforce any restrictions on these, but we probably should).

So could we do the VERBATIM_REGEX check only if the regex.match() check fails? Maybe change the code to something like (starting at line 114 and replacing all of the rest of the method):

if regex.match(rendered_arg):
    return arg

VERBATIM_REGEX = ...
if re.compile(VERBATIM_REGEX).search(rendered_arg):
    logger.warning(...)
    return arg

raise Exception('Invalid argument...')

Copy link
Member

Choose a reason for hiding this comment

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

Oh and also, I think we can loosen the definition of the VERBATIM_STRING regex to something like <<.+>>, because generally speaking it's possible for any verbatim string to be present, and we can't check any of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the comments. Done!

assert renderer.process_arg(
"my-cluster-<<item.value>>", None, {},
) == "my-cluster-<<item.value>>"
warning_mock.assert_called_once()
Copy link
Member

Choose a reason for hiding this comment

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

Nice tests, thanks!

Copy link
Member

@mchalek mchalek left a comment

Choose a reason for hiding this comment

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

Awesome thanks @hyungoos !

@mchalek
Copy link
Member

mchalek commented Jan 8, 2019

@hyungoos sadly Travis is failing with a minor linter error, but it is also taking many minutes to launch new jobs right now. I am going to merge with the broken test, push the fix myself, and then i will deploy the new version.

@mchalek mchalek merged commit f492d9d into etsy:master Jan 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants