Test regex names capitalization #206

PabloLec · 2021-10-11T15:59:53Z

Prerequisites

Have you read the documentation on contributing? https://github.com/bee-san/pyWhat/wiki/Adding-your-own-Regex

Why do we need this pull request?

Regex names capitalization are now tested.
Some words are ignored:

If they contain already one upper case char (e.g: SSH, URL, TOTP) or I also think about brand names like iPhone.
If they contain one numeric char like ed25519 or say, i18n.
If they are specified in the test (for now "a", "of", "etc).

What GitHub issues does this fix?

Make a test that tests whether the names of Regex are capitalised #205

Tell me what you think about the test and if you might have any false positive in my mind

ghost · 2021-10-11T16:19:29Z

tests/test_identifier.py

+
+    for entry in database:
+        entry_name = entry["Name"]
+        for word in entry_name.split(" "):


Why not just using split()?

Yep, got used to make it explicit due to a previous project :p Fixed it

bee-san

Thank you so much!!! :)

bee-san · 2021-10-11T16:42:08Z

tests/test_identifier.py

+def test_name_capitalization():
+    database = load_regexes()
+
+    for entry in database:
+        entry_name = entry["Name"]
+        for word in entry_name.split(" "):


Can we make a new test file test_regex_formating and move this test in there?

Also, can we move all other tests which test the format of that file? Like the rarity sorting 😄

bee-san · 2021-10-11T16:43:00Z

tests/test_identifier.py

+            if cleaned_word in ["a", "of", "etc"]:
+                continue
+
+            assert word.title() == word


When this test fails, can we please explain why it failed? There's an example of this with the ^ $ regex test which tells you exactly why it failed :)

codecov-commenter · 2021-10-11T17:13:39Z

Codecov Report

Merging #206 (55b3465) into main (669682c) will increase coverage by 0.06%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #206      +/-   ##
==========================================
+ Coverage   92.21%   92.27%   +0.06%     
==========================================
  Files          13       14       +1     
  Lines        1631     1644      +13     
==========================================
+ Hits         1504     1517      +13     
  Misses        127      127

Impacted Files	Coverage Δ
tests/test_identifier.py	`100.00% <ø> (ø)`
tests/test_regex_formatting.py	`100.00% <100.00%> (ø)`
tests/test_regex_identifier.py	`98.54% <100.00%> (-0.02%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 669682c...55b3465. Read the comment docs.

ghost

Please move test_if_all_tests_exist() to test_regex_formatting.py

PabloLec · 2021-10-11T17:20:42Z

Please move test_if_all_tests_exist()and test_sorted_by_rarity()to test_regex_formating.py

I just moved test_sorted_by_rarity(), I'm not sure if test_if_all_tests_exist() has to do with regex file formatting though ?

bee-san · 2021-10-11T17:23:10Z

Please move test_if_all_tests_exist()and test_sorted_by_rarity()to test_regex_formating.py

I just moved test_sorted_by_rarity(), I'm not sure if test_if_all_tests_exist() has to do with regex file formatting though ?

Make a new test file for testing the tests file? 👀

ghost · 2021-10-11T17:24:57Z

Please move test_if_all_tests_exist()and test_sorted_by_rarity()to test_regex_formating.py

I just moved test_sorted_by_rarity(), I'm not sure if test_if_all_tests_exist() has to do with regex file formatting though ?

Make a new test file for testing the tests file? 👀

That would be too much files, maybe rename test_regex_formatting.py?

bee-san · 2021-10-11T17:25:36Z

Please move test_if_all_tests_exist()and test_sorted_by_rarity()to test_regex_formating.py

I just moved test_sorted_by_rarity(), I'm not sure if test_if_all_tests_exist() has to do with regex file formatting though ?

Make a new test file for testing the tests file? 👀

That would be too much files, maybe rename test_regex_formatting.py?

That's only 5 test files? If we want, we could put them into folders, no?

PabloLec · 2021-10-11T17:28:43Z

By the way, I guess we should also move test_check_keys_in_json from test_identifier.py to test_regex_formatting.py ?

PabloLec · 2021-10-11T17:32:47Z

Please move test_if_all_tests_exist()and test_sorted_by_rarity()to test_regex_formating.py

I just moved test_sorted_by_rarity(), I'm not sure if test_if_all_tests_exist() has to do with regex file formatting though ?

Make a new test file for testing the tests file? eyes

That would be too much files, maybe rename test_regex_formatting.py?

That's only 5 test files? If we want, we could put them into folders, no?

I think test_if_all_tests_exist() could stay in test_regex_identifier.py. I mean it's not off topic, it is testing if all regex identifiers do have a regex identifier test.
It's related to the file name and of course related to all other tests in this file.

amadejpapez · 2021-10-11T17:35:21Z

Moving this special tests out of regular regex tests file seems like a good idea to me. Tho I don't know what to name the file or if more files would be better?

PabloLec · 2021-10-11T17:35:29Z

By the way, I guess we should also move test_check_keys_in_json from test_identifier.py to test_regex_formatting.py ?

I'll just move this one before merge

PabloLec · 2021-10-11T17:52:12Z

And while we are discussing tests files, I'm not sure about the usefulness of some tests in test_click.py. We do test that all regex work in test_regex_identifier.py and #202 plans to make it easier which is great. But there is a lot of repetition in test_click.py, every regex is also tested there. Either as an arg or from the fixture file.
I added some tests myself, as I seemed to be the way it was done but I'm not sure it is useful and pretty sure it could at least be simplified.
Any thoughts? Maybe I'm just missing something.

amadejpapez · 2021-10-11T18:02:47Z

When #202 gets merged with examples alongside in the database, we could maybe take those, write it to a file and run the file against pyWhat to verify that regex works if match is put in a file? But we also need to test boundaryless, so matches in between of something else..

PabloLec · 2021-10-11T18:08:12Z

Let's discuss this on #199

PabloLec added 3 commits October 11, 2021 17:34

Test regex names capitalization

7654ebd

Fix changed regex tests

388200a

Accept any name containing a num or an upper case char

59f1802

ghost reviewed Oct 11, 2021

View reviewed changes

bee-san reviewed Oct 11, 2021

View reviewed changes

Create regex formatting test file and move relative tests

d30469e

Move rarity sort test to regex_formatting

793e59c

ghost suggested changes Oct 11, 2021

View reviewed changes

Fix typo in file name

05bc984

bee-san approved these changes Oct 11, 2021

View reviewed changes

Move check_keys test to regex_formatting

55b3465

bee-san approved these changes Oct 11, 2021

View reviewed changes

bee-san merged commit 4ac82e6 into bee-san:main Oct 11, 2021

PabloLec mentioned this pull request Oct 11, 2021

Improve tests #199

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Test regex names capitalization #206

Test regex names capitalization #206

PabloLec commented Oct 11, 2021

ghost Oct 11, 2021 •

edited by ghost

PabloLec Oct 11, 2021

bee-san left a comment

bee-san Oct 11, 2021

bee-san Oct 11, 2021

codecov-commenter commented Oct 11, 2021 •

edited

ghost left a comment •

edited by ghost

PabloLec commented Oct 11, 2021

bee-san commented Oct 11, 2021

ghost commented Oct 11, 2021

bee-san commented Oct 11, 2021

PabloLec commented Oct 11, 2021 •

edited

PabloLec commented Oct 11, 2021 •

edited

amadejpapez commented Oct 11, 2021 •

edited

PabloLec commented Oct 11, 2021

PabloLec commented Oct 11, 2021 •

edited

amadejpapez commented Oct 11, 2021

PabloLec commented Oct 11, 2021

Test regex names capitalization #206

Test regex names capitalization #206

Conversation

PabloLec commented Oct 11, 2021

Prerequisites

Why do we need this pull request?

What GitHub issues does this fix?

ghost Oct 11, 2021 • edited by ghost

Choose a reason for hiding this comment

PabloLec Oct 11, 2021

Choose a reason for hiding this comment

bee-san left a comment

Choose a reason for hiding this comment

bee-san Oct 11, 2021

Choose a reason for hiding this comment

bee-san Oct 11, 2021

Choose a reason for hiding this comment

codecov-commenter commented Oct 11, 2021 • edited

Codecov Report

ghost left a comment • edited by ghost

Choose a reason for hiding this comment

PabloLec commented Oct 11, 2021

bee-san commented Oct 11, 2021

ghost commented Oct 11, 2021

bee-san commented Oct 11, 2021

PabloLec commented Oct 11, 2021 • edited

PabloLec commented Oct 11, 2021 • edited

amadejpapez commented Oct 11, 2021 • edited

PabloLec commented Oct 11, 2021

PabloLec commented Oct 11, 2021 • edited

amadejpapez commented Oct 11, 2021

PabloLec commented Oct 11, 2021

ghost Oct 11, 2021 •

edited by ghost

codecov-commenter commented Oct 11, 2021 •

edited

ghost left a comment •

edited by ghost

PabloLec commented Oct 11, 2021 •

edited

PabloLec commented Oct 11, 2021 •

edited

amadejpapez commented Oct 11, 2021 •

edited

PabloLec commented Oct 11, 2021 •

edited