Add support for Code Inspection and Duplicate Finder results using NDepend

[netwolfuk]

I want to know if there is a way to add info on Code Inspection and Duplicate Finder results to the email that is sent out?

[sven-weber]

We are also looking for a way to include Code Inspection results.
Are there any variables available that allow to adjust the templates in order to display this information?

[netwolfuk]

Hi @sven-weber

I never got to implement this as I couldn't come up with a generic solution which would work with all coverage tools.

Thinking about it now it seems like there are three approaches:

1. If the build has TeamCity coverage enabled it should be possible to get the coverage metrics from TeamCity and make them available to the velocity template.
2. Look for a published artifact with a specific name in a specific format. Then read the values from it and make them available to the template.
3. Look for a published artifact with a specific name and try to include it in the email body. I'm assuming that file is probably html, and the code would also need to find any images and attach them to the email too.

Options 2 and 3 would need the build to do some post processing of the results to make the output compatible with the template engine, and then mark them as artifacts to be published by the build.
This is because the email plugin code runs on the server after the build has completed.

Do you think on of those solutions would work for you?

[sven-weber]

Hi @netwolfuk,

thanks for your quick response!

In my opinion it would be the best to aim for solution one.

TeamCity has a separate tab in the Build where the results of the Code Inspection are displayed.
This tab seems to be already generic as it is displayed for all different inspection tools I have tested (Resharper, FxCop).

Maybe we can get the information we need from this tab?

I also took at look at the plugin code and the regarding TeamCity documentations to see if they deliver the needed information.
The SRunningBuild object provided to the methods of the notifier has a method called getStaticValues.
(see here) maybe these values contain a count of the code inspection errors.
The BuildStatistics object, which can also be requested from the SRunningBuild, does unfortunately not deliver informations about the code inspection.

I submitted a request about the problem to jetbrains (see here) and they suggested to include the count in the email title. Maybe that would also be appropriate?

Thanks for you help,
I really appreciate it.

[netwolfuk]

HI @sven-weber.
Great find! I will have a look at the results returned by getStatisticValues().

I don't seem to have access to the support request you raised. Perhaps it's only visible to yourself and the TeamCity team.

We can certainly add the count to the email title. It's also just a template.

[netwolfuk]

BTW, I had a look at the code over the weekend. It's very old, and I've learnt a lot since then.
I am refactoring it to not be all global static class variables.

[netwolfuk]

Running TeamCity in debug and stepping through the code, I found the following statistics:

• CodeCoverageAbsBTotal
• CodeCoverageAbsRCovered
• CodeCoverageAbsCCovered
• CodeCoverageAbsBCovered
• CodeCoverageAbsMCovered
• CodeCoverageAbsCTotal
• CodeCoverageAbsLCovered
• CodeCoverageAbsLTotal
• CodeCoverageAbsRTotal
• CodeCoverageC
• JacocoComplexityCovered
• CodeCoverageB
• CodeCoverageAbsMTotal
• CodeCoverageL
• JacocoComplexityTotal
• CodeCoverageR
• CodeCoverageM

[sven-weber]

Ok, Code Coverage value do not help us regarding code inspection....

[sven-weber]

Yeah, maybe the issue is only visible for me and the TC guys.. sorry for that.
It wasn't that helpful anyways...

I will have a look at the TC Library documentation to see if there is anything else we might be able to use

[sven-weber]

maybe the method getFullStatistics() does help

[netwolfuk]

I suspect there will be different items in the Hash of statistics based on the tools.
The actual JavaDoc says it can contain all build messages from the build

Includes all predefined ValueTypes reported for this build and custom metrics reported by service message

So, to add items to the list, it's possible to use the ServiceMessage function. This is probably how most plugins talk to TeamCity for these metrics.

Probably the best thing for me to do is to copy them all into a statistics object in the template context, and make them available to the template. I can print out debug messages to the teamcity log for every item added to the map.
Then we should be able to do things like...
$statistics.get('someKey') inside the template to print out the value.

[netwolfuk]

getFullStatistics() looks too specific. And I can't see much there other than Test stats.

[sven-weber]

You mean to copy all ServiceMessages to the context and make them accessible via in the template?

[netwolfuk]

Well sort of. It looks like TeamCity makes them all BigDecimal some how, so it's probably not all of them.

[sven-weber]

Ok, its worth a try.

I took a look at the Log of our FxCop run and it seems to not create ServiceMessages at all and rather publish the results (as xml) via WebDeploy.

[14:31:17] : Step 5/10: Run Code Analysis (FxCop) (16s)
[14:31:18] :	 [Step 5/10] Running FxCop
[14:31:18] :	 [Step 5/10] Matched assembly files:
[14:31:18] :	 [Step 5/10]   bin\AnyCPU\Release\Mosaic.exe
[14:31:18] :	 [Step 5/10] Used autodetected FxCop home directory
[14:31:18] :	 [Step 5/10] Starting: "C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\Team Tools\Static Analysis Tools\FxCop\FxCopCmd.exe" /forceoutput /gac /f:bin\AnyCPU\Release\Mosaic.exe /out:C:\BuildAgent\temp\buildTmp\fxcop-output-2969995639677068277\fxcop-result.xml
[14:31:18] :	 [Step 5/10] in directory: C:\BuildAgent\work\63f3ac10c8f6457d
[14:31:18] :	 [Step 5/10] Microsoft (R) FxCop Command-Line Tool, Version 15.0 (15.0.28010.0) X86
[14:31:18] :	 [Step 5/10] Copyright (C) Microsoft Corporation, All Rights Reserved.
[14:31:18] :	 [Step 5/10] 
[14:31:18] :	 [Step 5/10] Loaded dataflowrules.dll...
[14:31:18] :	 [Step 5/10] Loaded designrules.dll...
[14:31:18] :	 [Step 5/10] Loaded globalizationrules.dll...
[14:31:18] :	 [Step 5/10] Loaded interoperabilityrules.dll...
[14:31:18] :	 [Step 5/10] Loaded maintainabilityrules.dll...
[14:31:18] :	 [Step 5/10] Loaded mobilityrules.dll...
[14:31:18] :	 [Step 5/10] Loaded namingrules.dll...
[14:31:18] :	 [Step 5/10] Loaded performancerules.dll...
[14:31:18] :	 [Step 5/10] Loaded portabilityrules.dll...
[14:31:18] :	 [Step 5/10] Loaded reliabilityrules.dll...
[14:31:18] :	 [Step 5/10] Loaded securityrules.dll...
[14:31:18] :	 [Step 5/10] Loaded securitytransparencyrules.dll...
[14:31:18] :	 [Step 5/10] Loaded usagerules.dll...
[14:31:19] :	 [Step 5/10] Loaded Mosaic.exe...
[14:31:19] :	 [Step 5/10] Initializing Introspection engine...
[14:31:20] :	 [Step 5/10] Analyzing...
[14:31:23] :	 [Step 5/10] Initializing Phoenix engine...
[14:31:23] :	 [Step 5/10] Analyzing...
[14:31:31] :	 [Step 5/10] Analysis Complete.
[14:31:31] :	 [Step 5/10] 
[14:31:31] :	 [Step 5/10] NOTE: One or more referenced assemblies could not be found. Use the '/directory' or '/reference' switch to specify additional assembly reference search paths.
[14:31:31] :	 [Step 5/10] 
[14:31:32] :	 [Step 5/10] Writing 2519 messages...
[14:31:32] :	 [Step 5/10] Writing report to C:\BuildAgent\temp\buildTmp\fxcop-output-2969995639677068277\fxcop-result.xml...
[14:31:32] :	 [Step 5/10] Done:00:00:14.0794078
[14:31:32] :	 [Step 5/10] Process exited with code 0
[14:31:32] :	 [Step 5/10] Publishing artifacts (1s)
[14:31:32] :		 [Publishing artifacts] Collecting files to publish: [C:\BuildAgent\temp\buildTmp\fxcop-output-2969995639677068277\fxcop-result.xml=>.teamcity/FxCop/]
[14:31:33] :		 [Publishing artifacts] Publishing 1 file using [ArtifactsCachePublisher]: C:/BuildAgent/temp/buildTmp/fxcop-output-2969995639677068277/fxcop-result.xml => .teamcity/FxCop
[14:31:33] :		 [Publishing artifacts] Publishing 1 file using [WebPublisher]: C:/BuildAgent/temp/buildTmp/fxcop-output-2969995639677068277/fxcop-result.xml => .teamcity/FxCop
[14:31:32] :	 [Step 5/10] Importing inspection results
[14:31:32] :	 [Step 5/10] Skipped html report generation since not requested

This seems kind of strange to me.

I can check with other runners like Resharper

[netwolfuk]

Hmm, perhaps you have a set of Report Tabs configured.

If that's the case, we probably can't access that data from an sRunningBuild instance.
I'll try and get you a build to test in the next hour.