Basic Unittests; GitHub Actions workflow

Author: Dimos082

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Python Multi-OS Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-and-test:
+    runs-on: ${{ matrix.os }}  # Matrix strategy picks OS
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [ "2.7", "3.12", "3.13" ]
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: |
+          python -m unittest discover -s tests

tests/test_cli_monitor_basic.py

@@ -0,0 +1,31 @@
+import unittest
+import subprocess
+
+class TestCliMonitorBasic(unittest.TestCase):
+    """Tests the most basic functionality of cli_monitor.py."""
+
+    def test_echo_command(self):
+        """Verify 'echo Hello' runs without errors and prints 'Hello'."""
+        cmd = [
+            "python", "cli_monitor.py",
+            "--command", "echo Hello",
+            "--timer", "2"  # short run
+        ]
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        self.assertEqual(result.returncode, 0)
+        self.assertIn("Hello", result.stdout)
+
+    def test_invalid_frequency(self):
+        """Frequency outside allowed range should cause an error exit."""
+        cmd = [
+            "python", "cli_monitor.py",
+            "--command", "echo Hello",
+            "--frequency", "999999999"  # way too large
+        ]
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        # Expecting a non-zero exit code due to frequency validation
+        self.assertNotEqual(result.returncode, 0)
+        self.assertIn("Error: Frequency must be between", result.stdout)
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_cli_monitor_logging.py

@@ -0,0 +1,36 @@
+import unittest
+import subprocess
+import os
+
+class TestCliMonitorLogging(unittest.TestCase):
+    """Tests output-file logging and log pruning."""
+
+    def setUp(self):
+        self.log_file = "test_log_output.txt"
+        # Remove log file if it exists
+        if os.path.exists(self.log_file):
+            os.remove(self.log_file)
+
+    def tearDown(self):
+        # Clean up log file
+        if os.path.exists(self.log_file):
+            os.remove(self.log_file)
+
+    def test_log_pruning(self):
+        """Check that log file pruning occurs once it exceeds max size."""
+        cmd = [
+            "python", "cli_monitor.py",
+            "--command", "echo TestLogLine",
+            "--output-file", self.log_file,
+            "--max-log-size", "1",  # 1KB to force quick pruning
+            "--timer", "3"          # run a few iterations
+        ]
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        self.assertEqual(result.returncode, 0)
+        # We expect the log file to exist, but be under or ~1KB
+        self.assertTrue(os.path.exists(self.log_file))
+        file_size = os.path.getsize(self.log_file)
+        self.assertLessEqual(file_size, 1024, "Log file should be pruned to <= 1KB")
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_cli_monitor_regex.py

@@ -0,0 +1,35 @@
+import unittest
+import subprocess
+
+class TestCliMonitorRegex(unittest.TestCase):
+    """Tests regex matching and triggered command execution."""
+
+    def test_regex_trigger(self):
+        """Should detect 'ERROR' and run the triggered command."""
+        cmd = [
+            "python", "cli_monitor.py",
+            "--command", "echo ERROR OCCURRED",
+            "--regex", "ERROR",
+            "--regex-execute", "echo 'Trigger ran!'",
+            "--timer", "2"
+        ]
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        self.assertEqual(result.returncode, 0)
+        self.assertIn("ERROR OCCURRED", result.stdout)      # Main command output
+        self.assertIn("Trigger ran!", result.stdout)        # Triggered command output
+
+    def test_no_regex_no_trigger(self):
+        """No triggered command should run if no regex is provided."""
+        cmd = [
+            "python", "cli_monitor.py",
+            "--command", "echo Hello Again",
+            "--timer", "2"
+        ]
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        self.assertEqual(result.returncode, 0)
+        self.assertIn("Hello Again", result.stdout)
+        # Ensure we DON'T see "Trigger ran!"
+        self.assertNotIn("Trigger ran!", result.stdout)
+
+if __name__ == "__main__":
+    unittest.main()