[.NET] Selenium に純正の WebDriver Manager が付属するようになった話

Selenium でブラウザを操縦するには WebDriver も忘れずに!

Web ブラウザをプログラムから操作・操縦するライブラリの老舗である Selenium と、その .NET 用バインディングの NuGet パッケージの話。

.NET プログラムから Selenium を使って Web ブラウザを操作しようとする場合、"Selenium.WebDriver" NuGet パッケージをその .NET プログラムのプロジェクトに追加し、C# であれば以下のようなコードを実装することになる。

using OpenQA.Selenium;

using var driver = new OpenQA.Selenium.Chrome.ChromeDriver();

driver.Navigate().GoToUrl("https://www.bing.com/");

で、このプログラムをビルドして実行すると、よくあることとして、以下のエラーに遭遇することがある。

The path to the driver executable must be set by the webdriver.chrome.driver

system property; for more information, see https://chromedriver.chromium.org/. The latest version can be

downloaded from https://chromedriver.chromium.org/downloads

なぜこのようなエラーが発生するのかというと、実は Selenium によるブラウザの操縦にあたっては、Selenium のライブラリ本体とは別に、Chrome や Edge、Firefox といったブラウザ種別に応じた「ウェブドライバー (WebDriver)」という "プログラム" (実行可能ファイル、Windows なら .exe) を、別途事前にダウンロードしておき、実行可能なフォルダパスに配置しておく必要があるのだ。

Selenium に慣れていればどうということもないのだろうが、初見殺しとでも言えば良いのか、初心者の心臓には悪い話である。

で、.NET プログラミングの場合は、以下の NuGet パッケージを更にプロジェクトに追加しておくと、出力フォルダに各ブラウザ種別に応じた WebDriver が配置されるようになる。

ただ、これはこれで良し悪しで、環境にインストールされている実際の Web ブラウザのバージョンと、上記 NuGet パッケージのバージョンとが不一致だと「バージョンが合わない」というエラーになってしまったりする。

そんな背景から、「じゃぁ、現在の実行環境にインストールされている実際の Web ブラウザのバージョンに応じて、必要且つ最適なバージョンの WebDriver ファイルを、プログラムの実行時に自動で判断・ダウンロードしてくるようにしよう」というアプローチが発案され、これを実現してくれる NuGet パッケージ "WebDriverManager" も登場した。

上記 "WebDriverManager" NuGet パッケージをプロジェクトに追加しておくと、以下のようなコードにて、このプログラムの実行時に、最適なバージョンの WebDriver ファイルがダウンロードされ、実行可能となる。

using OpenQA.Selenium;

// 👇 これらの名前空間を開き...

using WebDriverManager;

using WebDriverManager.DriverConfigs.Impl;

// 👇 この行を追加して必要な WebDriver の判断とダウンロードを実行時に行なう!

new DriverManager().SetUpDriver(new ChromeConfig());

using var driver = new OpenQA.Selenium.Chrome.ChromeDriver();

というように、Selenium を使ってのブラウザ自動操縦にあたっては、WebDriver のダウンロードと配置をどうするか、という課題を開発者が解決する必要があるのであった。

Selenium 純正のドライバマネージャが付属するようになった!

しかしそれも今となっては昔。

昨年 2022 年 11 月にリリースされた Selenium のバージョン 4.6 から、Selenium のライブラリそれ自体に、前述の WebDriver Manager 相当の機能が組み込まれるようになったのだ!

機能名としては "WebDriver Manager" ではなくて "Selenium Manager" と呼ばれているが、 当時の公式ブログ記事 (下記リンク先) にてその紹介がされている。

前述の WebDriver Manager 相当の機能が、Selenium のライブラリそれ自体に純正品として組み込まれたことにより、NuGet パッケージ "Selenium.WebDriver" のみをプロジェクトに追加しておくだけで、それ以外の NuGet パッケージの追加や、別途事前の手作業での WebDriver のダウンロードや配置は一切不要で、いきなり、冒頭のコード (以下に再録) を実行するだけで、ブラウザの操縦が可能となった。

using OpenQA.Selenium;

using var driver = new OpenQA.Selenium.Chrome.ChromeDriver();

driver.Navigate().GoToUrl("https://www.bing.com/");

ちなみにこの Selenium Manager の機能によってダウンロードされる WebDriver ファイルは、Windows だと以下のようなフォルダ構成で保存されるようだ。

📂%USER_PROFILE% > 📂.cache > 📂 selenium

├─📂chromedriver

│ └─📂win32

│ └─📂111.0.5563.64

│ 📄chromedriver.exe
│
├─📂geckodriver

│ └─📂win64

│ └─📂0.32.2

│ 📄geckodriver.exe

│
└─📂IEDriverServer

└─📂win32

└─4.8.0
📄IEDriverServer.exe

なお、2022年11月の上記リンク先のブログ記事を見ると、この Selenium Manager 機能はまだ正式なリリースを迎えておらず、ベータ版としての位置づけらしく、実際、バージョン 4.6 時点では IEDriver は未対応だったりしたようである。

しかしその後、同年翌月 2022年12月の Selenium バージョン 4.7 では IEDriver にも対応し、本稿執筆時点の 2023年3月現在の最新バージョンである 4.8.1 に至っている。

ただ自分が確認した限りでは、この Selenium Manager 機能が、ベータ版の位置づけから正式なリリースに至ったとの情報は入手できていない。

とはいえベータ版とのことらしい今日現在であるが、とりあえず Windows OS および .NET バインディングの NuGet パッケージ (バージョン 4.8.1) においては、Chrome、Edge の IE モード、Firefox の各ブラウザで、期待どおり正常に機能することは確認できている。

まとめ

ということで、以上、昨年 2022 年 11 月以降、Selenium のバージョン 4.6 以降では必要な WebDriver を Selenium それ自体が自動で判断・ダウンロードして使うようになった。

そのため、WebDriver をどうやってダウンロードしたり配置したりするかを考えたり、バージョンの整合を気にしたりすることなく、初心者でも躓くことなく Selenium によるブラウザ自動操縦が可能になりました、という嬉しい話。