More than 3 years have passed since last update.

Jestによるテスト実行時のタイムゾーンを固定する

Posted at 2020-01-02

タイムゾーンによるテストへの影響

Jestを使って現在時刻の表示処理のようなテストをする場合、タイムゾーンが問題となるケースがあります。これは、開発に使うPCのタイムゾーンと、テストを実行するCIのタイムゾーンが異なるケースがあるためです。

例えば、開発用マシンは日本標準時(UTC+9)になっているのに対し、CircleCIやTravisCIなどのタイムゾーンがUTC+0だと、テストで得られる結果が異なり、どちらか一方で行われたテストが失敗することがあります。

Jestでテストを実行する際に、環境に依存することなく明示的にタイムゾーンを指定する場合は、 globalSetup で process.env.TZ を指定すれば良いです。具体的には以下のように設定します。

package.json

{
  "jest": {
    "globalSetup": "./jest-global-setup.js"
  }
}

(上は package.json を例としていますが、 jest.config.js を使用している場合も設定方法は同様です)

jest-global-setup.js

module.exports = async () => {
  process.env.TZ = 'Asia/Tokyo'; // 固定したい任意のタイムゾーンを指定
};

なお、蛇足ではありますが、 CircleCIの場合はコンテナのタイムゾーンを指定する方法もあるので、このアプローチを使うこともできます。