web-dev-qa-db-ja.com

コマンドラインまたはC＃アプリケーションからmsbuildのステータスを検出する方法

私はC＃でチェックアウト、ビルド、および展開アプリケーションを作成していますが、msbuild.exeへの呼び出しが成功したかどうかを検出するための最良の方法を知る必要があります。プロセスのエラーコードを使用しようとしましたが、これが常に正確かどうかはわかりません。

msbuild.exeが正常に完了したかどうかを（以下のコードで）確認する方法はありますか？

try
{
    Process msbProcess = new Process();
    msbProcess.StartInfo.FileName = this.MSBuildPath;
    msbProcess.StartInfo.Arguments = msbArguments;
    msbProcess.Start();
    msbProcess.WaitForExit();

    if (msbProcess.ExitCode != 0)
    {
        //
    }
    else
    {
        //
    }

    msbProcess.Close();
}
catch (Exception ex)
{
    //
}
c#msbuildprocessexit-code
26
Grant

私が判断できた限りでは、MSBuildはエラーが発生すると、終了コード> 0を返します。エラーが発生しない場合は、終了コード0が返されます。コード<0で終了するのを見たことがありません。

私はそれをバッチファイルで使用します：

msbuild <args>
if errorlevel 1 goto errorDone

このように使用してから4年間、このアプローチの正しさを疑う理由はありませんでした。

MSDNフォーラムのいくつかの質問は、同じことを尋ねます。例： http://social.msdn.Microsoft.com/forums/en-US/msbuild/thread/a4ae6b2b-9b1f-4e59-86b4-370f44d73a85 。標準の応答は、事実上、「エラーレベルが0の場合、エラーはありませんでした」です。

31
Jim Mischel

パーティーに少し遅すぎたらごめんなさい...でも質問が投稿されてから7年近く経ちましたが、完全な答えを見たかったのです。以下のコードを使用していくつかのテストを行いました。結論は次のとおりです。

分析

msbuild.exeは、少なくとも1つのビルドエラーが発生すると1を返し、ビルドが正常に完了すると0を返します。現在、プログラムは警告を考慮していません。つまり、警告付きのビルドが成功すると、msbuild.exeは引き続き0を返します。

存在しないプロジェクトをビルドしようとしたり、間違った引数（/myInvalidArgumentなど）を指定したりすると、msbuild.exeは1を返します。

ソースコード

次のC＃コードは、コマンドラインからmsbuild.exeを起動してお気に入りのプロジェクトをビルドするための完全な実装です。プロジェクトをコンパイルする前に、必要な環境設定をセットアップすることを忘れないでください。

あなたのBuildControlクラス：

using System;

namespace Example
{
    public sealed class BuildControl
    {
        // ...

        public bool BuildStuff()
        {
            MsBuilder builder = new MsBuilder(@"C:\...\project.csproj", "Release", "x86")
            {
                Target = "Rebuild", // for rebuilding instead of just building
            };
            bool success = builder.Build(out string buildOutput);
            Console.WriteLine(buildOutput);
            return success;
        }

        // ...
    }
}

MsBuilderクラス：コマンドラインからMsBuild.exeを呼び出してビルドします。

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;

namespace Example
{
    public sealed class MsBuilder
    {
        public string ProjectPath { get; }
        public string LogPath { get; set; }

        public string Configuration { get; }
        public string Platform { get; }

        public int MaxCpuCount { get; set; } = 1;
        public string Target { get; set; } = "Build";

        public string MsBuildPath { get; set; } =
            @"C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\MSBuild\15.0\Bin\MsBuild.exe";

        public string BuildOutput { get; private set; }

        public MsBuilder(string projectPath, string configuration, string platform)
        {
            ProjectPath = !string.IsNullOrWhiteSpace(projectPath) ? projectPath : throw new ArgumentNullException(nameof(projectPath));
            if (!File.Exists(ProjectPath)) throw new FileNotFoundException(projectPath);
            Configuration = !string.IsNullOrWhiteSpace(configuration) ? configuration : throw new ArgumentNullException(nameof(configuration));
            Platform = !string.IsNullOrWhiteSpace(platform) ? platform : throw new ArgumentNullException(nameof(platform));
            LogPath = Path.Combine(Path.GetDirectoryName(ProjectPath), $"{Path.GetFileName(ProjectPath)}.{Configuration}-{Platform}.msbuild.log");
        }

        public bool Build(out string buildOutput)
        {
            List<string> arguments = new List<string>()
            {
                $"/nologo",
                $"\"{ProjectPath}\"",
                $"/p:Configuration={Configuration}",
                $"/p:Platform={Platform}",
                $"/t:{Target}",
                $"/maxcpucount:{(MaxCpuCount > 0 ? MaxCpuCount : 1)}",
                $"/fileLoggerParameters:LogFile=\"{LogPath}\";Append;Verbosity=diagnostic;Encoding=UTF-8",
            };

            using (CommandLineProcess cmd = new CommandLineProcess(MsBuildPath, string.Join(" ", arguments)))
            {
                StringBuilder sb = new StringBuilder();
                sb.AppendLine($"Build started: Project: '{ProjectPath}', Configuration: {Configuration}, Platform: {Platform}");

                // Call MsBuild:
                int exitCode = cmd.Run(out string processOutput, out string processError);

                // Check result:
                sb.AppendLine(processOutput);
                if (exitCode == 0)
                {
                    sb.AppendLine("Build completed successfully!");
                    buildOutput = sb.ToString();
                    return true;
                }
                else
                {
                    if (!string.IsNullOrWhiteSpace(processError))
                        sb.AppendLine($"MSBUILD PROCESS ERROR: {processError}");
                    sb.AppendLine("Build failed!");
                    buildOutput = sb.ToString();
                    return false;
                }
            }
        }

    }
}

CommandLineProcess class-コマンドラインプロセスを開始し、終了するまで待機します。すべての標準出力/エラーがキャプチャされ、プロセス用に個別のウィンドウが開始されません。

using System;
using System.Diagnostics;
using System.IO;

namespace Example
{
    public sealed class CommandLineProcess : IDisposable
    {
        public string Path { get; }
        public string Arguments { get; }
        public bool IsRunning { get; private set; }
        public int? ExitCode { get; private set; }

        private Process Process;
        private readonly object Locker = new object();

        public CommandLineProcess(string path, string arguments)
        {
            Path = path ?? throw new ArgumentNullException(nameof(path));
            if (!File.Exists(path)) throw new ArgumentException($"Executable not found: {path}");
            Arguments = arguments;
        }

        public int Run(out string output, out string err)
        {
            lock (Locker)
            {
                if (IsRunning) throw new Exception("The process is already running");

                Process = new Process()
                {
                    EnableRaisingEvents = true,
                    StartInfo = new ProcessStartInfo()
                    {
                        FileName = Path,
                        Arguments = Arguments,
                        UseShellExecute = false,
                        RedirectStandardOutput = true,
                        RedirectStandardError = true,
                        CreateNoWindow = true,
                    },
                };

                if (!Process.Start()) throw new Exception("Process could not be started");
                output = Process.StandardOutput.ReadToEnd();
                err = Process.StandardError.ReadToEnd();
                Process.WaitForExit();
                try { Process.Refresh(); } catch { }
                return (ExitCode = Process.ExitCode).Value;
            }
        }

        public void Kill()
        {
            lock (Locker)
            {
                try { Process?.Kill(); }
                catch { }
                IsRunning = false;
                Process = null;
            }
        }

        public void Dispose()
        {
            try { Process?.Dispose(); }
            catch { }
        }
    }
}

[〜＃〜] ps [〜＃〜]：Visual Studio 2017/.NET4.7.2を使用しています

3
sɐunıɔןɐqɐp