chore: add model-exts conversion check (#2613)

Now that we are able to import models in python (#2581) we can enable
the roundtrip checks in the `validate` fixture of the `hugr-py` tests.

I have also added a couple more models to check when writing, mainly
JSON with compression and BINARY with no compression. This adds around 5
seconds of running time to the `hugr-py` tests.

And I've separated the `test_envelope.py::test_envelope` test case into
`test_envelope_binary` (parametrized for each `EnvelopeFormat` and
`compression`) and `test_envelope_text`.

Author: ferbetanzo

hugr-py/tests/conftest.py

@@ -8,7 +8,7 @@
 from typing_extensions import Self
 
 from hugr import cli, ext, tys
-from hugr.envelope import EnvelopeConfig
+from hugr.envelope import EnvelopeConfig, EnvelopeFormat
 from hugr.hugr import Hugr
 from hugr.ops import AsExtOp, Command, Const, Custom, DataflowOp, ExtOp, RegisteredOp
 from hugr.package import Package
@@ -166,16 +166,25 @@ def validate(
         if os.environ.get("HUGR_RENDER_DOT"):
             dot.pipe("svg")
 
-    # Encoding formats to test, indexed by the format name as used by
-    # `hugr convert --format`.
+    # Encoding formats to test. Note that these include other formats than
+    # those supported by `hugr convert`.
     FORMATS = {
         "json": EnvelopeConfig.TEXT,
+        "json-compressed": EnvelopeConfig(format=EnvelopeFormat.JSON, zstd=0),
         "model-exts": EnvelopeConfig.BINARY,
+        "model-exts-no-compression": EnvelopeConfig(
+            format=EnvelopeFormat.MODEL_WITH_EXTS, zstd=None
+        ),
     }
     # Envelope formats used when exporting test hugrs.
-    WRITE_FORMATS = ["json", "model-exts"]
-    # Envelope formats used as target for `hugr convert` before loading back the
-    # test hugrs.
+    WRITE_FORMATS = [
+        "json",
+        "json-compressed",
+        "model-exts",
+        "model-exts-no-compression",
+    ]
+    # Envelope formats used as target before loading back the test hugrs.
+    # These should correspond to the formats supported by `hugr convert`.
     LOAD_FORMATS = ["json", "model-exts"]
 
     # validate text and binary formats

hugr-py/tests/test_envelope.py

@@ -30,18 +30,27 @@ def package() -> Package:
     return Package([mod.hugr, mod2.hugr])
 
 
-def test_envelope(package: Package):
-    # Binary compression roundtrip
-    for format in [
+@pytest.mark.parametrize(
+    "compression", [None, 0], ids=["compression:None", "compression:0"]
+)
+@pytest.mark.parametrize(
+    "format",
+    [
         EnvelopeFormat.JSON,
         EnvelopeFormat.MODEL,
         EnvelopeFormat.MODEL_WITH_EXTS,
-    ]:
-        for compression in [None, 0]:
-            encoded = package.to_bytes(EnvelopeConfig(format=format, zstd=compression))
-            decoded = Package.from_bytes(encoded)
-            assert decoded == package
+    ],
+)
+def test_envelope_binary(
+    package: Package, compression: int | None, format: EnvelopeFormat
+):
+    # Binary compression roundtrip
+    encoded = package.to_bytes(EnvelopeConfig(format=format, zstd=compression))
+    decoded = Package.from_bytes(encoded)
+    assert decoded == package
+
 
+def test_envelope_text(package: Package):
     # String roundtrip
     encoded_str = package.to_str(EnvelopeConfig.TEXT)
     decoded = Package.from_str(encoded_str)