🏃 技術調査 - Runn

export RUNN_VERSION=X.X.X
curl -o runn.deb -L https://github.com/k1LoW/runn/releases/download/v$RUNN_VERSION/runn_$RUNN_VERSION-1_amd64.deb
dpkg -i runn.deb

export RUNN_VERSION=X.X.X
yum install https://github.com/k1LoW/runn/releases/download/v$RUNN_VERSION/runn_$RUNN_VERSION-1_amd64.rpm

export RUNN_VERSION=X.X.X
curl -o runn.apk -L https://github.com/k1LoW/runn/releases/download/v$RUNN_VERSION/runn_$RUNN_VERSION-1_amd64.apk
apk add runn.apk

docker container run -it --rm --name runn -v $PWD:/books ghcr.io/k1low/runn:latest list /books/*.yml

go get github.com/k1LoW/runn

# HTTP シナリオを生成して実行
runn new --and-run --desc 'httpbin.org GET' --out http.yml -- curl https://httpbin.org/json -H "accept: application/json"

# gRPC シナリオを生成して実行
runn new --and-run --desc 'grpcb.in Call' --out grpc.yml -- grpcurl -d '{"greeting": "alice"}' grpcb.in:9001 hello.HelloService/SayHello

# ランブック一覧を表示
runn list path/to/**/*.yml

# 実行結果
  id:      desc:             if:       steps:  path
-------------------------------------------------------------------------
  a1b7b02  Only if included  included       2  p/t/only_if_included.yml
  85ccd5f  List projects.                   4  p/t/p/list.yml

# ランブックをまとめて実行
runn run path/to/**/*.yml

# 実行結果
S....
5 scenarios, 1 skipped, 0 failures

desc: シナリオの説明
runners:
  req: https://example.com       # HTTP ランナー
  db: mysql://user:pass@host/db  # DB ランナー
vars:
  username: alice
  password: ${TEST_PASS}         # 環境変数参照
steps:
  - desc: ステップの説明
    req:
      /users:
        post:
          headers:
            Authorization: 'Bearer xxxxx'
          body:
            application/json:
              username: "{{ vars.username }}"
    test: |
      current.res.status == 201

runners:
  req: https://example.com
steps:
  - req:
      /users:
        post:
          headers:
            Authorization: 'Bearer xxxxx'
          body:
            application/json:
              username: alice
    test: |
      current.res.status == 201

runners:
  greq:
    addr: grpc.example.com:8080
    tls: true
    cacert: path/to/cacert.pem
    cert: path/to/cert.pem
    key: path/to/key.pem
steps:
  - greq:
      grpctest.GrpcTestService/Hello:
        headers:
          authentication: tokenhello
        message:
          name: alice
          num: 3

runners:
  db: postgres://dbuser:dbpass@hostname:5432/dbname
steps:
  - desc: ユーザー一覧を取得
    db:
      query: SELECT * FROM users;
      trace: false
    test: |
      len(current.rows) > 0

runners:
  cc: chrome://new
steps:
  - desc: ページ遷移してテキスト取得
    cc:
      actions:
        - navigate: https://pkg.go.dev/time
        - click: 'body > header > div.go-Header-inner > nav > div > ul > li:nth-child(2) > a'
        - waitVisible: 'body > footer'
        - text: 'h1'
    test: |
      current.text != ""

runners:
  sc: ssh://username@hostname:port
steps:
  - desc: リモートホスト名を取得
    sc:
      command: hostname
    test: |
      current.exit_code == 0

runners:
  sc:
    hostname: hostname
    user: username
    port: 22
    localForward: '33306:127.0.0.1:3306'

steps:
  - exec:
      command: echo "hello world"
      shell: bash
    test: |
      current.exit_code == 0
  - exec:
      command: grep hello
      stdin: '{{ steps[0].res.rawBody }}'

steps:
  - desc: 条件付きステップ
    if: vars.env == "production"
    req:
      /health:
        get:
          body: null
  - desc: 結果を変数にバインド
    bind:
      user_id: steps[0].res.body.id
  - desc: 変数をダンプ
    dump: vars.user_id

steps:
  - req:
      /users:
        get:
          body: null
    test: |
      current.res.status == 200
      && len(current.res.body.users) > 0
      && current.res.body.users[0].name == "alice"
      && current.res.headers["Content-Type"][0] == "application/json"

func TestServer(t *testing.T) {
    ts := httptest.NewServer(myHandler)
    t.Cleanup(ts.Close)

    opts := []runn.Option{
        runn.T(t),
        runn.Runner("req", ts.URL),
        runn.DBRunner("db", dbConn),
    }
    o, err := runn.Load("testdata/**/*.yml", opts...)
    if err != nil {
        t.Fatal(err)
    }
    if err := o.RunN(ctx); err != nil {
        t.Fatal(err)
    }
}

runn loadt --load-concurrent 10 path/to/**/*.yml

$ runn run path/to/**/*.yml --label users --label projects
$ runn run path/to/**/*.yml --id a1b7b02

# 最大並列数を指定して実行
$ runn run --concurrent --max-concurrent 4 path/to/**/*.yml

# シャードで分散実行（CI の並列ジョブに有効）
$ runn run --shard 3/1 path/to/**/*.yml  # 3分割の1番目
$ runn run --shard 3/2 path/to/**/*.yml  # 3分割の2番目

# 最初のエラーで停止
$ runn run --fail-fast path/to/**/*.yml

# ランダム順序で実行（再現性のためシードを指定可）
$ runn run --shuffle --seed 12345 path/to/**/*.yml

# サンプリング実行
$ runn run --sample 5 path/to/**/*.yml

# テストアサーションをスキップして動作確認のみ
$ runn run --skip-test path/to/**/*.yml

$ env RUNN_RUN=login go test ./...
$ env RUNN_SCOPES=read:parent,read:remote runn run path/to/**/*.yml

$ runn run path/to/**/*.yml --scopes read:parent,read:remote
$ runn run path/to/**/*.yml --scopes '!read:parent'  # 無効化

secrets:
  - vars.secret_token
  - binded_password
  - current.res.message.token

vars:
  token: ${SECRET_TOKEN}

name: API Scenario Tests
on:
  push:
    branches: [main]
  pull_request:
jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        shard: ["2/1", "2/2"]
    steps:
      - uses: actions/checkout@v4
      - name: Install runn
        run: |
          brew install k1LoW/tap/runn
      - name: Run API tests
        run: |
          runn run --fail-fast --shard ${{ matrix.shard }} testdata/**/*.yml
      - name: Coverage report
        if: always()
        run: |
          runn run --coverage testdata/**/*.yml

$ runn run --coverage path/to/**/*.yml

$ runn loadt --load-concurrent 2 --max-rps 10 path/to/*.yml

Number of runbooks per RunN....: 15
Duration (--duration)..........: 10s
Concurrent (--load-concurrent).: 2
Max RunN per second (--max-rps): 10

Total..........................: 12
Succeeded......................: 12
Failed.........................: 0
Error rate.....................: 0%
RunN per seconds...............: 1.2
Latency .......................: max=1835ms min=1451ms avg=1627ms p90=1741ms p99=1788ms

$ runn loadt --threshold 'error_rate < 10' path/to/*.yml

# 計測
$ runn run testdata/books/login.yml --profile

# 結果確認
$ runn rprof runn.prof
  runbook[login site](t/b/login.yml)           2995.72ms
    steps[0].req                                747.67ms
    steps[1].req                                185.69ms
    [total]                                    2995.84ms

debug: true

$ runn run --debug path/to/**/*.yml

$ runn run path/to/**/*.yml --capture path/to/dir

opts := []runn.Option{
    runn.T(t),
    runn.Capture(capture.Runbook("path/to/dir")),
}

trace: true

steps:
  waitingroom:
    loop:
      count: 10
      until: 'steps.waitingroom.res.status == "201"'
      minInterval: 500ms
      maxInterval: 10
    req:
      /cart/in:
        post:
          body:
            application/json:
              item_id: "{{ vars.item_id }}"

loop: 10
steps:
  - req:
      /items:
        get:
          body: null

concurrency: use-shared-db

concurrency:
  - use-shared-db
  - use-shared-api

runners:
  req: https://api.example.com
hostRules:
  - from: api.example.com
    to: staging.api.example.com

steps:
  cleanup:
    force: true
    dump: previous.res.body