Merge ~jugmac00/lazr.sshserver:apply-inclusive-naming into lazr.sshserver:main

[Jürgen Gmach]

Apply inclusive naming via the woke pre-commit hook

[Jürgen Gmach (jugmac00)]

@Colin - the replaced `_DummyTransport` did not look like a name, but more like an actual symbol. Maybe this refers to something in the past? Could not find that name, neither in this repo nor in LP from where it was split it seems.

[Colin Watson (cjwatson)]

`_DummyTransport` is a Twisted name - it's in `twisted.conch.ssh.session`. Given that that's outside our control, I think we should revert those changes here and add exemptions for them.

[Colin Watson (cjwatson)]

review: Needs Fixing

[Jürgen Gmach (jugmac00)]

> `_DummyTransport` is a Twisted name - it's in `twisted.conch.ssh.session`.
> Given that that's outside our control, I think we should revert those changes
> here and add exemptions for them.

Thank you for the reference.

Afaik you can only add inline ignores or next line ignores, while it still looks odd, I tried to come up with a readable solution.

I also created a discussion at https://github.com/get-woke/woke/discussions/159 - maybe there is another possibility to put a word in an allowlist.

Can I have another review? Thank you.

[Colin Watson (cjwatson)]

review: Approve

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index d4436ec..b6827cc 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -26,3 +26,7 @@ repos:
     rev: 5.10.1
     hooks:
     - id: isort
+-   repo: https://github.com/get-woke/woke
+    rev: v0.17.0
+    hooks:
+    -   id: woke-from-source
diff --git a/.woke.yaml b/.woke.yaml
new file mode 100644
index 0000000..71c13eb
--- /dev/null
+++ b/.woke.yaml
@@ -0,0 +1,228 @@
+
+# Based on Canonical's Guidelines
+# https://docs.google.com/document/d/1mJUa1VJHOMWa723dmKmNjSKGW-nlBv9xktzGZZwacVo/edit#heading=h.5efudb237qdb
+rules:
+  - name: whitelist
+    terms:
+      - whitelist
+      - white-list
+      - whitelisted
+      - white-listed
+    alternatives:
+      - allowlist
+      - inclusion list
+    severity: warning
+    note: "The underlying assumption of the whitelist/blacklist metaphor is that white = good and black = bad. Because colors in and of themselves have no predetermined meaning, any meaning we assign to them is cultural: for example, the color red in many Southeast Asian countries is lucky, and is often associated with events like marriages, whereas the color white carries the same connotations in many European countries. In the case of whitelist/blacklist, the terms originate in the publishing industry – one dominated by the USA and England, two countries which participated in slavery and which grapple with their racist legacies to this day."
+
+  - name: blacklist
+    terms:
+      - blacklist
+      - black-list
+      - blacklisted
+      - black-listed
+    alternatives:
+      - denylist
+      - blocklist
+      - exclusion list
+    severity: warning
+    note: "The underlying assumption of the whitelist/blacklist metaphor is that white = good and black = bad. Because colors in and of themselves have no predetermined meaning, any meaning we assign to them is cultural: for example, the color red in many Southeast Asian countries is lucky, and is often associated with events like marriages, whereas the color white carries the same connotations in many European countries. In the case of whitelist/blacklist, the terms originate in the publishing industry – one dominated by the USA and England, two countries which participated in slavery and which grapple with their racist legacies to this day."
+
+  - name: master-slave
+    terms:
+      - master-slave
+      - master/slave
+    alternatives:
+      - leader/follower
+      - main/replica
+      - primary/replica
+      - primary/standby
+      - primary/secondary
+
+  - name: slave
+    terms:
+      - slave
+    alternatives:
+      - follower
+      - replica
+      - standby
+
+  - name: grandfathered
+    terms:
+      - grandfathered
+    alternatives:
+      - legacy status
+      - legacied
+      - exempted
+      - carried
+      - brought forward
+      - rolled over
+
+  - name: man-hours
+    terms:
+      - man hours
+      - man-hours
+    alternatives:
+      - person hours
+      - engineer hours
+
+  - name: sanity
+    terms:
+      - sanity
+    alternatives:
+      - confidence
+      - quick check
+      - coherence check
+
+  - name: dummy
+    terms:
+      - dummy
+    alternatives:
+      - placeholder
+      - sample
+
+  - name: guys
+    terms:
+      - guys
+    alternatives:
+      - folks
+      - people
+      - you all
+      - y'all
+      - yinz
+
+  - name: whitebox
+    terms:
+      - white-box
+      - whitebox
+      - white box
+    alternatives:
+      - open-box
+
+  - name: blackbox
+    terms:
+      - black-box
+      - blackbox
+      - black box
+    alternatives:
+      - closed-box
+
+  - name: blackhat
+    terms:
+      - blackhat
+      - black-hat
+      - black hat
+    alternatives:
+      - attacker
+      - malicious actor
+
+  - name: whitehat
+    terms:
+      - whitehat
+      - white-hat
+      - white hat
+    alternatives:
+      - researcher
+      - security specialist
+
+  - name: illegal characters
+    terms:
+      - illegal characters
+    alternatives:
+      - invalid characters
+      - unsupported characters
+      - special characters
+
+  - name: native feature
+    terms:
+      - native feature
+    alternatives:
+      - core feature
+      - built-in feature
+
+  - name: native feature
+    terms:
+      - native feature
+    alternatives:
+      - core feature
+      - built-in feature
+
+  - name: chairman/foreman
+    terms:
+      - chairman
+      - foreman
+    alternatives:
+      - chair
+      - foreperson
+
+  - name: man in the middle
+    terms:
+      - man in the middle
+      - man-in-the-middle
+    alternatives:
+      - machine-in-the-middle
+      - person-in-the-middle
+      - system-in-the-middle
+      - intermediary attack
+
+  - name: middleman
+    terms:
+      - middleman
+    alternatives:
+      - middleperson
+      - intermediary
+
+  - name: manned
+    terms:
+      - manned
+    alternatives:
+      - crewed
+      - staffed
+      - monitored
+      - human operated
+
+  - name: mom test / girlfriend test
+    terms:
+      - mom test
+      - girlfriend test
+    alternatives:
+      - user test
+      - user friendly
+
+  - name: crazy
+    terms:
+      - crazy
+    alternatives:
+      - baffling
+      - unexplained
+      - errant
+
+  - name: cripples
+    terms:
+      - cripples
+    alternatives:
+      - slows down
+      - hinders
+      - obstructs
+
+  - name: crippling
+    terms:
+      - crippling
+    alternatives:
+      - attenuating
+      - incapacitating
+
+  - name: stonith/stomith
+    terms:
+      - stonith
+      - stomith
+    alternatives:
+      - fence failed nodes
+      - machines
+
+  - name: demilitarized zone
+    terms:
+      - demilitarized zone
+      - dmz
+    alternatives:
+      - perimeter network
+      - passthrough network
diff --git a/NEWS.txt b/NEWS.txt
index 43c2138..821a9cc 100644
--- a/NEWS.txt
+++ b/NEWS.txt
@@ -9,6 +9,7 @@ NEWS for lazr.sshserver
 - Add basic pre-commit configuration.
 - Apply black code formatter.
 - Add isort pre-commit hook.
+- Apply inclusive naming via the woke pre-commit hook.
 
 0.1.12 (2021-09-13)
 ===================
diff --git a/src/lazr/sshserver/session.py b/src/lazr/sshserver/session.py
index 29bde10..cdeefc3 100644
--- a/src/lazr/sshserver/session.py
+++ b/src/lazr/sshserver/session.py
@@ -57,8 +57,10 @@ class PatchedSSHSession(session.SSHSession, object):
         # necessary. See http://twistedmatrix.com/trac/ticket/2754.
         transport = getattr(self.client, "transport", None)
         if transport is not None:
-            # For SFTP connections, 'transport' is actually a _DummyTransport
-            # instance. Neither _DummyTransport nor the protocol it wraps
+            # name cannot be changed as it refers to a name in
+            # `twisted.conch.ssh.session``
+            # For SFTP connections, 'transport' is actually a _DummyTransport  # wokeignore:rule=dummy  # noqa: E501
+            # instance. Neither _DummyTransport nor the protocol it wraps  # wokeignore:rule=dummy  # noqa: E501
             # (filetransfer.FileTransferServer) support pausing.
             pauseProducing = getattr(transport, "pauseProducing", None)
             if pauseProducing is not None:
@@ -76,8 +78,10 @@ class PatchedSSHSession(session.SSHSession, object):
         # necessary. See http://twistedmatrix.com/trac/ticket/2754.
         transport = getattr(self.client, "transport", None)
         if transport is not None:
-            # For SFTP connections, 'transport' is actually a _DummyTransport
-            # instance. Neither _DummyTransport nor the protocol it wraps
+            # name cannot be changed as it refers to a name in
+            # `twisted.conch.ssh.session`
+            # For SFTP connections, 'transport' is actually a _DummyTransport  # wokeignore:rule=dummy  # noqa: E501
+            # instance. Neither _DummyTransport nor the protocol it wraps  # wokeignore:rule=dummy  # noqa: E501
             # (filetransfer.FileTransferServer) support pausing.
             resumeProducing = getattr(transport, "resumeProducing", None)
             if resumeProducing is not None:
diff --git a/src/lazr/sshserver/tests/test_auth.py b/src/lazr/sshserver/tests/test_auth.py
index 7fb7f21..58c7dae 100644
--- a/src/lazr/sshserver/tests/test_auth.py
+++ b/src/lazr/sshserver/tests/test_auth.py
@@ -91,8 +91,8 @@ class MockSSHTransport(SSHServerTransport):
 
     def __init__(self, portal):
         # In Twisted 8.0.1, Conch's transport starts referring to
-        # currentEncryptions where it didn't before. Provide a dummy value for
-        # it.
+        # currentEncryptions where it didn't before. Provide a placeholder
+        # value for it.
         self.currentEncryptions = SSHCiphers("none", "none", "none", "none")
         self.packets = []
         self.factory = self.Factory()
@@ -173,7 +173,6 @@ class TestUserAuthServer(UserAuthServerMixin, testtools.TestCase):
     def test_requestRaisesConchError(self):
         # ssh_USERAUTH_REQUEST should raise a ConchError if tryAuth returns
         # None. Added to catch a bug noticed by pyflakes.
-        # Whitebox test.
         def mock_try_auth(kind, user, data):
             return None