はじめての C# からの Selenium、そして NET Core ではエラーになる場合 : @jsakamoto

2018年 12月 09日

はじめての C# からの Selenium、そして NET Core ではエラーになる場合

Selenium とは

ここで言う Selenium とは、Web ブラウザをプログラミング言語から自動操縦することを可能にするソフトウェアだ。

本稿では、C# から Selenium の .NET バインディングを使用して Web ブラウザを操縦できるようになるまでの手順を紹介する。

なお、Selenium は、Firefox や Google Chrome などなど、各種 Web ブラウザを操縦可能だが、話を簡単にするためにとりあえず今回は Google Chrome を操縦することとする。

.NET Framework + Visual Studio の場合

まずは Visual Studio を起動し、プロジェクトの新規作成から適当な C# プロジェクトを作成する。

ここではコンソールアプリとしたが、必要に応じて WinForms などの GUI プロジェクトや単体テストプロジェクトでも構わない。

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22342786.png

続けて、NuGet パッケージマネージャーから、以下の 2 つのNuGet パッケージをこの C# プロジェクトに追加する。

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22342254.png

ちなみに、Firefox を操縦したければ Selenium.WebDriver.GeckoDriver NuGet パッケージをプロジェクトに追加すればよい。

あとはブラウザを操縦する C# プログラムを記述すればよい。

下記は Chrome で Bing 検索を開き、"Selenium WebDriver" という語句を検索実行する例だ。

using OpenQA.Selenium.Chrome;
...
using (var driver = new ChromeDriver())
{
  driver.Navigate().GoToUrl("https://www.bing.com/");

  driver
    .FindElementById("sb_form_q")
    .SendKeys("Selenium WebDriver");

  driver
    .FindElementById("sb_form_go")
    .Click();

  Console.WriteLine("OK");
  Console.ReadKey(intercept: true);
}

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22341684.png

以上でビルド & 実行 (Visual Studio 上で Ctrl + F5)　すれば、そのとおり実行される。

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22341144.png

以上である。

上記手順にあるとおり、ブラウザを Selenium 経由で操縦するための通訳を行なうプログラム、"WebDriver" も NuGet パッケージで配布されていて、これを参照する格好となっている。

例えば Google Chrome 用の WebDriver は (Windows OS の場合) "chromedriver.exe" というプログラムファイルである。

この "chromedriver.exe" が NuGet パッケージ参照によって、ビルド先の出力フォルダに自動でコピーされるのだ。

このため、

「このプロジェクトを git clone してビルド & 実行するには、事前に自分で WebDriver プログラムをダウンロードして、Path の通った適当なフォルダに解凍しておいてね」

みたいな事前の環境整備が不要である。

.NET Core + dotnet CLI の場合

.NET Core がインストールされている環境で、dotent コマンドを使い、同じようにやってみることにしよう。

コンソール (ターミナル) を開き、まずは適当な作業フォルダを作成しよう。

カレントディレクトリをこうして作成した作業フォルダの中に移動し、以下のコマンドで .NET Core なコンソールアプリの C# プロジェクトを新規作成する。

> dotnet new console

続けて、以下のコマンドで、Selenium.WebDriver、及び Selenium.WebDriver.ChromeDriver の両 NuGet パッケージの参照を追加する。

> dotnet add package Selenium.WebDriver
> dotnet add package Selenium.WebDriver.ChromeDriver

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22340684.png

これでプロジェクトができたので、適当なテキストエディタを使って C# プログラムを同じように書きあげればよい。

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22335972.png

ビルドと実行はコンソール (ターミナル) に戻って「dotnet run」コマンドを実行だ。

dotnet run

これで Google Chrome が起動...

と思ったら起動せずに下記エラーになってしまった。

Unhandled Exception: OpenQA.Selenium.DriverServiceNotFoundException: The chromedriver.exe file does not exist in the current directory or in a directory on the PATH environment variable.

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22335399.png

"chromedriver.exe" が見つからない!?

だがしかし、.NET Framework 版のときと同じように、"chromedriver.exe" はたしかに出力フォルダにコピーされている。

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22334328.png

.NET Framework 版と同じように作成したのに、一体何故!?

Selennium が WebDriver を探す場所

実は Selenium が WebDriver ファイルを探す場所は、環境変数 PATH が指すフォルダ群の他には、Selenium の .NET アセンブリファイルである WebDriver.dll が配置されているフォルダが対象となっている。

いっぽうで、.NET Core では NuGet パッケージ参照しているアセンブリファイル (.dll) は、出力フォルダにコピーされないのが既定の仕様である。

出力フォルダにコピーされない代わりに、%HOMEPATH%\.nuget\packages フォルダ以下に共有して保存されているアセンブリファイルが実行時にプロセスに読み込まれる仕組みだ。

そのため、.NET Core 版プロジェクトでは、Selenium の WebDriver.dll アセンブリがある場所 = (プロジェクトの出力フォルダではなく) %HOMEPATH%\.nuget\packages\...\selenium.webdriver\... みたいな場所で、"chromedriver.exe" を探してしまい、しかしもちろん、そんなところに "chromedriver.exe" は存在しないから件のエラーになってしまうという顛末である。

回避策 A - 出力フォルダにコピーしちゃう

C# プロジェクトファイル .csproj 内に指定を追記することで、.NET Core なプロジェクトであっても、参照している NuGet パッケージのアセンブリファイルを出力フォルダにコピーすることが可能だ。

具体的には、.csproj ファイル内の PropertyGroup ノード内に以下の記述を追加する。

<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22334874.png

こうしてビルドすると、WebDriver.dll が (.NET Framework のときと同じように) プロジェクトの出力フォルダにコピーされ、この状態であれば "chromedriver.exe" が見つかるので、無事実行できるようになる。

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22333706.png

ただ、.NET Core なプログラムだと、小さな NuGet パッケージをたくさん参照する傾向がありがちで、発行時はさすがにともかくも、通常のデバッグビルド・デバッグ実行のたびに大量の .dll が出力フォルダに毎回コピーされるのもどうかという気がしないでもない。

回避策 B - Selenium に明示的に教える

.NET Core なプロジェクトで、出力フォルダを確実に指す実行時情報がある。

AppDomain クラスの BaseDirectory プロパティだ。

そして幸い、Google Chrome 用 Web Driver "chromediver.exe" との通信を司る ChromeDriver クラスのコンストラクタは、"chromediver.exe" のありかを指定する1引数をもつオーバーロードバージョンがある。

この2者を組み合わせて以下のように "chromediver.exe" のあるフォルダを明示的に指定すれば良い。

var baseDir = AppDomain.CurrentDomain.BaseDirectory;
var driver = new ChromeDriver(baseDir);

はじめての C# からの Selenium、そして NET Core ではエラーになる場合_d0079457_22333091.png

こうすれば、.csproj をいじらずとも、期待どおり実行されるようになる。

まとめ

C# なプログラミングにおいては、.NET Framework 版、.NET Core 版のいずれであっても、

プロジェクト作成
NuGet パッケージ参照追加
コーディング

の 3ステップで Selenium によるブラウザ操縦プログラムが実装できる。

このとき、WebDriver ファイルの手動による事前配置は不要で、NuGet パッケージ参照によって WebDriver ファイルは解決される。

ただ、.NET Core のときは .NET Framework のときと比べてちょっとだけ手を掛けてやらねばならず、

プロジェクト設定を書き換えて、NuGet パッケージのアセンブリファイルをすべて出力フォルダにコピーするようにするか、
ソースコード上で、WebbDriver ファイルのあるフォルダを明示するか

しないと実行時に WebDriver ファイルが見つからないエラーとなるので注意。

下記 Issue が参考になるかと思う。

以上。

by developer-adjust | 2018-12-09 00:00 | Selenium


	ファン申請 ※ メッセージを入力してください

@jsakamoto