PHPStorm 远端执行单元测试

我的团队在开发阶段中，习惯以 rsync 将本机上的程式码同步至 测试机 上运行。

因此替功能撰写测试案例后，必须经过一些设定才能 远端执行测试案例。

以下将提供 PHPStorm 远端执行测试案例 配置步骤，包含：

新增远端部署（Development） 设定新增远端 PHP CLI 执行器 (Interpreter)新增一个远端调试器（Debugger）

---

1. 新增远端部署（Development） 设定

第一个步骤是设定远端部署，主要目的有两个：

让 PHPStorm 可以透过 ssh 连接至远端伺服器（测试机），执行测试案例。设定专案路径配对，让 PHPStorm 可以对应「你的本机程式码位置」与「测试机程式码位置」。

只要配对好 Development 设定，PHPStorm 就可以直接在测试机上执行 你所指定的测试案例（后面会示範）。

1.1 打开远端部署（Development）设定介面

远端部署（Development）的打开步骤依序为：Tools>Development>Configuration：

1.2 设定 ssh 连线资讯

打开远端部署（Development）设定介面后，你会看见预设第一个页籤为 Connection。

Connection 页籤要设定的是如何让 PHPStorm 连线登入至远端伺服器（测试机），
以下是必要设定说明：

Type：选择 SFTPHost：要连接的 Domain NameUser name：登入远端伺服器的 UserAuthentication：ssh 认证方式（可参考 SSH 公开金钥认证）Private key path：私钥位置 （可参考 SSH 公开金钥认证）Root path：远端伺服器中，专案的根目录路径（此为远端伺服器上的绝对路径）。此设定相当重要，用来对映本地与远端程式码。若没做好对映，后续 PHPStorm 会没办法辨认你要执行哪个测试案例。Web server URL：远端伺服器的对外 URL

1.3 设定专案档案对映（Mappings）资讯

Connection 页籤设定完成后，接着进入第二个页籤 Mappings。

Mappings 页籤用来设定「本机专案」与「远端专案」的档案对映关係。

必须设定的项目有：

Local path: 专案根目录路径（本机的绝对路径）Development path: 远端主机的专案根目录（注意，此为 Connection 页籤之 Root path 的相对路径）

完成档案对映资讯后，PHPStorm 就能辨认你的本机档案是对映至远端伺服器的哪个档案。

2. 新增远端 PHP CLI 执行器(Interpreter)

注意：执行此步骤前，必须元成第一个步骤 1.新增远端部署（Development）设定，否则无法进行下去。

此一步骤的目的是：让 PHPStorm 调用远端伺服器的 PHP 执行档 来启动 测试案例。

2.1 打开 PHP 设定页面

Mac：PHPStorm 左上角，依序点击 PHPStorm>Preferences>Language & Framework>PHPWindows：左上角，依序点击 >Files>Settings>Language & Framework>PHP

接着就能看见 PHP 设定页面：

2.2 打开新增 PHP-CLI Interpreter 的介面

于 2.1 打开 PHP 设定页面后，依照下图顺序，打开新增 PHP-CLI Interpreter 的介面：

2.3 设定 Remote PHP Interpreter

若按照步骤 2.2 操作，即可 PHPStorm 跳出新的视窗「Configuration Remote PHP Interpreter」。

这一步骤即需要完成两项设定：

设定 PHPStrom 如何连线至远端伺服器配置远端伺服器的 PHP 执行档 当作 CLI Interpreter。

若您已经完成 1.新增远端部署（Development）设定，则可以选择 Development Configuration 选项来替 PHPStrom 设定连线至远端伺服器的方式。

最后 PHP Interpreter path 则需填入 远端伺服器的 PHP 执行档 路径（实体路径）。

设定完成后，点击 OK。

此时回到原本 PHP 设定页面，若出现一个 Remote PHP xxx 的 CLI 设定档，即表设定成功。

3. 新增一个远端调试器（Debugger）

最后一个步骤，替测试案例新增一个远端调试器（Debugger）。

3.1 打开 Debugger 设定画面

打开 Debugger 设定画面，并点击 Edit Configuration：

3.2 打开测试框架的 Interpreter 设定画面

请一下图顺序，打开新增 PHPUnit 测试框架的 Remote Interpreter 画面。

3.3 设定 PHPUnit Remote Interpreter

若您已经完成 步骤2. 新增远端 PHP CLI 执行器(Interpreter)，则可以在 Interpreter 选单中选择刚刚建立的 Remote PHP xxx。

注意：上图中的 Default configuration file 是远端伺服器的 phpunit.xml 路径

3.4 设定完成

全部设定完成！
执行测试后，即可看见当前是在远端伺服器中执行测试：