Step 5 Add source code analysis¶
Another great addition for a build server is to ensure that the code in source control is 'clean' and maintainable.
We already know that is compiles, it passes tests and that we cover a lot of the code. All this is nice, but sadly enough it does not mean that the code is maintainable.
Simple example : there is an update required to an existing function, but someone just copies it, adding an extra argument to the copy and wires to this copy when needed. And if that person adds tests for this extra copy, the build is green. This results however in code that has lots of similar code lines. It would be best that no code duplication would exist(Utopia).
Another item is code quality : example : naming convention, dead-code detection, unused arguments or variables, ...
In VS2010 there is a build in rule-checker. Older visual studio did not have this, so one had to call external tools (fxcop, gendarme, ... for example). Even the build in Rule-Checker (which is just an updated version of FXCop) does not give the same overview that a dedicated program like NDepend does.
So lets start by adding these things into our builds.
Checking for code-duplication¶
The best program I've found for this is Simian It's the very fast, easy to set up, and free for open source(a reasonable price for other projects.)
Build script update¶
This a rather simple update, add a simian target, and define a few properties for ease of referencing. We also need to delete the generated output in the clean task. Shown in the full Build Script below. The new simian task :
1<property name="Simian_exe" value="c:\Tools\simian\bin\simian-2.3.32.exe" />
2<property name="Simian_Threshold" value="10" />
3<property name="Simian_output" value="simian.xml" />
4
5<target name="simian" description="find duplicate code" >
6 <exec program="${Simian_exe}" failonerror="false">
7 <arg value="-includes=**/*.cs" />
8 <arg value="-excludes=**/*Designer.cs" />
9 <arg value="-excludes=**/*Generated.cs" />
10 <arg value="-excludes=**/*Reference.cs" />
11 <arg value="-excludes=**/obj/*" />
12 <arg value="-threshold=${Simian_Threshold}" />
13 <arg value="-formatter=xml:${Simian_output}" />
14 </exec>
15</target>
CCNet config change¶
Here we only need to add the simian target in the QA-build definition : <target>simian</target>
The nant_target_QA block looks now like this :
1 <cb:define name="nant_target_qa">
2 <targetList>
3 <target>clean</target>
4 <target>simian</target>
5 <target>compile</target>
6 <target>cover</target>
7 </targetList>
8 </cb:define>
VS2010 Code Analysis¶
You can enable this option on the 'Code Analysis' tab in the VisualStudio project(Visual Studio 2010 Premium or Ultimate). Take for example the code from Step 4 Add Coverage - Code for converting coverage to XML and enable Code analysis.
Just take the 'Microsoft Minimum Recommend Rules' for now.
You'll see that there are 2 warnings about System.IDisposable.Dispose. You can create your own ruleset, and specify that a rule is a warning or an error. Errors will break the build.
Tip Code analysis adds up a lot of compile time, so I added a new build configuration for it in Visual Studio : QA, which is just a copy of Debug but with Code Analysis enabled.
Tip Code analysis rules are set per project. Each project can have different rule sets. For example a UI program will have different needs than a framework library.
CCNet config change¶
Because of the new build configuration QA, we'll introduce a new setting : nant_QA and use this in the QA-build definition.
1<cb:define name="nant_QA">
2 <executable>c:\Tools\nant\bin\nant.exe</executable>
3 <nologo>true</nologo>
4 <buildTimeoutSeconds>1800</buildTimeoutSeconds>
5 <buildArgs>-D:useExtraMsbuildLogger=true -listener:CCNetListener,CCNetListener -D:configuration=QA</buildArgs>
6</cb:define>
Code Section¶
CCNet config¶
1<cruisecontrol xmlns:cb="urn:ccnet.config.builder">
2 <!-- preprocessor settings -->
3 <cb:define WorkingDir="D:\WorkingFolders\" />
4 <cb:define WorkingMainDir="D:\ArtifactFolders\" />
5 <cb:define ArtifactsDir="\Artifacts" />
6
7 <!-- TFS settings for a CI build -->
8 <cb:define name="vsts_ci">
9 <server>http://tfs-server:8080/tfs/default/</server>
10 <username>cruise</username>
11 <password>**********</password>
12 <domain>tfs-server</domain>
13 <autoGetSource>true</autoGetSource>
14 <cleanCopy>true</cleanCopy>
15 <force>true</force>
16 <deleteWorkspace>true</deleteWorkspace>
17 </cb:define>
18
19 <!-- all projects will have at least these publishers -->
20 <cb:define name="common_publishers">
21 <merge>
22 <files>
23 <file>MStest_UnitTestResults.xml</file>
24 </files>
25 </merge>
26 <xmllogger />
27 <statistics />
28 <modificationHistory onlyLogWhenChangesFound="true" />
29 <artifactcleanup cleanUpMethod="KeepLastXSubDirs" cleanUpValue="2" />
30 <artifactcleanup cleanUpMethod="KeepLastXBuilds" cleanUpValue="25000" />
31 <!-- email the breakers on a broken build and when it's fixed -->
32 <email from="CruiseControl@TheBuilder.com"
33 mailhost="TheMailer.Company.com"
34 includeDetails="TRUE">
35 <groups/>
36 <users/>
37 <converters>
38 <ldapConverter domainName="Company" />
39 </converters>
40 <modifierNotificationTypes>
41 <NotificationType>Failed</NotificationType>
42 <NotificationType>Fixed</NotificationType>
43 </modifierNotificationTypes>
44 </email>
45 </cb:define>
46
47 <!-- the Nant build arguments for a CI build -->
48 <cb:define name="nant_CI">
49 <executable>c:\Tools\nant\bin\nant.exe</executable>
50 <nologo>true</nologo>
51 <buildTimeoutSeconds>1800</buildTimeoutSeconds>
52 <buildArgs>-D:useExtraMsbuildLogger=true -D:isCI=true -listener:CCNetListener,CCNetListener -D:configuration=Debug</buildArgs>
53 </cb:define>
54
55 <!-- the Nant build arguments for a QA build -->
56 <cb:define name="nant_QA">
57 <executable>c:\Tools\nant\bin\nant.exe</executable>
58 <nologo>true</nologo>
59 <buildTimeoutSeconds>1800</buildTimeoutSeconds>
60 <buildArgs>-D:useExtraMsbuildLogger=true -listener:CCNetListener,CCNetListener -D:configuration=QA</buildArgs>
61 </cb:define>
62
63 <!-- the nant targets for a CI build -->
64 <cb:define name="nant_target_CI">
65 <targetList>
66 <target>clean</target>
67 <target>compile</target>
68 <target>unit_test</target>
69 </targetList>
70 </cb:define>
71
72 <!-- the nant targets for a QA build -->
73 <cb:define name="nant_target_qa">
74 <targetList>
75 <target>clean</target>
76 <target>simian</target>
77 <target>compile</target>
78 <target>cover</target>
79 </targetList>
80 </cb:define>
81
82 <!-- end preprocessor settings -->
83
84 <!-- Projects -->
85 <cb:scope ProjectName="ProjectX">
86 <cb:define ProjectType="_CI" />
87 <project name="$(ProjectName)$(ProjectType)" queue="Q1" queuePriority="901">
88 <workingDirectory>$(WorkingDir)$(ProjectName)$(ProjectType)</workingDirectory>
89 <artifactDirectory>$(WorkingMainDir)$(ProjectName)$(ProjectType)$(ArtifactsDir)</artifactDirectory>
90
91 <labeller type="defaultlabeller" />
92
93 <intervalTrigger name="continuous" seconds="30" buildCondition="IfModificationExists" initialSeconds="30" />
94
95 <sourcecontrol type="vsts">
96 <workspace>$(ProjectName)</workspace>
97 <project>$/$(ProjectName)/Trunk</project>
98 <cb:vsts_ci/>
99 </sourcecontrol>
100
101 <tasks>
102 <nant>
103 <cb:nant_CI/>
104 <cb:nant_target_CI />
105 </nant>
106 </tasks>
107
108 <publishers>
109 <cb:common_publishers />
110 </publishers>
111
112 </project>
113 </cb:scope>
114
115 <cb:scope ProjectName="ProjectX">
116 <cb:define ProjectType="_QA" />
117 <project name="$(ProjectName)$(ProjectType)" queue="Q1" queuePriority="801">
118 <workingDirectory>$(WorkingDir)$(ProjectName)$(ProjectType)</workingDirectory>
119 <artifactDirectory>$(WorkingMainDir)$(ProjectName)$(ProjectType)$(ArtifactsDir)</artifactDirectory>
120
121 <scheduleTrigger time="06:30" buildCondition="ForceBuild" name="QA_Scheduled">
122
123 <labeller type="defaultlabeller" />
124
125 <sourcecontrol type="vsts">
126 <workspace>$(ProjectName)</workspace>
127 <project>$/$(ProjectName)/Main</project>
128 <cb:vsts_ci/>
129 </sourcecontrol>
130
131 <tasks>
132 <nant>
133 <cb:nant_QA/>
134 <cb:nant_target_qa />
135 </nant>
136 </tasks>
137
138 <publishers>
139 <cb:common_publishers />
140 </publishers>
141
142 </project>
143 </cb:scope>
144
145 <!-- End Projects -->
146 </cruisecontrol>
Nant Build Script¶
1 <project default="help">
2 <property name="solution" unless="${property::exists('solution')}" value="ProjectX.sln" />
3 <property name="configuration" unless="${property::exists('configuration')}" value="Debug" />
4 <property name="CCNetListenerFile" unless="${property::exists('CCNetListenerFile')}" value="listen.xml" />
5 <property name="msbuildverbose" unless="${property::exists('msbuildverbose')}" value="normal" />
6 <property name="CCNetLabel" unless="${property::exists('CCNetLabel')}" value="0.0.0.0" />
7 <property name="WantedCoveragePercent" value="75" />
8
9 <property name="mstest_metadatafile" value="${string::replace(solution, '.sln', '.vsmdi')}" />
10 <property name="mstest_unit_test_file" value="MStest_UnitTestResults.xml" />
11 <property name="mstest_CoverageFile" value="MStest_Cover.xml" />
12 <property name="TurnCoverageFileIntoXml_exe" value="C:\Tools\TurnCoverageFileIntoXml\TurnCoverageFileIntoXml.exe" />
13 <property name="Simian_exe" value="c:\Tools\simian\ bin\simian-2.3.32.exe" />
14 <property name="Simian_Threshold" value="10" />
15 <property name="Simian_output" value="simian.xml" />
16
17 <property overwrite="false" name="msbuildlogger" value="C:\Program Files\CruiseControl.NET\server\MSBuildListener.dll" />
18 <property overwrite="false" name="versionInfofile" value="VersionInfo.cs" />
19
20 <!-- custom scripts -->
21 <script language="C#" prefix="RuWi">
22 <references>
23 <include name="System.Xml.dll" />
24 <include name="System.dll" />
25 </references>
26 <imports>
27 <import namespace="System.Text" />
28 </imports>
29 <code>
30 <![CDATA[
31 [Function("UpdateVersionFile")]
32 public static bool UpdateVersionFile(string inputFile, string newVersion, bool debugMode)
33 {
34 bool ok = true;
35 try
36 {
37 System.IO.StreamReader versionFile = new System.IO.StreamReader(inputFile, System.Text.Encoding.ASCII);
38 string line = "";
39 System.Text.StringBuilder result = new StringBuilder();
40 string searchPatternVersion = @"(\d+\.\d+\.\d+\.\d+)";
41 string searchPatternAssemblyProduct = string.Format(@"AssemblyProduct\({0}(.*?)\{0}", "\"");
42 string replacePatternAssemblyProduct = string.Format(@"AssemblyProduct({0}(Debug)${1}1{2}{0}", "\"", "{", "}");
43
44 while (!versionFile.EndOfStream)
45 {
46 line = versionFile.ReadLine();
47
48 if (System.Text.RegularExpressions.Regex.IsMatch(line, searchPatternVersion) && (line.Contains("AssemblyFileVersion")))
49 {
50 line = System.Text.RegularExpressions.Regex.Replace(line, searchPatternVersion, newVersion);
51 }
52
53 if (debugMode && System.Text.RegularExpressions.Regex.IsMatch(line, searchPatternAssemblyProduct))
54 {
55 line = System.Text.RegularExpressions.Regex.Replace(line, searchPatternAssemblyProduct, replacePatternAssemblyProduct);
56 }
57
58 result.AppendLine(line);
59 }
60
61 versionFile.Close();
62
63 System.IO.StreamWriter updatedVersionfile = new System.IO.StreamWriter(inputFile);
64 updatedVersionfile.Write(result.ToString());
65 updatedVersionfile.Close();
66 }
67 catch (Exception ex)
68 {
69 ok = false;
70 Console.WriteLine(ex.ToString());
71 }
72 return ok;
73 }
74 ]]>
75 </code>
76 </script>
77
78 <script language="C#" prefix="RuWi">
79 <code>
80 <![CDATA[
81 [Function("FindFile")]
82 public static string FindFile(string folderName, string searchPattern)
83 {
84 var f = System.IO.Directory.GetFiles(folderName, searchPattern, System.IO.SearchOption.AllDirectories);
85 if (f.Length > 0)
86 {
87 return f[0];
88 }
89
90 return "";
91 }
92 ]]>
93 </code>
94 </script>
95
96 <!-- end custom scripts -->
97
98 <target name="help" >
99 <echo message="Removed for keeping the file shorter." />
100 </target>
101
102 <target name="clean" description="deletes all created files">
103 <delete >
104 <fileset>
105 <patternset >
106 <include name="**/bin/**" />
107 <include name="**/obj/**" />
108 <include name="${mstest_unit_test_file}" />
109 <include name="${mstest_CoverageFile}" />
110 </patternset>
111 </fileset>
112 </delete>
113 </target>
114
115 <target name="adjustversion" description="Adjusts the version in the version.info file">
116 <if test="${not file::exists(versionInfofile)}">
117 <fail message="file: ${versionInfofile} which must contains the version info was NOT found" />
118 </if>
119
120 <echo message="Setting version to ${CCNetLabel}" />
121
122 <property name="debugMode" value = "False" />
123 <property name="debugMode" value = "True" if="${configuration=='Debug'}" />
124 <if test="${not RuWi::UpdateVersionFile(versionInfofile,CCNetLabel,debugMode)}">
125 <fail message="updating file: ${versionInfofile} which must contains the version info failed" />
126 </if>
127 </target>
128
129 <target name="compile" description="compiles the solution in the wanted configuration" depends="adjustversion">
130 <msbuild project="${solution}" >
131 <arg value="/p:Configuration=${configuration}" />
132 <arg value="/p:CCNetListenerFile=${CCNetListenerFile}" />
133 <arg value="/v:${msbuildverbose}" />
134 <arg value="/l:${msbuildlogger}" />
135 </msbuild>
136 </target>
137
138 <target name="unit_test" description="runs the unit tests" depends="compile">
139 <if test="${file::exists(mstest_metadatafile)}">
140 <exec program="${mstest_exe}">
141 <arg value="/testmetadata:${mstest_metadatafile}" />
142 <arg value="/resultsfile:${mstest_unit_test_file}" />
143 <arg value="/testlist:UnitTests" />
144 </exec>
145 </if>
146 </target>
147
148 <target name = "cover" description="runs the tests with coverage" >
149 <!--
150 company rule : code coverage settings must be set via the file CodeCoverage.testsettings
151 with the following NamingScheme : baseName="cover_me" appendTimeStamp="false" useDefault="false"
152 -->
153 <if test="${file::exists('CodeCoverage.testsettings')}">
154
155 <exec program="${mstest_exe}" failonerror="false" resultproperty="testresult.temp" >
156 <arg value="/testmetadata:${mstest_metadatafile}" />
157 <arg value="/resultsfile:${mstest_unit_test_file}" />
158 <arg value="/testsettings:CodeCoverage.testsettings" />
159 <arg value="/testlist:UnitTests" />
160 </exec>
161
162 <property name="TestsOK" value="false" unless="${int::parse(testresult.temp)==0}"/>
163 <property name="DataCoverageFilePath" value="${RuWi::FindFile('cover_me','data.coverage')}" />
164
165 <fail message="No data.coverage found in cover_me folder" unless="${string::get-length(DataCoverageFilePath)>0}" />
166
167 <echo message="DataCoverageFilePath : ${DataCoverageFilePath}" />
168
169 <exec program="${TurnCoverageFileIntoXml_exe}" >
170 <arg value="${DataCoverageFilePath}" />
171 <arg value="cover_me\Out" />
172 <arg value="${mstest_CoverageFile}" />
173 <arg value="${WantedCoveragePercent}" />
174 </exec>
175
176 <fail message="Failures reported in unit tests." unless="${TestsOK}" />
177 </if>
178 </target>
179
180 <target name="simian" description="find duplicate code" >
181 <exec program="${Simian_exe}" failonerror="false">
182 <arg value="-includes=**/*.cs" />
183 <arg value="-excludes=**/*Designer.cs" />
184 <arg value="-excludes=**/*Generated.cs" />
185 <arg value="-excludes=**/*Reference.cs" />
186 <arg value="-excludes=**/obj/*" />
187 <arg value="-threshold=${Simian_Threshold}" />
188 <arg value="-formatter=xml:${Simian_output}" />
189 </exec>
190 </target>
191
192 </project>
193