Merge pull request #144 from slauger/feature/mock-nitro-api

Add Mock NITRO API Server for Integration Testing

Author: slauger

.github/workflows/lint-and-type-check.yml

@@ -36,7 +36,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -e .
-          pip install ruff black mypy types-requests pytest
+          pip install ruff black mypy types-requests pytest flask
 
       - name: Run ruff (linting)
         run: |
@@ -60,7 +60,7 @@ jobs:
       - name: Run tests
         run: |
           echo "Running pytest..."
-          pytest tests/ -v --tb=short
+          pytest tests/ -vv --tb=short
         continue-on-error: false
 
   summary:

.github/workflows/pyinstaller.yml

@@ -32,7 +32,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -e .
-        pip install ruff black mypy types-requests pytest
+        pip install ruff black mypy types-requests pytest flask
 
     - name: Run ruff (linting)
       run: |
@@ -55,7 +55,7 @@ jobs:
     - name: Run tests
       run: |
         echo "Running pytest..."
-        pytest tests/ -v --tb=short
+        pytest tests/ -vv --tb=short
       continue-on-error: false
 
   build:

.github/workflows/release.yml

@@ -44,7 +44,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -e .
-          pip install ruff black mypy types-requests pytest
+          pip install ruff black mypy types-requests pytest flask
 
       - name: Run ruff (linting)
         run: |
@@ -67,7 +67,7 @@ jobs:
       - name: Run tests
         run: |
           echo "Running pytest..."
-          pytest tests/ -v --tb=short
+          pytest tests/ -vv --tb=short
         continue-on-error: false
 
       - name: Test CLI

README.md

@@ -69,6 +69,25 @@ pip install .
 pip install -e ".[dev]"
 ```
 
+### Pre-built Binaries (Standalone)
+
+For systems without Python or pip, download standalone executables from the [Releases page](https://github.com/slauger/check_netscaler/releases):
+
+- **Linux**: `check_netscaler-linux`
+- **macOS**: `check_netscaler-macos`
+- **Windows**: `check_netscaler-windows.exe`
+
+These binaries are built with PyInstaller and include all dependencies. No Python installation required.
+
+```bash
+# Linux/macOS example
+chmod +x check_netscaler-linux
+./check_netscaler-linux --help
+
+# Windows example
+check_netscaler-windows.exe --help
+```
+
 ## Quick Start
 
 ```bash

check_netscaler/commands/license.py

@@ -120,7 +120,9 @@ def _get_license_files(self) -> List[str]:
 
         # Get all .lic files from /nsconfig/license
         try:
-            data = self.client.get_config("systemfile", args="filelocation:/nsconfig/license")
+            data = self.client.get_config(
+                "systemfile", url_options="args=filelocation:/nsconfig/license"
+            )
 
             if "systemfile" not in data:
                 return []
@@ -151,7 +153,8 @@ def _check_license_file(self, filename: str, warning_days: int, critical_days: i
         try:
             # Get license file content
             data = self.client.get_config(
-                "systemfile", args=f"filelocation:/nsconfig/license,filename:{filename}"
+                "systemfile",
+                url_options=f"args=filelocation:/nsconfig/license,filename:{filename}",
             )
 
             if "systemfile" not in data:

check_netscaler/commands/ntp.py

@@ -230,65 +230,68 @@ def _check_thresholds(self, ntp_info: Dict, thresholds: Dict) -> tuple:
         offset = float(ntp_info["synced_offset"])
         offset_text = f"Offset {ntp_info['synced_offset']} secs"
 
-        if thresholds["offset_critical"] is not None:
-            if abs(offset) >= thresholds["offset_critical"]:
-                worst_status = STATE_CRITICAL
-                offset_text += " (CRITICAL)"
-        elif thresholds["offset_warning"] is not None:
-            if abs(offset) >= thresholds["offset_warning"]:
-                worst_status = STATE_WARNING
-                offset_text += " (WARNING)"
+        if (
+            thresholds["offset_critical"] is not None
+            and abs(offset) >= thresholds["offset_critical"]
+        ):
+            worst_status = STATE_CRITICAL
+            offset_text += " (CRITICAL)"
+        elif (
+            thresholds["offset_warning"] is not None and abs(offset) >= thresholds["offset_warning"]
+        ):
+            worst_status = STATE_WARNING
+            offset_text += " (WARNING)"
 
         messages.append(offset_text)
 
         # Check jitter
         jitter = ntp_info["synced_jitter"]
         jitter_text = f"jitter={jitter}"
 
-        if thresholds["jitter_critical"] is not None:
-            if jitter >= thresholds["jitter_critical"]:
-                if worst_status != STATE_CRITICAL:
-                    worst_status = STATE_CRITICAL
-                jitter_text += " (CRITICAL)"
-        elif thresholds["jitter_warning"] is not None:
-            if jitter >= thresholds["jitter_warning"]:
-                if worst_status == STATE_OK:
-                    worst_status = STATE_WARNING
-                jitter_text += " (WARNING)"
+        if thresholds["jitter_critical"] is not None and jitter >= thresholds["jitter_critical"]:
+            if worst_status != STATE_CRITICAL:
+                worst_status = STATE_CRITICAL
+            jitter_text += " (CRITICAL)"
+        elif thresholds["jitter_warning"] is not None and jitter >= thresholds["jitter_warning"]:
+            if worst_status == STATE_OK:
+                worst_status = STATE_WARNING
+            jitter_text += " (WARNING)"
 
         messages.append(jitter_text)
 
         # Check stratum (higher is worse)
         stratum = ntp_info["synced_stratum"]
         stratum_text = f"stratum={stratum}"
 
-        if thresholds["stratum_critical"] is not None:
-            if stratum > thresholds["stratum_critical"]:
-                if worst_status != STATE_CRITICAL:
-                    worst_status = STATE_CRITICAL
-                stratum_text += " (CRITICAL)"
-        elif thresholds["stratum_warning"] is not None:
-            if stratum > thresholds["stratum_warning"]:
-                if worst_status == STATE_OK:
-                    worst_status = STATE_WARNING
-                stratum_text += " (WARNING)"
+        if thresholds["stratum_critical"] is not None and stratum > thresholds["stratum_critical"]:
+            if worst_status != STATE_CRITICAL:
+                worst_status = STATE_CRITICAL
+            stratum_text += " (CRITICAL)"
+        elif thresholds["stratum_warning"] is not None and stratum > thresholds["stratum_warning"]:
+            if worst_status == STATE_OK:
+                worst_status = STATE_WARNING
+            stratum_text += " (WARNING)"
 
         messages.append(stratum_text)
 
         # Check truechimers (lower is worse)
         truechimers = ntp_info["truechimers"]
         truechimers_text = f"truechimers={truechimers}"
 
-        if thresholds["truechimers_critical"] is not None:
-            if truechimers <= thresholds["truechimers_critical"]:
-                if worst_status != STATE_CRITICAL:
-                    worst_status = STATE_CRITICAL
-                truechimers_text += " (CRITICAL)"
-        elif thresholds["truechimers_warning"] is not None:
-            if truechimers <= thresholds["truechimers_warning"]:
-                if worst_status == STATE_OK:
-                    worst_status = STATE_WARNING
-                truechimers_text += " (WARNING)"
+        if (
+            thresholds["truechimers_critical"] is not None
+            and truechimers <= thresholds["truechimers_critical"]
+        ):
+            if worst_status != STATE_CRITICAL:
+                worst_status = STATE_CRITICAL
+            truechimers_text += " (CRITICAL)"
+        elif (
+            thresholds["truechimers_warning"] is not None
+            and truechimers <= thresholds["truechimers_warning"]
+        ):
+            if worst_status == STATE_OK:
+                worst_status = STATE_WARNING
+            truechimers_text += " (WARNING)"
 
         messages.append(truechimers_text)
 

check_netscaler/commands/sslcert.py

@@ -51,7 +51,8 @@ def execute(self) -> CheckResult:
 
             # Get SSL certificates
             objecttype = getattr(self.args, "objecttype", None) or "sslcertkey"
-            data = self.client.get_config(objecttype)
+            objectname = getattr(self.args, "objectname", None)
+            data = self.client.get_config(objecttype, objectname)
 
             if objecttype not in data:
                 return CheckResult(

docs/commands/sslcert.md

@@ -62,6 +62,14 @@ check_netscaler -C sslcert --limit "^test-"
 
 ### Check single certificate
 
+Use `--objectname` to check a specific certificate by its exact name:
+
+```bash
+check_netscaler -C sslcert -n wildcard.example.com
+```
+
+Or use `--filter` with a regex pattern:
+
 ```bash
 check_netscaler -C sslcert --filter "^wildcard.example.com$"
 ```

pyproject.toml

@@ -39,6 +39,7 @@ dev = [
     "ruff>=0.0.285",
     "mypy>=1.5.0",
     "types-requests>=2.31.0",
+    "flask>=2.3.0",
 ]
 
 [project.scripts]

tests/conftest.py

@@ -2,6 +2,8 @@
 Pytest configuration and shared fixtures
 """
 
+import time
+
 import pytest
 
 
@@ -15,3 +17,34 @@ def sample_args():
 def sample_args_with_auth():
     """Sample CLI arguments with authentication"""
     return ["-H", "192.168.1.1", "-C", "state", "-u", "admin", "-p", "secret", "-s"]
+
+
+@pytest.fixture
+def mock_nitro_server():
+    """
+    Pytest fixture for Mock NITRO API Server
+
+    Usage:
+        def test_something(mock_nitro_server):
+            url = mock_nitro_server.get_url()
+            # Test against mock server...
+    """
+    import socket
+
+    from tests.mocks.nitro_server import MockNITROServer
+
+    # Find a free port
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+        s.bind(("", 0))
+        s.listen(1)
+        port = s.getsockname()[1]
+
+    server = MockNITROServer(port=port)
+    server.start(threaded=True)
+
+    # Give server time to start
+    time.sleep(1)
+
+    yield server
+
+    server.stop()