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

Add check for non-inclusive language; Clean up / Workaround non-inclusive words #551

Merged
merged 2 commits into from
Jan 19, 2023

Conversation

nhosoi
Copy link
Contributor

@nhosoi nhosoi commented Jan 15, 2023

Add check for non-inclusive language

Add a check for usage of terms and language that is considered non-inclusive. We are using the woke tool for this with a wordlist that can be found at
https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml

Note: this commit uses the customized woke placed locally in .github/actions/custom-woke-action to support a new option --count-only-error-for-failure option. The local action custom-woke-action will be replaced with the official woke once get-woke/woke#252 (Add an option "--count-only-error-for-failure") is processed.

Clean up / Workaround non-inclusive words.

  • CHANGELOG.md
  • README.md
  • contributing.md
  • library/network_connections.py
  • module_utils/network_lsr/argument_validator.py
  • module_utils/network_lsr/ethtool.py
  • tests/ensure_provider_tests.py
  • tests/playbooks/tests_bond_options.yml
  • tests/unit/test_network_connections.py

Additional note: There are too many warning level words master and dump to skip with # wokeignore:rule=word. So, I use the customized woke to skip the warning words in this PR. The # wokeignore:rule=word is mainly applied to the error level word slave (and warning level words in the python codes).

@coveralls
Copy link

coveralls commented Jan 15, 2023

Coverage Status

Coverage: 43.407%. Remained the same when pulling e7e156f on nhosoi:woke-action into c526da3 on linux-system-roles:main.

@nhosoi
Copy link
Contributor Author

nhosoi commented Jan 15, 2023

[citest]

@nhosoi
Copy link
Contributor Author

nhosoi commented Jan 16, 2023

I cannot reproduce the tests_network_state_nm-FAILED.log failure in RHEL-9.2.0-20230111.33/ansible-2.13/.

The latest compose available is RHEL-9.2.0-20230116.28. Could it be the issue?

@@ -170,15 +170,15 @@ Changelog
### Changes

- Use inclusive language
- `slave` is deprecated in favor of `port`
- `master` is deprecated in favor of `controller`
- `slave` is deprecated in favor of `port` <!--- wokeignore:rule=slave -->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The subject line of this PR may need to be properly adjusted. Because the changes are about workarounding the woke non-inclusive language failure with the wokeignore: rule=* comment.

@nhosoi nhosoi changed the title Add check for non-inclusive language Add check for non-inclusive language; Clean up / Workaround non-inclusive words Jan 16, 2023
- CHANGELOG.md
- README.md
- contributing.md
- library/network_connections.py
- module_utils/network_lsr/argument_validator.py
- module_utils/network_lsr/ethtool.py
- tests/ensure_provider_tests.py
- tests/playbooks/tests_bond_options.yml
- tests/unit/test_network_connections.py

Signed-off-by: Noriko Hosoi <[email protected]>
Add a check for usage of terms and language that is considered
non-inclusive. We are using the woke tool for this with a wordlist
that can be found at
https://github.com/linux-system-roles/tox-lsr/blob/main/src/tox_lsr/config_files/woke.yml

Note: this commit uses the customized woke placed locally in
    .github/actions/custom-woke-action to support a new option
    --count-only-error-for-failure option.
    The local action custom-woke-action will be replaced with
    the official woke once get-woke/woke#252
    (Add an option "--count-only-error-for-failure") is processed.

Signed-off-by: Noriko Hosoi <[email protected]>
@nhosoi
Copy link
Contributor Author

nhosoi commented Jan 18, 2023

@liangwen12year, it seems the coveralls failure disappeared by replacing

line  # wokeignore:rule=word

with

# wokeignore:rule=word
line

in library/network_connections.py and module_utils/network_lsr/argument_validator.py.

Could you please review this pr one more time? Thanks!

Copy link
Collaborator

@liangwen12year liangwen12year left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM now. Thanks.

@richm
Copy link
Contributor

richm commented Jan 18, 2023

LGTM now. Thanks.

ready to merge?

@nhosoi
Copy link
Contributor Author

nhosoi commented Jan 18, 2023

LGTM now. Thanks.

ready to merge?

I think so unless we are supposed to figure out this failure...

integration / integration (c7) (pull_request)
podman exec -i 261a047fb77a23027094bacd59e5097a796fc4c5a3425286d580d85ad7f29961 /bin/bash -c 'while ! systemctl is-active dbus; do sleep 1; done'
Failed to get D-Bus connection: Operation not permitted

@richm
Copy link
Contributor

richm commented Jan 18, 2023

LGTM now. Thanks.

ready to merge?

I think so unless we are supposed to figure out this failure...

No, not related.

integration / integration (c7) (pull_request)
podman exec -i 261a047fb77a23027094bacd59e5097a796fc4c5a3425286d580d85ad7f29961 /bin/bash -c 'while ! systemctl is-active dbus; do sleep 1; done'
Failed to get D-Bus connection: Operation not permitted

@nhosoi
Copy link
Contributor Author

nhosoi commented Jan 19, 2023

@liangwen12year, if ok, could you please merge this pr? Thanks!

@richm richm merged commit 75f2448 into linux-system-roles:main Jan 19, 2023
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.

4 participants