First 2 keywords for case-insensitive string comparison #2447
Conversation
This file contains hidden or 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
…d not be changed when running
…rings" perform string compares case-insensitively; Modified the Acceptance tests affected by the above 2 keywords; Added an Acceptance test to prove out the case-insensitive string comparison;
…rings" perform string compares case-insensitively; (#1) Modified the Acceptance tests affected by the above 2 keywords; Added an Acceptance test to prove out the case-insensitive string comparison;
pekkaklarck
requested changes
Sep 22, 2016
There was a problem hiding this comment.
This looks pretty good already. Fixing tests that are broken due to new argument is a very good catch.
I added some comments about things I hope could be changed. Most of them are pretty minor and something you couldn't possibly know beforehand. The only real bug seems to be using str().
| @@ -74,6 +74,10 @@ Should Not Be Equal with bytes containing non-ascii characters | |||
| Should Not Be Equal ${BYTES WITH NON ASCII} unicode | |||
| Should Not Be Equal ${BYTES WITH NON ASCII} ${BYTES WITH NON ASCII} | |||
|
|
|||
| Should Be Equal With Case Insensitivity | |||
| Should Be Equal "test value" "TEST VALUE" ignore_case=True | |||
| Should Be Equal As Strings "test value" "TEST VALUE" ignore_case=True | |||
There was a problem hiding this comment.
- Quotes in the verified text are not necessary and mainly confuse reader.
- I'd prefer having case-insensitive test after normal Should Be Equal test.
- Should test also with non-ASCII characters. For example that
HYVÄÄ YÖTÄ(good night in Finnish) equalshyvää yötäcase-insensitively. Could consider using[Template]like many other tests here. - Should Be Equal As Strings should get its own test after normal Should Be Equal As Strings test.
| @@ -613,9 +613,16 @@ def should_be_equal(self, first, second, msg=None, values=True): | |||
| for example, string ``false`` or ``no values``. See `Boolean arguments` | |||
| section for more details. | |||
|
|
|||
| ``ignore_case`` is False by default. It is a boolean value, and if True | |||
| indicates that 'first' and 'second' should be compared case-insensitively, | |||
| provided that 'first' and 'second' are string types. | |||
There was a problem hiding this comment.
- Docs should refer to
Boolean argumentssection about possible values forignore_case. You can check how other keywords here do it. Values should also be handled according to that section, but more about that below. - Should use double-backticks style also with arguments
firstandsecond. - Should add a note that this is a new feature in Robot Framework 3.0.1.
| If both arguments are multiline strings, the comparison is done using | ||
| `multiline string comparisons`. | ||
| """ | ||
| if ignore_case and is_string(first) and is_string(second): |
There was a problem hiding this comment.
Should use is_truthy(ignore_case) similarly as other keywords accepting Boolean values. See also the previous comment about docs referring to Boolean arguments section.
| If both arguments are multiline strings, the comparison is done using | ||
| `multiline string comparisons`. | ||
| """ | ||
| if ignore_case and is_string(first) and is_string(second): | ||
| first = str(first).lower() | ||
| second = str(second).lower() |
There was a problem hiding this comment.
Must not use str() here because it won't handle non-ASCII characters in Python 2. If we know values are strings, we can simply do first = first.lower(). Adding a test for non-ASCII stuff like I proposed in another comment is a good idea.
8 tasks
…o krizex-master
PR #2438 by @krizex already fixed the problem with settings preserving some date between runds he had reported as #2437. This commit slightly cleans up the code and unit tests in the PR. A new unit/integration test to validate the real problem with --rerunfailed that this problem caused is added too.
Added Pygments styles and configured docutils to be compatible with them. Embedding Pygments styles to all Libdoc outputs may be a bit questionable, but they are small enough that I don't think it is a real problem. We may also later add syntax highlighting to Libdoc's default syntax too. Also made background color used by examples etc. in Libdoc outputs and also in logs and reports a little lighter. Syntax highlighting looks better on a little lighter background and this background color is used also in the User Guide.
No need to use external Robot lexer anymore now that Pygments 2.1 suppors all new features. Also made it an error to use invalid syntax highlight language.
…bles, such that returned messages match the currently expected output (e.g. "FAIL: 'test' != 'TEST1'" rather than"FAIL: 'test' != 'test1'" when the user passed in "TEST1"); Added Acceptance tests for all the keywords affected by the case-insensitivity changes;
…d not be changed when running
PR #2438 by @krizex already fixed the problem with settings preserving some date between runds he had reported as #2437. This commit slightly cleans up the code and unit tests in the PR. A new unit/integration test to validate the real problem with --rerunfailed that this problem caused is added too.
Added Pygments styles and configured docutils to be compatible with them. Embedding Pygments styles to all Libdoc outputs may be a bit questionable, but they are small enough that I don't think it is a real problem. We may also later add syntax highlighting to Libdoc's default syntax too. Also made background color used by examples etc. in Libdoc outputs and also in logs and reports a little lighter. Syntax highlighting looks better on a little lighter background and this background color is used also in the User Guide.
No need to use external Robot lexer anymore now that Pygments 2.1 suppors all new features. Also made it an error to use invalid syntax highlight language.
…rings" perform string compares case-insensitively; Modified the Acceptance tests affected by the above 2 keywords; Added an Acceptance test to prove out the case-insensitive string comparison;
…bles, such that returned messages match the currently expected output (e.g. "FAIL: 'test' != 'TEST1'" rather than"FAIL: 'test' != 'test1'" when the user passed in "TEST1"); Added Acceptance tests for all the keywords affected by the case-insensitivity changes;
…rk into CaseInsensitive
…rings" perform string compares case-insensitively; Modified the Acceptance tests affected by the above 2 keywords; Added an Acceptance test to prove out the case-insensitive string comparison;
…bles, such that returned messages match the currently expected output (e.g. "FAIL: 'test' != 'TEST1'" rather than"FAIL: 'test' != 'test1'" when the user passed in "TEST1"); Added Acceptance tests for all the keywords affected by the case-insensitivity changes;
…rings" perform string compares case-insensitively; Modified the Acceptance tests affected by the above 2 keywords; Added an Acceptance test to prove out the case-insensitive string comparison;
…bles, such that returned messages match the currently expected output (e.g. "FAIL: 'test' != 'TEST1'" rather than"FAIL: 'test' != 'test1'" when the user passed in "TEST1"); Added Acceptance tests for all the keywords affected by the case-insensitivity changes;
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.
…rings" perform string compares case-insensitively; (#1)
Modified the Acceptance tests affected by the above 2 keywords;
Added an Acceptance test to prove out the case-insensitive string comparison;