Cleanup canonical tests

Author: Julow

test/xref2/canonical_module.t/run.t

@@ -0,0 +1,29 @@
+Test that @canonical tags work on compilation units when it is placed in the
+top-comment.
+
+The module Test_x is expected to be referenced as Test.X.
+
+  $ compile test_x.mli test_y.ml test.ml
+
+Test_x and Test_y have a 'canonical' field:
+
+  $ odoc_print test_x.odocl | jq -c ".canonical"
+  {"Some":{"`Dot":[{"`Root":"Test"},"X"]}}
+  $ odoc_print test_y.odocl | jq -c ".canonical"
+  {"Some":{"`Dot":[{"`Root":"Test"},"Y"]}}
+
+Test_x is defined as a .mli file and Test_y as a .ml file in order to test the
+loader code handling canonical tags.
+
+Submodules *_out have the canonical tag in the declarations and submodules *_in
+have it in the top-comment.
+
+Every references should be marked as canonical:
+
+  $ odoc_print test.odocl | jq -c ".content.Module.items | .[] | .Module[1].type_.Alias[0] | select(.)"
+  {"`Resolved":{"`Canonical":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},{"`Resolved":{"`Alias":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"X"]}}]}}]}}
+  {"`Resolved":{"`Canonical":[{"`Module":[{"`Canonical":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},{"`Resolved":{"`Alias":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"X"]}}]}}]},"Out"]},{"`Resolved":{"`Alias":[{"`Module":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},"Out"]},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"X_out"]}}]}}]}}
+  {"`Resolved":{"`Canonical":[{"`Module":[{"`Canonical":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},{"`Resolved":{"`Alias":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"X"]}}]}}]},"In"]},{"`Resolved":{"`Alias":[{"`Module":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_x"]}},"In"]},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"X_in"]}}]}}]}}
+  {"`Resolved":{"`Canonical":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},{"`Resolved":{"`Alias":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"Y"]}}]}}]}}
+  {"`Resolved":{"`Canonical":[{"`Module":[{"`Canonical":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},{"`Resolved":{"`Alias":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"Y"]}}]}}]},"Out"]},{"`Resolved":{"`Alias":[{"`Module":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},"Out"]},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"Y_out"]}}]}}]}}
+  {"`Resolved":{"`Canonical":[{"`Module":[{"`Canonical":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},{"`Resolved":{"`Alias":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"Y"]}}]}}]},"In"]},{"`Resolved":{"`Alias":[{"`Module":[{"`Identifier":{"`Root":[{"`RootPage":"test"},"Test_y"]}},"In"]},{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"Y_in"]}}]}}]}}

test/xref2/canonical_module.t/test.ml

@@ -0,0 +1,12 @@
+(** Main module of this test. See [run.t] *)
+
+module X = Test_x
+module X_out = Test_x.Out
+module X_in = Test_x.In
+module Y = Test_y
+module Y_out = Test_y.Out
+module Y_in = Test_y.In
+
+type t = Test_x.t (* Through hidden path *)
+
+type u = Y.t (* Through canonical path *)

test/xref2/canonical_module.t/test_x.mli

@@ -0,0 +1,18 @@
+(** We expect this module to be referenced through Test.X.
+
+    @canonical Test.X *)
+
+type t
+(** @canonical Test.t *)
+
+(** @canonical Test.X_out *)
+module Out : sig
+  type t
+end
+
+module In : sig
+  (** @canonical Test.X_in *)
+
+  (** @canonical Test.v *)
+  type t
+end

test/xref2/canonical_module.t/test_y.ml

@@ -0,0 +1,16 @@
+(** An other canonical unit test but this time in an .ml file.
+
+    @canonical Test.Y *)
+
+type t
+
+(** @canonical Test.Y_out *)
+module Out = struct
+  type t
+end
+
+module In = struct
+  (** @canonical Test.Y_in *)
+
+  type t
+end