MsBuildTaskTest.cs :  » Build-Systems » CruiseControl.NET » ThoughtWorks » CruiseControl » UnitTests » Core » Tasks » C# / CSharp Open Source

using System.Diagnostics;
using System.IO;
using System.Runtime.InteropServices;
using Exortech.NetReflector;
using NUnit.Framework;
using Rhino.Mocks;
using ThoughtWorks.CruiseControl.Core;
using ThoughtWorks.CruiseControl.Core.Tasks;
using ThoughtWorks.CruiseControl.Core.Util;
using ThoughtWorks.CruiseControl.Remote;

namespace ThoughtWorks.CruiseControl.UnitTests.Core.Tasks{
  [TestFixture]
  public class MsBuildTaskTest : ProcessExecutorTestFixtureBase
  {
    private const string defaultLogger = "ThoughtWorks.CruiseControl.MsBuild.dll";
    private string logfile;
    private IIntegrationResult result;
    private MsBuildTask task;
        private MockRepository mocks = new MockRepository();

    [SetUp]
    protected void SetUp()
    {
      var shadowCopier = mocks.DynamicMock<IShadowCopier>();
      SetupResult.For(shadowCopier.RetrieveFilePath(defaultLogger)).Return(defaultLogger);

      var executionEnvironment = mocks.DynamicMock<IExecutionEnvironment>();
      SetupResult.For(executionEnvironment.IsRunningOnWindows).Return(true);
      SetupResult.For(executionEnvironment.RuntimeDirectory).Return(RuntimeEnvironment.GetRuntimeDirectory());

      mocks.ReplayAll();


      CreateProcessExecutorMock(Path.Combine(RuntimeEnvironment.GetRuntimeDirectory(), "MSBuild.exe"));
      task = new MsBuildTask((ProcessExecutor) mockProcessExecutor.MockInstance, executionEnvironment, shadowCopier);

      result = IntegrationResult();
      result.Label = "1.0";
      result.ArtifactDirectory = DefaultWorkingDirectory;
      logfile = Path.Combine(result.ArtifactDirectory, MsBuildTask.LogFilename);
      TempFileUtil.DeleteTempFile(logfile);
    }

    [TearDown]
    protected void TearDown()
    {
      Verify();
    }

    [Test]
    public void ExecuteSpecifiedProject()
    {
            string args = "/nologo /t:target1;target2 " + IntegrationProperties() + " /p:Configuration=Release myproject.sln" + GetLoggerArgument();
      ExpectToExecuteArguments(args, DefaultWorkingDirectory);

      task.ProjectFile = "myproject.sln";
      task.Targets = "target1;target2";
      task.BuildArgs = "/p:Configuration=Release";
      task.Timeout = 600;

            mocks.ReplayAll();
      task.Run(result);

      Assert.AreEqual(1, result.TaskResults.Count);
      Assert.AreEqual(IntegrationStatus.Success, result.Status);
        Assert.That(result.TaskOutput, Is.Empty);
    }

    [Test]
    public void AddQuotesAroundProjectsWithSpacesAndHandleNoSpecifiedTargets()
    {
      ExpectToExecuteArguments(@"/nologo " + IntegrationProperties() + @" ""my project.proj""" + GetLoggerArgument());
      task.ProjectFile = "my project.proj";

            mocks.ReplayAll();
            task.Run(result);
    }

    [Test]
    public void AddQuotesAroundTargetsWithSpaces()
    {
            ExpectToExecuteArguments(@"/nologo /t:first;""next task"" " + IntegrationProperties() + GetLoggerArgument());
      task.Targets = "first;next task";

            mocks.ReplayAll();
      task.Run(result);
    }

    [Test]
    public void AddQuotesAroundPropertiesWithSpaces()
    {
      // NOTE: Property names are sorted alphabetically when passed as process arguments
      // Tests that look for the correct arguments will fail if the following properties
      // are not sorted alphabetically.
            string expectedProperties = string.Format(@"/p:CCNetArtifactDirectory={2};CCNetBuildCondition=IfModificationExists;CCNetBuildDate={0};CCNetBuildTime={1};CCNetFailureUsers=;CCNetIntegrationStatus=Success;CCNetLabel=""My Label"";CCNetLastIntegrationStatus=Success;CCNetListenerFile={3};CCNetModifyingUsers=;CCNetNumericLabel=0;CCNetProject=test;CCNetRequestSource=foo;CCNetUser=;CCNetWorkingDirectory={4}", testDateString, testTimeString, StringUtil.AutoDoubleQuoteString(result.ArtifactDirectory), StringUtil.AutoDoubleQuoteString(Path.GetTempPath() + "test_ListenFile.xml"), StringUtil.AutoDoubleQuoteString(DefaultWorkingDirectoryWithSpaces));
            ExpectToExecuteArguments(@"/nologo " + expectedProperties + GetLoggerArgument(), DefaultWorkingDirectoryWithSpaces);
      result.Label = @"My Label";
      result.WorkingDirectory = DefaultWorkingDirectoryWithSpaces;

            mocks.ReplayAll();
      task.Run(result);
    }

    [Test]
    public void DoNotAddQuotesAroundBuildArgs()
    {
            ExpectToExecuteArguments(@"/nologo " + IntegrationProperties() + @" /noconsolelogger /p:Configuration=Debug" + GetLoggerArgument());
      task.BuildArgs = "/noconsolelogger /p:Configuration=Debug";
            mocks.ReplayAll();
      task.Run(result);      
    }

    [Test]
    public void RebaseFromWorkingDirectory()
    {
            ProcessInfo info = NewProcessInfo("/nologo " + IntegrationProperties() + GetLoggerArgument(), Path.Combine(DefaultWorkingDirectory, "src"));
      info.WorkingDirectory = Path.Combine(DefaultWorkingDirectory, "src");
      ExpectToExecute(info);
      task.WorkingDirectory = "src";

            mocks.ReplayAll();
      task.Run(result);
    }

    [Test]
    public void TimedOutExecutionShouldCauseBuilderException()
    {
      ExpectToExecuteAndReturn(TimedOutProcessResult());
            Assert.That(delegate { task.Run(result); },
                        Throws.TypeOf<BuilderException>());
    }

    [Test]
    public void TimedOutExecutionShouldFailBuild()
    {
      try
      {
        ExpectToExecuteAndReturn(TimedOutProcessResult());
        task.Run(result);
      }
      catch (BuilderException)
      {
      }
      Assert.AreEqual(IntegrationStatus.Exception, result.Status);
    }

    [Test]
    public void ShouldAutomaticallyMergeTheBuildOutputFile()
    {
            TempFileUtil.CreateTempXmlFile(string.Format(logfile, task.LogFileId), "<output/>");
      ExpectToExecuteAndReturn(SuccessfulProcessResult());
      task.Run(result);
      Assert.AreEqual(2, result.TaskResults.Count);
        Assert.That(result.TaskOutput, Is.EqualTo("<output/>"));
      Assert.IsTrue(result.Succeeded);
    }

    [Test]
    public void ShouldFailOnFailedProcessResult()
    {
            TempFileUtil.CreateTempXmlFile(string.Format(logfile, task.LogFileId), "<output/>");
      ExpectToExecuteAndReturn(FailedProcessResult());
      task.Run(result);
      Assert.AreEqual(2, result.TaskResults.Count);
      Assert.AreEqual("<output/>" + ProcessResultOutput, result.TaskOutput);
      Assert.IsTrue(result.Failed);      
    }

    [Test]
    public void PopulateFromConfiguration()
    {
      const string xml = @"<msbuild>
  <executable>C:\WINDOWS\Microsoft.NET\Framework\v2.0.50215\MSBuild.exe</executable>
  <workingDirectory>C:\dev\ccnet</workingDirectory>
  <projectFile>CCNet.sln</projectFile>
  <buildArgs>/p:Configuration=Debug /v:diag</buildArgs>
  <targets>Build;Test</targets>
  <timeout>15</timeout>
  <logger>Kobush.Build.Logging.XmlLogger,Kobush.MSBuild.dll;buildresult.xml</logger>
    <priority>BelowNormal</priority>
</msbuild>";
      task = (MsBuildTask) NetReflector.Read(xml);
      Assert.AreEqual(@"C:\WINDOWS\Microsoft.NET\Framework\v2.0.50215\MSBuild.exe", task.Executable);
      Assert.AreEqual(@"C:\dev\ccnet", task.WorkingDirectory);
      Assert.AreEqual("CCNet.sln", task.ProjectFile);
      Assert.AreEqual("Build;Test", task.Targets);
      Assert.AreEqual("/p:Configuration=Debug /v:diag", task.BuildArgs);
      Assert.AreEqual(15, task.Timeout);
      Assert.AreEqual("Kobush.Build.Logging.XmlLogger,Kobush.MSBuild.dll;buildresult.xml", task.Logger);
            Assert.AreEqual(ProcessPriorityClass.BelowNormal, task.Priority);
    }

    [Test]
    public void PopulateFromMinimalConfiguration()
    {
      task = (MsBuildTask) NetReflector.Read("<msbuild />");
      Assert.AreEqual(defaultExecutable, task.Executable);
      Assert.AreEqual(MsBuildTask.DefaultTimeout, task.Timeout);
      Assert.AreEqual(null, task.Logger);
    }

    private string GetLoggerArgument()
    {
      var logger = string.IsNullOrEmpty(task.Logger) ? defaultLogger : task.Logger;
            return string.Format(@" /l:{0};{1}", StringUtil.AutoDoubleQuoteString(logger), StringUtil.AutoDoubleQuoteString(string.Format(logfile, task.LogFileId)));
    }

    private string IntegrationProperties()
    {
      // NOTE: Property names are sorted alphabetically when passed as process arguments
      // Tests that look for the correct arguments will fail if the following properties
      // are not sorted alphabetically.      
            return string.Format(@"/p:CCNetArtifactDirectory={3};CCNetBuildCondition=IfModificationExists;CCNetBuildDate={1};CCNetBuildTime={2};CCNetFailureUsers=;CCNetIntegrationStatus=Success;CCNetLabel=1.0;CCNetLastIntegrationStatus=Success;CCNetListenerFile={4};CCNetModifyingUsers=;CCNetNumericLabel=0;CCNetProject=test;CCNetRequestSource=foo;CCNetUser=;CCNetWorkingDirectory={0}", StringUtil.AutoDoubleQuoteString(DefaultWorkingDirectory), testDateString, testTimeString, StringUtil.AutoDoubleQuoteString(result.ArtifactDirectory), StringUtil.AutoDoubleQuoteString(Path.GetTempPath() + "test_ListenFile.xml"));
    }
  }
}