You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2019/08/17 08:43:53 UTC

[GitHub] [airflow] BasPH opened a new pull request #5847: [AIRFLOW-5241] Make test class names consistent by starting with Test

BasPH opened a new pull request #5847: [AIRFLOW-5241] Make test class names consistent by starting with Test
URL: https://github.com/apache/airflow/pull/5847
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Airflow Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
     - https://issues.apache.org/jira/browse/AIRFLOW-5241
     - In case you are fixing a typo in the documentation you can prepend your commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
     - In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Description
   
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   I believe there are many ways to improve the current test suite. To start, I suggest to make the test class naming consistent by always starting with "Test".
   
   Some insights:
   - There are 557 test classes (`grep -r "class" . | grep "TestCase" | wc -l`)
   - 240 of those start with "Test"
   - 277 of those end with "Test"
   - Leaving 40 classes with some other name, e.g. CliTests, PluginsTestRBAC and DagGcpSystemTestCase
   
   There is no convention AFAIK in unittest for test classes (only tests themselves -> start with "test"). I suggest to make all test classes start with "Test" because I know there is some work being done on moving to Pytest, which discovers test classes starting with "Test" ([link](http://doc.pytest.org/en/latest/goodpractices.html#conventions-for-python-test-discovery)).
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   This PR involved renaming all non Test* named test classes.
   
   I had to make one other change in tests/utils/test_helpers.py which contained two classes TestHelpers and HelpersTest, both testing exactly the same things, even with identical test names. I merged the two classes and merged the tests with identical names.
   
   ### 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](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain docstrings that explain what it does
     - If you implement backwards incompatible changes, please leave a note in the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so we can assign it to a appropriate release
   
   ### Code Quality
   
   - [ ] Passes `flake8`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services