Merge pull request #23 from Open-MBEE/develop

aligned with syside 0.8.1

Author: wobrschalek

examples/library.sysml

@@ -0,0 +1,11 @@
+ package lpkg {
+    part def A {
+        port p;
+    }
+}
+
+package pkg {
+    private import lpkg::*;
+
+    part a:A;
+}

examples/t.sysml

@@ -0,0 +1,13 @@
+
+    part m0001_2N {
+
+        part nx0001 {
+            port scp_outside2;
+        }
+
+        part tcs0001{
+            port scp;
+        }
+
+        interface tcs0001.scp to nx0001.scp_outside2;
+    }

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flexo_syside_lib"
-version = "0.3.0"
+version = "0.4.0"
 description = "Using syside sysmlv2 with Flexo"
 authors = [{name="Robert Karban", email="robert.karban@planetaryutilities.com"}]
 readme = "README.md"

src/flexo_syside_lib/core.py

@@ -50,9 +50,11 @@ def _wrap_elements_as_payload(data: List[Dict[str, Any]]) -> List[Dict[str, Any]
 
         # Add identity
         identity = {"@id": clean_element.get("@id")} if "@id" in clean_element else {}
-        clean_element["identity"] = identity
 
-        transformed.append({"payload": clean_element})
+        transformed.append({
+            "payload": clean_element,
+            "identity": identity
+        })
 
     return transformed
 
@@ -200,6 +202,8 @@ def convert_json_to_sysml_textual(json_flexo:str, debug:bool=False):
 
         # 2) Ensure root namespace is first (this function expects a JSON string)
         json_import = _make_root_namespace_first(json_in)
+        # with open("debug.json", "w", encoding="utf-8") as f:
+        #     f.write(json_import)
 
         # 3) Deserialize
         try:

tests/test_core.py

@@ -14,6 +14,7 @@ class TestUtilityFunctions:
 
     def test_replace_none_with_empty(self):
         """Test the _replace_none_with_empty utility function."""
+        # Import here to ensure license is set up
         from flexo_syside_lib.core import _replace_none_with_empty
 
         data = {"a": None, "b": [1, None, {"c": None}]}
@@ -33,26 +34,13 @@ def test_wrap_elements_as_payload(self):
         from flexo_syside_lib.core import _wrap_elements_as_payload
 
         elements = [
-            {"@id": "ID1", "name": None},
+            {"@id": "ID1", "@uri": "ignore", "name": None},
             {"name": "X", "props": [None, 1]},
         ]
         wrapped = _wrap_elements_as_payload(elements)
-        # check wrapper structure
-        assert isinstance(wrapped, list)
-        assert all("payload" in e for e in wrapped)
-
-        # identity should now be inside payload
-        assert wrapped[0]["payload"]["identity"] == {"@id": "ID1"}
-
-        # @uri should be removed
-        assert "@uri" not in wrapped[0]["payload"]
-
-        # None should become "" in name
+        assert wrapped[0]["identity"] == {"@id": "ID1"}
         assert wrapped[0]["payload"]["name"] == ""
-
-        # props should remain list with None preserved
         assert wrapped[1]["payload"]["props"][0] is None
-        assert wrapped[1]["payload"]["props"][1] == 1    
 
     def test_make_root_namespace_first(self):
         """Test the _make_root_namespace_first utility function."""
@@ -105,6 +93,7 @@ def test_convert_sysml_string_to_json(self, mock_syside):
         """Test converting SysML string to JSON with mocked SysIDE."""
         from flexo_syside_lib.core import convert_sysml_string_textual_to_json
 
+        # Sample SysML content
         sample_sysml = '''
         package TestPackage {
             part def Component {
@@ -113,16 +102,19 @@ def test_convert_sysml_string_to_json(self, mock_syside):
         }
         '''
 
+        # Sample JSON data
         sample_json = [
             {"@id": "ns1", "@type": "Namespace", "qualifiedName": "2020-01-01T00:00:00Z"},
             {"@id": "comp1", "@type": "Component", "name": "TestComponent"},
         ]
 
+        # Mock SysIDE components
         mock_model = Mock()
         mock_diagnostics = Mock()
         mock_diagnostics.contains_errors.return_value = False
         mock_syside.load_model.return_value = (mock_model, mock_diagnostics)
 
+        # Mock the model serialization
         mock_model.user_docs = [Mock()]
         mock_locked = Mock()
         mock_locked.root_node = Mock()
@@ -131,8 +123,11 @@ def test_convert_sysml_string_to_json(self, mock_syside):
         mock_context_manager.__exit__ = Mock(return_value=None)
         mock_model.user_docs[0].lock.return_value = mock_context_manager
 
+        # Mock JSON writer
         mock_writer = Mock()
         mock_writer.result = json.dumps(sample_json)
+        
+        # Mock serialization options
         mock_options = Mock()
 
         with patch('flexo_syside_lib.core._create_json_writer', return_value=mock_writer), \
@@ -141,16 +136,18 @@ def test_convert_sysml_string_to_json(self, mock_syside):
 
             payload, json_string = convert_sysml_string_textual_to_json(sample_sysml)
 
+            # Verify we get a payload structure
             assert isinstance(payload, list)
             assert len(payload) > 0
 
-            # Verify payload structure (updated)
+            # Verify payload structure
             for item in payload:
                 assert "payload" in item
-                assert "identity" in item["payload"]
+                assert "identity" in item
                 assert isinstance(item["payload"], dict)
-                assert isinstance(item["payload"]["identity"], dict)
+                assert isinstance(item["identity"], dict)
 
+            # Verify JSON string is valid
             parsed_json = json.loads(json_string)
             assert isinstance(parsed_json, list)
             assert len(parsed_json) > 0
@@ -160,6 +157,7 @@ def test_convert_sysml_file_to_json(self, mock_syside):
         """Test converting SysML file to JSON with mocked SysIDE."""
         from flexo_syside_lib.core import convert_sysml_file_textual_to_json
 
+        # Sample SysML content
         sample_sysml = '''
         package TestPackage {
             part def Component {
@@ -168,16 +166,19 @@ def test_convert_sysml_file_to_json(self, mock_syside):
         }
         '''
 
+        # Sample JSON data
         sample_json = [
             {"@id": "ns1", "@type": "Namespace", "qualifiedName": "2020-01-01T00:00:00Z"},
             {"@id": "comp1", "@type": "Component", "name": "TestComponent"},
         ]
 
+        # Mock SysIDE components
         mock_model = Mock()
         mock_diagnostics = Mock()
         mock_diagnostics.contains_errors.return_value = False
         mock_syside.try_load_model.return_value = (mock_model, mock_diagnostics)
 
+        # Mock the model serialization
         mock_model.user_docs = [Mock()]
         mock_locked = Mock()
         mock_locked.root_node = Mock()
@@ -186,8 +187,11 @@ def test_convert_sysml_file_to_json(self, mock_syside):
         mock_context_manager.__exit__ = Mock(return_value=None)
         mock_model.user_docs[0].lock.return_value = mock_context_manager
 
+        # Mock JSON writer
         mock_writer = Mock()
         mock_writer.result = json.dumps(sample_json)
+        
+        # Mock serialization options
         mock_options = Mock()
 
         with patch('flexo_syside_lib.core._create_json_writer', return_value=mock_writer), \
@@ -201,16 +205,18 @@ def test_convert_sysml_file_to_json(self, mock_syside):
             try:
                 payload, json_string = convert_sysml_file_textual_to_json(temp_file)
 
+                # Verify we get a payload structure
                 assert isinstance(payload, list)
                 assert len(payload) > 0
 
-                # Verify payload structure (updated)
+                # Verify payload structure
                 for item in payload:
                     assert "payload" in item
-                    assert "identity" in item["payload"]
+                    assert "identity" in item
                     assert isinstance(item["payload"], dict)
-                    assert isinstance(item["payload"]["identity"], dict)
+                    assert isinstance(item["identity"], dict)
 
+                # Verify JSON string is valid
                 parsed_json = json.loads(json_string)
                 assert isinstance(parsed_json, list)
                 assert len(parsed_json) > 0
@@ -223,7 +229,7 @@ def test_convert_json_to_sysml_textual_invalid_input(self):
         from flexo_syside_lib.core import convert_json_to_sysml_textual
 
         with pytest.raises(TypeError, match="json_flexo must be dict/list/str"):
-            convert_json_to_sysml_textual(123)
+            convert_json_to_sysml_textual(123)  # Invalid type
 
     @patch('flexo_syside_lib.core.syside')
     def test_create_json_writer(self, mock_syside):
@@ -260,10 +266,15 @@ class TestLicenseHandling:
 
     def test_import_without_license_graceful_failure(self):
         """Test that import fails gracefully when no license is available."""
+        # This test verifies that the import behavior is predictable
+        # In CI, we'll mock syside to avoid license issues
         pass
 
     def test_utility_functions_work_without_syside(self):
         """Test that utility functions work even if SysIDE is mocked."""
+        # This test ensures our utility functions are truly independent
         from flexo_syside_lib.core import _replace_none_with_empty
+        
+        # Test that the function works regardless of SysIDE state
         result = _replace_none_with_empty({"test": None})
         assert result == {"test": ""}