開発を進めていると管理しなければならない環境変数が多くなってきます。
k6でも同じ話が起きがちなのです。
本記事では環境変数の管理をする上でk6の拡張機能のxk6-dotenv
が便利なので、これを紹介します。
xk6-dotenv: https://github.com/szkiba/xk6-dotenv
前提
xk6のinstallを未実施の方は、まずはこちらの環境構築から始めましょう。
goの環境がない方は、別途環境構築をお願いいたします。
xk6-dotenvのinstall
以下のコマンドで、k6コマンドをビルドしましょう。
TypeScriptで開発している関係上、xk6-tsもinstallしています。
使い方
プロジェクトのルートディレクトリに.envファイルを準備します。
ref: https://github.com/gonkunkun/k6-template/blob/main/.env.sample
__ENV
を利用して、好きな場所から環境変数を読み込みましょう。
ref: https://github.com/gonkunkun/k6-template/blob/main/src/sample-product/common/env.ts
以上です!
k6実行時に、.envファイルの中身を読み込んで、環境変数に自動的に突っ込んでくれます。
余談
こんなに利用しやすくなったのはつい最近のことです。
2024/04/02にアップデートがありました。
https://github.com/szkiba/xk6-dotenv/releases/tag/v0.2.0
それまでは、以下の要領でファイルを読み込む処理を噛ませる必要がありました。
アプデにより、この処理入れなくても、自動的に環境変数としてロードしてくれるようになりましたあ。
以前のバージョンの拡張機能を利用されている方は、以下のようなエラーが出ると思います。
以下のようなPR例に従って修正しましょう。
PR: https://github.com/gonkunkun/k6-template/pull/5
短いですが以上です。
良いk6ライフを!