Merge pull request #32 from Daylily-Informatics/feature/ip-stub-trailing-dot-validation

feat: reject ip_stub with trailing dot across all entry points

Author: iamh2o

tests/test_cli.py

@@ -255,6 +255,38 @@ def test_bootstrap_json_hides_scan_progress(self, mock_zpl_cls):
         assert "printers_found" in result.output
 
 
+class TestCLIBootstrapTrailingDot:
+    """Tests for trailing-dot ip_stub rejection in bootstrap command."""
+
+    def test_bootstrap_rejects_trailing_dot(self):
+        """bootstrap --ip-stub '192.168.1.' exits with error."""
+        result = runner.invoke(app, ["bootstrap", "--ip-stub", "192.168.1."])
+        assert result.exit_code == 1
+        assert "trailing dot" in result.output
+
+    def test_bootstrap_rejects_trailing_dot_short_flag(self):
+        """bootstrap -i '10.0.0.' exits with error."""
+        result = runner.invoke(app, ["bootstrap", "-i", "10.0.0."])
+        assert result.exit_code == 1
+        assert "trailing dot" in result.output
+
+
+class TestCLIPrinterScanTrailingDot:
+    """Tests for trailing-dot ip_stub rejection in printer scan command."""
+
+    def test_printer_scan_rejects_trailing_dot(self):
+        """printer scan --ip-stub '192.168.1.' exits with error."""
+        result = runner.invoke(app, ["printer", "scan", "--ip-stub", "192.168.1."])
+        assert result.exit_code == 1
+        assert "trailing dot" in result.output
+
+    def test_printer_scan_rejects_trailing_dot_short_flag(self):
+        """printer scan -i '10.0.0.' exits with error."""
+        result = runner.invoke(app, ["printer", "scan", "-i", "10.0.0."])
+        assert result.exit_code == 1
+        assert "trailing dot" in result.output
+
+
 
 # ---------------------------------------------------------------------------
 # zday man — interactive documentation browser

tests/test_core_functions.py

@@ -315,3 +315,51 @@ def test_cache_hit(self):
         assert result["online"] is True
 
         clear_printer_cache()
+
+
+class TestIpStubTrailingDotRejection:
+    """Tests for rejecting ip_stub values that end with a trailing dot."""
+
+    def test_probe_rejects_trailing_dot(self):
+        """probe_zebra_printers_add_to_printers_json raises ValueError for trailing dot."""
+        import zebra_day.print_mgr as zdpm
+
+        zp = zdpm.zpl()
+        with pytest.raises(ValueError, match="trailing dot"):
+            zp.probe_zebra_printers_add_to_printers_json(ip_stub="192.168.1.")
+
+    def test_probe_rejects_single_dot(self):
+        """A bare '.' is also rejected."""
+        import zebra_day.print_mgr as zdpm
+
+        zp = zdpm.zpl()
+        with pytest.raises(ValueError, match="trailing dot"):
+            zp.probe_zebra_printers_add_to_printers_json(ip_stub=".")
+
+    def test_probe_rejects_multiple_trailing_dots(self):
+        """Multiple trailing dots (e.g. '10.0.0..') are rejected."""
+        import zebra_day.print_mgr as zdpm
+
+        zp = zdpm.zpl()
+        with pytest.raises(ValueError, match="trailing dot"):
+            zp.probe_zebra_printers_add_to_printers_json(ip_stub="10.0.0..")
+
+    def test_probe_accepts_valid_stub(self):
+        """Valid ip_stub (no trailing dot) does NOT raise ValueError.
+
+        We mock http.client connections to avoid real network I/O.
+        """
+        import zebra_day.print_mgr as zdpm
+
+        zp = zdpm.zpl()
+        # Mock HTTPConnection and HTTPSConnection so the 255-IP loop
+        # completes instantly without real network calls.
+        with mock.patch("http.client.HTTPConnection") as mock_http, \
+             mock.patch("http.client.HTTPSConnection") as mock_https:
+            # Make every connection attempt raise immediately (no printer)
+            mock_http.return_value.request.side_effect = OSError("mocked")
+            mock_https.return_value.request.side_effect = OSError("mocked")
+            try:
+                zp.probe_zebra_printers_add_to_printers_json(ip_stub="10.0.0")
+            except ValueError:
+                pytest.fail("Valid ip_stub raised ValueError")

tests/test_top_level_api.py

@@ -325,3 +325,26 @@ def test_all_functions_in_all(self):
         for func_name in expected_functions:
             assert func_name in zd.__all__, f"{func_name} not in __all__"
             assert hasattr(zd, func_name), f"{func_name} not accessible on module"
+
+
+class TestScanIpStubTrailingDot:
+    """Tests for trailing-dot ip_stub rejection in the top-level scan() API."""
+
+    def setup_method(self):
+        import zebra_day
+
+        zebra_day._reset_zpl()
+
+    def test_scan_rejects_trailing_dot(self):
+        """scan() raises ValueError before calling the core method."""
+        import zebra_day as zd
+
+        with pytest.raises(ValueError, match="trailing dot"):
+            zd.scan(ip_stub="192.168.1.")
+
+    def test_scan_rejects_trailing_dot_different_prefix(self):
+        """scan() rejects any trailing-dot ip_stub."""
+        import zebra_day as zd
+
+        with pytest.raises(ValueError, match="trailing dot"):
+            zd.scan(ip_stub="10.0.0.")

tests/test_web_server.py

@@ -1322,6 +1322,38 @@ def test_import_section_shows_package_templates(self, client):
         assert "import-cb" in response.text
 
 
+class TestScanTrailingDotRejection:
+    """Tests for trailing-dot ip_stub rejection on web scan routes."""
+
+    def test_config_scan_rejects_trailing_dot(self, client):
+        """GET /config/scan?ip_stub=192.168.1. returns 400."""
+        resp = client.get("/config/scan", params={"ip_stub": "192.168.1."})
+        assert resp.status_code == 400
+        assert "trailing dot" in resp.json()["detail"]
+
+    def test_config_scan_stream_rejects_trailing_dot(self, client):
+        """GET /config/scan/stream?ip_stub=10.0.0. returns 400."""
+        resp = client.get("/config/scan/stream", params={"ip_stub": "10.0.0."})
+        assert resp.status_code == 400
+        assert "trailing dot" in resp.json()["detail"]
+
+    def test_config_scan_accepts_valid_stub(self, client, monkeypatch):
+        """GET /config/scan with valid ip_stub does NOT return 400."""
+        zp = client.app.state.zp
+        monkeypatch.setattr(
+            zp,
+            "probe_zebra_printers_add_to_printers_json",
+            lambda **kw: None,
+        )
+        resp = client.get(
+            "/config/scan",
+            params={"ip_stub": "192.168.1"},
+            follow_redirects=False,
+        )
+        # Should redirect (303) on success, not 400
+        assert resp.status_code == 303
+
+
 # Keep the simple assertion test for backward compatibility
 def test_web_ui():
     """Simple test to ensure test module loads."""

zebra_day/__init__.py

@@ -137,10 +137,18 @@ def scan(ip_stub: str = "192.168.1", lab: str = "default") -> None:
         ip_stub: First three octets of IP range to scan (default: "192.168.1")
         lab: Lab identifier to add discovered printers to (default: "default")
 
+    Raises:
+        ValueError: If ip_stub ends with a trailing dot.
+
     Example:
         >>> import zebra_day as zd
         >>> zd.scan(ip_stub="10.0.0", lab="production")
     """
+    if isinstance(ip_stub, str) and ip_stub.endswith("."):
+        raise ValueError(
+            f"ip_stub must not end with a trailing dot: '{ip_stub}'. "
+            f"Use '{ip_stub.rstrip('.')}' instead."
+        )
     zp = _get_zpl()
     zp.probe_zebra_printers_add_to_printers_json(ip_stub=ip_stub, lab=lab)
 

zebra_day/cli/__init__.py

@@ -215,6 +215,13 @@ def bootstrap(
             except Exception:
                 ip_stub = "192.168.1"
 
+        if ip_stub.endswith("."):
+            console.print(
+                f"[red]✗[/red] ip-stub must not end with a trailing dot: '{ip_stub}'. "
+                f"Use '{ip_stub.rstrip('.')}' instead."
+            )
+            raise typer.Exit(1)
+
         if not json_output:
             console.print(f"\n[cyan]→[/cyan] Scanning network for Zebra printers ({ip_stub}.*)...")
             if silent_scan:

zebra_day/cli/printer.py

@@ -50,6 +50,13 @@ def scan(
         local_ip = _get_local_ip()
         ip_stub = ".".join(local_ip.split(".")[:-1])
 
+    if ip_stub.endswith("."):
+        console.print(
+            f"[red]✗[/red] ip-stub must not end with a trailing dot: '{ip_stub}'. "
+            f"Use '{ip_stub.rstrip('.')}' instead."
+        )
+        raise typer.Exit(1)
+
     if not json_output:
         console.print(f"[cyan]→[/cyan] Scanning {ip_stub}.* for Zebra printers...")
         console.print("[dim]  This may take a few minutes...[/dim]")

zebra_day/print_mgr.py

@@ -228,6 +228,13 @@ def probe_zebra_printers_add_to_printers_json(
         scan_wait = seconds to re-try probing until moving on. 0.5 default may be too quick/slow
         lab = code for the lab key to add/update to given finding new printers
         """
+        # Reject trailing-dot ip_stub (e.g. "192.168.1." is invalid)
+        if isinstance(ip_stub, str) and ip_stub.endswith("."):
+            raise ValueError(
+                f"ip_stub must not end with a trailing dot: '{ip_stub}'. "
+                f"Use '{ip_stub.rstrip('.')}' instead."
+            )
+
         # Ensure schema version is set
         if "schema_version" not in self.printers:
             self.printers["schema_version"] = "2.1.0"

zebra_day/web/routers/ui.py

@@ -727,6 +727,12 @@ async def modern_config_scan(
     lab: str = "scan-results",
 ):
     """Scan network for printers."""
+    if ip_stub.endswith("."):
+        raise HTTPException(
+            status_code=400,
+            detail=f"ip_stub must not end with a trailing dot: '{ip_stub}'. "
+            f"Use '{ip_stub.rstrip('.')}' instead.",
+        )
     zp = request.app.state.zp
     zp.probe_zebra_printers_add_to_printers_json(ip_stub=ip_stub, scan_wait=scan_wait, lab=lab)
     time.sleep(2.2)
@@ -741,6 +747,12 @@ async def modern_config_scan_stream(
     lab: str = "scan-results",
 ):
     """Stream network scan progress via Server-Sent Events (SSE)."""
+    if ip_stub.endswith("."):
+        raise HTTPException(
+            status_code=400,
+            detail=f"ip_stub must not end with a trailing dot: '{ip_stub}'. "
+            f"Use '{ip_stub.rstrip('.')}' instead.",
+        )
     zp = request.app.state.zp
     scan_jobs = _get_scan_jobs(request.app)