Add Windows tests to CI

Author: mattleibow

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
         configuration: [Release, Debug]
 
     steps:

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest]
+        os: [macos-latest, windows-latest]
         configuration: [Release]
 
     steps:
@@ -29,9 +29,26 @@ jobs:
       with:
         dotnet-version: '6.x'
 
-    - name: Install Mono
+    - name: Install Mono - Ubuntu
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        sudo apt install ca-certificates gnupg
+        sudo gpg --homedir /tmp --no-default-keyring --keyring gnupg-ring:/usr/share/keyrings/mono-official-archive-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
+        sudo chmod +r /usr/share/keyrings/mono-official-archive-keyring.gpg
+        echo "deb [signed-by=/usr/share/keyrings/mono-official-archive-keyring.gpg] https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
+        sudo apt update
+        sudo apt install mono-complete mono-vbnc
+
+    - name: Install Mono - macOS
+      if: matrix.os == 'macos-latest'
       run: |
         brew install --cask mono-mdk
 
+    - name: Install Mono - Windows
+      if: matrix.os == 'windows-latest'
+      run: |
+        winget install Mono.Mono --accept-source-agreements --accept-package-agreements
+        echo "PATH=$env:PATH;C:\Program Files\Mono\bin" >> $env:GITHUB_ENV
+
     - name: Run tests
       run: make prepare all check CONFIGURATION=${{ matrix.configuration }}

Makefile

@@ -22,13 +22,13 @@ clean:
 check: build check-monodoc check-mdoc
 
 check-mdoc:
-	cd mdoc; $(MAKE) check -B
+	$(MAKE) check -B -C mdoc
 
 nuget:
 	nuget pack mdoc/mdoc.nuspec -outputdirectory bin/Nuget
 
 check-monodoc:
-	cd monodoc; $(MAKE) check -B
+	$(MAKE) check -B -C monodoc
 
 zip:
 	rm -f $(BIN)/mdoc*.zip

external/Test/AttachedEventsAndProperties.dll

@@ -1,6 +1,6 @@
 CONFIGURATION = Release
 PROGRAM = ../bin/$(CONFIGURATION)/mdoc.exe
-MONO = mono
+MONO = $(if $(filter Windows_NT,$(OS)),,mono)
 CSCOMPILE = mcs
 VBCOMPILE = vbnc
 TEST_CSCFLAGS = -target:library
@@ -47,8 +47,8 @@ EXTRA_DISTFILES = \
 MULTI-CLASSIC = Test/DocTest-DropNS-classic.dll Test/DocTest-DropNS-classic-multitest.dll
 MULTI-UNIFIED = Test/DocTest-DropNS-unified.dll Test/DocTest-DropNS-unified-multitest.dll
 
-DIFF = diff -rup 
-DIFF_QUIET = diff --brief
+DIFF = diff -rup $(if $(filter Windows_NT,$(OS)),--strip-trailing-cr,)
+DIFF_QUIET = diff --brief $(if $(filter Windows_NT,$(OS)),--strip-trailing-cr,)
 
 ifeq ($(ENVIRONMENT),wsl)
 DIFF = diff -rup -Z
@@ -59,11 +59,40 @@ cleanup:
 	-rm -Rf Test/en.actual Test/html.actual
 
 nunit: 
-	mono ../packages/NUnit.ConsoleRunner.3.6.0/tools/nunit3-console.exe mdoc.Test/bin/$(CONFIGURATION)/mdoc.Test.dll
+	$(MONO) ../packages/NUnit.ConsoleRunner.3.6.0/tools/nunit3-console.exe mdoc.Test/bin/$(CONFIGURATION)/mdoc.Test.dll
+
+ifeq ($(filter Windows_NT,$(OS)),)
 
 Test/DocTest-VB-Eii.dll:
 	$(VBCOMPILE) -out:Test/DocTest-VB-Eii.dll  Test/ClassEnumerator.vb
 
+../mdoc/mdoc.Test/mdoc.Test.FSharp/bin/Release/mdoc.Test.FSharp.dll:
+	msbuild ../mdoc/mdoc.Test/mdoc.Test.FSharp/mdoc.Test.FSharp.fsproj -property:Configuration=Release
+
+Test/TestInterfaceImplementation/bin/Release/TestInterfaceImplementation.dll:
+	msbuild ../mdoc/Test/TestInterfaceImplementation/TestInterfaceImplementation.csproj -property:Configuration=Release
+
+Test/AttachedEventsAndProperties/bin/Release/AttachedEventsAndProperties.dll:
+	msbuild ../mdoc/Test/AttachedEventsAndProperties/AttachedEventsAndProperties.csproj -property:Configuration=Release
+
+else # Full .NET Framework has extra attributes and slightly different generated types
+
+Test/DocTest-VB-Eii.dll:
+	cp ../external/Test/DocTest-VB-Eii.dll Test/DocTest-VB-Eii.dll
+
+../mdoc/mdoc.Test/mdoc.Test.FSharp/bin/Release/mdoc.Test.FSharp.dll:
+	cp ../external/Test/mdoc.Test.FSharp.dll ../mdoc/mdoc.Test/mdoc.Test.FSharp/bin/Release/mdoc.Test.FSharp.dll
+
+Test/TestInterfaceImplementation/bin/Release/TestInterfaceImplementation.dll:
+	mkdir -p Test/TestInterfaceImplementation/bin/Release/
+	cp ../external/Test/TestInterfaceImplementation.dll Test/TestInterfaceImplementation/bin/Release/TestInterfaceImplementation.dll
+
+Test/AttachedEventsAndProperties/bin/Release/AttachedEventsAndProperties.dll:
+	mkdir -p Test/AttachedEventsAndProperties/bin/Release/
+	cp ../external/Test/AttachedEventsAndProperties.dll Test/AttachedEventsAndProperties/bin/Release/AttachedEventsAndProperties.dll
+
+endif
+
 Test/DocTest-addNonGeneric.dll:
 	$(CSCOMPILE) $(TEST_CSCFLAGS) -unsafe -debug -optimize -target:library -out:$@ Test/DocTest-addNonGeneric.cs
 
@@ -174,7 +203,7 @@ Test/DocTest-typeForwards-Third.dll:
 	$(CSCOMPILE) $(TEST_CSCFLAGS) -unsafe -debug -optimize -target:library -out:Test/DocTest-typeForwards-Third-First.dll /reference:$@ Test/DocTest-typeForwards.cs /define:THIRD
 
 Test/DocTest-TypeProjection.dll:
-	rm -f DocTest-TypeProjection.dll
+	rm -f $@
 	$(CSCOMPILE) $(TEST_CSCFLAGS) -unsafe -debug -optimize -target:library -out:$@ Test/DocTest-TypeProjection.cs
 
 # build test dll to test forwardings nested type
@@ -183,7 +212,7 @@ Test/DocTest-nestedType-typeForwards-First.dll:
 	$(CSCOMPILE) $(TEST_CSCFLAGS) -unsafe -debug -optimize -target:library -out:$@ Test/DocTest-nestedType-typeForwards.cs /define:FIRST
 
 Test/DocTest-LongFileName.dll:
-	rm -f DocTest-LongFileName.dll
+	rm -f $@
 	$(CSCOMPILE) $(TEST_CSCFLAGS) -unsafe -debug -optimize -target:library -out:$@ Test/DocTest-LongFileName.cs
 
 .PHONY: Test/DocTest-nestedType-typeForwards-Second.dll
@@ -670,7 +699,7 @@ check-monodocer-fx-statistics-remove:
 
 check-monodocer-fsharp:
 	-rm -Rf Test/en.actual
-	msbuild ../mdoc/mdoc.Test/mdoc.Test.FSharp/mdoc.Test.FSharp.fsproj -property:Configuration=Release
+	$(MAKE) ../mdoc/mdoc.Test/mdoc.Test.FSharp/bin/Release/mdoc.Test.FSharp.dll
 	$(MONO) $(PROGRAM) update -lang fsharp -o Test/en.actual ../mdoc/mdoc.Test/mdoc.Test.FSharp/bin/Release/mdoc.Test.FSharp.dll
 
 ifeq ($(ENVIRONMENT), wsl)
@@ -682,7 +711,7 @@ endif
 
 check-monodocer-members-implementation:
 	-rm -Rf Test/en.actual
-	msbuild ../mdoc/Test/TestInterfaceImplementation/TestInterfaceImplementation.csproj -property:Configuration=Release
+	$(MAKE) Test/TestInterfaceImplementation/bin/Release/TestInterfaceImplementation.dll
 	$(MONO) $(PROGRAM) update -o Test/en.actual Test/TestInterfaceImplementation/bin/Release/TestInterfaceImplementation.dll
 	$(DIFF) Test/en.expected.members-implementation Test/en.actual
 
@@ -768,7 +797,7 @@ check-monodocer-import-fx-update: check-monodocer-import-fx-work
 
 check-monodocer-attached-entities:
 	-rm -Rf Test/en.actual
-	msbuild ../mdoc/Test/AttachedEventsAndProperties/AttachedEventsAndProperties.csproj -property:Configuration=Release
+	$(MAKE) Test/AttachedEventsAndProperties/bin/Release/AttachedEventsAndProperties.dll
 	$(MONO) $(PROGRAM) update --debug -o Test/en.actual Test/AttachedEventsAndProperties/bin/Release/AttachedEventsAndProperties.dll -lang docid -lang vb.net -lang fsharp -lang javascript -lang c++/cli -lang c++/cx -lang c++/winrt
 	$(DIFF) Test/en.expected-attached-entities Test/en.actual
 

external/Test/DocTest-VB-Eii.dll

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Runtime.InteropServices;
 using System.Xml.Linq;
 using Mono.Documentation;
 using Mono.Documentation.Framework;
@@ -406,7 +407,9 @@ public void GetTypeXmlPath_ShouldReturnCorrectPath_WhenTypeIsDropped()
             string result = fileSource.GetTypeXmlPath(basePath, nsName, typeName);
 
             // Assert
-            string expectedResult = "basePath/DroppedNamespace.Namespace/TypeName.xml";
+            string expectedResult = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+                ? "basePath\\DroppedNamespace.Namespace\\TypeName.xml"
+                : "basePath/DroppedNamespace.Namespace/TypeName.xml";
             Assert.AreEqual(expectedResult, result);
         }