lvi-api-client 0.2.4__tar.gz → 0.2.6__tar.gz

{lvi_api_client-0.2.4 → lvi_api_client-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lvi-api-client
-Version: 0.2.4
+Version: 0.2.6
 Summary: LogicVein API Client Library
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown

lvi_api_client-0.2.6/VERSION

@@ -0,0 +1 @@
+0.2.6

{lvi_api_client-0.2.4 → lvi_api_client-0.2.6}/src/logicvein/lvi_api_client.py

@@ -3003,6 +3003,7 @@ class LogicVeinAPIClient:
             commands (str): CLI commands to run, one per line.
             job_name (str): Display name for the job.
             backup_on_completion (bool): If True, LVI backs up the device after the job runs.
+            description (str): The job's description. Empty uses ``job_name``.
 
         Returns:
             Dict[str, Any]: The saved job record (contains ``jobId``), or None on failure.
@@ -3011,7 +3012,7 @@ class LogicVeinAPIClient:
             {
                 "jobId": 0,
                 "jobName": job_name,
-                "description": description or "Job scheduled by ServiceNow",
+                "description": description or job_name,
                 "managedNetworks": [network],
                 "jobType": "Script Tool Job",
                 "subType": "org.ziptie.tools.scripts.commandRunner",
@@ -3052,6 +3053,8 @@ class LogicVeinAPIClient:
             network (str): LVI managed network the device belongs to.
             commands (str): CLI commands to run, one per line.
             job_name (str): Display name for the job in the LVI scheduler.
+            backup_on_completion (bool): If True, LVI backs up the device after the job runs.
+            description (str): The job's description. Empty uses ``job_name``.
 
         Returns:
             Dict[str, Any]: The job execution result dict from LVI (contains ``id``
@@ -3071,7 +3074,7 @@ class LogicVeinAPIClient:
                 "tool": "org.ziptie.tools.scripts.commandRunner",
                 "backupOnCompletion": "true" if backup_on_completion else "false",
             },
-            description=description or "Job scheduled by ServiceNow",
+            description=description or job_name,
         )
 
     # =====================================================
@@ -4620,27 +4623,32 @@ class LogicVeinAPIClient:
         where ``recordId`` is the ``id`` field from a ``getExecutionDetails``
         record.
 
+        The server finds the output by ``recordId`` alone: a record of another
+        execution comes back as long as the execution ID exists.
+
         Args:
             execution_id: The execution ID (``executionId`` from the job result).
             record_id: The per-device record ID (``id`` from ``getExecutionDetails``).
 
         Returns:
-            The raw output text, or an empty string if the request fails.
+            The raw output text.
+
+        Raises:
+            requests.HTTPError: If the server refuses the request, for example
+                401 for a bad token, 404 for an unknown execution or 500 for a
+                malformed ID.
+            ValueError: If the server has no record with that ID. It answers
+                200 with an empty body and no content type then, which is not
+                an empty output: a Command Runner output holds at least the
+                command and the prompt.
         """
         url = f"https://{self.host}/servlet/pluginDetail"
         params = {"executionId": execution_id, "recordId": record_id}
-        try:
-            response = self.lvi_client.get(url, params=params, timeout=self.timeout)
-            response.raise_for_status()
-            return response.text
-        except Exception as exc:
-            logger.warning(
-                "get_execution_output failed for executionId=%s recordId=%s: %s",
-                execution_id,
-                record_id,
-                exc,
-            )
-            return ""
+        response = self.lvi_client.get(url, params=params, timeout=self.timeout)
+        response.raise_for_status()
+        if not response.content and not response.headers.get("Content-Type"):
+            raise ValueError(f"No output record {record_id} in execution {execution_id}")
+        return response.text
 
     # =====================================================
     # ZeroTouch

{lvi_api_client-0.2.4 → lvi_api_client-0.2.6}/src/lvi_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lvi-api-client
-Version: 0.2.4
+Version: 0.2.6
 Summary: LogicVein API Client Library
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown

{lvi_api_client-0.2.4 → lvi_api_client-0.2.6}/tests/test_lvi_api_client.py

@@ -5048,7 +5048,7 @@ class TestCreateCommandRunnerJob:
 
 
 class TestGetExecutionOutput:
-    """Tests for get_execution_output (lines 3641-3674): success and exception paths."""
+    """Tests for get_execution_output: the text on success, and an error for every failure."""
 
     @pytest.fixture
     def client(self, monkeypatch):
@@ -5057,39 +5057,50 @@ class TestGetExecutionOutput:
         with patch("src.logicvein.lvi_api_client.requests.Session"):
             return LogicVeinAPIClient()
 
+    @staticmethod
+    def answer(status, body=b"", content_type=None):
+        """A real requests.Response, shaped like the lab server's answers (issue #6)."""
+        response = requests.Response()
+        response.status_code = status
+        response._content = body
+        response.encoding = "utf-8"
+        if content_type:
+            response.headers["Content-Type"] = content_type
+        response.url = "https://test.example.com/servlet/pluginDetail"
+        return response
+
     def test_get_execution_output_success(self, client):
-        """get_execution_output returns response text on success."""
-        mock_get_response = Mock()
-        mock_get_response.raise_for_status = Mock()
-        mock_get_response.text = "show version output\nCisco IOS Version 15.1"
-        client.lvi_client.get = Mock(return_value=mock_get_response)
+        """get_execution_output returns the text, and asks for the execution and record."""
+        output = b"show clock\r\n16:57:34.919 UTC Sat Nov 7 2026\r\nc1800#"
+        client.lvi_client.get = Mock(return_value=self.answer(200, output, "text/plain;charset=utf-8"))
 
         result = client.get_execution_output(execution_id=42, record_id=7)
 
-        assert result == "show version output\nCisco IOS Version 15.1"
-        client.lvi_client.get.assert_called_once()
-        call_args = client.lvi_client.get.call_args
-        assert "executionId" in call_args.kwargs["params"]
-        assert call_args.kwargs["params"]["executionId"] == 42
-        assert call_args.kwargs["params"]["recordId"] == 7
+        assert result == output.decode()
+        assert client.lvi_client.get.call_args.kwargs["params"] == {"executionId": 42, "recordId": 7}
 
-    def test_get_execution_output_http_error_returns_empty_string(self, client):
-        """get_execution_output returns '' when raise_for_status raises."""
-        mock_get_response = Mock()
-        mock_get_response.raise_for_status.side_effect = requests.HTTPError("403 Forbidden")
-        client.lvi_client.get = Mock(return_value=mock_get_response)
+    @pytest.mark.parametrize("status", [401, 404, 500])
+    def test_get_execution_output_http_error_raises(self, client, status):
+        """A refused read raises instead of reading as an empty output (issue #6)."""
+        page = b"<!doctype html><html></html>"
+        client.lvi_client.get = Mock(return_value=self.answer(status, page, "text/html;charset=utf-8"))
 
-        result = client.get_execution_output(execution_id=42, record_id=7)
+        with pytest.raises(requests.HTTPError):
+            client.get_execution_output(execution_id=42, record_id=7)
 
-        assert result == ""
+    def test_get_execution_output_unknown_record_raises(self, client):
+        """The server answers an unknown record with 200, no body and no content type (issue #6)."""
+        client.lvi_client.get = Mock(return_value=self.answer(200))
 
-    def test_get_execution_output_connection_error_returns_empty_string(self, client):
-        """get_execution_output returns '' when a connection exception is raised."""
-        client.lvi_client.get = Mock(side_effect=requests.exceptions.ConnectionError("refused"))
+        with pytest.raises(ValueError, match="No output record 7 in execution 42"):
+            client.get_execution_output(execution_id=42, record_id=7)
 
-        result = client.get_execution_output(execution_id=99, record_id=1)
+    def test_get_execution_output_connection_error_raises(self, client):
+        """A transport failure propagates instead of reading as an empty output (issue #6)."""
+        client.lvi_client.get = Mock(side_effect=requests.exceptions.ConnectionError("refused"))
 
-        assert result == ""
+        with pytest.raises(requests.exceptions.ConnectionError):
+            client.get_execution_output(execution_id=99, record_id=1)
 
 
 class TestRunCommandRunnerJob:
@@ -5121,6 +5132,27 @@ class TestRunCommandRunnerJob:
         assert result["executionId"] == "exec-77"
         client.lvi_client.post.assert_called_once()
 
+    def test_run_command_runner_job_describes_the_job_by_its_name(self, client, mock_response):
+        """An empty description uses the job name, not "Job scheduled by ServiceNow" (issue #5)."""
+        mock_response.json.return_value = {"jsonrpc": "2.0", "id": "t", "result": {"executionId": 1}}
+        client.lvi_client.post = Mock(return_value=mock_response)
+
+        client.run_command_runner_job("10.1.1.1", "Default", "show version", job_name="NTP check")
+
+        body = json.loads(client.lvi_client.post.call_args.kwargs["data"])
+        assert body["method"] == "Scheduler.runNow"
+        assert body["params"]["jobData"]["description"] == "NTP check"
+
+    def test_run_command_runner_job_keeps_a_given_description(self, client, mock_response):
+        """A description the caller gives is sent as it is."""
+        mock_response.json.return_value = {"jsonrpc": "2.0", "id": "t", "result": {"executionId": 1}}
+        client.lvi_client.post = Mock(return_value=mock_response)
+
+        client.run_command_runner_job("10.1.1.1", "Default", "show version", description="Change 42")
+
+        body = json.loads(client.lvi_client.post.call_args.kwargs["data"])
+        assert body["params"]["jobData"]["description"] == "Change 42"
+
     def test_run_command_runner_job_with_backup(self, client, mock_response):
         """run_command_runner_job passes backup_on_completion=True in job parameters."""
         mock_response.json.return_value = {
@@ -5201,15 +5233,15 @@ class TestCreateCommandRunnerJobBackupAndDescription:
         body = json.loads(client.lvi_client.post.call_args.kwargs["data"])
         assert body["params"]["jobData"]["description"] == "My custom description"
 
-    def test_empty_description_defaults_to_service_now_string(self, client, mock_response):
-        """create_command_runner_job defaults description when empty string passed."""
+    def test_empty_description_defaults_to_the_job_name(self, client, mock_response):
+        """create_command_runner_job describes the job by its name, not by any one caller (issue #5)."""
         mock_response.json.return_value = {"jsonrpc": "2.0", "id": "t", "result": {"jobId": 12}}
         client.lvi_client.post = Mock(return_value=mock_response)
 
-        client.create_command_runner_job("10.1.1.1", "Default", "show version", description="")
+        client.create_command_runner_job("10.1.1.1", "Default", "show version", job_name="NTP check", description="")
 
         body = json.loads(client.lvi_client.post.call_args.kwargs["data"])
-        assert body["params"]["jobData"]["description"] == "Job scheduled by ServiceNow"
+        assert body["params"]["jobData"]["description"] == "NTP check"
 
 
 class TestRunJobNowSubTypeBranch:

lvi_api_client-0.2.4/VERSION

@@ -1 +0,0 @@
-0.2.4