Yucchiy's Note

ProcessXを試してみる

TechProcessXC#CLIShell

Cysharp/ProcessX: Simplify call an external process with the async streams in C# 8.0. neue cc - ProcessX - C#でProcessを C# 8.0非同期ストリームで簡単に扱うライブラリ

C#でシェルを書くためのライブラリである Cysharp/ProcessX を触ってみます。

通常C#でシェルを実行するには、外部プロセスを System.Diagnostics.Process クラスなどを介して実行します。ただしこの記事に言及されているように、Process.Startメソッドに渡すProcessStartInfoは指定するフラグが多かったり、また非同期外部プロセス起動で標準出力を受け取る際の注意点にあるようにハマリポイントが多かったりで、結構大変だったりします。（あと指定するフラグも、個人的には少し分かりづらかったりします。）

実行したいコマンドを記述して、その結果をC#の文字列として受け取りたいだけなのに... 、ってのを実現したライブラリが「ProcessX」、という理解です。

インストール

NuGetからProcessXをインストールできます。Visual StudioなどのIDEではNuGetのウインドウから下図のようにProcessXを探してきてインストールします。

Visual StudioでのNuGet経由でのインストール方法

Visual StudioでのNuGet経由でのインストール方法

Visual StudioでのNuGet経由でのインストール方法

またはコマンドライン経由でインストールする場合は、プロジェクト配下で

$ dotnet add package ProcessX

でインストールできます。

使い方

本記事では一旦シンプルなコマンド実行にとどめますが（そのうち色々触ったら記事を書くかもです）、単純なコマンド実行であれば、 ProcessX.StartAsync("zikkoushitai-command") を呼び出すだけでコマンドを実行し、その結果を文字列で受け取ることができます。

例えば ls を実行して、結果を受け取る場合は下記のようにかけます。

using Cysharp.Diagnostics;

await foreach (string item in ProcessX.StartAsync("ls"))
{
    // lsの結果を1行ずつコンソールに出力
    Console.WriteLine(item);
}

また、コマンドラインの実行結果を全行まとめて受け取る場合には下記が利用できます。

string[] result = await ProcessX.StartAsync("ls").ToTask();

こんな感じで、ほぼBashなどでのコマンド実行と同じような書き心地で、C#上でコマンドライン実行ができそうです。（ちなみに ls の場合は、もしかしたら [Directory.GetFiles](https://docs.microsoft.com/en-us/dotnet/api/system.io.directory.getfiles?view=net-6.0) を用いたほうがいい、という話はありそうですが... それはそれとして。）

ちなみに紹介記事にあるように、コマンド実行時のExitCodeが0以外が返ってきた場合、 ProcessErrorException 例外は飛んでくる仕様になっています。つまり、Bashなどでset -eをつけてスクリプトを記述することと同じようなエラーハンドリングとなっています。

set -eの場合はスクリプトが即座に終了してしまいますが、ProcessXで記述する場合は都度例外が飛んでくるので、エラーハンドリングはより柔軟におこなえるのは便利かもしれません。

try
{
    await foreach (var item in ProcessX.StartAsync("sonzaishinai-command")) { }
}
catch (ProcessErrorException ex)
{
    // ExitCodeが0以外の場合はここにくる
    Console.WriteLine(ex.ToString());
}

WSL上でのデバッグ

Visual Studio上で実行すると（当然ですが）Windowsのコマンドラインとして実行されます。もしBashなどのシェルスクリプト代わりにプログラムする場合、デバッグ実行をLinux上などで行いたいかもしれません。その場合、WSL上でデバッグ実行すると確認しやすいかもしれません。

Visual Studio 2022のPreview 3から、WSLを用いて.NETのアプリケーションをLinux上でデバッグする機能が追加されています。

Debug .NET apps in Linux using WSL - Visual Studio (Windows) | Microsoft Docs

詳細については上の記事に記載されていますが、今回やりたいLinux上で.NETアプリケーションを実行するところまで触れておきます。

この機能を利用するには、WSLコンポーネントをインストールする必要があります。Visual Studioのメニューから「Tools > Get Tools and Features」を開きます。

Visual Stuiod Installerが開かれるので、「個別のコンポーネント」をクリックし、検索ボックスに「WSL」などと入力して、「WSL を用いた .NET デバッグ」のコンポーネントにチェックを入れて、右下の「変更」をクリックしてインストールします。

WSLコンポーネントのインストール方法

WSLコンポーネントのインストール方法

次に、 launchSettings.jsonを開いて、下図のようにWSL項目を追記します。

launchSettings.jsonにWSL項目を追記

launchSettings.jsonにWSL項目を追記

一応、コピペ用にテキストも記載しておきます。

"WSL": {
    "commandName": "WSL"
}

commandName 項目に WSL を記載すればよいわけです。ちなみに、実行するWSLのディストリビューションを明記することもできます。

"WSL": {
    "commandName": "WSL",
    "distributionName": "Ubuntu-20.04"
}

あとは下図のようにWSLをデバッグ実行として選択して実行すれば、Linux上で実行されます。実行先のLinuxディストリビューション上に.NET Coreが入っていない場合は、自動的にインストールされますが、その際パスワード（Linux上のユーザーの）を求められるので入力が必要です。

デバッグ実行にWSLを指定

デバッグ実行にWSLを指定

ProcessXのWSL上での実行結果

ProcessXのWSL上での実行結果

まとめ

ProcessXの概要から簡単な使い方、WSL上でのデバッグ実行まで取り上げました。

個人的にいくつかのシェルスクリプトをC#で置き換えられたらいいなーと思うことがあり触り始めましたが、わりと雰囲気良さそうな感じです。

またなにか進めば、ProcessX関連で記事を書きたいと思います。

参考