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

.github/actions/custom-woke-action/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2020 Caitlin Elfring <celfring@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

.github/actions/custom-woke-action/README.md

@@ -0,0 +1,78 @@
+# woke-action
+
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/get-woke/woke-action?logo=github&sort=semver)](https://github.com/get-woke/woke-action/releases)
+
+Woke GitHub Actions allow you to execute [`woke`](https://github.com/get-woke/woke) command within GitHub Actions.
+
+The output of the actions can be viewed from the Actions tab in the main repository view.
+
+## Usage
+
+The most common usage is to run `woke` on a file/directory. This workflow can be configured by adding the following content to the GitHub Actions workflow YAML file (ie in `.github/workflows/woke.yaml`).
+
+```yaml
+name: woke
+on:
+  - pull_request
+jobs:
+  woke:
+    name: woke
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: woke
+        uses: get-woke/woke-action@v0
+        with:
+          # Cause the check to fail on any broke rules
+          fail-on-error: true
+```
+
+## Inputs
+
+Inputs to configure the `woke` GitHub Actions.
+
+| Input            | Default               | Description                                                                                       |
+|------------------|-----------------------|---------------------------------------------------------------------------------------------------|
+| `woke-args`      | `.`                   | (Optional) Additional flags to run woke with (see <https://github.com/get-woke/woke#usage>) |
+| `woke-version`   | latest                | (Optional) Release version of `woke` (defaults to latest version)                                 |
+| `fail-on-error`  | `false`               | (Optional) Fail the GitHub Actions check for any failures.                                        |
+| `workdir`        | `.`                   | (Optional) Run `woke` this working directory relative to the root directory.                      |
+| `github-token`   | `${{ github.token }}` | (Optional) Custom GitHub Access token (ie `${{ secrets.MY_CUSTOM_TOKEN }}`).                      |
+
+## License
+
+This application is licensed under the MIT License, you may obtain a copy of it
+[here](https://github.com/get-woke/woke-action/blob/main/LICENSE).
+
+## Only Changed Files
+
+If you're interested in only running `woke` against files that have changed in a PR,
+consider something like [Get All Changed Files Action](https://github.com/marketplace/actions/get-all-changed-files). With this, you can add a workflow that looks like:
+
+```yaml
+
+name: 'woke'
+on:
+  - pull_request
+jobs:
+  woke:
+    name: 'woke'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v2
+
+      - uses: jitterbit/get-changed-files@v1
+        id: files
+
+      - name: 'woke'
+        uses: get-woke/woke-action@v0
+        with:
+          # Cause the check to fail on any broke rules
+          fail-on-error: true
+          # See https://github.com/marketplace/actions/get-all-changed-files
+          # for more options
+          woke-args: ${{ steps.files.outputs.added_modified }}
+```

.github/actions/custom-woke-action/action.yml

@@ -0,0 +1,46 @@
+name: 'Run woke'
+description: >-
+  Run woke on pull requests to detect non-inclusive language
+  in your source code.
+author: 'Caitlin Elfring (caitlinelfring)'
+inputs:
+  github-token:
+    description: 'GITHUB_TOKEN'
+    required: true
+    default: ${{ github.token }}
+  woke-args:
+    description: 'woke arguments'
+    default: '.'
+    required: false
+  fail-on-error:
+    description: |
+      Exit code when errors are found [true,false]
+      Default is `false`.
+    default: 'false'
+    required: false
+  workdir:
+    description: 'Working directory relative to the root directory.'
+    default: '.'
+    required: false
+  woke-version:
+    description: >-
+      woke version, defaults to the latest `v0` version.
+      Override to pin to a specific version
+    default: 'v0'
+    required: false
+runs:
+  using: 'composite'
+  steps:
+    - run: $GITHUB_ACTION_PATH/entrypoint.sh
+      shell: bash
+      env:
+        # INPUT_<VARIABLE_NAME> is not available in Composite run steps
+        # https://github.com/actions/runner/issues/665
+        INPUT_GITHUB_TOKEN: ${{ inputs.github-token }}
+        INPUT_WOKE_VERSION: ${{ inputs.woke-version }}
+        INPUT_WOKE_ARGS: ${{ inputs.woke-args }}
+        INPUT_FAIL_ON_ERROR: ${{ inputs.fail-on-error }}
+        INPUT_WORKDIR: ${{ inputs.workdir }}
+branding:
+  icon: 'check-circle'
+  color: 'gray-dark'

.github/actions/custom-woke-action/entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# shellcheck disable=SC2086
+
+set -e
+
+cd "${GITHUB_WORKSPACE}/${INPUT_WORKDIR}" || exit 1
+
+TEMP_PATH="$(mktemp -d)"
+PATH="${TEMP_PATH}:$PATH"
+
+echo '::group:: Installing woke ... https://github.com/nhosoi/woke'
+curl https://raw.githubusercontent.com/nhosoi/woke/main/woke -o "${TEMP_PATH}/woke"
+chmod 0755 "${TEMP_PATH}/woke"
+echo '::endgroup::'
+
+echo '::group:: Running woke ...'
+woke \
+  --output github-actions \
+  --exit-1-on-failure="${INPUT_FAIL_ON_ERROR:-false}" \
+  ${INPUT_WOKE_ARGS}
+echo '::endgroup::'

.github/actions/custom-woke-action/testdata/bad.txt

@@ -0,0 +1 @@
+I have a whitelist and a blacklist. What should I do about it?

.github/workflows/woke.yml

@@ -0,0 +1,19 @@
+# yamllint disable rule:line-length
+name: Check for non-inclusive language
+on:  # yamllint disable-line rule:truthy
+  - pull_request
+jobs:
+  woke:
+    name: woke
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: custom woke
+        # Originally, uses: get-woke/woke-action@v0
+        uses: ./.github/actions/custom-woke-action
+        with:
+          woke-args: "-c https://raw.githubusercontent.com/linux-system-roles/tox-lsr/main/src/tox_lsr/config_files/woke.yml --count-only-error-for-failure"
+          # Cause the check to fail on any broke rules
+          fail-on-error: true

CHANGELOG.md

@@ -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 -->
+- `master` is deprecated in favor of `controller` <!--- wokeignore:rule=master -->
 
 ### New features
 
 - Support disabling IPv6
 - Support `dns_options` when using one or more IPv4 nameservers
 - Support Ethtool coalesce settings
-- Support dummy interfaces
+- Support dummy interfaces <!--- wokeignore:rule=dummy -->
 
 ### Bug fixes
 

README.md

@@ -843,6 +843,7 @@ following options:
 
 - `all_ports_active`
 
+    <!--- wokeignore:rule=slave -->
     `all_slaves_active` in kernel and NetworkManager. The boolean value `false` drops
     the duplicate frames (received on inactive ports) and the boolean value `true`
     delivers the duplicate frames.

contributing.md

@@ -399,7 +399,7 @@ comment. The available commands are:
 - [citest] - Trigger a re-test for all machines.
 - [citest bad] - Trigger a re-test for all machines with an error or failure status.
 - [citest pending] - Trigger a re-test for all machines with a pending status.
-- [citest commit:<sha1\>] - Whitelist a commit to be tested if the submitter is not
+- [citest commit:<sha1\>] - Specify a commit to be tested if the submitter is not
   trusted.
 
 How to reach us

library/network_connections.py

@@ -140,9 +140,11 @@ def _link_infos_fetch():
         links = {}
         for ifname in os.listdir("/sys/class/net/"):
             if not os.path.islink("/sys/class/net/" + ifname):
-                # /sys/class/net may contain certain entries that are not
-                # interface names, like 'bonding_master'. Skip over files
-                # that are not links.
+                # /sys/class/net may contain certain entries
+                # that are not interface names, like
+                # wokeignore:rule=master
+                # 'bonding_master'.
+                # Skip over files that are not links.
                 continue
             links[ifname] = {
                 "ifindex": SysUtil._link_read_ifindex(ifname),
@@ -359,6 +361,7 @@ def ifcfg_create(
             ifcfg["TYPE"] = "Bridge"
         elif connection["type"] == "bond":
             ifcfg["TYPE"] = "Bond"
+            # wokeignore:rule=master
             ifcfg["BONDING_MASTER"] = "yes"
             opts = ["mode=%s" % (connection["bond"]["mode"])]
             if connection["bond"]["miimon"] is not None:
@@ -452,9 +455,12 @@ def ifcfg_create(
             if connection["port_type"] == "bridge":
                 ifcfg["BRIDGE"] = m
             elif connection["port_type"] == "bond":
+                # wokeignore:rule=master
                 ifcfg["MASTER"] = m
+                # wokeignore:rule=slave
                 ifcfg["SLAVE"] = "yes"
             elif connection["port_type"] == "team":
+                # wokeignore:rule=master
                 ifcfg["TEAM_MASTER"] = m
                 if "TYPE" in ifcfg:
                     del ifcfg["TYPE"]
@@ -894,13 +900,17 @@ def connection_create(self, connections, idx, connection_current=None):
                 if option in ["all_ports_active", "use_carrier", "tlb_dynamic_lb"]:
                     value = int(value)
                 if option in ["all_ports_active", "packets_per_port"]:
+                    # wokeignore:rule=slave
                     option = option.replace("port", "slave")
                 s_bond.add_option(option, str(value))
         elif connection["type"] == "team":
             s_con.set_property(NM.SETTING_CONNECTION_TYPE, NM.SETTING_TEAM_SETTING_NAME)
+        # wokeignore:rule=dummy
         elif connection["type"] == "dummy":
             s_con.set_property(
-                NM.SETTING_CONNECTION_TYPE, NM.SETTING_DUMMY_SETTING_NAME
+                # wokeignore:rule=dummy
+                NM.SETTING_CONNECTION_TYPE,
+                NM.SETTING_DUMMY_SETTING_NAME,
             )
         elif connection["type"] == "vlan":
             s_con.set_property(NM.SETTING_CONNECTION_TYPE, NM.SETTING_VLAN_SETTING_NAME)
@@ -1045,9 +1055,12 @@ def connection_create(self, connections, idx, connection_current=None):
 
         if connection["controller"] is not None:
             s_con.set_property(
-                NM.SETTING_CONNECTION_SLAVE_TYPE, connection["port_type"]
+                # wokeignore:rule=slave
+                NM.SETTING_CONNECTION_SLAVE_TYPE,
+                connection["port_type"],
             )
             s_con.set_property(
+                # wokeignore:rule=master
                 NM.SETTING_CONNECTION_MASTER,
                 ArgUtil.connection_find_controller_uuid(
                     connection["controller"], connections, idx

module_utils/network_lsr/argument_validator.py

@@ -1794,6 +1794,7 @@ class ArgValidator_DictConnection(ArgValidatorDict):
         "vlan",
         "macvlan",
         "wireless",
+        # wokeignore:rule=dummy
         "dummy",
     ]
     VALID_PORT_TYPES = ["bridge", "bond", "team"]
@@ -1828,10 +1829,12 @@ def __init__(self):
                     enum_values=ArgValidator_DictConnection.VALID_PORT_TYPES,
                 ),
                 ArgValidatorDeprecated(
+                    # wokeignore:rule=slave
                     "slave_type",
                     deprecated_by="port_type",
                 ),
                 ArgValidatorStr("controller"),
+                # wokeignore:rule=master
                 ArgValidatorDeprecated("master", deprecated_by="controller"),
                 ArgValidatorStr("interface_name", allow_empty=True),
                 ArgValidatorMac("mac"),

module_utils/network_lsr/ethtool.py

@@ -23,7 +23,9 @@ def get_perm_addr(ifname):
     ETHTOOL_GPERMADDR ioctl command.
 
     Please for further documentation, see:
+    wokeignore:rule=master
     https://github.com/torvalds/linux/blob/master/include/uapi/linux/ethtool.h#L734
+    wokeignore:rule=master
     https://github.com/torvalds/linux/blob/master/include/uapi/linux/ethtool.h#L1388
     https://git.kernel.org/pub/scm/network/ethtool/ethtool.git/tree/ethtool.c#n4172
     """

tests/ensure_provider_tests.py

@@ -67,7 +67,7 @@
     },
     "playbooks/tests_bond_options.yml": {},
     "playbooks/tests_eth_dns_support.yml": {},
-    "playbooks/tests_dummy.yml": {},
+    "playbooks/tests_dummy.yml": {},  # wokeignore:rule=dummy
     "playbooks/tests_infiniband.yml": {},
     "playbooks/tests_ipv6_disabled.yml": {},
     "playbooks/tests_ipv6_dns_search.yml": {},

tests/playbooks/tests_bond_options.yml

@@ -88,6 +88,7 @@
             - { key: 'ad_actor_system', value: '00:00:5e:00:53:5d'}
             - { key: 'ad_select', value: 'stable'}
             - { key: 'ad_user_port_key', value: '1023'}
+            # wokeignore:rule=slave
             - { key: 'all_slaves_active', value: '1'}
             - { key: 'downdelay', value: '0'}
             - { key: 'lacp_rate', value: 'slow'}