Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 2.7 KB

README.md

File metadata and controls

116 lines (80 loc) · 2.7 KB

awspec Gem Travis Scrutinizer Gemnasium

RSpec tests for your AWS resources.

Installation

Add this line to your application's Gemfile:

gem 'awspec'

And then execute:

$ bundle

Or install it yourself as:

$ gem install awspec

Usage

1. Generate awspec init files

$ awspec init

2. Set AWS credentials

2-1. Use Shared Credentials

$ aws configure

...

$ export AWS_REGION='ap-northeast-1'

2-2. Use spec/secrets.yml

$ cat <<EOF > spec/secrets.yml
region: ap-northeast-1
aws_access_key_id: XXXXXXXXXXXXXXXXXXXX
aws_secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
EOF

3. Write spec/*_spec.rb

describe ec2('my-ec2-tag-name') do
  it { should be_running }
  its(:instance_id) { should eq 'i-ec12345a' }
  its(:image_id) { should eq 'ami-abc12def' }
  its(:public_ip_address) { should eq '123.0.456.789' }
  it { should have_security_group('my-security-group-name') }
  it { should belong_to_vpc('my-vpc') }
  it { should belong_to_subnet('subnet-1234a567') }
  it { should have_eip('123.0.456.789') }
end

4. Run tests

$ bundle exec rake spec

Advanced Usage: Spec generate command

Generate spec from AWS resources already exists.

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

Support AWS Resources

  • EC2 (ec2)
  • RDS (rds)
    • RDS DB Parameter Group (rds_db_parameter_group)
  • Security Group (security_group)
  • VPC (vpc)
  • S3 (s3)
  • Route53
    • Route53 Hosted Zone (route53_hosted_zone)
  • AutoScaling
    • Auto Scaling Group (auto_scaling_group)
  • Subnet (subnet)
  • RouteTable (route_table)
  • EBS Volume

Next..

  • IAM
  • ...

TODO

  • Comment format for Document generation
  • Spec generate command

Contributing

  1. Fork it ( https://github.com/k1LoW/awspec/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

References

awspec is inspired by Serverspec.