[jira] [Commented] (AIRFLOW-4054) assertEqualIgnoreMultipleSpaces doesn't have test and passes when it should fail

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AIRFLOW-4054?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16788785#comment-16788785 ] 

ASF GitHub Bot commented on AIRFLOW-4054:
-----------------------------------------

jucke commented on pull request #4886: AIRFLOW-4054 Fix assertEqualIgnoreMultipleSpaces util and add tests
URL: https://github.com/apache/airflow/pull/4886
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] 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-4054
     - 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)).
   
   ### Description
   
   `assertEqualIgnoreMultipleSpaces` util doesn't have tests, but is used in multiple tests: https://github.com/apache/airflow/search?q=assertEqualIgnoreMultipleSpaces&unscoped_q=assertEqualIgnoreMultipleSpaces
   
   It compares two strings after trimming white spaces. Currently assertion passes even when strings are different. Reason is that `_trim(s)` method doesn't have a return statement, therefore returning `None` for both first and second trimmed strings.
   
   ```
   def assertEqualIgnoreMultipleSpaces(case, first, second, msg=None):
   	def _trim(s):
   	        re.sub(r"\s+", " ", s.strip())
   	return case.assertEqual(_trim(first), _trim(second), msg)
    ```
   
   Is causes `assertEqual` compare `None` with `None`, therefore forcing assertion `assertEqualIgnoreMultipleSpaces` to pass.
   
   Code change is:
   
   ```
   def assertEqualIgnoreMultipleSpaces(case, first, second, msg=None):
   	def _trim(s):
   	        return re.sub(r"\s+", " ", s.strip())
   	return case.assertEqual(_trim(first), _trim(second), msg)
    ```
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   * Test that `assertEqualIgnoreMultipleSpaces` passes when strings are equal after trimming white space
   * Test that `assertEqualIgnoreMultipleSpaces` throws `AssertionError` when strings are not equal after trimming white space
   
   ### 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.
     - 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
     - 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


> assertEqualIgnoreMultipleSpaces doesn't have test and passes when it should fail
> --------------------------------------------------------------------------------
>
>                 Key: AIRFLOW-4054
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-4054
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: utils
>            Reporter: Julia
>            Priority: Major
>
> assertEqualIgnoreMultipleSpaces util is supposed to compare two strings trimming white spaces. Currently assertion passes even when strings are completely different. No tests exist for this.
>   
> {code:java}
> def assertEqualIgnoreMultipleSpaces(case, first, second, msg=None):
>     def _trim(s):
>         re.sub(r"\s+", " ", s.strip())
>     return case.assertEqual(_trim(first), _trim(second), msg)
> {code}
>  
> Reason is that _trim(s) method doesn't have a return statement, therefore returning None for first and second trimmed string. Is causes assertEqual compare None with None, forcing assertion assertEqualIgnoreMultipleSpaces to pass.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)