Add validation to catch legacy imports #6081
Merged
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
Codecov Report
|
sarah-witt
reviewed
Mar 18, 2020
datadog_checks_dev/datadog_checks/dev/tooling/commands/validate/imports.py
Outdated
Show resolved
Hide resolved
| echo_debug(f'Checking {check_name}') | ||
|
|
||
| # focus on check and testing directories | ||
| bases = [os.path.join(integrations_root, check_name, base) for base in ('datadog_checks', 'tests')] |
There was a problem hiding this comment.
nit: some of the file/directory logic could be moved to functions in utils
There was a problem hiding this comment.
Could you clarify this one a bit? Which functions would be useful in as a utility function?
There was a problem hiding this comment.
I was thinking something like turning this line into get_python_files_for_check(check) or something like that. It could be useful for future scripts
There was a problem hiding this comment.
This is a good idea - but may be better suited for a separate PR. There are several options which could be helpful and not sure those discussions would be suited for here.
datadog_checks_dev/datadog_checks/dev/tooling/commands/validate/imports.py
Show resolved
Hide resolved
datadog_checks_dev/datadog_checks/dev/tooling/commands/validate/imports.py
Show resolved
Hide resolved
ChristineTChen
approved these changes
Mar 19, 2020
There was a problem hiding this comment.
Nice! Tested out locally
Validating imports avoiding deprecated modules ...
Validation failed: 152 deprecated imports found in 113 files:
/Users/christine.chen/dev/integrations-core/active_directory/datadog_checks/active_directory/active_directory.py: line # 3
from datadog_checks.checks.win import PDHBaseCheck
/Users/christine.chen/dev/integrations-core/activemq_xml/datadog_checks/activemq_xml/activemq_xml.py: line # 8
from datadog_checks.checks import AgentCheck
...
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.
Motivation
The
datadog_checkspackage was rearranged for all packages to be hosted under thebasesub package. The original module locations have been updated to redirect to those imports for backwards compatibility, but usage of them is deprecated.This tool will identify those imports and report them as errors, for future use in our CI.
It also includes an
autofixoption, to aid in the initial mass migration of changing all the files en masse before we introduce this validation to CI.