Running MSBuild programmatically

I am trying to execute MSBuild programmatically and can't execute the following command:

string command = string.Format(@"C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild.exe  ""{0}\{1}.csproj""", _args.ProjectPath, _args.ProjectName);

The string gets rendered as:

C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild.exe  "C:\...\TestResults\Foo 2011-08-31 16_29_40\Out\Foo\solutionName\projectName\projectName.csproj"

I then use new ProcessStartInfo(command). The problem seems to be the space between Foo and 2011. I get the following output:

MSBUILD : error MSB1008: Only one project can be specified.
Switch: 16_29_40\Out\Foo\solutionName\projectName\projectName.csproj

How do I pass in the project file to MSBuild?


I would recommend stronlgy to go the official route via classes/interfaces in Microsoft.Build namespace. Microsoft uses this all over the place, so this should count for something...

Esp. the class Microsoft.Build.Execution.BuildManager and the Singleton Microsoft.Build.Execution.BuildManager.DefaultBuildManager is what you are after to run a build task... source code examples:

  • http://social.msdn.microsoft.com/Forums/en-US/msbuild/thread/ec95c513-f972-45ad-b108-5fcfd27f39bc/
  • Logging Build messages with MSBuild 4.0

Here a full working example with a simple logger.

To build a solution:

using Microsoft.Build.Evaluation;
using Microsoft.Build.Execution;

string projectFileName = "C:\\Users...\\MySolution.sln"; // <--- Change here can be another
                                                         //      Visual Studio type.
                                                         //      Example: .vcxproj

BasicLogger Logger = new BasicLogger();
var projectCollection = new ProjectCollection();
var buildParamters = new BuildParameters(projectCollection);
buildParamters.Loggers = new List<Microsoft.Build.Framework.ILogger>() { Logger };
var globalProperty = new Dictionary<String, String>();
globalProperty.Add("Configuration", "Debug"); //<--- change here
globalProperty.Add("Platform", "x64");//<--- change here
BuildManager.DefaultBuildManager.ResetCaches();
var buildRequest = new BuildRequestData(projectFileName, globalProperty, null, new String[] { "Build" }, null);
var buildResult = BuildManager.DefaultBuildManager.Build(buildParamters, buildRequest);
if (buildResult.OverallResult == BuildResultCode.Failure)
{
    // Catch result ...
}
MessageBox.Show(Logger.GetLogString());    // Display output ..

And the logger class (strongly derived of this MSDN logger):

public class BasicLogger : Logger
{
    MemoryStream streamMem = new MemoryStream();


    /// <summary>
    /// Initialize is guaranteed to be called by MSBuild at the start of the build
    /// before any events are raised.
    /// </summary>
    public override void Initialize(IEventSource eventSource)
    {
        try
        {
            // Open the file
            this.streamWriter = new StreamWriter(streamMem);
            //this.streamWriter = new StreamWriter(logFile);
        }
        catch (Exception ex)
        {
            if
            (
                ex is UnauthorizedAccessException
                || ex is ArgumentNullException
                || ex is PathTooLongException
                || ex is DirectoryNotFoundException
                || ex is NotSupportedException
                || ex is ArgumentException
                || ex is SecurityException
                || ex is IOException
            )
            {
                throw new LoggerException("Failed to create log file: " + ex.Message);
            }
            else
            {
                // Unexpected failure
                throw;
            }
        }

        // For brevity, we'll only register for certain event types. Loggers can also
        // register to handle TargetStarted/Finished and other events.
        eventSource.ProjectStarted += new ProjectStartedEventHandler(eventSource_ProjectStarted);
        eventSource.TaskStarted += new TaskStartedEventHandler(eventSource_TaskStarted);
        eventSource.MessageRaised += new BuildMessageEventHandler(eventSource_MessageRaised);
        eventSource.WarningRaised += new BuildWarningEventHandler(eventSource_WarningRaised);
        eventSource.ErrorRaised += new BuildErrorEventHandler(eventSource_ErrorRaised);
        eventSource.ProjectFinished += new ProjectFinishedEventHandler(eventSource_ProjectFinished);
    }


    void eventSource_ErrorRaised(object sender, BuildErrorEventArgs e)
    {
        // BuildErrorEventArgs adds LineNumber, ColumnNumber, File, amongst other parameters
        string line = String.Format(": ERROR {0}({1},{2}): ", e.File, e.LineNumber, e.ColumnNumber);
        WriteLineWithSenderAndMessage(line, e);
    }


    void eventSource_WarningRaised(object sender, BuildWarningEventArgs e)
    {
        // BuildWarningEventArgs adds LineNumber, ColumnNumber, File, amongst other parameters
        string line = String.Format(": Warning {0}({1},{2}): ", e.File, e.LineNumber, e.ColumnNumber);
        WriteLineWithSenderAndMessage(line, e);
    }


    void eventSource_MessageRaised(object sender, BuildMessageEventArgs e)
    {
        // BuildMessageEventArgs adds Importance to BuildEventArgs
        // Let's take account of the verbosity setting we've been passed in deciding whether to log the message
        if ((e.Importance == MessageImportance.High && IsVerbosityAtLeast(LoggerVerbosity.Minimal))
            || (e.Importance == MessageImportance.Normal && IsVerbosityAtLeast(LoggerVerbosity.Normal))
            || (e.Importance == MessageImportance.Low && IsVerbosityAtLeast(LoggerVerbosity.Detailed))
        )
        {
            WriteLineWithSenderAndMessage(String.Empty, e);
        }
    }


    void eventSource_TaskStarted(object sender, TaskStartedEventArgs e)
    {
        // TaskStartedEventArgs adds ProjectFile, TaskFile, TaskName
        // To keep this log clean, this logger will ignore these events.
    }


    void eventSource_ProjectStarted(object sender, ProjectStartedEventArgs e)
    {
        // ProjectStartedEventArgs adds ProjectFile, TargetNames
        // Just the regular message string is good enough here, so just display that.
        WriteLine(String.Empty, e);
        indent++;
    }


    void eventSource_ProjectFinished(object sender, ProjectFinishedEventArgs e)
    {
        // The regular message string is good enough here too.
        indent--;
        WriteLine(String.Empty, e);
    }


    /// <summary>
    /// Write a line to the log, adding the SenderName and Message
    /// (these parameters are on all MSBuild event argument objects)
    /// </summary>
    private void WriteLineWithSenderAndMessage(string line, BuildEventArgs e)
    {
        if (0 == String.Compare(e.SenderName, "MSBuild", true /*ignore case*/))
        {
            // Well, if the sender name is MSBuild, let's leave it out for prettiness
            WriteLine(line, e);
        }
        else
        {
            WriteLine(e.SenderName + ": " + line, e);
        }
    }


    /// <summary>
    /// Just write a line to the log
    /// </summary>
    private void WriteLine(string line, BuildEventArgs e)
    {
        for (int i = indent; i > 0; i--)
        {
            streamWriter.Write("\t");
        }
        streamWriter.WriteLine(line + e.Message);
    }


    public string GetLogString()
    {
        var sr = new StreamReader(streamMem);
        var myStr = sr.ReadToEnd();
        return myStr;
    }


    /// <summary>
    /// Shutdown() is guaranteed to be called by MSBuild at the end of the build, after all
    /// events have been raised.
    /// </summary>
    ///
    ///
    public override void Shutdown()
    {
        streamWriter.Flush();
        streamMem.Position = 0;
    }

    private StreamWriter streamWriter;
    private int indent;

}

Also be sure to use the correct MSBuild Framework Assemblies (i.e not the "4.0" version) ( see here )


You need to use the Arguments property of the ProcessStartInfo to pass parameters.

e.g.

var p = new Process();
p.StartInfo = new ProcessStartInfo(@"C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild.exe")      
p.StartInfo.Arguments = string.Format(@"{0}\{1}.csproj", _args.ProjectPath, _args.ProjectName)

p.Start();

However, for MSBuild specifically you should use the official method as Yahia mentions.