feat: Implement tests for Global

Author: spotandjake

.gitignore

@@ -1,10 +1,15 @@
+# Esy
 node_modules/
 _esy/
 _build/
+
+# Ocaml
 .merlin
+
+# General
 META
-.vscode/
 .DS_Store
 *.tar.gz
 *.install
 *.zip
+

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "ocamllabs.ocaml-platform"
+  ]
+}

test/global_test.re

@@ -0,0 +1,103 @@
+open Binaryen;
+open Frame_work;
+
+suite("Global", () => {
+  let create_test_global = (wasm_mod, name) => {
+    Global.add_global(
+      wasm_mod,
+      name,
+      Type.int32,
+      false,
+      Expression.Const.make(wasm_mod, Literal.int32(0l)),
+    );
+  };
+  test("Add global", () => {
+    let wasm_mod = Module.create();
+    let _ = create_test_global(wasm_mod, "test_global");
+    Printf.printf("%s\n", Module.write_text(wasm_mod));
+    Module.dispose(wasm_mod);
+  });
+  test("Get Name", () => {
+    let wasm_mod = Module.create();
+    let name = "test_global";
+    let test_global = create_test_global(wasm_mod, name);
+    assert(Global.get_name(test_global) == name);
+    Module.dispose(wasm_mod);
+  });
+  test("Get Type", () => {
+    let wasm_mod = Module.create();
+    let test_global = create_test_global(wasm_mod, "test_non_null");
+    assert(!Type.is_nullable(Global.get_type(test_global)));
+    let test_global =
+      Global.add_global(
+        wasm_mod,
+        "test_null",
+        Type.nullref,
+        false,
+        Expression.Null.make(),
+      );
+    assert(Type.is_nullable(Global.get_type(test_global)));
+    Module.dispose(wasm_mod);
+  });
+  test("Get Global", () => {
+    let wasm_mod = Module.create();
+    let name = "test_global";
+    let _ = create_test_global(wasm_mod, name);
+    let test_global = Global.get_global(wasm_mod, name);
+    assert(Global.get_name(test_global) == name);
+    Module.dispose(wasm_mod);
+  });
+  test("Is Mutable", () => {
+    let wasm_mod = Module.create();
+    let test_global = create_test_global(wasm_mod, "test_global");
+    assert(!Global.is_mutable(test_global));
+    let mutable_global =
+      Global.add_global(
+        wasm_mod,
+        "mutable_global",
+        Type.int32,
+        true,
+        Expression.Const.make(wasm_mod, Literal.int32(42l)),
+      );
+    assert(Global.is_mutable(mutable_global));
+    Module.dispose(wasm_mod);
+  });
+  test("Number of Globals", () => {
+    let wasm_mod = Module.create();
+    assert(Global.get_num_globals(wasm_mod) == 0);
+    let _ = create_test_global(wasm_mod, "global1");
+    let _ = create_test_global(wasm_mod, "global2");
+    assert(Global.get_num_globals(wasm_mod) == 2);
+    Module.dispose(wasm_mod);
+  });
+  test("Remove Global", () => {
+    let wasm_mod = Module.create();
+    let _ = create_test_global(wasm_mod, "global_to_remove");
+    assert(Global.get_num_globals(wasm_mod) == 1);
+    Global.remove_global(wasm_mod, "global_to_remove");
+    assert(Global.get_num_globals(wasm_mod) == 0);
+    Module.dispose(wasm_mod);
+  });
+  test("Get Global by Index", () => {
+    let wasm_mod = Module.create();
+    let name1 = "global1";
+    let name2 = "global2";
+    let _ = create_test_global(wasm_mod, name1);
+    let _ = create_test_global(wasm_mod, name2);
+    let global1 = Global.get_global_by_index(wasm_mod, 0);
+    let global2 = Global.get_global_by_index(wasm_mod, 1);
+    assert(Global.get_name(global1) == name1);
+    assert(Global.get_name(global2) == name2);
+    Module.dispose(wasm_mod);
+  });
+  test("Get Init Expr", () => {
+    let wasm_mod = Module.create();
+    let test_global = create_test_global(wasm_mod, "test_global");
+    let init_expr = Global.get_init_expr(test_global);
+    switch (Expression.get_kind(init_expr)) {
+    | Expression.Const => assert(true)
+    | _ => assert(false)
+    };
+    Module.dispose(wasm_mod);
+  });
+});

test/test.expected

@@ -46,7 +46,21 @@ Running suite: Function
  )
 )
 . Running test: set_debug_location
-{"version":3,"sources":[],"names":[],"mappings":"uBASoB,C"}Running suite: Literal
+{"version":3,"sources":[],"names":[],"mappings":"uBASoB,C"}Running suite: Global
+. Running test: Add global
+(module
+ (global $test_global i32 (i32.const 0))
+)
+
+. Running test: Get Name
+. Running test: Get Type
+. Running test: Get Global
+. Running test: Is Mutable
+. Running test: Number of Globals
+. Running test: Remove Global
+. Running test: Get Global by Index
+. Running test: Get Init Expr
+Running suite: Literal
 . Running test: int32
 (module
  (type $0 (func))

test/test.re

@@ -1,33 +1,22 @@
-open Module_test;
-open Literal_test;
-open Function_test;
-open Settings_test;
+open Module_test; // TODO: Document
+open Literal_test; // TODO: Document
+open Function_test; // TODO: Document
+open Settings_test; // TODO: Document
 open Type_test;
-// TODO: Table
-// TODO: Struct_Type
-// TODO: Signature_Type
-// TODO: Passes
-// TODO: Packed_Type
-// TODO: OP
-// TODO: Memory
-// TODO: Import
-// TODO: Heap_Type
-// TODO: Global
-// TODO: Expression
-// TODO: Export
-// TODO: Element_Segment
-// TODO: Array_Type
-
-// let wasm_mod = Module.create ()
-// let _ = Module.set_features wasm_mod [ Module.Feature.all ]
-// let import_wasm_mod = Module.create ()
-
-// (* Testing pass_argument *)
-// let _ = assert (Settings.get_pass_argument "theKey" = None)
-// let _ = Settings.set_pass_argument "theKey" "theValue"
-// let _ = assert (Settings.get_pass_argument "theKey" = Some "theValue")
-// let _ = Settings.set_pass_argument "theKey" "theValue2"
-// let _ = assert (Settings.get_pass_argument "theKey" = Some "theValue2")
+// TODO: Heap_Type (quick)
+// TODO: Array_Type (quick)
+// TODO: Struct_Type (quick)
+// TODO: Signature_Type (quick)
+// TODO: Packed_Type (quick)
+open Global_test; // TODO: Document
+// TODO: Memory (Medium)
+// TODO: Table (Medium)
+// TODO: Element_Segment (Medium)
+// TODO: Export (Medium)
+// TODO: Import (Medium)
+// TODO: Passes (Hard)
+// TODO: Expression (Hard)
+// TODO: OP (Medium)
 
 // let _ =
 //   Import.add_memory_import import_wasm_mod "internal_name" "external_name"
@@ -142,18 +131,6 @@ open Type_test;
 
 // let _ = Expression.print table_grow
 
-// let _ =
-//   Global.add_global wasm_mod "max_int64" Type.int64 false
-//     (Expression.Const.make wasm_mod (Literal.int64 Int64.max_int))
-
-// let _ =
-//   Global.add_global wasm_mod "max_int64_mut" Type.int64 true
-//     (Expression.Const.make wasm_mod (Literal.int64 Int64.max_int))
-
-// let _ =
-//   Global.add_global wasm_mod "test_float64_bits" Type.float64 false
-//     (Expression.Const.make wasm_mod (Literal.float64_bits 0x3FF3AE147AE147AEL))
-
 // let _ =
 //   Table.add_active_element_segment wasm_mod "table" "elem" [ "adder" ]
 //     (Expression.Const.make wasm_mod (Literal.int32 0l))