Refactor tests and update changelog; enhance test functionality and improve production handling

Author: grongierisc

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Refactor whole unittest and e2e test suite for better maintainability and reliability
+- Export production now returns Production name as key in the returned dict for better clarity
 
 ## [3.5.5] - 2026-01-23
 ### Added

src/iop/cls/IOP/Service/Remote/Rest/v1.cls

@@ -276,7 +276,6 @@ ClassMethod PostTest() As %Status
 
 		// Optionally restart the target component before testing
 		If restart {
-			zw "Restarting target component: "_target
 			$$$ThrowOnError(##class(Ens.Director).EnableConfigItem(target, 0, 1))
 			$$$ThrowOnError(##class(Ens.Director).EnableConfigItem(target, 1, 1))
 		}
@@ -304,11 +303,23 @@ ClassMethod PostTest() As %Status
 				Set result.body = response.GetObjectJson(.atEnd)
 				set result.classname = response.classname
 				Set result.truncated = 'atEnd
+			} 
+			Else {
+				Set result.classname = response.%ClassName(1)
+				// Use the ObjectScript XML Serializer so arbitrary objects and collections are captured.
+				Try {
+					Set xmlWriter = ##class(%XML.Writer).%New()
+					Set xmlStream = ##class(%Stream.TmpCharacter).%New()
+					$$$ThrowOnError(xmlWriter.OutputToStream(xmlStream))
+					$$$ThrowOnError(xmlWriter.RootObject(response))
+					Do xmlStream.Rewind()
+					Set body = ""
+					While 'xmlStream.AtEnd { Set body = body _ xmlStream.Read(32000) }
+					Set result.body = body
+				} Catch {
+					Set result.body = ""
+				}
 			}
-		} Else {
-			Set result.classname = response.%ClassName(1)
-			// TODO, try to use the ObjectScript XML Serializer to capture the response body as XML, which can handle arbitrary objects including collections. For now we'll just return an empty body for non-IOP.Message responses.
-			Set result.body = ""
 		}
 		set sc = $$EndCapture^%SYS.Capture(msg,.msgArray)
 		Return ..%WriteResponse(result.%ToJSON())

src/tests/e2e/local/bench/cls/Bench.Operation.cls

@@ -23,11 +23,30 @@ Method Method(
     Quit tStatus
 }
 
+/// Description
+Method MethodRandom(
+	pRequest As Ens.StringRequest,
+	Output pResponse As Ens.StringResponse) As %Status
+{
+    set tStatus = $$$OK
+    set pResponse = ##class(Ens.StringResponse).%New()
+
+    try{
+        set pResponse.StringValue = $R(1000000) // Return a random number as string
+
+    }
+    catch exp
+    {
+        set tStatus = exp.AsStatus()
+    }
+    Quit tStatus
+}
+
 XData MessageMap
 {
 <MapItems>
     <MapItem MessageType="Ens.Request">
-        <Method>Method</Method>
+        <Method>MethodRandom</Method>
     </MapItem>
     <MapItem MessageType="IOP.Message">
         <Method>Method</Method>

src/tests/e2e/remote/test_rest_api.py

@@ -131,7 +131,12 @@ class TestExport:
     def _need_production(self, remote_director):
         prod = remote_director.get_default_production()
         if prod in ("", "Not defined"):
-            pytest.skip("No default production defined")
+            # List productions and pick the first one if no default is set
+            prods = remote_director.list_productions()
+            if not prods:
+                pytest.skip("No productions available to test export")
+            # Prods is an object with production names as keys, so take the first key
+            prod = next(iter(prods.keys()))
         self.production = prod
 
     def test_export_returns_200(self, remote_director):
@@ -140,18 +145,17 @@ def test_export_returns_200(self, remote_director):
                         namespace=remote_director._namespace)
         assert resp.status_code == 200
 
-    def test_export_body_has_xml_key(self, remote_director):
+    def test_export_body_has_data(self, remote_director):
         data = remote_director._check_error(
             remote_director._get("/export", {"production": self.production})
         )
-        assert "xml" in data
+        assert data is not None
 
-    def test_export_xml_is_non_empty_string(self, remote_director):
+    def test_export_json_is_non_empty_string(self, remote_director):
         data = remote_director._check_error(
             remote_director._get("/export", {"production": self.production})
         )
-        assert isinstance(data["xml"], str)
-        assert len(data["xml"]) > 0
+        assert len(data) > 0
 
 
 # ---------------------------------------------------------------------------

src/tests/e2e/remote/test_test_component.py

@@ -4,16 +4,48 @@
     IOP_URL=http://localhost:52773 pytest src/tests/e2e/remote/
 """
 import pytest
+import requests
+
+
+@pytest.fixture(scope="module")
+def default_production(remote_director):
+    """Default production name for the configured namespace.
+
+    Falls back to the first production found in the list; skips only when
+    no production exists at all.
+    """
+    prod = remote_director.get_default_production()
+    if prod in ("", "Not defined"):
+        prods = remote_director.list_productions()
+        if not prods:
+            pytest.skip("No productions available")
+        prod = next(iter(prods))
+    return prod
+
+
+@pytest.fixture(scope="module")
+def first_active_component(remote_director, default_production):
+    """Name of the first enabled component in the default production, or skip."""
+    try:
+        remote_director.start_production(default_production)
+    except (RuntimeError, requests.exceptions.HTTPError):
+        pass  # already running
+
+    components = remote_director.export_production(default_production)
+    production_data = list(components.values())[0]
+    items = production_data.get("Item", [])
+    if isinstance(items, dict):
+        items = [items]
+    active = [item for item in items if item.get("@Enabled", "1") == "1"]
+    if not active:
+        pytest.skip("No active components found in the default production")
+    return active[0]["@Name"]
 
 
 class TestComponentTesting:
-    def test_test_component_returns_response(self, remote_director):
+    def test_test_component_returns_response(self, remote_director, default_production):
         """POST /test with a basic Ens.StringRequest should return a valid response."""
-        default_target = remote_director.get_default_production()
-        if default_target in ("", "Not defined"):
-            pytest.skip("No default production defined")
-
-        # This test uses Ens.StringRequest as a generic smoke test.
+        # Uses Ens.StringRequest as a generic smoke test.
         # Adjust target and classname to match your environment.
         try:
             result = remote_director.test_component(
@@ -35,38 +67,20 @@ def test_test_component_bad_target_raises(self, remote_director):
                 body='{"StringValue": "ping"}',
             )
 
-    def test_test_component_bad_classname_raises(self, remote_director):
+    def test_test_component_bad_classname_raises(self, remote_director, default_production):
         """Sending with a non-existent classname should raise RuntimeError."""
-        default_target = remote_director.get_default_production()
-        if default_target in ("", "Not defined"):
-            pytest.skip("No default production defined")
-
         with pytest.raises(RuntimeError):
             remote_director.test_component(
                 target=None,
                 classname="This.Class.DoesNotExist",
                 body='{"StringValue": "ping"}',
             )
 
-    def test_test_component_restart(self, remote_director):
+    def test_test_component_restart(self, remote_director, first_active_component):
         """Test that the restart option in test_component works without error."""
-        default_target = remote_director.get_default_production()
-        if default_target in ("", "Not defined"):
-            pytest.skip("No default production defined")
-
-        # export the default production's components and pick one to target for this test
-        components = remote_director.export_components()
-        active_components = [c for c in components if c["active"]]
-        
-
-        if not active_components:
-            pytest.skip("No active components found in the default production")
-
-        target_component = active_components[0]["name"]
-        
         result = remote_director.test_component(
-            target=target_component,
-            classname="Ens.StringRequest",
+            target=first_active_component,
+            classname=None,
             body='{"StringValue": "ping"}',
             restart=True,
         )

src/tests/unit/test_cli.py

@@ -11,6 +11,15 @@
 class TestIOPCli(unittest.TestCase):
     """Test cases for IOP CLI functionality."""
 
+    def setUp(self):
+        # Force local mode regardless of any IOP_URL / IOP_SETTINGS env vars
+        # that may be set by a parallel e2e test session.
+        self._remote_patcher = patch('iop._cli.get_remote_settings', return_value=None)
+        self._remote_patcher.start()
+
+    def tearDown(self):
+        self._remote_patcher.stop()
+
     def test_help_and_basic_commands(self):
         """Test basic CLI commands like help and namespace."""
         # Test help
@@ -50,15 +59,18 @@ def test_namespace_with_value_prints_help(self):
     def test_default_settings(self):
         """Test default production settings."""
         # Test with name
-        with self.assertRaises(SystemExit) as cm:
-            main(['-d', 'Bench.Production'])
-        self.assertEqual(cm.exception.code, 0)
-        self.assertEqual(_Director.get_default_production(), 'Bench.Production')
+        with patch('iop._director._Director.set_default_production') as mock_set, \
+             patch('iop._director._Director.get_default_production', return_value='Bench.Production'):
+            with self.assertRaises(SystemExit) as cm:
+                main(['-d', 'Bench.Production'])
+            self.assertEqual(cm.exception.code, 0)
+            mock_set.assert_called_once_with('Bench.Production')
 
-        # Test without name
-        with self.assertRaises(SystemExit) as cm:
-            main(['-d'])
-        self.assertEqual(cm.exception.code, 0)
+        # Test without name — just prints the current default
+        with patch('iop._director._Director.get_default_production', return_value='Bench.Production'):
+            with self.assertRaises(SystemExit) as cm:
+                main(['-d'])
+            self.assertEqual(cm.exception.code, 0)
 
     def test_production_controls(self):
         """Test production control commands (start, stop, restart, kill)."""
@@ -77,12 +89,13 @@ def test_production_controls(self):
 
         # Test stop
         with patch('iop._director._Director.stop_production') as mock_stop:
-            with patch('sys.stdout', new=StringIO()) as fake_out:
-                with self.assertRaises(SystemExit) as cm:
-                    main(['-S'])
-                self.assertEqual(cm.exception.code, 0)
-                mock_stop.assert_called_once()
-                self.assertEqual(fake_out.getvalue().strip(), 'Production Bench.Production stopped')
+            with patch('iop._director._Director.get_default_production', return_value='Bench.Production'):
+                with patch('sys.stdout', new=StringIO()) as fake_out:
+                    with self.assertRaises(SystemExit) as cm:
+                        main(['-S'])
+                    self.assertEqual(cm.exception.code, 0)
+                    mock_stop.assert_called_once()
+                    self.assertEqual(fake_out.getvalue().strip(), 'Production Bench.Production stopped')
 
         # Test restart
         with patch('iop._director._Director.restart_production') as mock_restart:

src/tests/unit/test_utils.py

@@ -131,7 +131,8 @@ def test_fallback_key_when_no_name_attr(self):
         assert "Production" in data
 
 
-class TestRemoteMigration:    @patch('requests.put')
+class TestRemoteMigration:    
+    @patch('requests.put')
     @patch('iop._utils._Utils._load_settings')
     @patch('os.walk')
     def test_migrate_remote_verify_ssl_true(self, mock_walk, mock_load_settings, mock_put):