Code Analysis on Marko Apfel

Simian counts errors in Jenkins dashboard but shows in details “No violation found”

Thu, 08 Dec 2011 16:46:00 +0100

Problem

Jenkins dashboard shows following simian analysis:

But after clicking one item I get:

Toolset agnostic build server and Silverlight projects

Thu, 10 Nov 2011 22:42:00 +0100

Problem

Normally I try to have my continuous integration as most a possible toolset free to ensure that no local stuff could have an impact to my build.

My Silverlight app references a special compile target in a folder outside my developer tree:

MSB4067: The element beneath element is unrecognized.

Tue, 08 Nov 2011 11:32:00 +0100

Problem

Our global Jenkins continuous integration server throws this error during compile step. My local TeamCity continuous integration server runs fine. What is the difference.

Background

I integrate some static code analysis steps via MSBuild-targets in the csproj files.

Running StyleCop without an installation to empower continuous integration

Mon, 07 Nov 2011 22:32:00 +0100

Problem

A continuous integration server should only have a minimal toolset installed. This ensures that no unwanted libraries could affect the build and other steps.

Clearly that with this slogan also StyleCop should not be installed to the CI server. But we wanna have this analysis as an part of the whole build.

Code Contracts: For unit test a manual rebuild is needed for toggeling “runtime checking”

Sat, 04 Jun 2011 01:19:00 +0200

Toggeling the checkbox “Perform Runtime Contract Checking” lets run the next application start with the new set option. But for unit test an explicit new build will apply the option for the next run.

Installation experiences with NDepend under Win7/64 with restricted user permissions

Mon, 27 Dec 2010 19:10:00 +0100

Today Patrick gives me a new license for his static code analysis tool NDepend for my fresh machine with Win7/64. This platform is new for me, so some things are different to Win XP. Maybe that till yet some of these things are not well enough understood from me. So I stepped in some traps.

Searching the new FxCop-Release (10.0)

Mon, 05 Jul 2010 14:45:00 +0200

Today my FxCop-GUI stated, that a new release is available – but the link to this release is broken.

After googling a little bit i realized, that the new release of FxCop ist actually only included in “Windows SDK for Windows 7.1”.

My own set of SuppressMessage-lines

Mon, 05 Jul 2010 10:35:00 +0200

StyleCop issues

inheritedoc-comment

Using -comment is not recognized by StyleCop. So this needs a suppression:

// <inheritdoc />
[SuppressMessage(
 "Microsoft.StyleCop.CSharp.DocumentationRules",
 "SA1604:ElementDocumentationMustHaveSummary",
 Justification = "InheritDoc")]

FxCop issues

Too few namespaces

[module: SuppressMessage(
 "Microsoft.Design",
 "CA1020:AvoidNamespacesWithFewTypes",
 Scope = "namespace",
 Target = "EsriDE.Core.Service.Logging",
 Justification = "We want to have this namespace, but do not have enough classes to go in it right now to satisfy the rule.")]

ReSharper only supports non static test methods

[SuppressMessage(
 "Microsoft.Performance",
 "CA1822:MarkMembersAsStatic",
 Justification = "ReSharper could not handle static test methods.")]

No strong name

[assembly: SuppressMessage(
 "Microsoft.Design",
 "CA2210:AssembliesShouldHaveValidStrongNames",
 Justification = "Strong name is not needed for this.")]

Catching general exception

[SuppressMessage(
 "Microsoft.Design",
 "CA1031:DoNotCatchGeneralExceptionTypes",
 Justification = "We do not know which exceptions could be thrown.")]

Justification for samples and fixtures

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "For fixtures this is OK.")]

Setter but no Getter (for example in IoC or NHibernate-context)

[SuppressMessage(
 "Microsoft.Usage",
 "CA2227:CollectionPropertiesShouldBeReadOnly",
 Justification = "Setter is needed for nhibernate, otherwise a NHibernate.PropertyNotFoundException will be thrown.")]

[SuppressMessage(
 "Microsoft.Xyz",
 "CAxyz:XYZ",
 Justification = "We only need a setter for setter injection.")]

Instantiation with IoC

[SuppressMessage(
 "Microsoft.Performance",
 "CA1811:AvoidUncalledPrivateCode",
 Justification = "We need this for unit tests.")]

[SuppressMessage(
 "Microsoft.Performance",
 "CA1812:AvoidUninstantiatedInternalClasses",
 Justification = "Class would be instantiated by IoC framework.")]

Incorrect naming

[SuppressMessage(
 "Microsoft.StyleCop.CSharp.NamingRules",
 "SA1310:FieldNamesMustNotContainUnderscore",
 Justification = "Windows message constants are commonly named as WM\_xxxxx")]

Incorrect casing

[module: SuppressMessage(
 "Microsoft.Naming",
 "CA1709:IdentifiersShouldBeCasedCorrectly",
 Scope = "type",
 Target = "EsriDE.Data.Access.IDbFactory",
 MessageId = "<WrongCasedWord>")]

[module: SuppressMessage(
 "Microsoft.Naming",
 "CA1709:IdentifiersShouldBeCasedCorrectly",
 Scope = "type",
 MessageId = "<WrongCasedWord>)]

Parametername should match base declaration

[SuppressMessage(
 "Microsoft.Naming",
 "CA1725:ParameterNamesShouldMatchBaseDeclaration",
 Justification = "Rule CA1725 has a bug when inspecting parameters from methods from interfaces. So suppress it with class.")]

Throwing ApplicationException

[SuppressMessage(
 "Microsoft.Usage",
 "CA2201:DoNotRaiseReservedExceptionTypes",
 Justification = "ApplicationException is OK.")]

FxCop is too strict

[SuppressMessage("
 Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "We decide that this is OK.")]

[module: SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Scope = "resource",
 Target = "EsriDE.PipelineManagement.Core.Properties.Messages.resources",
 MessageId = "Toolbar",
 Justification = "We decide that this is OK.")]

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "This is by design.")]

Code from untaught colleagues

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "Currently, we do not have enough knowledge or experience to fix this.")]

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "Cowboy-coding colleagues.")]

Specify a project-specific custom dictionary for FxCop build tasks and Visual Studio Team System static code analysis

Fri, 02 Jul 2010 11:27:00 +0200

Using a project-specific custom dictionary for FxCop and FxCop build tasks is very simple. The FxCopCmd call in the FxCop-target offers the parameter /dictionary:<DictionaryName> for that.

But for Visual Studio a little bit more steps are needed. And these steps must me gone for all projects.

Installing StyleCop for ReSharper

Thu, 12 Nov 2009 05:58:00 +0100

Installing StyleCop for ReSharper under an administrative account does not activate this ReSharper plugin under my developer account.

A system analysis show, that this plugin is installed under

%userprofile%\Local Settings\Application Data\JetBrains\ReSharper\v4.5\vs9.0\Plugins\Microsoft StyleCop for ReSharper

AgentSmith: suppressing spell checking warnings

Thu, 12 Nov 2009 03:42:00 +0100

If AgentSmith throws a warning that some term is not spelled correctly for this term the spell checking could be suppressed with:

//agentsmith spellcheck disable
...
//agentsmith spellcheck enable

Working with Microsoft FxCop

Wed, 11 Nov 2009 09:06:00 +0100

Run FxCop as a post build event

Since FxCop 1.36 it is possible to include FxCop in a post-build event.

So FxCop runs after compiling in Visual Studio and allows you directly jumping to the warned line.

ReSharper is not available

Mon, 09 Nov 2009 07:23:00 +0100

Today a colleague ask me to help.

On his system all ReSharper menus are grayed out. Also the Visual Studio Add-In Manager does not show this add-in.

He tried:

a new installation: without success,
running with administrative privilegeg: without success,
looking in event- and application-logs: no entries.

After searching a little bit with old buddy google we found this message: Wild World of Visual Studio – Mysterious Component