AWS SDK のスタブを使って awspec の generator サンプルを試作するメモ

時代はスタブ
さて、今回は
- awspec の generator
- CloudWatch Logs の Generator を作るにあたって
ということで
- ここでスタブ
- サンプルを実装してみました
おわり
- 言いたかったこと

時代はスタブ

AWS SDK を使ってツールを作ったりする場合、動作確認で直接リソースに対してアクセスしていいのは 30 代まで。40 代はリソースへのアクセスを止めてスタブを使いたいところです。

Client Response Stubs | AWS Developer Blog

ということで、上記の記事を参考にして awspec の generator サンプルを試作したいと思います。

さて、今回は

awspec の generator

awspec には既存のリソースの状態を書き出してくれる generator という機能があり、以下のように実行することで各リソースの状態を spec ファイルに書き出してくれます。

$ awspec generate ec2 vpc-ab123cde >> spec/ec2_spec.rb

詳細については、以下の記事をご一読ください。

qiita.com

awspec の各リソースタイプにおける generator 実装は以下のようにとてもシンプルに出来ています（と勝手に思っていますが、間違っていたらすいません）。

describe や list 系のメソッドで対象となるリソースを全件取得する
取得したリソース情報を ERB を使って spec ファイルに書き出している

CloudWatch Logs の Generator を作るにあたって

以下の点について検討しました。

#describe_log_groups は一回で最大 50 件しか情報を取得出来ない（50 件以上あれば next_token を使って、次のリクエストを生成しなければいけない）
50 件以上の情報を CLI やマネジメントコンソールで作るのはめんどくさい（limit オプションを使えば、任意の件数毎に取得出来る）

ということで

ここでスタブ

AWS SDK for Ruby のスタブは aws-sdk-core を導入すれば利用出来るようです。

以下のようにインスタンスを生成する際のオプションとして stub_responses: true を付与するだけ。簡単ですな。

require 'aws-sdk'

cw_logs_client = Aws::CloudWatchLogs::Client.new(stub_responses: true)
p cw_logs_client

実行するとレスポンスが得られます。

$ bundle exec ruby sample.rb
#<Aws::CloudWatchLogs::Client>

例えば、#describe_log_groups のレスポンスをスタブで返したい場合には以下のように書きます。

require 'aws-sdk'

cw_logs_client = Aws::CloudWatchLogs::Client.new(stub_responses: true)
cw_logs_client.stub_responses(:describe_log_groups,
  log_groups:[{log_group_name:'log1'},{log_group_name:'log2'},{log_group_name:'log3'}], next_token: '12345'
)

res = cw_logs_client.describe_log_groups
p res

実行すると以下のようなレスポンスが得られます。

$ bundle exec ruby test3.rb
#<struct Aws::CloudWatchLogs::Types::DescribeLogGroupsResponse log_groups=[#<struct Aws::CloudWatchLogs::Types::LogGroup log_group_name="log1", creation_time=nil, retention_in_days=nil, metric_filter_count=nil, arn=nil, stored_bytes=nil>, #<struct Aws::CloudWatchLogs::Types::LogGroup log_group_name="log2", creation_time=nil, retention_in_days=nil, metric_filter_count=nil, arn=nil, stored_bytes=nil>, #<struct Aws::CloudWatchLogs::Types::LogGroup log_group_name="log3", creation_time=nil, retention_in_days=nil, metric_filter_count=nil, arn=nil, stored_bytes=nil>], next_token="12345">

ちゃんと、それっぽいレスポンスを返せているようです。

サンプルを実装してみました

スタブを利用して以下のようなサンプルを実装してみました。

#!/usr/bin/env ruby

require 'aws-sdk'
require 'erb'

cw_logs_client = Aws::CloudWatchLogs::Client.new(stub_responses: true)
cw_logs_client.stub_responses(:describe_log_groups,
  { log_groups:[{log_group_name:'log1'},{log_group_name:'log2'},{log_group_name:'log3'}], next_token: '12345' },
  { log_groups:[{log_group_name:'log4'},{log_group_name:'log5'}] }
)

# refer to: https://github.com/k1LoW/awspec/blob/master/lib/awspec/helper/finder/ecs.rb#L24-L34
req = {}
log_groups = []
loop do
  res = cw_logs_client.describe_log_groups(req)
  log_groups.push(*res.log_groups)
  break if res.next_token.nil?
  req[:next_token] = res.next_token
end

template = <<-'EOF'
<% log_groups.each do |log_group| %>
describe cloudwatch_logs('<%= log_group.log_group_name %>') do
  it { should exist }
<%- unless log_group.retention_in_days == nil -%>
  its(:retention_in_days) { should eq '<%= log_group.retention_in_days %>' }
<% end -%>
end
<% end %>
EOF
puts ERB.new(template, nil, '-').result(binding).chomp

実行すると以下のように出力されます。

$ bundle exec ruby sample.rb

describe cloudwatch_logs('log1') do
  it { should exist }
end

describe cloudwatch_logs('log2') do
  it { should exist }
end

describe cloudwatch_logs('log3') do
  it { should exist }
end

describe cloudwatch_logs('log4') do
  it { should exist }
end

describe cloudwatch_logs('log5') do
  it { should exist }
end

ちゃんと next_token によるページ送りの処理も動作確認できました。

このサンプルを利用して awspec の generator に実装を加えていきたいと思います。

おわり

言いたかったこと

40 代からはスタブを使いましょう
スタブはインスタンス作成時に stub_responses: true だけで簡単に使えます
スタブで返したいレスポンスの内容はドキュメントを参照しましょう

ようへいの日々精進XP

よかろうもん