Enforcing Quality with Tools

Artur Dorochowicz

https://github.com/ArturDorochowicz/

Agenda

Principles

Visual Studio Code Analysis

What's wrong with this code?

using (var smtp = new SmtpClient { Host = "smtp.gmail.com" })
{
    smtp.Send("from@from.com", "to@to.com", "subject", "body");
}

Code Analysis

• Static analysis tool of managed assemblies - analyses binaries
• Validates against .NET Framework Design Guidelines
• Integrated into Visual Studio and the build system
• In VS2010 available only in Premium and Ultimate
• In VS2012 available in all paid editions as well as in Express with limited number of rules
• FxCop - standalone analysis tool (fxcopcmd.exe) with somewhat different set of rules; Available in Microsoft Download Center and in Windows SDK; Microsoft is phasing it out

Installation

• Nothing to install - Code Analysis is part of the build out of the box
• Integration with the build is governed by an MSBuild project file
• Available configuration options can be discovered from here

$(MSBuildExtensionPath)\Microsoft\VisualStudio\v11.0\CodeAnalysis\Microsoft.CodeAnalysis.Targets

StyleCop

StyleCop

• Source code style verification tool - for C# code only
• Validates against .NET Framework Design Guidelines and formatting style recommended by Microsoft
• Originally an internal Microsoft tool, later released to the public
• Now it's an open source project - stylecop.codeplex.com

Installation

Install StyleCop.MSBuild NuGet package into each project where the analysis is desired

PM> Install-Package StyleCop.MSBuild

MSBuild Properties

• StyleCopEnabled - enables the analysis, true by default which makes the analysis run on each build
• StyleCopTreatErrorsAsWarnings - report issues as warnings, true by default

Recommended settings should be added to each project file manually

<PropertyGroup>
    <StyleCopEnabled>false</StyleCopEnabled>
    <StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>
</PropertyGroup>

Visual Studio integration

Integration makes it easier to configure StyleCop, but is irrelevant for the analysis during the build.

Installer at stylecop.codeplex.com includes Visual Studio extension, JetBrains ReSharper plugin as well as StyleCop MSBuild targets.

Configuration

By default StyleCop searches for configuration files — Settings.StyleCop — from the project directory up.

Multiple files are merged from top to bottom allowing for the recommended setup:

• common settings file for the solution in the solution directory
• project specific overrides in each individual project directory

Rules

The default rule set includes all of the rules

Consider disabling some of them:

• Documentation rules
• UsingDirectivesMustBePlacedWithinNamespace
• AccessModifierMustBeDeclared
• PrefixLocalCallsWithThis, PrefixCallsCorrectly, FieldNamesMustNotBeginWithUnderscore

Suppressing violations

Selectively suppress violations with Code Analysis' SuppressMessage attribute

[System.Diagnostics.CodeAnalysis.SuppressMessage(
    "StyleCop.CSharp.OrderingRules",
    "SA1202:ElementsMustBeOrderedByAccess",
    Justification = "Optional, but you should always provide one.")]
public class MyClass
{
    static void PrivateBeforePublic()
    {
    }

    public static void Public()
    {
    }
}

Introducing to legacy projects

StyleCop Visual Studio extension allows to exclude individual files from the analysis

<Compile Include="ThisFileIsExludedFromStyleCop.cs">
    <ExcludeFromStyleCop>True</ExcludeFromStyleCop>
</Compile>

Use ExcludeFromStyleCop tool for mass exclusion

• Introducing StyleCop on Legacy Projects
• StyleCop 4.3 Release Download
• ExcludeFromStyleCop

ReSharper integration

The plugin does not use Settings.StyleCop files — matching configuration needs to be established again in ReSharper options.

The division of StyleCop settings into solution and project level settings files can be matched with ReSharper team-shared solution level and project level settings and committing them to source control.

ReSharper Settings - JetBrains blog Share StyleCop compatible ReSharper settings between different machines - József Kanczler

Execution

Example command line

msbuild MySolution.sln
    /target:Build
    /property:Configuration=Release
    /property:StyleCopEnabled=true

JSHint

What's wrong with this code?

function calculateCost(order) {
    return
        order.getProductsTotal() +
        order.getShippingCost();
}

JSHint

• JSHint, a JavaScript Code Quality Tool - www.jshint.com
• JavaScript analysis tool, detects errors and potential problems
• Little code style verification, will be removed in a future version
• Community fork of Douglas Crockford's JSLint

Installation

mkdir node_modules
npm install grunt
npm install grunt-cli
npm install grunt-contrib-jshint
copy path\to\node.exe node_modules\.bin\

Configuration: .jshintrc

{
// Enforcing
 "newcap"   : true,  // Require capitalization of all constructor functions e.g. `new F()`
 "undef"    : true,  // Require all non-global variables to be declared (prevents global leaks)
 "strict"   : true,  // Requires all functions run in ES5 Strict Mode
  /* ... */
// Relaxing
 "asi"      : false, // Tolerate Automatic Semicolon Insertion (no semicolons)
 "debug"    : false, // Allow debugger statements e.g. browser breakpoints.
 "evil"     : false, // Tolerate use of `eval` and `new Function()`
  /* ... */
// Environments
 "browser"  : true,  // Web Browser (window, document, etc)
// Custom Globals
 "globals" : {}      // additional predefined global variables
}

http://www.jshint.com/docs/options Defaults: https://github.com/jshint/jshint/blob/master/examples/.jshintrc

Configuration: .jshintignore

# Exclude libraries, third party code
# and other files that shouldn't be checked
Scripts/lib/**

# Prevent checking VS compilation output directories
bin/**
obj/**

Configuration: Gruntfile.js

module.exports = function (grunt) {
    grunt.initConfig({
        jshint: {
            all: ['**/*.js'],
            options: {
                jshintrc: true
            }
        }
    });
    grunt.loadTasks('../../node_modules/grunt-contrib-jshint/tasks');
};

https://github.com/gruntjs/grunt-contrib-jshint

Suppressing violations

Inline configuration in script file — override has function scope

/* jshint undef: true, unused: true */
/* global MY_GLOBAL */

Ignore a piece of code altogether

// Code here will be linted with JSHint.
/* jshint ignore:start */
// Code here will be ignored by JSHint.
/* jshint ignore:end */

How to marry Grunt with MSBuild?

See the accompanying JSHint sample for details

Visual Studio integration

Extensions for JSHint/JSLint analysis

• Web Essentials 2012
• Web Essentials 2013 - for VS 2013
• Mindscape Web Workbench
• JSLint.NET for Visual Studio
• JSLint.VS2012

Only Web Essentials 2013 uses .jshintrc and .jshintignore files. In other cases settings will need to be established again in the extension.

Execution

Example command line

msbuild MySolution.sln
    /target:Build
    /property:Configuration=Release
    /property:JSHintEnabled=true

Enforcing Quality with Tools

Artur Dorochowicz

https://github.com/ArturDorochowicz/presentation-enforcing-quality-with-tools