Quality Assurance Improvements (#3)

Test:
* Create test_tree_reader.py
* Create test_tree_runner.py

Treescriptify:
* Update tree_reader.py - debug method generate_from_json
* Update tree_runner.py - remove unnecessary spaces between arguments

Workflow:
* Update ci_run.yml - increase code coverage limit to 95, add windows and macos ci tests, add python 3.11 tests, debug strategy matrix os

Author: DK96-OS

.github/workflows/ci_run.yml

@@ -11,10 +11,12 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
     strategy:
+      max-parallel: 3
       matrix:
-        python-version: [ '3.12' ]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [ '3.11', '3.12' ]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
@@ -23,13 +25,15 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install Dependencies
-        run: python -m pip install --user pytest pytest-cov
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest pytest-cov
 
       - name: Run unit tests
-        run: pytest test/ --cov --cov-report=html --cov-fail-under=75
+        run: pytest test/ --cov --cov-report=html --cov-fail-under=95
 
       - name: Upload Test Coverage Reports
         uses: actions/upload-artifact@v4
         with:
-          name: treescriptify-cov
+          name: treescriptify-cov-${{ matrix.os }}-${{ matrix.python-version }}
           path: htmlcov/

test/treescriptify/test_tree_reader.py

@@ -0,0 +1,40 @@
+"""Testing Module Methods
+"""
+import pytest
+
+from treescriptify.tree_node_data import TreeNodeData
+from treescriptify.tree_reader import generate_from_json
+
+
+def wrap_root_dir(inner_dirs: str) -> str:
+	return '{"type":"directory", "name":".", "contents":[' + inner_dirs + ']}'
+
+
+def get_src_dir() -> str:
+	return '{"type":"directory", "name":"src", "contents":[]}'
+
+
+def get_file(name: str) -> str:
+	return '{"type":"file","name":"' + name + '"}'
+
+
+def test_generate_from_json_empty_dir_returns_empty_list():
+	tree_gen = generate_from_json(wrap_root_dir(''))
+	assert list(tree_gen) == []
+
+
+def test_generate_from_json_src_dir_returns_tree_node():
+	tree_gen = generate_from_json(wrap_root_dir(get_src_dir()))
+	assert list(tree_gen) == [TreeNodeData(0, True, 'src')]
+
+
+@pytest.mark.parametrize(
+    'test_input,expected',
+    [
+        (wrap_root_dir(get_file('build.file')), [TreeNodeData(0, False, 'build.file')]),
+        (wrap_root_dir(get_file('build.file') + ',\n\t\t' + get_file('req.txt')), [TreeNodeData(0, False, 'build.file'), TreeNodeData(0, False, 'req.txt')]),
+    ]
+)
+def test_generate_from_json_(test_input, expected):
+	tree_gen = generate_from_json(test_input)
+	assert list(tree_gen) == expected

test/treescriptify/test_tree_runner.py

@@ -0,0 +1,41 @@
+"""Testing Module Methods
+"""
+import pytest
+import subprocess
+
+from input.input_data import InputData
+from treescriptify.tree_runner import _check_arguments, get_tree_json
+
+
+def get_cmd_result(*args, **kwargs):
+	result = type('MyObject', (object,), {'stdout': '[{"type":"directory","name":".","contents":[{"type":"file","name":"test_script_writer.py"},{"type":"file","name":"test_tree_reader.py"},{"type":"file","name":"test_tree_runner.py"}]}]'})
+	return result
+
+
+def test_get_tree_json_():
+	input_data = InputData()
+	with pytest.MonkeyPatch().context() as c:
+		c.setattr(subprocess, 'run', lambda *args, **kwargs: get_cmd_result(*args, **kwargs))
+		result = get_tree_json(input_data)
+		expected_files = [
+			"test_script_writer.py",
+			"test_tree_reader.py",
+			"test_tree_runner.py",
+		]
+		for filename in expected_files:
+			assert filename in result
+
+
+@pytest.mark.parametrize(
+    'test_input,expected',
+    [
+        (InputData(include_hidden=False, git_ignore=False), ''),
+        (InputData(git_ignore=False), '-a'),
+        (InputData(), '-a --gitignore'),
+        (InputData(directories_only=True), '-d -a --gitignore'),
+        (InputData(prune_dirs=True), '--prune -a --gitignore'),
+        (InputData(directories_only=True, prune_dirs=True), '-d --prune -a --gitignore'),
+    ]
+)
+def test_check_arguments(test_input, expected):
+	assert _check_arguments(test_input) == expected

treescriptify/tree_reader.py

@@ -9,7 +9,7 @@
 def generate_from_json(json_string: str) -> Generator[TreeNodeData, None, None]:
     """Read the JSON string and generate TreeNodeData for all elements.
     """
-    full_json = json.loads(json_string)[0]
+    full_json = json.loads(json_string)
     for i in full_json['contents']:
         for node in _process_node(i, 0):
             yield node

treescriptify/tree_runner.py

@@ -15,21 +15,20 @@ def get_tree_json(data: InputData) -> str:
         shell=True,
         timeout=3
     )
-    output = result.stdout
     #error = result.stderr
-    return output
+    return result.stdout
 
 
 def _check_arguments(data: InputData) -> str:
     """Check the Input Data and map flags to tree command.
     """
     extras = []
     if data.directories_only:
-        extras.append('-d ')
+        extras.append('-d')
     if data.prune_dirs:
-        extras += ['--prune ']
+        extras += ['--prune']
     if data.include_hidden:
-        extras += ['-a ']
+        extras += ['-a']
     if data.git_ignore:
-        extras.append('--gitignore ')
+        extras.append('--gitignore')
     return ' '.join(extras)