hugr-core 0.27.1

//! Tests for the HUGR serialization format.

use super::*;
use crate::builder::{
    Container, DFGBuilder, Dataflow, DataflowHugr, DataflowSubContainer, HugrBuilder,
    ModuleBuilder, endo_sig, inout_sig, test::closed_dfg_root_hugr,
};
use crate::envelope::{EnvelopeConfig, read_envelope, write_envelope};
use crate::extension::ExtensionRegistry;
use crate::extension::prelude::Noop;
use crate::extension::prelude::{bool_t, qb_t, usize_t};
use crate::extension::simple_op::MakeRegisteredOp;
use crate::extension::test::SimpleOpDef;
use crate::hugr::internal::HugrMutInternals;
use crate::hugr::test::check_hugr_equality;
use crate::hugr::validate::ValidationError;
use crate::hugr::views::ExtractionResult;
use crate::metadata::Metadata;
use crate::ops::custom::{ExtensionOp, OpaqueOp, OpaqueOpError};
use crate::ops::{self, DFG, Input, Module, Output, Value, dataflow::IOTrait};
use crate::package::Package;
use crate::std_extensions::arithmetic::float_types::float64_type;
use crate::std_extensions::arithmetic::int_types::{ConstInt, INT_TYPES};
use crate::std_extensions::logic::LogicOp;
use crate::std_extensions::std_reg;
use crate::test_file;
use crate::types::type_param::TypeParam;
use crate::types::{
    FuncValueType, PolyFuncType, PolyFuncTypeRV, Signature, SumType, Type, TypeArg, TypeBound,
    TypeRV,
};
use crate::{OutgoingPort, Visibility, type_row};
use std::fs::File;
use std::io::{BufReader, Cursor};

use std::sync::LazyLock;

use itertools::Itertools;
use jsonschema::{Draft, Validator};
use portgraph::{Hierarchy, LinkMut, PortMut, UnmanagedDenseMap, multiportgraph::MultiPortGraph};
use rstest::rstest;

/// A serde-serializable hugr. Used for testing.
#[derive(Debug, serde::Serialize)]
#[serde(transparent)]
#[allow(deprecated)]
pub(super) struct HugrSer<'h>(#[serde(serialize_with = "Hugr::serde_serialize")] pub &'h Hugr);
/// A serde-deserializable hugr. Used for testing.
#[derive(Debug, serde::Deserialize)]
#[serde(transparent)]
#[allow(deprecated)]
pub(super) struct HugrDeser(#[serde(deserialize_with = "Hugr::serde_deserialize")] pub Hugr);

/// Version 1 of the Testing HUGR serialization format, see `testing_hugr.py`.
#[derive(Serialize, Deserialize, PartialEq, Debug, Default)]
struct SerTestingLatest {
    typ: Option<crate::types::TypeRV>,
    sum_type: Option<crate::types::SumType>,
    poly_func_type: Option<crate::types::PolyFuncTypeRV>,
    value: Option<crate::ops::Value>,
    optype: Option<NodeSer>,
    op_def: Option<SimpleOpDef>,
}

struct NamedSchema {
    name: &'static str,
    schema: Validator,
}

impl NamedSchema {
    pub fn new(name: &'static str, schema: Validator) -> Self {
        Self { name, schema }
    }

    pub fn check(&self, val: &serde_json::Value) -> Result<(), String> {
        let mut errors = self.schema.iter_errors(val).peekable();
        if errors.peek().is_none() {
            return Ok(());
        }

        // errors don't necessarily implement Debug
        let mut strs = vec![format!("Schema failed to validate: {}", self.name)];
        strs.extend(errors.flat_map(|error| {
            [
                format!("Validation error: {error}"),
                format!("Instance path: {}", error.instance_path()),
            ]
        }));
        strs.push("Serialization test failed.".to_string());
        Err(strs.join("\n"))
    }

    pub fn check_schemas(
        val: &serde_json::Value,
        schemas: impl IntoIterator<Item = &'static Self>,
    ) -> Result<(), String> {
        schemas.into_iter().try_for_each(|schema| schema.check(val))
    }
}

macro_rules! include_schema {
    ($name:ident, $path:literal) => {
        static $name: LazyLock<NamedSchema> =
            LazyLock::new(|| {
                NamedSchema::new(stringify!($name), {
                    let schema_val: serde_json::Value = serde_json::from_str(include_str!(
                        concat!("../../../../resources/json-schema/", $path, "_live.json")
                    ))
                    .unwrap();
                    Validator::options()
                        .with_draft(Draft::Draft7)
                        .build(&schema_val)
                        .expect("Schema is invalid.")
                })
            });
    };
}

include_schema!(SCHEMA, "hugr_schema");
include_schema!(SCHEMA_STRICT, "hugr_schema_strict");
include_schema!(TESTING_SCHEMA, "testing_hugr_schema");
include_schema!(TESTING_SCHEMA_STRICT, "testing_hugr_schema_strict");

fn get_schemas(b: bool) -> impl IntoIterator<Item = &'static NamedSchema> {
    let schemas: [&'static NamedSchema; 2] = [&SCHEMA, &SCHEMA_STRICT];
    b.then_some(schemas.into_iter()).into_iter().flatten()
}

fn get_testing_schemas(b: bool) -> impl IntoIterator<Item = &'static NamedSchema> {
    let schemas: Vec<&'static NamedSchema> = vec![&TESTING_SCHEMA, &TESTING_SCHEMA_STRICT];
    b.then_some(schemas.into_iter()).into_iter().flatten()
}

macro_rules! impl_sertesting_from {
    ($typ:ty, $field:ident) => {
        #[cfg(test)]
        impl From<$typ> for SerTestingLatest {
            fn from(v: $typ) -> Self {
                let mut r: Self = Default::default();
                r.$field = Some(v);
                r
            }
        }
    };
}

impl_sertesting_from!(crate::types::TypeRV, typ);
impl_sertesting_from!(crate::types::SumType, sum_type);
impl_sertesting_from!(crate::types::PolyFuncTypeRV, poly_func_type);
impl_sertesting_from!(crate::ops::Value, value);
impl_sertesting_from!(NodeSer, optype);
impl_sertesting_from!(SimpleOpDef, op_def);

impl From<PolyFuncType> for SerTestingLatest {
    fn from(v: PolyFuncType) -> Self {
        let v: PolyFuncTypeRV = v.into();
        v.into()
    }
}

impl From<Type> for SerTestingLatest {
    fn from(v: Type) -> Self {
        let t: TypeRV = v.into();
        t.into()
    }
}

#[test]
fn empty_hugr_serialize() {
    check_hugr_json_roundtrip(&Hugr::default(), true);
}

fn ser_deserialize_check_schema<T: serde::de::DeserializeOwned>(
    val: serde_json::Value,
    schemas: impl IntoIterator<Item = &'static NamedSchema>,
) -> T {
    NamedSchema::check_schemas(&val, schemas).unwrap();
    serde_json::from_value(val).unwrap()
}

/// Serialize and deserialize a value, validating against a schema.
fn ser_roundtrip_check_schema<TSer: Serialize, TDeser: serde::de::DeserializeOwned>(
    g: &TSer,
    schemas: impl IntoIterator<Item = &'static NamedSchema>,
) -> TDeser {
    let val = serde_json::to_value(g).unwrap();
    match NamedSchema::check_schemas(&val, schemas) {
        Ok(()) => serde_json::from_value(val).unwrap(),
        Err(msg) => panic!("ser_roundtrip_check_schema failed with {msg}, input was {val}"),
    }
}

/// Serialize a Hugr and check that it is valid against the schema.
///
/// # Panics
///
/// Panics if the serialization fails or if the schema validation fails.
pub(crate) fn check_hugr_serialization_schema(hugr: &Hugr) {
    let schemas = get_schemas(true);
    let hugr_ser = HugrSer(hugr);
    let val = serde_json::to_value(hugr_ser).unwrap();
    NamedSchema::check_schemas(&val, schemas).unwrap();
}

/// Serialize and deserialize a HUGR, and check that the result is the same as the original.
///
/// If `check_schema` is true, checks the serialized json against the in-tree schema.
///
/// Note that we do not literally compare the before and after `Hugr`s for
/// equality, because impls of `CustomConst` are not required to implement
/// equality checking.
///
/// Returns the deserialized HUGR.
fn check_hugr_json_roundtrip(hugr: &impl HugrView, check_schema: bool) -> Hugr {
    // Transform the whole view into a HUGR.
    let (mut base, extract_map) = hugr.extract_hugr(hugr.module_root());
    base.set_entrypoint(extract_map.extracted_node(hugr.entrypoint()));

    let new_hugr: HugrDeser =
        ser_roundtrip_check_schema(&HugrSer(&base), get_schemas(check_schema));

    check_hugr_equality(&base, &new_hugr.0);
    new_hugr.0
}

/// Deserialize a HUGR json, ensuring that it is valid against the schema.
pub fn check_hugr_deserialize(hugr: &Hugr, value: serde_json::Value, check_schema: bool) -> Hugr {
    let new_hugr: HugrDeser = ser_deserialize_check_schema(value, get_schemas(check_schema));

    check_hugr_equality(hugr, &new_hugr.0);
    new_hugr.0
}

fn check_testing_roundtrip(t: impl Into<SerTestingLatest>) {
    let before = Versioned::new_latest(t.into());
    let after = ser_roundtrip_check_schema(&before, get_testing_schemas(true));
    assert_eq!(before, after);
}

fn test_schema_val() -> serde_json::Value {
    serde_json::json!({
        "op_def":null,
        "optype":{
            "name":"polyfunc1",
            "op":"FuncDefn",
            "visibility": "Public",
            "parent":0,
            "signature":{
                "body":{
                    "input":[],
                    "output":[]
                },
                "params":[
                    {"bound":null,"tp":"BoundedNat"}
                ]
            }
        },
        "poly_func_type":null,
        "sum_type":null,
        "typ":null,
        "value":null,
        "version":"live"
    })
}

fn schema_val() -> serde_json::Value {
    serde_json::json!({"nodes": [], "edges": [], "version": "live"})
}

#[rstest]
#[case(&TESTING_SCHEMA, &TESTING_SCHEMA_STRICT, test_schema_val(), Some("optype"))]
#[case(&SCHEMA, &SCHEMA_STRICT, schema_val(), None)]
fn wrong_fields(
    #[case] lax_schema: &'static NamedSchema,
    #[case] strict_schema: &'static NamedSchema,
    #[case] mut val: serde_json::Value,
    #[case] target_loc: impl IntoIterator<Item = &'static str> + Clone,
) {
    use serde_json::Value;
    fn get_fields(
        val: &mut Value,
        mut path: impl Iterator<Item = &'static str>,
    ) -> &mut serde_json::Map<String, Value> {
        let Value::Object(fields) = val else { panic!() };
        match path.next() {
            Some(n) => get_fields(fields.get_mut(n).unwrap(), path),
            None => fields,
        }
    }
    // First, some "known good" JSON
    NamedSchema::check_schemas(&val, [lax_schema, strict_schema]).unwrap();

    // Now try adding an extra field
    let fields = get_fields(&mut val, target_loc.clone().into_iter());
    fields.insert(
        "extra_field".to_string(),
        Value::String("not in schema".to_string()),
    );
    strict_schema.check(&val).unwrap_err();
    lax_schema.check(&val).unwrap();

    // And removing one
    let fields = get_fields(&mut val, target_loc.into_iter());
    fields.remove("extra_field").unwrap();
    let key = fields.keys().next().unwrap().clone();
    fields.remove(&key).unwrap();

    lax_schema.check(&val).unwrap_err();
    strict_schema.check(&val).unwrap_err();
}

/// Generate an optype for a node with a matching amount of inputs and outputs.
fn gen_optype(g: &MultiPortGraph<u32, u32, u32>, node: portgraph::NodeIndex) -> OpType {
    let inputs = g.num_inputs(node);
    let outputs = g.num_outputs(node);
    match (inputs == 0, outputs == 0) {
        (false, false) => DFG {
            signature: Signature::new(vec![usize_t(); inputs - 1], vec![usize_t(); outputs - 1]),
        }
        .into(),
        (true, false) => Input::new(vec![usize_t(); outputs - 1]).into(),
        (false, true) => Output::new(vec![usize_t(); inputs - 1]).into(),
        (true, true) => Module::new().into(),
    }
}

#[test]
fn simpleser() {
    let mut g = MultiPortGraph::new();

    let entrypoint = g.add_node(0, 0);
    let a = g.add_node(1, 1);
    let b = g.add_node(3, 2);
    let c = g.add_node(1, 1);
    let a0 = g.add_node(0, 1);
    let a1 = g.add_node(1, 0);
    let b0 = g.add_node(0, 1);
    let b1 = g.add_node(1, 0);
    let c0 = g.add_node(0, 1);
    let c1 = g.add_node(1, 0);

    g.link_nodes(a, 0, b, 0).unwrap();
    g.link_nodes(a, 0, b, 0).unwrap();
    g.link_nodes(b, 0, b, 1).unwrap();
    g.link_nodes(b, 1, c, 0).unwrap();
    g.link_nodes(b, 1, a, 0).unwrap();
    g.link_nodes(c, 0, a, 0).unwrap();
    g.link_nodes(a0, 0, a1, 0).unwrap();
    g.link_nodes(b0, 0, b1, 0).unwrap();
    g.link_nodes(c0, 0, c1, 0).unwrap();

    let mut h = Hierarchy::new();
    let mut op_types = UnmanagedDenseMap::new();

    op_types[entrypoint] = gen_optype(&g, entrypoint);

    for (n, children) in [(a, [a0, a1]), (b, [b0, b1]), (c, [c0, c1])] {
        h.push_child(n, entrypoint).unwrap();
        op_types[n] = gen_optype(&g, n);
        for child in children {
            h.push_child(child, n).unwrap();
            op_types[child] = gen_optype(&g, child);
        }
    }

    let hugr = Hugr {
        graph: g,
        hierarchy: h,
        module_root: entrypoint,
        entrypoint,
        op_types,
        metadata: Default::default(),
        extensions: ExtensionRegistry::default(),
    };

    check_hugr_json_roundtrip(&hugr, true);
}

#[test]
fn weighted_hugr_ser() {
    struct NameMetadata;
    impl Metadata for NameMetadata {
        type Type<'hugr> = &'hugr str;
        const KEY: &'static str = "name";
    }

    struct ValMetadata;
    impl Metadata for ValMetadata {
        type Type<'hugr> = u32;
        const KEY: &'static str = "val";
    }

    let hugr = {
        let mut module_builder = ModuleBuilder::new();
        module_builder.set_metadata::<NameMetadata>("test");

        let t_row = vec![Type::new_sum([vec![usize_t()], vec![qb_t()]])];
        let mut f_build = module_builder
            .define_function("main", Signature::new(t_row.clone(), t_row))
            .unwrap();

        let outputs = f_build
            .input_wires()
            .map(|in_wire| {
                f_build
                    .add_dataflow_op(Noop(f_build.get_wire_type(in_wire).unwrap()), [in_wire])
                    .unwrap()
                    .out_wire(0)
            })
            .collect_vec();
        f_build.set_metadata::<ValMetadata>(42);
        f_build.finish_with_outputs(outputs).unwrap();

        module_builder.finish_hugr().unwrap()
    };

    check_hugr_json_roundtrip(&hugr, true);
}

#[test]
fn dfg_roundtrip() -> Result<(), Box<dyn std::error::Error>> {
    let tp: Vec<Type> = vec![bool_t(); 2];
    let mut dfg = DFGBuilder::new(Signature::new(tp.clone(), tp))?;
    let mut params: [_; 2] = dfg.input_wires_arr();
    for p in &mut params {
        *p = dfg
            .add_dataflow_op(Noop(bool_t()), [*p])
            .unwrap()
            .out_wire(0);
    }
    let hugr = dfg.finish_hugr_with_outputs(params)?;

    check_hugr_json_roundtrip(&hugr, true);
    Ok(())
}

#[test]
fn extension_ops() -> Result<(), Box<dyn std::error::Error>> {
    let tp: Vec<Type> = vec![bool_t(); 1];
    let mut dfg = DFGBuilder::new(endo_sig(tp))?;
    let [wire] = dfg.input_wires_arr();

    // Add an extension operation
    let extension_op: ExtensionOp = LogicOp::Not.to_extension_op().unwrap();
    let wire = dfg
        .add_dataflow_op(extension_op.clone(), [wire])
        .unwrap()
        .out_wire(0);

    let hugr = dfg.finish_hugr_with_outputs([wire])?;

    check_hugr_json_roundtrip(&hugr, true);
    Ok(())
}

#[test]
fn opaque_ops() -> Result<(), Box<dyn std::error::Error>> {
    let tp: Vec<Type> = vec![bool_t(); 1];
    let mut dfg = DFGBuilder::new(endo_sig(tp))?;
    let [wire] = dfg.input_wires_arr();

    // Add an extension operation
    let extension_op: ExtensionOp = LogicOp::Not.to_extension_op().unwrap();
    let wire = dfg
        .add_dataflow_op(extension_op.clone(), [wire])
        .unwrap()
        .out_wire(0);

    // Add an unresolved opaque operation
    let opaque_op: OpaqueOp = extension_op.into();
    let ext_name = opaque_op.extension().clone();
    let wire = dfg.add_dataflow_op(opaque_op, [wire]).unwrap().out_wire(0);

    assert_eq!(
        dfg.finish_hugr_with_outputs([wire]),
        Err(ValidationError::OpaqueOpError(OpaqueOpError::UnresolvedOp(
            wire.node(),
            "Not".into(),
            ext_name,
        ))
        .into())
    );

    Ok(())
}

#[test]
fn function_type() -> Result<(), Box<dyn std::error::Error>> {
    let fn_ty = Type::new_function(Signature::new_endo([bool_t()]));
    let mut bldr = DFGBuilder::new(Signature::new_endo([fn_ty.clone()]))?;
    let op = bldr.add_dataflow_op(Noop(fn_ty), bldr.input_wires())?;
    let h = bldr.finish_hugr_with_outputs(op.outputs())?;

    check_hugr_json_roundtrip(&h, true);
    Ok(())
}

#[test]
fn hierarchy_order() -> Result<(), Box<dyn std::error::Error>> {
    let mut hugr = closed_dfg_root_hugr(Signature::new(vec![qb_t()], vec![qb_t()]));
    let [old_in, out] = hugr.get_io(hugr.entrypoint()).unwrap();
    hugr.connect(old_in, 0, out, 0);

    // Now add a new input
    let new_in = hugr.add_node(Input::new([qb_t()].to_vec()).into());
    hugr.disconnect(old_in, OutgoingPort::from(0));
    hugr.connect(new_in, 0, out, 0);
    hugr.move_before_sibling(new_in, old_in);
    hugr.remove_node(old_in);
    hugr.validate()?;

    let rhs: Hugr = check_hugr_json_roundtrip(&hugr, true);
    rhs.validate()?;
    Ok(())
}

#[test]
fn constants_roundtrip() -> Result<(), Box<dyn std::error::Error>> {
    let mut builder = DFGBuilder::new(inout_sig([], [INT_TYPES[4].clone()])).unwrap();
    let w = builder.add_load_value(ConstInt::new_s(4, -2).unwrap());
    let hugr = builder.finish_hugr_with_outputs([w])?;

    let ser = serde_json::to_string(&HugrSer(&hugr))?;
    let deser: HugrDeser = serde_json::from_str(&ser)?;

    let mut hugr_deser = deser.0;
    hugr_deser.resolve_extension_defs(hugr.extensions())?;

    assert_eq!(hugr, hugr_deser);

    Ok(())
}

#[test]
fn serialize_types_roundtrip() {
    let g: Type = Type::new_function(Signature::new_endo([]));
    check_testing_roundtrip(g.clone());

    // A Simple tuple
    let t = Type::new_tuple(vec![usize_t(), g]);
    check_testing_roundtrip(t);

    // A Classic sum
    let t = TypeRV::new_sum([vec![usize_t()], vec![float64_type()]]);
    check_testing_roundtrip(t);

    let t = Type::new_unit_sum(4);
    check_testing_roundtrip(t);
}

#[rstest]
#[case(bool_t())]
#[case(usize_t())]
#[case(INT_TYPES[2].clone())]
#[case(Type::new_alias(crate::ops::AliasDecl::new("t", TypeBound::Linear)))]
#[case(Type::new_var_use(2, TypeBound::Copyable))]
#[case(Type::new_tuple(vec![bool_t(),qb_t()]))]
#[case(Type::new_sum([vec![bool_t(),qb_t()], vec![Type::new_unit_sum(4)]]))]
#[case(Type::new_function(Signature::new_endo([qb_t(),bool_t(),usize_t()])))]
fn roundtrip_type(#[case] typ: Type) {
    check_testing_roundtrip(typ);
}

#[rstest]
#[case(SumType::new_unary(2))]
#[case(SumType::new([vec![usize_t(), qb_t()].into(), type_row![]]))]
fn roundtrip_sumtype(#[case] sum_type: SumType) {
    check_testing_roundtrip(sum_type);
}

#[rstest]
#[case(Value::unit())]
#[case(Value::true_val())]
#[case(Value::unit_sum(3,5).unwrap())]
#[case(Value::extension(ConstInt::new_u(2,1).unwrap()))]
#[case(Value::sum(1,[Value::extension(ConstInt::new_u(2,1).unwrap())], SumType::new([vec![], vec![INT_TYPES[2].clone()]])).unwrap())]
#[case(Value::tuple([Value::false_val(), Value::extension(ConstInt::new_s(2,1).unwrap())]))]
fn roundtrip_value(#[case] value: Value) {
    check_testing_roundtrip(value);
}

fn polyfunctype1() -> PolyFuncType {
    let function_type = Signature::new_endo(type_row![]);
    PolyFuncType::new([TypeParam::max_nat_type()], function_type)
}

fn polyfunctype2() -> PolyFuncTypeRV {
    let tv0 = TypeRV::new_row_var_use(0, TypeBound::Linear);
    let tv1 = TypeRV::new_row_var_use(1, TypeBound::Copyable);
    let params = [TypeBound::Linear, TypeBound::Copyable].map(TypeParam::new_list_type);
    let inputs = vec![
        TypeRV::new_function(FuncValueType::new([tv0.clone()], [tv1.clone()])),
        tv0,
    ];
    let res = PolyFuncTypeRV::new(params, FuncValueType::new(inputs, [tv1]));
    // Just check we've got the arguments the right way round
    // (not that it really matters for the serialization schema we have)
    res.validate().unwrap();
    res
}

#[rstest]
#[case(Signature::new_endo(type_row![]).into())]
#[case(polyfunctype1())]
#[case(PolyFuncType::new([TypeParam::StringType], Signature::new_endo([Type::new_var_use(0, TypeBound::Copyable)])))]
#[case(PolyFuncType::new([TypeBound::Copyable.into()], Signature::new_endo([Type::new_var_use(0, TypeBound::Copyable)])))]
#[case(PolyFuncType::new([TypeParam::new_list_type(TypeBound::Linear)], Signature::new_endo(type_row![])))]
#[case(PolyFuncType::new([TypeParam::new_tuple_type([TypeBound::Linear.into(), TypeParam::bounded_nat_type(2.try_into().unwrap())])], Signature::new_endo(type_row![])))]
#[case(PolyFuncType::new(
    [TypeParam::new_list_type(TypeBound::Linear)],
    Signature::new_endo([Type::new_tuple([TypeRV::new_row_var_use(0, TypeBound::Linear)])])))]
fn roundtrip_polyfunctype_fixedlen(#[case] poly_func_type: PolyFuncType) {
    check_testing_roundtrip(poly_func_type);
}

#[rstest]
#[case(FuncValueType::new_endo(type_row![]).into())]
#[case(PolyFuncTypeRV::new([TypeParam::StringType], FuncValueType::new_endo([Type::new_var_use(0, TypeBound::Copyable)])))]
#[case(PolyFuncTypeRV::new([TypeBound::Copyable.into()], FuncValueType::new_endo([Type::new_var_use(0, TypeBound::Copyable)])))]
#[case(PolyFuncTypeRV::new([TypeParam::new_list_type(TypeBound::Linear)], FuncValueType::new_endo(type_row![])))]
#[case(PolyFuncTypeRV::new([TypeParam::new_tuple_type([TypeBound::Linear.into(), TypeParam::bounded_nat_type(2.try_into().unwrap())])], FuncValueType::new_endo(type_row![])))]
#[case(PolyFuncTypeRV::new(
    [TypeParam::new_list_type(TypeBound::Linear)],
    FuncValueType::new_endo([TypeRV::new_row_var_use(0, TypeBound::Linear)])))]
#[case(polyfunctype2())]
fn roundtrip_polyfunctype_varlen(#[case] poly_func_type: PolyFuncTypeRV) {
    check_testing_roundtrip(poly_func_type);
}

#[rstest]
#[case(ops::Module::new())]
#[case(ops::FuncDefn::new_vis("polyfunc1", polyfunctype1(), Visibility::Private))]
#[case(ops::FuncDefn::new_vis("pubfunc1", polyfunctype1(), Visibility::Public))]
#[case(ops::AliasDefn { name: "aliasdefn".into(), definition: Type::new_unit_sum(4)})]
#[case(ops::AliasDecl { name: "aliasdecl".into(), bound: TypeBound::Linear})]
#[case(ops::Const::new(Value::false_val()))]
#[case(ops::Input::new(vec![Type::new_var_use(3,TypeBound::Copyable)]))]
#[case(ops::Output::new(vec![Type::new_function(FuncValueType::new_endo(type_row![]))]))]
#[case(ops::Call::try_new(polyfunctype1(), [TypeArg::BoundedNat(1)]).unwrap())]
#[case(ops::CallIndirect { signature : Signature::new_endo([bool_t()]) })]
fn roundtrip_optype(#[case] optype: impl Into<OpType> + std::fmt::Debug) {
    check_testing_roundtrip(NodeSer {
        parent: portgraph::NodeIndex::new(0).into(),
        op: optype.into(),
    });
}

#[test]
// test all standard extension serialisations are valid against scheme
fn std_extensions_valid() {
    let std_reg = crate::std_extensions::std_reg();
    for ext in std_reg {
        let val = serde_json::to_value(ext).unwrap();
        NamedSchema::check_schemas(&val, get_schemas(true)).unwrap();
        // check deserialises correctly, can't check equality because of custom binaries.
        let deser: crate::extension::Extension = serde_json::from_value(val.clone()).unwrap();
        assert_eq!(serde_json::to_value(deser).unwrap(), val);
    }
}

#[test]
#[cfg_attr(miri, ignore)] // Opening files is not supported in (isolated) miri
// https://github.com/CQCL/hugr/issues/2600
fn cfg_edge_ordering() {
    let pkg: Package = Package::load(
        BufReader::new(File::open(test_file!("issue-2600.hugr")).unwrap()),
        None,
    )
    .unwrap();
    pkg.validate().unwrap();

    let mut data1: Vec<u8> = Vec::new();
    let _ = write_envelope(&mut data1, &pkg, EnvelopeConfig::text());

    let buff1 = Cursor::new(data1);
    let (_, pkg1) = read_envelope(buff1, &std_reg()).unwrap();
    pkg1.validate().unwrap();
}

mod proptest {
    use super::check_testing_roundtrip;
    use super::{NodeSer, SimpleOpDef};
    use crate::ops::{OpType, OpaqueOp, Value};
    use crate::types::{PolyFuncTypeRV, Type};
    use proptest::prelude::*;

    impl Arbitrary for NodeSer {
        type Parameters = ();
        type Strategy = BoxedStrategy<Self>;
        fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy {
            (
                (0..i32::MAX as usize).prop_map(|x| portgraph::NodeIndex::new(x).into()),
                any::<OpType>(),
            )
                .prop_map(|(parent, op)| {
                    if let OpType::ExtensionOp(ext_op) = op {
                        let opaque: OpaqueOp = ext_op.into();
                        NodeSer {
                            parent,
                            op: opaque.into(),
                        }
                    } else {
                        NodeSer { parent, op }
                    }
                })
                .boxed()
        }
    }

    proptest! {
        #[test]
        fn prop_roundtrip_type(t:  Type) {
            check_testing_roundtrip(t);
        }

        #[test]
        fn prop_roundtrip_poly_func_type(t: PolyFuncTypeRV) {
            check_testing_roundtrip(t);
        }

        #[test]
        fn prop_roundtrip_value(t: Value) {
            check_testing_roundtrip(t);
        }

        #[test]
        fn prop_roundtrip_optype(op: NodeSer ) {
            check_testing_roundtrip(op);
        }

        #[test]
        fn prop_roundtrip_opdef(opdef: SimpleOpDef) {
            check_testing_roundtrip(opdef);
        }
    }
}