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

[AIRFLOW-3680] Consistency update in tests for All GCP-related operators #4485

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Jan 11, 2019

This commit performs consistency change for tests for all GCP-related operators.
The operators were evolving over time and the approach to implement those
have changed over time. After some 30+ operators implemented, it's time
to introduce some consistency across all the operators. Those are:

  • Separating out System test cases from Unit test cases
  • Consistent names of variables that are used in system test cases
  • Updated documentation to be consistent across the operators
  • Updated examples to be better readable and runnable as System Tests
  • Added helper methods that allow to make setUp/tearDown for System Tests

Make sure you have checked all steps below.

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"

Description

  • Here are some details about my PR, including screenshots of any UI changes:

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:

Commits

  • My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.
    • All the public functions and the classes in the PR contain docstrings that explain what it does

Code Quality

  • Passes flake8

This commit performs consistency change for tests for all GCP-related operators.
The operators were evolving over time and the approach to implement those
have changed over time. After some 30+ operators implemented, it's time
to introduce some consistency across all the operators. Those are:

* Separating out System test cases from Unit test cases
* Consistent names of variables that are used in system test cases
* Updated documentation to be consistent across the operators
* Updated examples to be better readable and runnable as System Tests
* Added helper methods that allow to make setUp/tearDown for System Tests
@potiuk potiuk closed this Jan 11, 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.

None yet

1 participant