Redisアクション

Redisアクションは、RedisまたはValkeyのサーバーでコマンドを実行し、その応答を返します。APIがキャッシュやセッションストアに残したものを、ワークフローから確かめられます。

外部アクションとしてmozership/probe-redis で公開しています。ワークフローが初めて使うときにProbeがダウンロードし、固定したコミットのaction.ymlが示すSHA-256と一致する実行ファイルだけを実行します。Probe v1.21.0以降が必要です。

基本的な構文

ワークフローでは40文字のコミットSHAでアクションを固定します。各リリース のノートの先頭に、コピーして使うアクションとコミットがあります。このページの例では、actionsで一度だけ名前を付けています。actionsにはProbe v1.24.0以降が必要です。それより前のProbeでは、各usesにアクションを完全な形で書きます。

name: Session
actions:
  redis: github.com/mozership/probe-redis@7d60e0699a914e3c987ed5f2403ed8a7f3d176fa # v0.1.0
jobs:
  - name: session
    steps:
      - name: Sign in
        id: login
        uses: http
        with:
          url: https://api.example.com
          post: /login
          body: {user: ada, password: "{{vars.password}}"}
        test: res.code == 200
        outputs:
          session: res.body.session_id
 
      - name: The session is in the store, and expires
        uses: redis
        with:
          url: redis://cache.example.com:6379/0
          password: "{{vars.redis_password}}"
          commands:
            - [HGET, "session:{{outputs.login.session}}", user]
            - [TTL, "session:{{outputs.login.session}}"]
        test: status == 0 && res.results[0] == "ada" && res.results[1] > 0

ステップごとに新しい接続を開き、commandsを順に実行して閉じます。そのため、接続に属する状態は次のステップに引き継がれません。トランザクションや、HELLO 3とそれに続くコマンドは、1つのステップにまとめて書きます。

パラメータ

これら以外のキーをwithに書くと、何も送らずにステップが失敗します。action.ymlがこれらをparamsとして宣言しているので、probe checkはそのようなキーを行番号つきで報告します。

URLまたはwithにユーザー名かパスワードがあれば、アクションはコマンドの前にAUTHで認証し、URLがデータベースを指定していればそれを選択します。Probeは、ステップを表示するすべての箇所でpasswordの値を伏せます。v1.24.0以降はurlの中のパスワードも伏せます。

アクションが接続するのは、URLが指す1台のサーバーだけです。クラスタのMOVEDとASKのリダイレクトは追わず、センチネルにマスターを問い合わせることもしません。そのようなリダイレクトは、ほかと同じエラー応答として扱います。

コマンド

commandsの各項目が1つのコマンドで、2つの書き方があります。

リストの書き方は引用符が要らないので、テンプレートから来る値にはこちらを使います。

次のコマンドは実行しません。

• AUTHと、AUTHを付けたHELLO。ユーザー名とパスワードは、コマンドと一緒に表示されないように、urlかusernameとpasswordで指定します。
• SUBSCRIBE、PSUBSCRIBE、SSUBSCRIBE、MONITOR、SYNC、PSYNC、CLIENT REPLY。アクションはコマンドごとに1つの応答を読みますが、これらはサーバーが1つの応答で答えないためです。

レスポンスオブジェクト

応答は次のような値になります。

UTF-8でない文字列は、{"base64": "//4="}のように、バイト列をbase64で持つオブジェクトになります。

HELLO 3がなければサーバーはRESP2で答えます。RESP2ではマップがキーと値を交互に並べたリストになるので、nameとageを持つハッシュのHGETALLは["name", "Ada", "age", "36"]です。同じステップで先にHELLO 3を送ると、{"name": "Ada", "age": "36"}として受け取れます。

steps:
  - name: A hash as an object
    uses: redis
    with:
      url: redis://localhost:6379
      commands:
        - HELLO 3
        - [HGETALL, "user:1"]
    test: res.results[1].name == "Ada"

res.errorsの各項目には次のプロパティがあります。

サーバーに接続できた後は、サーバーが返したものはすべて結果なので、テストでエラーを確かめられます。エラーがあってもステップは止まりません。後続のコマンドも実行し、その応答はres.resultsのそれぞれの位置に入ります。

steps:
  - name: The key is not a list
    uses: redis
    with:
      url: redis://localhost:6379
      commands:
        - [SET, greeting, hello]
        - [LPUSH, greeting, x]
        - [GET, greeting]
    test: |
      status == 1 &&
      res.results == ["OK", nil, "hello"] &&
      res.errors[0].index == 1 && res.errors[0].code == "WRONGTYPE"

アクション自身のAUTHやSELECTをサーバーが拒否した場合、コマンドは送りません。res.resultsは空で、res.errorsには番号が-1のエラーが1つ入ります。

エラーとして失敗するのは、サーバーと通信できなかったステップだけです。接続の拒否、信頼できない証明書、サーバーによる切断、アクションが読める大きさを超えた応答（16 MiBの文字列、または1,048,576項目のリスト）、タイムアウトがこれにあたります。

ガードの下での動作

このアクションは実行のガードを守り、action.ymlでguard: [read-only, allow-host]を宣言しています。そのため、どちらの下でも--allow-actionなしで実行されます。アクションが拒否したステップは、接続する前に種別refusedで失敗します。

• --read-onlyの下では、すべてのコマンドが読み取りだけと分かっているステップだけを実行します。そうでなければステップ全体を拒否し、拒否のメッセージにコマンドを示します。
• --allow-hostの下では、urlのホストとポートが、実行で許可されている必要があります。ポートのないURLは6379として扱います。アクションはほかのホストには接続しません。

読み取りだけと分かっているコマンドは次のとおりです。STOREを付けたSORTのように、書き方によって読み取りにも書き込みにもなるコマンドは含みません。コマンドから効果を判定できないスクリプトと関数も含みません。_ROの形があるものは、そちらを使ってください。

OBJECT、MEMORY、XINFO、CLIENT、COMMAND、PUBSUBはHELPも受け付けます。JSON.GETやFT.SEARCHのようなモジュールのコマンドはアクションが知らないので、それを使うステップは--allow-actionで許可する必要があります。

ガードを参照してください。

関連項目

• 外部アクション - Probeが外部アクションを解決し、照合する仕組み
• Database - MySQL、PostgreSQL、SQLiteへのクエリ
• S3 - S3とS3互換ストレージのオブジェクト