Only use and install mslex on Windows (#36)

* Fix lint issues where encoding was not specified

* Only use and install mslex on Windows

* Escape backslash in test_windows

* Alter Windows CI name

Since we actually have some tests
other than the path sanity test, it
probably makes sense to just call it
a Windows test now.

* Disable pylint issue with mslex import

It's raising an unable to import issue with
that line, which makes sense since mslex wouldn't
be installed on any other platform other than Windows,
but it also wouldn't be run on any other platform so
it seems to be a non issue.

Co-authored-by: Eugene Triguba <[email protected]>

Author: eugenetriguba

.github/workflows/windows_sanity.yml renamed to .github/workflows/windows.yml

@@ -1,6 +1,7 @@
-# This workflow checks that windows paths (a\b\c) work correctly when passed as args to taskipy
+# This workflow checks that windows paths (a\b\c) work correctly when 
+# passed as args to taskipy and that mslex is installed.
 
-name: Taskipy Windows Sanity Test
+name: Taskipy Windows Tests
 
 on:
   push:
@@ -13,15 +14,15 @@ jobs:
     runs-on: windows-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.8
+    - name: Set up Python 3.9
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.9
     - name: Install Poetry
       run: |
         python -m pip install --upgrade pip
         pip install poetry
     - name: Install dependencies
       run: poetry install
-    - name: Test Windows-Style Paths
-      run: poetry run task run_unittest_as_windows_sanity tests\test_windows_sanity.py
+    - name: Test Windows
+      run: poetry run task test_windows

poetry.lock

@@ -23,7 +23,7 @@ task = 'taskipy.cli:main'
 python = "^3.6"
 toml = "^0.10.0"
 psutil = "^5.7.2"
-mslex = "^0.3.0"
+mslex = { version = "^0.3.0", markers = "sys_platform == 'win32'" }
 colorama = "^0.4.4"
 
 [tool.poetry.dev-dependencies]
@@ -36,7 +36,7 @@ psutil = "^5.6.7"
 test = { cmd = "python -m unittest -v tests/test_*.py", help = "runs all tests" }
 post_test = "./task lint"
 
-run_unittest_as_windows_sanity = { cmd = "python -m unittest -v", help = "this is a command that is run by our Windows CI on Github" }
+test_windows = { cmd = "python -m unittest -v tests\\test_windows.py", help = "this is a command that is run by our Windows CI on Github" }
 
 lint = { cmd = "./task lint_pylint && ./task lint_mypy", help = "lint project with pylint for style and mypy for typings" }
 lint_pylint = "pylint tests taskipy"

pyproject.toml

@@ -3,8 +3,6 @@
 import psutil  # type: ignore
 import signal
 import subprocess
-import shlex
-import mslex # type: ignore
 from pathlib import Path
 from typing import List, Union, Optional
 
@@ -13,6 +11,11 @@
 from taskipy.task import Task
 from taskipy.help import HelpFormatter
 
+if platform.system() == 'Windows':
+    import mslex as shlex  # type: ignore # pylint: disable=E0401
+else:
+    import shlex  # type: ignore[no-redef]
+
 
 class TaskRunner:
     def __init__(self, cwd: Union[str, Path]):
@@ -56,11 +59,6 @@ def __run_command_and_return_exit_code(self, command: str, args: List[str] = Non
         if self.__project.runner is not None:
             command = f'{self.__project.runner} {command}'
 
-        def quote_arg(arg: str) -> str:
-            if platform.system() == 'Windows':
-                return mslex.quote(arg)
-            return shlex.quote(arg)
-
         def send_signal_to_task_process(signum: int, _frame) -> None:
             # pylint: disable=W0640
             psutil_process_wrapper = psutil.Process(process.pid)
@@ -75,7 +73,7 @@ def send_signal_to_task_process(signum: int, _frame) -> None:
             else:
                 process.send_signal(signum)
 
-        command_with_args = ' '.join([command] + [quote_arg(arg) for arg in args])
+        command_with_args = ' '.join([command] + [shlex.quote(arg) for arg in args])
         process = subprocess.Popen(command_with_args,
                                    shell=True,
                                    cwd=self.__working_dir)

taskipy/task_runner.py

@@ -76,7 +76,7 @@ def test_running_task(self):
         cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
         self.run_task('create_hello_txt', cwd=cwd)
 
-        with open(path.join(cwd, 'hello.txt'), 'r') as f:
+        with open(path.join(cwd, 'hello.txt'), 'r', encoding='utf-8') as f:
             hello_file_contents = f.readline().strip()
 
         self.assertEqual(hello_file_contents, 'hello, world')

tests/test_taskipy.py

@@ -0,0 +1,26 @@
+import platform
+
+import unittest
+
+
+@unittest.skipIf(platform.system() != 'Windows', 'Windows only tests')
+class WindowsTestCase(unittest.TestCase):
+    def test_windows_path_sanity(self):
+        '''
+        This test case is a no-op, and exists only to ensure that windows paths work
+        as part of the windows sanity ci test.
+        '''
+        print('sanity passed - test was run')
+
+    def test_mslex_install(self):
+        '''Ensure that mslex is installed on Windows'''
+        try:
+            import mslex  # type: ignore # pylint: disable=W0611,C0415
+        except ImportError:
+            self.fail('Unable to import mslex')
+
+    def test_mslex_import(self):
+        '''Ensure that mslex is used as shlex'''
+        from taskipy.task_runner import shlex  # pylint: disable=C0415
+
+        self.assertEqual(shlex.__name__, 'mslex')

tests/test_windows.py

@@ -24,7 +24,7 @@ def __init__(self, py_project_toml: str):
 
     def generate_project(self, temp_dir: str):
         os.makedirs(temp_dir)
-        with open(path.join(temp_dir, 'pyproject.toml'), 'w') as f:
+        with open(path.join(temp_dir, 'pyproject.toml'), 'w', encoding='utf-8') as f:
             f.write(self._py_project_toml)