chore: add ManagedReference YAML roundtrip tests

dotnet · Sep 28, 2024 · dada078 · dada078
1 parent cc435bf
commit dada078
Show file tree

Hide file tree

Showing 4 changed files with 419 additions and 0 deletions.
diff --git a/test/docfx.Tests/SerializationTests/TestData/ManagedReference/BuildFromAssembly.yml b/test/docfx.Tests/SerializationTests/TestData/ManagedReference/BuildFromAssembly.yml
@@ -0,0 +1,32 @@
+### YamlMime:ManagedReference
+items:
+- uid: BuildFromAssembly
+  commentId: N:BuildFromAssembly
+  id: BuildFromAssembly
+  children:
+  - BuildFromAssembly.Class1
+  - BuildFromAssembly.Issue5432
+  langs:
+  - csharp
+  - vb
+  name: BuildFromAssembly
+  nameWithType: BuildFromAssembly
+  fullName: BuildFromAssembly
+  type: Namespace
+  assemblies:
+  - BuildFromAssembly
+references:
+- uid: BuildFromAssembly.Class1
+  commentId: T:BuildFromAssembly.Class1
+  isExternal: true
+  href: BuildFromAssembly.Class1.html
+  name: Class1
+  nameWithType: Class1
+  fullName: BuildFromAssembly.Class1
+- uid: BuildFromAssembly.Issue5432
+  commentId: T:BuildFromAssembly.Issue5432
+  isExternal: true
+  href: BuildFromAssembly.Issue5432.html
+  name: Issue5432
+  nameWithType: Issue5432
+  fullName: BuildFromAssembly.Issue5432
diff --git a/...x.Tests/SerializationTests/TestData/ManagedReference/BuildFromCSharpSourceCode.CSharp.yml b/...x.Tests/SerializationTests/TestData/ManagedReference/BuildFromCSharpSourceCode.CSharp.yml
@@ -0,0 +1,340 @@
+### YamlMime:ManagedReference
+items:
+- uid: BuildFromCSharpSourceCode.CSharp
+  commentId: T:BuildFromCSharpSourceCode.CSharp
+  id: CSharp
+  parent: BuildFromCSharpSourceCode
+  children:
+  - BuildFromCSharpSourceCode.CSharp.Main(System.String[])
+  langs:
+  - csharp
+  - vb
+  name: CSharp
+  nameWithType: CSharp
+  fullName: BuildFromCSharpSourceCode.CSharp
+  type: Class
+  source:
+    remote:
+      path: samples/seed/dotnet/csharp/CSharp.cs
+      branch: main
+      repo: https://github.com/dotnet/docfx
+    id: CSharp
+    path: dotnet/csharp/CSharp.cs
+    startLine: 7
+  namespace: BuildFromCSharpSourceCode
+  syntax:
+    content: public class CSharp
+    content.vb: Public Class CSharp
+  inheritance:
+  - System.Object
+  inheritedMembers:
+  - System.Object.Equals(System.Object)
+  - System.Object.Equals(System.Object,System.Object)
+  - System.Object.GetHashCode
+  - System.Object.GetType
+  - System.Object.MemberwiseClone
+  - System.Object.ReferenceEquals(System.Object,System.Object)
+  - System.Object.ToString
+- uid: BuildFromCSharpSourceCode.CSharp.Main(System.String[])
+  commentId: M:BuildFromCSharpSourceCode.CSharp.Main(System.String[])
+  id: Main(System.String[])
+  parent: BuildFromCSharpSourceCode.CSharp
+  langs:
+  - csharp
+  - vb
+  name: Main(string[])
+  nameWithType: CSharp.Main(string[])
+  fullName: BuildFromCSharpSourceCode.CSharp.Main(string[])
+  type: Method
+  source:
+    remote:
+      path: samples/seed/dotnet/csharp/CSharp.cs
+      branch: main
+      repo: https://github.com/dotnet/docfx
+    id: Main
+    path: dotnet/csharp/CSharp.cs
+    startLine: 9
+  namespace: BuildFromCSharpSourceCode
+  syntax:
+    content: public static void Main(string[] args)
+    parameters:
+    - id: args
+      type: System.String[]
+    content.vb: Public Shared Sub Main(args As String())
+  overload: BuildFromCSharpSourceCode.CSharp.Main*
+  nameWithType.vb: CSharp.Main(String())
+  fullName.vb: BuildFromCSharpSourceCode.CSharp.Main(String())
+  name.vb: Main(String())
+references:
+- uid: BuildFromCSharpSourceCode
+  commentId: N:BuildFromCSharpSourceCode
+  href: BuildFromCSharpSourceCode.html
+  name: BuildFromCSharpSourceCode
+  nameWithType: BuildFromCSharpSourceCode
+  fullName: BuildFromCSharpSourceCode
+- uid: System.Object
+  commentId: T:System.Object
+  parent: System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object
+  name: object
+  nameWithType: object
+  fullName: object
+  nameWithType.vb: Object
+  fullName.vb: Object
+  name.vb: Object
+- uid: System.Object.Equals(System.Object)
+  commentId: M:System.Object.Equals(System.Object)
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
+  name: Equals(object)
+  nameWithType: object.Equals(object)
+  fullName: object.Equals(object)
+  nameWithType.vb: Object.Equals(Object)
+  fullName.vb: Object.Equals(Object)
+  name.vb: Equals(Object)
+  spec.csharp:
+  - uid: System.Object.Equals(System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.Object.Equals(System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.Object.Equals(System.Object,System.Object)
+  commentId: M:System.Object.Equals(System.Object,System.Object)
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
+  name: Equals(object, object)
+  nameWithType: object.Equals(object, object)
+  fullName: object.Equals(object, object)
+  nameWithType.vb: Object.Equals(Object, Object)
+  fullName.vb: Object.Equals(Object, Object)
+  name.vb: Equals(Object, Object)
+  spec.csharp:
+  - uid: System.Object.Equals(System.Object,System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.Object.Equals(System.Object,System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.Object.GetHashCode
+  commentId: M:System.Object.GetHashCode
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
+  name: GetHashCode()
+  nameWithType: object.GetHashCode()
+  fullName: object.GetHashCode()
+  nameWithType.vb: Object.GetHashCode()
+  fullName.vb: Object.GetHashCode()
+  spec.csharp:
+  - uid: System.Object.GetHashCode
+    name: GetHashCode
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.GetHashCode
+    name: GetHashCode
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
+  - name: (
+  - name: )
+- uid: System.Object.GetType
+  commentId: M:System.Object.GetType
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.gettype
+  name: GetType()
+  nameWithType: object.GetType()
+  fullName: object.GetType()
+  nameWithType.vb: Object.GetType()
+  fullName.vb: Object.GetType()
+  spec.csharp:
+  - uid: System.Object.GetType
+    name: GetType
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.GetType
+    name: GetType
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
+  - name: (
+  - name: )
+- uid: System.Object.MemberwiseClone
+  commentId: M:System.Object.MemberwiseClone
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
+  name: MemberwiseClone()
+  nameWithType: object.MemberwiseClone()
+  fullName: object.MemberwiseClone()
+  nameWithType.vb: Object.MemberwiseClone()
+  fullName.vb: Object.MemberwiseClone()
+  spec.csharp:
+  - uid: System.Object.MemberwiseClone
+    name: MemberwiseClone
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.MemberwiseClone
+    name: MemberwiseClone
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
+  - name: (
+  - name: )
+- uid: System.Object.ReferenceEquals(System.Object,System.Object)
+  commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
+  name: ReferenceEquals(object, object)
+  nameWithType: object.ReferenceEquals(object, object)
+  fullName: object.ReferenceEquals(object, object)
+  nameWithType.vb: Object.ReferenceEquals(Object, Object)
+  fullName.vb: Object.ReferenceEquals(Object, Object)
+  name.vb: ReferenceEquals(Object, Object)
+  spec.csharp:
+  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
+    name: ReferenceEquals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
+    name: ReferenceEquals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: ','
+  - name: " "
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.Object.ToString
+  commentId: M:System.Object.ToString
+  parent: System.Object
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.object.tostring
+  name: ToString()
+  nameWithType: object.ToString()
+  fullName: object.ToString()
+  nameWithType.vb: Object.ToString()
+  fullName.vb: Object.ToString()
+  spec.csharp:
+  - uid: System.Object.ToString
+    name: ToString
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.Object.ToString
+    name: ToString
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
+  - name: (
+  - name: )
+- uid: System
+  commentId: N:System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system
+  name: System
+  nameWithType: System
+  fullName: System
+- uid: BuildFromCSharpSourceCode.CSharp.Main*
+  commentId: Overload:BuildFromCSharpSourceCode.CSharp.Main
+  href: BuildFromCSharpSourceCode.CSharp.html#BuildFromCSharpSourceCode_CSharp_Main_System_String___
+  name: Main
+  nameWithType: CSharp.Main
+  fullName: BuildFromCSharpSourceCode.CSharp.Main
+- uid: System.String[]
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.string
+  name: string[]
+  nameWithType: string[]
+  fullName: string[]
+  nameWithType.vb: String()
+  fullName.vb: String()
+  name.vb: String()
+  spec.csharp:
+  - uid: System.String
+    name: string
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.string
+  - name: '['
+  - name: ']'
+  spec.vb:
+  - uid: System.String
+    name: String
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.string
+  - name: (
+  - name: )
diff --git a/test/docfx.Tests/SerializationTests/TestData/ManagedReference/api.yml b/test/docfx.Tests/SerializationTests/TestData/ManagedReference/api.yml
@@ -0,0 +1,23 @@
+### YamlMime:ManagedReference
+items:
+- uid: dummy1
+  source:
+    remote:
+      path: dummy1.cs
+      branch: main
+      repo: https://github.com/dotnet/docfx
+- uid: dummy2
+  source:
+    remote:
+      path: dummy2.cs
+      branch: main
+      repo: https://github.com/dotnet/docfx
+references:
+  - uid: System.String
+    name: string
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.string
+shouldSkipMarkup: false
+memberLayout: separatePages
+additionalMetadata1: 1
+additionalMetadata2: 2