feat: port xunit and nunit loggers into testlogger repo. (#68)

* feat: port xunit and nunit loggers into testlogger repo. * chore: add new tests to CI * fix: revert preview feature usage. * chore: create nuget package for loggers.
spekt · Jun 17, 2024 · 677c53f · 677c53f
1 parent 6249398
commit 677c53f
Show file tree

Hide file tree

Showing 74 changed files with 3,909 additions and 103 deletions.
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -13,13 +13,13 @@ jobs:
         os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     env:
-      APP_BUILD_VERSION: ${{ format('3.1.{0}', github.run_number) }}
+      APP_BUILD_VERSION: ${{ format('4.0.{0}', github.run_number) }}
     steps:
       - uses: actions/checkout@v2
-      - name: Setup .NET 7.0
+      - name: Setup .NET 8.0
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.x
       - name: Setup .NET 3.1.x
         uses: actions/setup-dotnet@v1
         with:
@@ -29,9 +29,14 @@ jobs:
       - name: Package (release)
         run: dotnet pack -c Release -p:PackageVersion=${{ env.APP_BUILD_VERSION }}
       - name: Unit test
-        run: dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/TestLogger.UnitTests/TestLogger.UnitTests.csproj -p:CollectCoverage=true -p:CoverletOutputFormat=opencover
+        run: |
+          dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/TestLogger.UnitTests/TestLogger.UnitTests.csproj -p:CollectCoverage=true -p:CoverletOutputFormat=opencover
+          dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/NUnit.Xml.TestLogger.UnitTests/NUnit.Xml.TestLogger.UnitTests.csproj -p:CollectCoverage=true -p:CoverletOutputFormat=opencover
       - name: Acceptance test
-        run: dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/TestLogger.AcceptanceTests/TestLogger.AcceptanceTests.csproj
+        run: |
+          dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/TestLogger.AcceptanceTests/TestLogger.AcceptanceTests.csproj
+          dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/Xunit.Xml.TestLogger.AcceptanceTests/Xunit.Xml.TestLogger.AcceptanceTests.csproj
+          dotnet test -p:PackageVersion=${{ env.APP_BUILD_VERSION }} test/NUnit.Xml.TestLogger.AcceptanceTests/NUnit.Xml.TestLogger.AcceptanceTests.csproj
       - name: Upload Verification Files on Fail
         if: ${{ failure() }}
         uses: actions/upload-artifact@v2
@@ -48,5 +53,6 @@ jobs:
       - name: Publish packages
         if: ${{ github.event_name == 'push' && matrix.os == 'ubuntu-latest' }}
         run: |
-          dotnet nuget push 'src/TestLogger/bin/Release/*.nupkg' --api-key ${{ secrets.GITHUB_TOKEN }} --source https://nuget.pkg.github.com/spekt/index.json
           dotnet nuget push 'src/TestLogger/bin/Release/*.nupkg' --api-key ${{ secrets.SPEKT_MYGET_KEY }} --source https://www.myget.org/F/spekt/api/v3/index.json
+          dotnet nuget push 'src/Xunit.Xml.Package/bin/Release/*.nupkg' --api-key ${{ secrets.SPEKT_MYGET_KEY }} --source https://www.myget.org/F/spekt/api/v3/index.json
+          dotnet nuget push 'src/NUnit.Xml.Package/bin/Release/*.nupkg' --api-key ${{ secrets.SPEKT_MYGET_KEY }} --source https://www.myget.org/F/spekt/api/v3/index.json
diff --git a/.gitignore b/.gitignore
@@ -25,7 +25,7 @@ bld/
 [Ll]og/
 
 # Test results
-**/test-results.xml
+**/*test-results.xml
 **/test-results.json
 
 # Visual Studio 2015/2017 cache/options directory
@@ -335,6 +335,9 @@ ASALocalRun/
 # MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
+# VSTest logs
+log*.txt
+
 .vscode/settings.json
 
 *.received.txt
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -0,0 +1,15 @@
+<Project>
+  <PropertyGroup>
+    <!-- Test Assets use the minimum supported versions -->
+    <NETTestSdkMinimumVersion>16.5.0</NETTestSdkMinimumVersion>
+    <XunitVersion>2.3.1</XunitVersion>
+    <XunitTestAdapterVersion>2.3.1</XunitTestAdapterVersion>
+    <NUnitVersion>3.13.2</NUnitVersion>
+    <NUnitTestAdapterVersion>4.0.0</NUnitTestAdapterVersion>
+    <MSTestVersion>3.4.3</MSTestVersion>
+
+    <!-- Only use stable versions of stylecop -->
+    <StylecopVersion>1.1.118</StylecopVersion>
+  </PropertyGroup>
+</Project>
+<!-- vim: set ft=xml : -->
diff --git a/build.ps1 b/build.ps1
@@ -3,7 +3,7 @@ ForEach ($local in $($locals -split "`r`n"))
 {
     $local = $local.Substring($local.IndexOf(":") + 2)
     "Deleting from $local"
-    dotnet nuget delete Json.TestLogger 3.1.0-dev --force-english-output --non-interactive -s $local
+    dotnet nuget delete Json.TestLogger 4.0.0-dev --force-english-output --non-interactive -s $local
 }
 
 Remove-Item .\test\package\bin\ -Recurse

diff --git a/build.sh b/build.sh
@@ -3,4 +3,7 @@
 
 dotnet pack &&\
 dotnet test test/TestLogger.UnitTests/TestLogger.UnitTests.csproj -p:CollectCoverage=true -p:CoverletOutputFormat=opencover &&\
-dotnet test test/TestLogger.AcceptanceTests/TestLogger.AcceptanceTests.csproj
+dotnet test test/NUnit.Xml.TestLogger.UnitTests/NUnit.Xml.TestLogger.UnitTests.csproj -p:CollectCoverage=true -p:CoverletOutputFormat=opencover &&\
+dotnet test test/TestLogger.AcceptanceTests/TestLogger.AcceptanceTests.csproj &&\
+dotnet test test/Xunit.Xml.TestLogger.AcceptanceTests/Xunit.Xml.TestLogger.AcceptanceTests.csproj &&\
+dotnet test test/NUnit.Xml.TestLogger.AcceptanceTests/NUnit.Xml.TestLogger.AcceptanceTests.csproj
diff --git a/scripts/dependencies.props b/scripts/dependencies.props
diff --git a/scripts/settings.targets b/scripts/settings.targets
@@ -2,7 +2,7 @@
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <SourceRoot Condition="$(SourceRoot) == ''">$(MSBuildThisFileDirectory)../../</SourceRoot>
-    <SourcePrefix>3.1.0</SourcePrefix>
+    <SourcePrefix>4.0.0</SourcePrefix>
   </PropertyGroup>
   <PropertyGroup>
     <!-- Versioning is defined from the build script. Use a default dev build if it's not defined.
@@ -39,8 +39,6 @@
     <DefineConstants>$(DefineConstants);CODE_ANALYSIS</DefineConstants>
   </PropertyGroup>
 
-  <Import Project="$(MSBuildThisFileDirectory)dependencies.props" />
-
   <!-- Common dependencies for all projects -->
   <ItemGroup>
     <AdditionalFiles Include="$(SourceRoot)scripts\stylecop.json">
@@ -52,26 +50,6 @@
     </PackageReference>
   </ItemGroup>
 
-  <!-- Test project settings -->
-  <Choose>
-    <When Condition="$(TestProject) == 'true'">
-      <ItemGroup>
-        <PackageReference Include="MSTest.TestFramework">
-          <Version>$(MSTestVersion)</Version>
-        </PackageReference>
-        <PackageReference Include="MSTest.TestAdapter">
-          <Version>$(MSTestVersion)</Version>
-        </PackageReference>
-        <PackageReference Include="Moq">
-          <Version>$(MoqVersion)</Version>
-        </PackageReference>
-        <PackageReference Include="Microsoft.NET.Test.Sdk">
-          <Version>$(NETTestSdkVersion)</Version>
-        </PackageReference>
-      </ItemGroup>
-    </When>
-  </Choose>
-
   <!-- Code analysis settings -->
   <PropertyGroup>
     <CodeAnalysisRuleSet>$(SourceRoot)scripts/stylecop.ruleset</CodeAnalysisRuleSet>

diff --git a/scripts/version.props b/scripts/version.props
@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <PackageVersion Condition="'$(PackageVersion)' == ''">3.1.0-dev</PackageVersion>
+    <PackageVersion Condition="'$(PackageVersion)' == ''">4.0.0-dev</PackageVersion>
   </PropertyGroup>
 </Project>
 <!-- vi: set ft=xml: -->
diff --git a/src/NUnit.Xml.Package/NUnit.Xml.Package.csproj b/src/NUnit.Xml.Package/NUnit.Xml.Package.csproj
@@ -0,0 +1,63 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <SourceRoot Condition="$(SourceRoot) == ''">..\..\</SourceRoot>
+  </PropertyGroup>
+  <Import Project="$(SourceRoot)scripts/settings.targets" />
+
+  <PropertyGroup>
+    <TargetFramework>netstandard1.5</TargetFramework>
+    <Version>$(PackageVersion)</Version>
+    <AssemblyName>NUnitXml.TestLogger</AssemblyName>
+
+    <!-- This isn't an assembly -->
+    <GenerateAssemblyConfigurationAttribute>false</GenerateAssemblyConfigurationAttribute>
+    <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
+    <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
+    <GenerateAssemblyDescriptionAttribute>false</GenerateAssemblyDescriptionAttribute>
+    <GenerateAssemblyFileVersionAttribute>false</GenerateAssemblyFileVersionAttribute>
+    <GenerateAssemblyInformationalVersionAttribute>false</GenerateAssemblyInformationalVersionAttribute>
+    <GenerateAssemblyTitleAttribute>false</GenerateAssemblyTitleAttribute>
+    <GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
+    <GenerateNeutralResourcesLanguageAttribute>false</GenerateNeutralResourcesLanguageAttribute>
+
+    <!-- Don't create outputs during build or publish -->
+    <CopyBuildOutputToOutputDirectory>false</CopyBuildOutputToOutputDirectory>
+    <CopyOutputSymbolsToOutputDirectory>false</CopyOutputSymbolsToOutputDirectory>
+    <CopyBuildOutputToPublishDirectory>false</CopyBuildOutputToPublishDirectory>
+    <CopyOutputSymbolsToPublishDirectory>false</CopyOutputSymbolsToPublishDirectory>
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
+
+    <!-- Disable warning that there are no source files. It is intentional. -->
+    <NoWarn>$(NoWarn);2008;NU5127</NoWarn>
+
+    <!-- Nuget pack configuration -->
+    <NuspecFile>bin\$(Configuration)\$(TargetFramework)\NUnitXml.TestLogger.nuspec</NuspecFile>
+    <NuspecProperties>version=$(Version)</NuspecProperties>
+    <IncludeContentInPack>false</IncludeContentInPack>
+    <IncludeBuildOutput>false</IncludeBuildOutput>
+    <PackageIcon>packageIcon.png</PackageIcon>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\NUnit.Xml.TestLogger\NUnit.Xml.TestLogger.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="NUnitXml.TestLogger.props">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+    <Content Include="NUnitXml.TestLogger.nuspec">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Update="packageIcon.png" Pack="true" PackagePath="">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
+  <!-- Prevent Csc from being called -->
+  <Target Name="CoreCompile" />
+</Project>
diff --git a/src/NUnit.Xml.Package/NUnitXml.TestLogger.nuspec b/src/NUnit.Xml.Package/NUnitXml.TestLogger.nuspec
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<package >
+  <metadata>
+    <id>NunitXml.TestLogger</id>
+    <version>$version$</version>
+    <title>NunitXml.TestLogger</title>
+    <authors>spekt</authors>
+    <owners>spekt</owners>
+    <projectUrl>https://github.com/spekt/nunit.testlogger</projectUrl>
+    <description>Xml logger for NUnit v3 compliant xml report when test is running with "dotnet test" or "dotnet vstest".</description>
+    <license type="expression">MIT</license>
+    <icon>packageIcon.png</icon>
+  </metadata>
+  <files>
+    <file src="Microsoft.VisualStudio.TestPlatform.Extension.Nunit.Xml.TestLogger.dll" target="build\_common\" />
+    <file src="Spekt.TestLogger.dll" target="build\_common\" />
+    <file src="packageIcon.png" target="\" />
+
+    <!-- Net Core -->
+    <file src="NunitXml.TestLogger.props" target="build\netstandard1.0\" />
+
+    <!-- Desktop -->
+    <file src="NunitXml.TestLogger.props" target="build\net45\" />
+  </files>
+</package>
diff --git a/src/NUnit.Xml.Package/NUnitXml.TestLogger.props b/src/NUnit.Xml.Package/NUnitXml.TestLogger.props
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="12.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <Content Include="$(MSBuildThisFileDirectory)..\_common\Microsoft.VisualStudio.TestPlatform.Extension.NUnit.Xml.TestLogger.dll">
+      <Link>Microsoft.VisualStudio.TestPlatform.Extension.NUnit.Xml.TestLogger.dll</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>False</Visible>
+    </Content>
+    <Content Include="$(MSBuildThisFileDirectory)..\_common\Spekt.TestLogger.dll">
+      <Link>Spekt.TestLogger.dll</Link>
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <Visible>False</Visible>
+    </Content>
+  </ItemGroup>
+</Project>
diff --git a/src/NUnit.Xml.Package/packageIcon.png b/src/NUnit.Xml.Package/packageIcon.png
diff --git a/src/NUnit.Xml.TestLogger/Assembly.cs b/src/NUnit.Xml.TestLogger/Assembly.cs
@@ -0,0 +1,16 @@
+// Copyright (c) Spekt Contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+// <auto-generated>
+// Skip code analysis errors.
+// </auto-generated>
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: ExcludeFromCodeCoverage]
+
+namespace System.Diagnostics.CodeAnalysis
+{
+    [AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Constructor | AttributeTargets.Event | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Struct, AllowMultiple = false, Inherited = false)]
+    internal sealed class ExcludeFromCodeCoverageAttribute : Attribute { }
+}
diff --git a/src/NUnit.Xml.TestLogger/NUnit.Xml.TestLogger.csproj b/src/NUnit.Xml.TestLogger/NUnit.Xml.TestLogger.csproj
@@ -0,0 +1,26 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <SourceRoot Condition="$(SourceRoot) == ''">..\..\</SourceRoot>
+  </PropertyGroup>
+  <Import Project="$(SourceRoot)scripts/settings.targets" />
+
+  <PropertyGroup>
+    <TargetFramework>netstandard1.5</TargetFramework>
+    <AssemblyName>Microsoft.VisualStudio.TestPlatform.Extension.NUnit.Xml.TestLogger</AssemblyName>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <PropertyGroup Label="Configuration">
+    <RootNamespace>Microsoft.VisualStudio.TestPlatform.Extension.NUnit.Xml.TestLogger</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../TestLogger/TestLogger.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.TestPlatform.ObjectModel" Version="15.5.0" />
+    <PackageReference Include="System.ValueTuple" Version="4.3.0" />
+  </ItemGroup>
+
+</Project>