Finding the problem on a partially succeeded build
- by Martin Hinshelwood
Now that I have the Build failing because of a genuine bug and not just because of a test framework failure, lets see if we can trace through to finding why the first test in our new application failed. Lets look at the build and see if we can see why there is a red cross on it. First, lets open that build list. On Team Explorer Expand your Team Project Collection | Team Project and then Builds. Double click the offending build. Figure: Opening the Build list is a key way to see what the current state of your software is. Figure: A test is failing, but we can now view the Test Results to find the problem Figure: You can quite clearly see that the test has failed with “The device is not ready”. To me the “The Device is not ready” smacks of a System.IO exception, but it passed on my local computer, so why not on the build server? Its a FaultException so it is most likely coming from the Service and not the client, so lets take a look at the client method that the test is calling: bool IProfileService.SaveDefaultProjectFile(string strComputerName)
{
ProjectFile file = new ProjectFile()
{
ProjectFileName = strComputerName + "_" + System.DateTime.Now.ToString("yyyyMMddhhmmsss") + ".xml",
ConnectionString = "persist security info=False; pooling=False; data source=(local); application name=SSW.SQLDeploy.vshost.exe; integrated security=SSPI; initial catalog=SSWSQLDeployNorthwindSample",
DateCreated = System.DateTime.Now,
DateUpdated = System.DateTime.Now,
FolderPath = @"C:\Program Files\SSW SQL Deploy\SampleData\",
IsComplete=false,
Version = "1.3",
NewDatabase = true,
TimeOut = 5,
TurnOnMSDE = false,
Mode="AutomaticMode"
};
string strFolderPath = "D:\\"; //LocalSettings.ProjectFileBasePath;
string strFileName = strFolderPath + file.ProjectFileName;
try
{
using (FileStream fs = new FileStream(strFileName, FileMode.Create))
{
DataContractSerializer serializer = new DataContractSerializer(typeof(ProjectFile));
using (XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs))
{
serializer.WriteObject(writer, file);
}
}
}
catch (Exception ex)
{
//TODO: Log the exception
throw ex;
return false;
}
return true;
}
Figure: You can see on lines 9 and 18 that there are calls being made to specific folders and disks.
What is wrong with this code? What assumptions mistakes could the developer have made to make this look OK:
That every install would be to “C:\Program Files\SSW SQL Deploy”
That every computer would have a “D:\\”
That checking in code at 6pm because the had to go home was a good idea.
lets solve each of these problems:
We are in a web service… lets store data within the web root. So we can call “Server.MapPath(“~/App_Data/SSW SQL Deploy\SampleData”) instead.
Never reference an explicit path. If you need some storage for your application use IsolatedStorage.
Shelve your code instead.
What else could have been done?
Code review before check-in – The developer should have shelved their code and asked another dev to look at it.
Use Defensive programming – Make sure that any code that has the possibility of failing has checks.
Any more options?
Let me know and I will add them.
What do we do?
The correct things to do is to add a Bug to the backlog, but as this is probably going to be fixed in sprint, I will add it directly to the sprint backlog.
Right click on the failing test Select “Create Work Item | Bug”
Figure: Create an associated bug to add to the backlog.
Set the values for the Bug making sure that it goes into the right sprint and Area. Make your steps to reproduce as explicit as possible, but “See test” is valid under these circumstances.
Figure: Add it to the correct Area and set the Iteration to the Area name or the Sprint if you think it will be fixed in Sprint and make sure you bring it up at the next Scrum Meeting.
Note: make sure you leave the “Assigned To” field blank as in Scrum team members sign up for work, you do not give it to them. The developer who broke the test will most likely either sign up for the bug, or say that they are stuck and need help.
Note: Visual Studio has taken care of associating the failing test with the Bug.
Save…
Technorati Tags: WCF,MSTest,MSBuild,Team Build 2010,Team Test 2010,Team Build,Team Test
