Skip to content

Commit 3805ce1

Browse files
nickadcock-bangonickadcock-bango
committed
Adding TeamCity dotnet core test logger
1 parent bd02183 commit 3805ce1

File tree

5 files changed

+392
-0
lines changed

5 files changed

+392
-0
lines changed

‎.gitignore

+249
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# User-specific files
5+
*.suo
6+
*.user
7+
*.userosscache
8+
*.sln.docstates
9+
10+
# User-specific files (MonoDevelop/Xamarin Studio)
11+
*.userprefs
12+
13+
# Build results
14+
[Dd]ebug/
15+
[Dd]ebugPublic/
16+
[Rr]elease/
17+
[Rr]eleases/
18+
[Xx]64/
19+
[Xx]86/
20+
[Bb]uild/
21+
bld/
22+
[Bb]in/
23+
[Oo]bj/
24+
25+
# Visual Studio 2015 cache/options directory
26+
.vs/
27+
# Uncomment if you have tasks that create the project's static files in wwwroot
28+
#wwwroot/
29+
30+
# MSTest test Results
31+
[Tt]est[Rr]esult*/
32+
[Bb]uild[Ll]og.*
33+
34+
# NUNIT
35+
*.VisualState.xml
36+
TestResult.xml
37+
38+
# Build Results of an ATL Project
39+
[Dd]ebugPS/
40+
[Rr]eleasePS/
41+
dlldata.c
42+
43+
# DNX
44+
project.lock.json
45+
artifacts/
46+
47+
*_i.c
48+
*_p.c
49+
*_i.h
50+
*.ilk
51+
*.meta
52+
*.obj
53+
*.pch
54+
*.pdb
55+
*.pgc
56+
*.pgd
57+
*.rsp
58+
*.sbr
59+
*.tlb
60+
*.tli
61+
*.tlh
62+
*.tmp
63+
*.tmp_proj
64+
*.log
65+
*.vspscc
66+
*.vssscc
67+
.builds
68+
*.pidb
69+
*.svclog
70+
*.scc
71+
72+
# Chutzpah Test files
73+
_Chutzpah*
74+
75+
# Visual C++ cache files
76+
ipch/
77+
*.aps
78+
*.ncb
79+
*.opendb
80+
*.opensdf
81+
*.sdf
82+
*.cachefile
83+
*.VC.db
84+
85+
# Visual Studio profiler
86+
*.psess
87+
*.vsp
88+
*.vspx
89+
*.sap
90+
91+
# TFS 2012 Local Workspace
92+
$tf/
93+
94+
# Guidance Automation Toolkit
95+
*.gpState
96+
97+
# ReSharper is a .NET coding add-in
98+
_ReSharper*/
99+
*.[Rr]e[Ss]harper
100+
*.DotSettings.user
101+
102+
# JustCode is a .NET coding add-in
103+
.JustCode
104+
105+
# TeamCity is a build add-in
106+
_TeamCity*
107+
108+
# DotCover is a Code Coverage Tool
109+
*.dotCover
110+
111+
# NCrunch
112+
_NCrunch_*
113+
.*crunch*.local.xml
114+
nCrunchTemp_*
115+
116+
# MightyMoose
117+
*.mm.*
118+
AutoTest.Net/
119+
120+
# Web workbench (sass)
121+
.sass-cache/
122+
123+
# Installshield output folder
124+
[Ee]xpress/
125+
126+
# DocProject is a documentation generator add-in
127+
DocProject/buildhelp/
128+
DocProject/Help/*.HxT
129+
DocProject/Help/*.HxC
130+
DocProject/Help/*.hhc
131+
DocProject/Help/*.hhk
132+
DocProject/Help/*.hhp
133+
DocProject/Help/Html2
134+
DocProject/Help/html
135+
136+
# Click-Once directory
137+
publish/
138+
139+
# Publish Web Output
140+
*.[Pp]ublish.xml
141+
*.azurePubxml
142+
143+
# TODO: Un-comment the next line if you do not want to checkin
144+
# your web deploy settings because they may include unencrypted
145+
# passwords
146+
#*.pubxml
147+
*.publishproj
148+
149+
# NuGet Packages
150+
*.nupkg
151+
# The packages folder can be ignored because of Package Restore
152+
**/packages/*
153+
# except build/, which is used as an MSBuild target.
154+
!**/packages/build/
155+
# Uncomment if necessary however generally it will be regenerated when needed
156+
#!**/packages/repositories.config
157+
# NuGet v3's project.json files produces more ignoreable files
158+
*.nuget.props
159+
*.nuget.targets
160+
161+
# Microsoft Azure Build Output
162+
csx/
163+
*.build.csdef
164+
165+
# Microsoft Azure Emulator
166+
ecf/
167+
rcf/
168+
169+
# Microsoft Azure ApplicationInsights config file
170+
ApplicationInsights.config
171+
172+
# Windows Store app package directory
173+
AppPackages/
174+
BundleArtifacts/
175+
176+
# Visual Studio cache files
177+
# files ending in .cache can be ignored
178+
*.[Cc]ache
179+
# but keep track of directories ending in .cache
180+
!*.[Cc]ache/
181+
182+
# Others
183+
ClientBin/
184+
[Ss]tyle[Cc]op.*
185+
~$*
186+
*~
187+
*.dbmdl
188+
*.dbproj.schemaview
189+
*.pfx
190+
*.publishsettings
191+
node_modules/
192+
orleans.codegen.cs
193+
194+
# RIA/Silverlight projects
195+
Generated_Code/
196+
197+
# Backup & report files from converting an old project file
198+
# to a newer Visual Studio version. Backup files are not needed,
199+
# because we have git ;-)
200+
_UpgradeReport_Files/
201+
Backup*/
202+
UpgradeLog*.XML
203+
UpgradeLog*.htm
204+
205+
# SQL Server files
206+
*.mdf
207+
*.ldf
208+
209+
# Business Intelligence projects
210+
*.rdl.data
211+
*.bim.layout
212+
*.bim_*.settings
213+
214+
# Microsoft Fakes
215+
FakesAssemblies/
216+
217+
# GhostDoc plugin setting file
218+
*.GhostDoc.xml
219+
220+
# Node.js Tools for Visual Studio
221+
.ntvs_analysis.dat
222+
223+
# Visual Studio 6 build log
224+
*.plg
225+
226+
# Visual Studio 6 workspace options file
227+
*.opt
228+
229+
# Visual Studio LightSwitch build output
230+
**/*.HTMLClient/GeneratedArtifacts
231+
**/*.DesktopClient/GeneratedArtifacts
232+
**/*.DesktopClient/ModelManifest.xml
233+
**/*.Server/GeneratedArtifacts
234+
**/*.Server/ModelManifest.xml
235+
_Pvt_Extensions
236+
237+
# LightSwitch generated files
238+
GeneratedArtifacts/
239+
ModelManifest.xml
240+
241+
# Paket dependency manager
242+
.paket/paket.exe
243+
244+
# FAKE - F# Make
245+
.fake/
246+
/AmazonBilling/AmazonBilling/XmlDsigLog.txt
247+
*XmlDsigLog.txt
248+
*XmlDsigLog.txt
249+
*XmlDsigLog.txt

‎DotnetCore.TeamCityLogger.sln

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio 15
4+
VisualStudioVersion = 15.0.26124.0
5+
MinimumVisualStudioVersion = 15.0.26124.0
6+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DotnetCore.TeamCityLogger", "DotnetCore.TeamCityLogger\DotnetCore.TeamCityLogger.csproj", "{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}"
7+
EndProject
8+
Global
9+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
10+
Debug|Any CPU = Debug|Any CPU
11+
Debug|x64 = Debug|x64
12+
Debug|x86 = Debug|x86
13+
Release|Any CPU = Release|Any CPU
14+
Release|x64 = Release|x64
15+
Release|x86 = Release|x86
16+
EndGlobalSection
17+
GlobalSection(SolutionProperties) = preSolution
18+
HideSolutionNode = FALSE
19+
EndGlobalSection
20+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
21+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
22+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Debug|Any CPU.Build.0 = Debug|Any CPU
23+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Debug|x64.ActiveCfg = Debug|x64
24+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Debug|x64.Build.0 = Debug|x64
25+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Debug|x86.ActiveCfg = Debug|x86
26+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Debug|x86.Build.0 = Debug|x86
27+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Release|Any CPU.ActiveCfg = Release|Any CPU
28+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Release|Any CPU.Build.0 = Release|Any CPU
29+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Release|x64.ActiveCfg = Release|x64
30+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Release|x64.Build.0 = Release|x64
31+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Release|x86.ActiveCfg = Release|x86
32+
{5054ACA3-6BE3-4DFF-9334-4B43D8E35889}.Release|x86.Build.0 = Release|x86
33+
EndGlobalSection
34+
EndGlobal

‎DotnetCore.TeamCityLogger/DotnetCore.TeamCityLogger.csproj

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>netstandard2.0</TargetFramework>
5+
</PropertyGroup>
6+
7+
<ItemGroup>
8+
<PackageReference Include="Microsoft.VisualStudio.TestPlatform.ObjectModel" Version="14.0.0" />
9+
</ItemGroup>
10+
11+
</Project>

‎DotnetCore.TeamCityLogger/Logger.cs

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
using Microsoft.VisualStudio.TestPlatform.ObjectModel;
2+
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;
3+
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Text.RegularExpressions;
7+
8+
namespace DotnetCore.TeamCityLogger
9+
{
10+
[FriendlyName("teamcity")]
11+
[ExtensionUri("logger://bango.net/teamcity/v1")]
12+
public class TeamCityLogger : ITestLogger
13+
{
14+
private const string StartingMessagePattern = @"^\[.+\]\s+Starting:\s+(.+)$";
15+
private Stack<string> suiteNames;
16+
17+
public void Initialize(TestLoggerEvents events, string testRunDirectory)
18+
{
19+
suiteNames = new Stack<string>();
20+
events.TestResult += this.TestResultHandler;
21+
events.TestRunMessage += this.TestRunMessageHandler;
22+
events.TestRunComplete += this.TestRunCompleteHandler;
23+
}
24+
25+
private void TestResultHandler(object sender, TestResultEventArgs e)
26+
{
27+
string testName = e.Result.TestCase.DisplayName;
28+
29+
if (e.Result.Outcome == TestOutcome.Skipped)
30+
{
31+
WriteServiceMessage($"testIgnored name='{testName}'");
32+
return;
33+
}
34+
35+
WriteServiceMessage($"testStarted name='{testName}'");
36+
37+
foreach (var message in e.Result.Messages)
38+
{
39+
if (message.Category == TestResultMessage.StandardOutCategory)
40+
{
41+
WriteServiceMessage($"testStdOut name='{testName}'] out='{message.Text}'");
42+
}
43+
else if (message.Category == TestResultMessage.StandardErrorCategory)
44+
{
45+
WriteServiceMessage($"testStdErr name='{testName}'] out='{message.Text}'");
46+
}
47+
}
48+
49+
if (e.Result.Outcome == TestOutcome.Failed)
50+
{
51+
WriteServiceMessage($"testFailed name='{testName}' message='{e.Result.ErrorMessage}' details='{e.Result.ErrorStackTrace}'");
52+
}
53+
54+
WriteServiceMessage($"testFinished name='{testName}' duration='{e.Result.Duration.TotalMilliseconds}'");
55+
}
56+
57+
private void TestRunMessageHandler(object sender, TestRunMessageEventArgs e)
58+
{
59+
Match match = Regex.Match(e.Message, StartingMessagePattern);
60+
if (match.Success && match.Groups.Count == 2)
61+
{
62+
string suiteName = match.Groups[1].Value;
63+
WriteServiceMessage($"testSuiteStarted name='{suiteName}'");
64+
suiteNames.Push(suiteName);
65+
}
66+
}
67+
68+
private void TestRunCompleteHandler(object sender, TestRunCompleteEventArgs e)
69+
{
70+
if (suiteNames.Count > 0)
71+
{
72+
WriteServiceMessage($"testSuiteFinished name='{suiteNames.Pop()}'");
73+
}
74+
}
75+
76+
private static void WriteServiceMessage(string message)
77+
{
78+
Console.WriteLine($"##teamcity[{message.Replace("\r\n","\\r\\n").Replace("\n","\\n")}]");
79+
}
80+
}
81+
}

‎Readme.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# DotnetCore.TeamCityLogger
2+
3+
#### Table of Contents
4+
5+
1. [Description](#description)
6+
2. [Usage](#usage)
7+
8+
## Description
9+
This library contains a dotnet core logger that can be used be used to log test results to a TeamCity server using service messages as descibed in the TeamCity documentation: https://confluence.jetbrains.com/display/TCD10/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ReportingTests
10+
11+
## Usage
12+
In order to use the library you can either:
13+
* Add the library as a reference to the test project
14+
* Add the DotnetCore.TeamCityLogger.dll to the dotnet extensions directory. E.g (note that your sdk install location make differ):
15+
* Windows: C:\Program Files\dotnet\sdk\2.0.0\Extensions
16+
* Linux: /usr/share/dotnet/sdk/2.0.0/Extensions/
17+
After installation the logger can be used like a normal dotnet test logger: `dotnet test --logger teamcity`

0 commit comments

Comments
 (0)