Add tests

.github/workflows/lint.yml

@@ -38,7 +38,6 @@ jobs:
             build-essential debhelper dh-python dh-apparmor
           git config --global --add safe.directory "$GITHUB_WORKSPACE"
       - uses: actions/checkout@v4
-
       - name: Test build
         run: |
           dpkg-buildpackage -b -i -us -uc
@@ -47,3 +46,5 @@ jobs:
         run: |
           set -o xtrace
           ./run-tests
+          git clone https://github.com/nickboucher/trojan-source
+          ./unicode-testscript

pyproject.toml

@@ -2,6 +2,8 @@
 line-length = 79
 [tool.mypy]
 strict="yes"
+[tool.pylint.'SIMILARITIES']
+min-similarity-lines=10
 [tool.pylint.'FORMAT']
 expected-line-ending-format="LF"
 max-line-length=79

run-tests

@@ -5,13 +5,14 @@ pyrc="${git_toplevel}/pyproject.toml"
 pythonpath="${git_toplevel}/usr/lib/python3/dist-packages"
 export PYTHONPATH="${pythonpath}${PYTHONPATH+":${PYTHONPATH}"}"
 
-pytest=(python3 -m pytest -o 'python_files=*.py')
+pytest=(python3 -m pytest -o 'python_files=tests/*.py')
 black=(black --config="${pyrc}" --color --diff --check)
 pylint=(pylint --rcfile="${pyrc}")
 mypy=(mypy --config-file="${pyrc}")
 
 cd "${pythonpath}/stdisplay/"
-"${pytest[@]}" "${@}"
+# Ideally, these variables should be ignored by the tests...
+NO_COLOR="" COLORTERM="" TERM="xterm-direct" "${pytest[@]}" "${@}"
 "${black[@]}" .
 find . -type f -name "*.py" -print0 | xargs -0 "${pylint[@]}"
 "${mypy[@]}" .

unicode-testscript

@@ -3,23 +3,15 @@
 ## Copyright (C) 2025 - 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ## See the file COPYING for copying conditions.
 
-## NOTE:
-## Assumes folder 'trojan-source' in the home folder.
-##
-## cd ~
-## git clone git@github.com:nickboucher/trojan-source.git
-
-## TODO: Convert into proper unit test and/or CI.
-
 #set -x
 set -e
 set -o nounset
 set -o pipefail
 set -o errtrace
 
-if [ "$(id -u)" = 0 ]; then
-   printf "%s\n" "$0: ERROR: No need to run as root!" >&2
-   exit 1
+if [ "$(id -u)" = 0 ] && [ -z "${GITHUB_WORKSPACE:-}" ]; then
+    printf "%s\n" "$0: ERROR: No need to run as root!" >&2
+    exit 1
 fi
 
 folder_list="Assembly  Bash  C  C#  C++  Go  Java  JavaScript  Python  RegEx  Rust  Solidity"

usr/bin/stcat

@@ -1,25 +1,12 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 ## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 ## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ##
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
-"""Safely print stdin or file to stdout."""
-
-from fileinput import input as file_input
-from sys import stdin, stdout
-from stdisplay.stdisplay import stdisplay
-
-
-def main() -> None:
-    """Safely print stdin or file to stdout."""
-    stdin.reconfigure(errors="ignore")  # type: ignore
-    ## File input reads stdin when no file is provided or file is '-'.
-    for untrusted_text in file_input(encoding="ascii", errors="replace"):
-        stdout.write(stdisplay(untrusted_text))
-    stdout.flush()
-
+from stdisplay.stcat import main
 
 if __name__ == "__main__":
     main()

usr/bin/stcatn

@@ -1,31 +1,12 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 ## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 ## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ##
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
-"""
-Safely print stdin or file to stdout with tweaks
-(trim trailing whitespace, ensure final newline).
-"""
-
-from fileinput import input as file_input
-from sys import stdin, stdout
-from stdisplay.stdisplay import stdisplay
-
-
-def main() -> None:
-    """
-    main
-    """
-    stdin.reconfigure(errors="ignore")  # type: ignore
-
-    for line in file_input(encoding="ascii", errors="replace"):
-        stdout.write(stdisplay(line).rstrip() + "\n")
-
-    stdout.flush()
-
+from stdisplay.stcatn import main
 
 if __name__ == "__main__":
     main()

usr/bin/stecho

@@ -1,24 +1,12 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 ## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 ## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ##
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
-"""Safely print argument to stdout with echo's formatting."""
-
-from sys import argv, stdout
-from stdisplay.stdisplay import stdisplay
-
-
-def main() -> None:
-    """Safely print argument to stdout with echo's formatting."""
-    if len(argv) > 1:
-        untrusted_text = " ".join(argv[1:])
-        stdout.write(stdisplay(untrusted_text))
-    stdout.write("\n")
-    stdout.flush()
-
+from stdisplay.stecho import main
 
 if __name__ == "__main__":
     main()

usr/bin/stprint

@@ -1,23 +1,12 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 ## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 ## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ##
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
-"""Safely print argument to stdout."""
-
-from sys import argv, stdout
-from stdisplay.stdisplay import stdisplay
-
-
-def main() -> None:
-    """Safely print argument to stdout."""
-    if len(argv) > 1:
-        untrusted_text = "".join(argv[1:])
-        stdout.write(stdisplay(untrusted_text))
-        stdout.flush()
-
+from stdisplay.stprint import main
 
 if __name__ == "__main__":
     main()

usr/bin/stsponge

@@ -1,35 +1,12 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 ## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 ## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ##
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
-"""Safely print stdin to stdout or file."""
-
-from sys import argv, stdin, stdout
-import shutil
-from tempfile import NamedTemporaryFile
-from stdisplay.stdisplay import stdisplay
-
-
-def main() -> None:
-    """Safely print stdin to stdout or file."""
-    untrusted_text_list = []
-    stdin.reconfigure(errors="ignore")  # type: ignore
-    for untrusted_text in stdin:
-        untrusted_text_list.append(untrusted_text)
-    if len(argv) == 1:
-        stdout.write(stdisplay("".join(untrusted_text_list)))
-        stdout.flush()
-    else:
-        with NamedTemporaryFile(mode="w", delete=False) as temp_file:
-            temp_file.write(stdisplay("".join(untrusted_text_list)))
-            temp_file.flush()
-        for file in argv[1:]:
-            shutil.copy2(temp_file.name, file)
-        temp_file.close()
-
+from stdisplay.stsponge import main
 
 if __name__ == "__main__":
     main()

usr/bin/sttee

@@ -1,28 +1,12 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 ## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 ## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
 ##
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
-"""Safely print stdin to stdout and file."""
-from sys import argv, stdin, stdout
-from stdisplay.stdisplay import stdisplay
-
-
-def main() -> None:
-    """Safely print stdin to stdout and file."""
-    untrusted_text_list = []
-    stdin.reconfigure(errors="ignore")  # type: ignore
-    for untrusted_text in stdin:
-        untrusted_text_list.append(untrusted_text)
-        stdout.write(stdisplay(untrusted_text))
-    stdout.flush()
-    if len(argv) > 1:
-        for file_arg in argv[1:]:
-            with open(file_arg, mode="w", encoding="ascii") as file:
-                file.write(stdisplay("".join(untrusted_text_list)))
-
+from stdisplay.sttee import main
 
 if __name__ == "__main__":
     main()

usr/lib/python3/dist-packages/stdisplay/stcat.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python3
+
+## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+"""Safely print stdin or file to stdout."""
+
+from fileinput import input as file_input
+from sys import stdin, stdout, modules
+from stdisplay.stdisplay import stdisplay
+
+
+def main() -> None:
+    """Safely print stdin or file to stdout."""
+    # https://github.com/pytest-dev/pytest/issues/4843
+    if "pytest" not in modules:
+        stdin.reconfigure(errors="ignore")  # type: ignore
+    ## File input reads stdin when no file is provided or file is '-'.
+    for untrusted_text in file_input(encoding="ascii", errors="replace"):
+        stdout.write(stdisplay(untrusted_text))
+    stdout.flush()
+
+
+if __name__ == "__main__":
+    main()

usr/lib/python3/dist-packages/stdisplay/stcatn.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+"""
+Safely print stdin or file to stdout with tweaks
+(trim trailing whitespace, ensure final newline).
+"""
+
+from fileinput import input as file_input
+from sys import stdin, stdout, modules
+from stdisplay.stdisplay import stdisplay
+
+
+def main() -> None:
+    """
+    main
+    """
+    # https://github.com/pytest-dev/pytest/issues/4843
+    if "pytest" not in modules:
+        stdin.reconfigure(errors="ignore")  # type: ignore
+
+    for line in file_input(encoding="ascii", errors="replace"):
+        stdout.write(stdisplay(line).rstrip() + "\n")
+
+    stdout.flush()
+
+
+if __name__ == "__main__":
+    main()

usr/lib/python3/dist-packages/stdisplay/stecho.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+
+## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+"""Safely print argument to stdout with echo's formatting."""
+
+from sys import argv, stdout
+from stdisplay.stdisplay import stdisplay
+
+
+def main() -> None:
+    """Safely print argument to stdout with echo's formatting."""
+    if len(argv) > 1:
+        untrusted_text = " ".join(argv[1:])
+        stdout.write(stdisplay(untrusted_text))
+    stdout.write("\n")
+    stdout.flush()
+
+
+if __name__ == "__main__":
+    main()

usr/lib/python3/dist-packages/stdisplay/stprint.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+
+## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+"""Safely print argument to stdout."""
+
+from sys import argv, stdout
+from stdisplay.stdisplay import stdisplay
+
+
+def main() -> None:
+    """Safely print argument to stdout."""
+    if len(argv) > 1:
+        untrusted_text = "".join(argv[1:])
+        stdout.write(stdisplay(untrusted_text))
+        stdout.flush()
+
+
+if __name__ == "__main__":
+    main()

usr/lib/python3/dist-packages/stdisplay/stsponge.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+
+## SPDX-FileCopyrightText: 2025 Benjamin Grande M. S. <ben.grande.b@gmail.com>
+## SPDX-FileCopyrightText: 2025 ENCRYPTED SUPPORT LLC <adrelanos@whonix.org>
+##
+## SPDX-License-Identifier: AGPL-3.0-or-later
+
+"""Safely print stdin to stdout or file."""
+
+from sys import argv, stdin, stdout, modules
+import shutil
+from tempfile import NamedTemporaryFile
+from stdisplay.stdisplay import stdisplay
+
+
+def main() -> None:
+    """Safely print stdin to stdout or file."""
+    # https://github.com/pytest-dev/pytest/issues/4843
+    if "pytest" not in modules:
+        stdin.reconfigure(errors="ignore")  # type: ignore
+    untrusted_text_list = []
+    for untrusted_text in stdin:
+        untrusted_text_list.append(untrusted_text)
+    if len(argv) == 1:
+        stdout.write(stdisplay("".join(untrusted_text_list)))
+        stdout.flush()
+    else:
+        with NamedTemporaryFile(mode="w", delete=False) as temp_file:
+            temp_file.write(stdisplay("".join(untrusted_text_list)))
+            temp_file.flush()
+        for file in argv[1:]:
+            shutil.copy2(temp_file.name, file)
+        temp_file.close()
+
+
+if __name__ == "__main__":
+    main()