【Cloud Functions】デプロイ直前にランタイム環境変数を利用した関数のテストは出来ない、のかもしれない

はじまり#

リサちゃん

あれー？　テストがうまく通らないぞー？

135ml

デプロイ前のテストですね

リサちゃん

この環境変数を読み取らないと先に進まないんだが・・・

135ml

Noneになってるね

※当ページはアフィリエイト広告を利用しています。

まず、何が起きてるんだ#

最近（2024/04/26 ぐらいですかね）、 Python で書いた関数を Google Cloud のコンソールから、 Cloud Functions としてデプロイしようとした時の話です。

今回の事象は、 Python 3.10、 Python 3.12 および Go 1.22 のランタイムで確認しました。

まあ、コンソールで Cloud Functions を開いて新しい関数を作成し始めると、こんな画面になりますよね。

そしたら、ランタイム環境変数を設定します。

そして、こんな風に関数を打ち込みます。　今回は、テストとして実行するためにこんな記述とします。

1
import functions_framework
2
import os
3

4
@functions_framework.http
5
def hello_http(request):
6
    """HTTP Cloud Function.
7
    Args:
8
        request (flask.Request): The request object.
9
        <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
10
    Returns:
11
        The response text, or any set of values that can be turned into a
12
        Response object using `make_response`
13
        <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
14
    """
15
    request_json = request.get_json(silent=True)
16
    request_args = request.args
17

18
    vari = os.getenv("TEST_ENV")
19
    print(vari)
20
    vari = os.environ.get("TEST_ENV")
21
    print(vari)
22
    vari = os.environ["TEST_ENV_2"]
23
    print(vari)
24

25

26
    if request_json and 'name' in request_json:
27
        name = request_json['name']
28
    elif request_args and 'name' in request_args:
29
        name = request_args['name']
30
    else:
31
        name = 'World'
32
    return 'Hello {}!'.format(name)

そして、「関数をテスト」をクリックして、ビルドのち直前のリクエストテストをしますよね・・・あれっ・・・。

すると、こんな感じのエラーメッセージが表示されます。os.environの返り値はdict型なので、環境変数にキーがないとKeyErrorを吐き出します。

1
Traceback (most recent call last):
2
  File "/layers/google.python.pip/pip/lib/python3.10/site-packages/flask/app.py", line 1473, in wsgi_app
3
    response = self.full_dispatch_request()
4

5
  // ...略
6

7
  File "/workspace/main.py", line 22, in hello_http
8
    vari = os.environ["TEST_ENV_2"]
9
  File "/layers/google.python.runtime/python/lib/python3.10/os.py", line 680, in __getitem__
10
    raise KeyError(key) from None
11
KeyError: 'TEST_ENV_2'

えーと、確かにランタイム環境変数は設定したはずですが・・・

はて？

デプロイ後に再度テストをしてみる#

エラーになってしまいましたが、意に介さずにデプロイしてみます。

はい、デプロイが終わったら、もう一度リクエストのテストをしてみます。

実行すると、今回は特にエラーも起きず、ちゃんとレスポンスが返ってきます。

右下を見ると、環境変数を取得した事が分かるログも出力されていますね。

そういう仕様ということだろうか・・・#

以下の、コンソールを介して関数をデプロイするドキュメントや、環境変数を設定する部分のドキュメントなどを読んでは見ましたが、デプロイ前に環境変数を取得できないとは書いてないんですね。（ビルドは終わってるんですけどね。）

Google Cloud Documentation

クイックスタート: gcloud CLI で Cloud Run functions の関数をデプロイする | Google Cloud Documentation

gcloud CLI を使用して Cloud Run functions の HTTP 関数のサンプルをデプロイする方法について説明します。

docs.cloud.google.com

Google Cloud Documentation

サービスの環境変数を構成する | Cloud Run | Google Cloud Documentation

Google Cloud コンソールまたは gcloud CLI を使用して Cloud Run サービスの環境変数を構成する方法について説明します。

docs.cloud.google.com

そして、その環境変数のドキュメントに、 Cloud Functions でデフォルトで予約されている環境変数のキーがあるそうなので、その環境変数は取得できないのかどうかも調べてみました。

デフォルトで予約されている環境変数は取得できるのか#

2024/04/29 時点で Cloud Functions で自動的に設定されるランタイム環境変数のキーは以下のとおりです。

ビルド直後でデプロイ直前にテストをするとこんな感じになります。

FUNCTION_TARGET、FUNCTION_SIGNATURE_TYPEおよびPORTと、 3 種類のキーは取得できましたが、K_SERVICEおよびK_REVISIONのキーは取得できませんでした。

デプロイ後にテストをするとこんな感じで、全てのキーが取得できています。

うーん、不思議だ。

まとめ#

この記事では、 Cloud Functions のデプロイ前にランタイム環境変数が取得できなかったことについて解説しました。

• Google Cloud Functions でユーザーが設定したランタイム環境変数は、デプロイ後にのみ取得可能。
• 一部の自動的に設定されるランタイム環境変数は取得可能だが、全てではない。

Secret Manager などを噛ませれば、デプロイ直前にシークレットを使ったテストが出来るんでしょうけど。

まあ、それが面倒だからランタイム環境変数に設定しているのであって、この仕様には疑問でした・・・。

プログラミングのお供に#

おしまい#

リサちゃん

じゃあ、デプロイ前はテストできないじゃん。

135ml

環境変数ってよく使うんだけどな。

以上になります！