Codeception + SeleniumServer + ChromeWebDriverでのUserAgentの変更方法

Question

受け入れテストをCodeceptionとSeleniumServerを使って自動化しようと考えています。この場合にユーザエージェントの切り替えをどのようにすればいいのか教えて欲しいです。

該当システムはユーザエージェントでPC版とスマホ版の表示切り替えをしていて、
現状PC版のテストはプロトタイプが作れたのですが、ユーザエージェントの切替方法が分からずスマホ版のテストの目処が立ちません。

以下のようにacceptance.suite.ymlに書いて実行してみましたがダメでした。（PC版で実行されてしまいました）

class_name: AcceptanceTester
modules:
    enabled: [WebDriver]
    config:
      WebDriver:
        url: 'http://test.host.jp'
        browser: chrome
        capabilities:
          userAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12F70 Safari/600.1.4"

調べていてデフォルトで使えるFirefoxWebDriverでは難しそう（出来なそう？）だったので、ChromeWebDriverを使ってみています。
この辺を見る限りmobileEmulationの当たりを上手く設定出来ればいけるのかとおもっているのですがCodeceptionを使ったときにどうしていいか分からず。。。

また、Codeception + SeleniumServer + ChromeWebDriverと書きましたがスマホ版のテストが出来るならChromeでなくても良いと考えています。

Answer 1

連続で失礼します。

個人的に興味もありましたので、ChromeWebDriverで挑戦してみましたところ、以下の方法でうまくいきました。

環境は以下のとおりです。（その他は前の回答と同じ）

• ChromeDriver 2.16
• Chrome 43.0.2357.130 m (64-bit)

---

そもそもで、Codeceptionが依存しているphp-webdriverがmobileEmulationに対応していないようですので、そこを考慮する必要がありました。

まず、php-webdriverに含まれているChromeOptionsを拡張したクラスを用意します。

<?php
class ExtendedChromeOptions extends \ChromeOptions
{
    protected $mobileEmulation;

    public function setMobileEmulation($mobileEmulation)
    {
        $this->mobileEmulation = $mobileEmulation;
    }

    public function toArray()
    {
        $options = parent::toArray();
        $options['mobileEmulation'] = $this->mobileEmulation;
        return $options;
    }
}

次に、先ほど回答させていただいたAcceptanceHelperのloadFirefoxProfileをChromeに対応します。

<?php
namespace Codeception\Module;

class AcceptanceHelper extends \Codeception\Module\WebDriver
{
    protected function loadFirefoxProfile()
    {
        if (isset($this->config['capabilities']['userAgent'])) {
            if ($this->config['browser'] === 'firefox') {
                $profile = new \FirefoxProfile();
                $profile->setPreference(
                  'general.useragent.override',
                  $this->config['capabilities']['userAgent']
                );
                $this->capabilities['firefox_profile'] = $profile->encode();
            } else if ($this->config['browser'] === 'chrome') {
                $mobileEmulation = [
                    'userAgent' => $this->config['capabilities']['userAgent']
                ];
                $options = new \ExtendedChromeOptions();
                $options->setMobileEmulation($mobileEmulation);
                $this->capabilities[\ChromeOptions::CAPABILITY] = $options->toArray();
            }
        } else {
            parent::loadFirefoxProfile();
        }
    }
}

（もはや、処理内容が「loadFirefoxProfile」という命名とはずれてますが、適した場所がここしかないので。。。。）

最後に、acceptance.suite.ymlはbrowserを firefox -> chrome に変更するのみですので、割愛します。

試してはいませんが、deviceMetricsなんかも設定できそうな雰囲気が致します。

以上です。参考になさってください。

Comments

[退会済みユーザー]

回答いただきありがとうございました！
無事ユーザエージェントの変更に成功しました！

また、ヘルパークラスの使用方法についても理解が深まりました。
本当にありがとうございました。

[piccagliani]

早速試していただき、ありがとうございました！
お役に立ててうれしいです！

Answer 2

こんにちは。

質問にあるChromeWebDriverではないですが、、、、FirefoxWebDriverでユーザーエージェントの切り替えを行うことができましたので共有します。

私の環境は以下のとおりです。

• Windows 8.1
• PHP 5.5.15
• Codeception 2.0.15
• Selenium Standalone Server 2.44.0
• Firefox Developer Edition 40.0a2 (2015-05-28)

---

まず、WebDriverモジュールのloadFirefoxProfileメソッドを tests/support/AcceptanceHelper.php でオーバーライドします。

<?php
namespace Codeception\Module;

class AcceptanceHelper extends \Codeception\Module\WebDriver
{
    protected function loadFirefoxProfile() {
        if (isset($this->config['capabilities']['userAgent'])) {
            $profile = new \FirefoxProfile();
            $profile->setPreference(
                'general.useragent.override',
                $this->config['capabilities']['userAgent']
            );
            $this->capabilities['firefox_profile'] = $profile->encode();
        } else {
            parent::loadFirefoxProfile();
        }
    }
}

（オリジナルのloadFirefoxProfileでは、ファイルシステム上のプロファイルを読み込む実装になっているため、プロファイルを用意してもいいのかもしれませんが、暗号化が必要など、手間がかかりそうでした。。。。）

次に、acceptance.suite.ymlを少し変更します。

class_name: AcceptanceTester
modules:
    enabled: [AcceptanceHelper]  # ←WebDriverをAcceptanceHelperに変更
    config:
      AcceptanceHelper:  # ←WebDriverをAcceptanceHelperに変更
        url: 'http://test.host.jp'
        browser: firefox
        capabilities:
          userAgent: "Mozilla/5.0 (iPhone; CPU iPhone OS 8_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12F70 Safari/600.1.4"

---

urlをhttp://www.google.co.jpに設定すると、スマホ用の画面が表示されることを確認しました。試してみてください。

なお、もしすでにAcceptanceHelperにかなり手が入っていていじることができない、という場合は別のクラスを定義してそちらでloadFirefoxProfileをオーバーライドすれば大丈夫だと思います。（合わせてsuite設定もそのクラスに合わせて変更します）

テストが順調にいくことをお祈りしてます！

Comments

[退会済みユーザー]

firefoxについても無事成功しました。ありがとうございました！