cthiesfork-awspec 1.0.0

data/doc/_resource_types/redshift_cluster_parameter_group.md

@@ -0,0 +1,17 @@
+### first
+
+```ruby
+describe redshift_cluster_parameter_group('my-redshift-cluster-parameter-group') do
+  its(:datestyle) { should eq 'ISO, MDY' }
+  its(:query_group) { should eq 'default' }
+  its(:require_ssl) { should eq 'false' }
+end
+```
+
+### exist
+
+```ruby
+describe redshift_cluster_parameter_group('my-redshift-cluster-parameter-group') do
+  it { should exist }
+end
+```

data/doc/_resource_types/route53_hosted_zone.md

@@ -0,0 +1,27 @@
+### exist
+
+```ruby
+describe route53_hosted_zone('example.com.') do
+  it { should exist }
+end
+```
+
+### have_record_set
+
+```ruby
+describe route53_hosted_zone('example.com.') do
+  its(:resource_record_set_count) { should eq 6 }
+  it { should have_record_set('example.com.') }
+  it { should have_record_set('example.com.').type('a') }
+  it { should have_record_set('example.com.').a('123.456.7.890') }
+  it { should have_record_set('*.example.com.').cname('example.com') }
+  it { should have_record_set('example.com.').mx('10 mail.example.com') }
+  it { should have_record_set('mail.example.com.').a('123.456.7.890').ttl(3600) }
+  ns = 'ns-123.awsdns-45.net.
+ns-6789.awsdns-01.org.
+ns-2345.awsdns-67.co.uk.
+ns-890.awsdns-12.com.'
+  it { should have_record_set('example.com.').ns(ns) }
+  it { should have_record_set('s3.example.com.').alias('s3-website-us-east-1.amazonaws.com.', 'Z2ABCDEFGHIJKL') }
+end
+```

data/doc/_resource_types/route_table.md

@@ -0,0 +1,60 @@
+### exist
+
+```ruby
+describe route_table('my-route-table') do
+  it { should exist }
+end
+```
+
+### have_route
+
+```ruby
+describe route_table('my-route-table') do
+  it { should have_route('10.0.0.0/16').target(gateway: 'local') }
+  it { should have_route('0.0.0.0/0').target(gateway: 'igw-1ab2345c') }
+  it { should have_route('192.168.1.0/24').target(instance: 'my-ec2') }
+  it { should have_route('192.168.2.0/24').target(vpc_peering_connection: 'my-pcx') }
+  it { should have_route('192.168.3.0/24').target(nat: 'nat-7ff7777f') }
+end
+```
+
+### have_subnet
+
+```ruby
+describe route_table('my-route-table') do
+  it { should have_subnet('my-subnet') }
+end
+```
+
+### have_tag
+
+```ruby
+describe route_table('my-route-table') do
+  it { should have_tag('Name').value('my-route-table') }
+end
+```
+
+### route_count
+```ruby
+describe route_table('my-route-table') do
+  its (:route_count) { should eq 10 }
+end
+```
+
+### advanced
+
+`route_table` can use `Aws::EC2::RouteTable` resource (see http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/RouteTable.html).
+
+```ruby
+describe route_table('my-route-table') do
+  its('vpc.id') { should eq 'vpc-ab123cde' }
+end
+```
+
+or
+
+```ruby
+describe s3_bucket('my-bucket') do
+  its('resource.vpc.id') { should eq 'vpc-ab123cde' }
+end
+```

data/doc/_resource_types/s3_bucket.md

@@ -0,0 +1,158 @@
+### exist
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it { should exist }
+end
+```
+
+### have_acl_grant
+
+```ruby
+describe s3_bucket('my-bucket') do
+  its(:acl_owner) { should eq 'my-bucket-owner' }
+  its(:acl_grants_count) { should eq 3 }
+  it { should have_acl_grant(grantee: 'my-bucket-owner', permission: 'FULL_CONTROL') }
+  it { should have_acl_grant(grantee: 'http://acs.amazonaws.com/groups/s3/LogDelivery', permission: 'WRITE') }
+  it { should have_acl_grant(grantee: '68f4bb06b094152df53893bfba57760e', permission: 'READ') }
+end
+```
+
+### have_cors_rule
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it do
+    should have_cors_rule(
+      allowed_methods: ['GET'],
+      allowed_origins: ['*']
+    )
+  end
+  it do
+    should have_cors_rule(
+      allowed_headers: ['*'],
+      allowed_methods: ['GET'],
+      allowed_origins: ['https://example.org', 'https://example.com'],
+      expose_headers:  ['X-Custom-Header'],
+      max_age_seconds: 3600
+    )
+  end
+end
+```
+
+### have_policy
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it do
+    should have_policy <<-POLICY
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "AllowPublicRead",
+      "Effect": "Allow",
+      "Principal": "*",
+      "Action": "s3:GetObject",
+      "Resource": "arn:aws:s3:::my-bucket/*"
+    }
+  ]
+}
+    POLICY
+  end
+end
+```
+
+### have_object
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it { should have_object('path/to/object') }
+end
+```
+
+### have_lifecycle_rule
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it do
+    should have_lifecycle_rule(
+      id: 'MyRuleName',
+      noncurrent_version_expiration: { noncurrent_days: 1 },
+      expiration: { days: 2 },
+      transitions: [{ days: 3, storage_class: 'GLACIER' }],
+      status: 'Enabled'
+    )
+  end
+
+  it do
+    should have_lifecycle_rule(
+      id: 'MyRuleName2',
+      prefix: '123/',
+      noncurrent_version_expiration: { noncurrent_days: 2 },
+      expiration: { days: 3 },
+      transitions: [{ days: 5, storage_class: 'STANDARD_IA' }, { days: 10, storage_class: 'GLACIER' }],
+      status: 'Enabled'
+    )
+  end
+end
+```
+
+### have_logging_enabled
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it { should have_logging_enabled(target_bucket: 'my-log-bucket', target_prefix: 'logs/') }
+end
+```
+
+### have_tag
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it { should have_tag('env').value('dev') }
+end
+```
+
+### have_versioning_enabled
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it { should have_versioning_enabled }
+end
+```
+
+### have_mfa_delete_enabled
+
+```ruby
+describe s3_bucket('my-bucket') do
+  it { should have_mfa_delete_enabled }
+end
+```
+
+### have_server_side_encryption
+
+```
+describe s3_bucket('my-bucket') do
+  it { should have_server_side_encryption(algorithm: "AES256") }
+  it { should have_server_side_encryption(algorithm: "aws:kms") }
+end
+```
+
+### advanced
+
+`s3_bucket` can use `Aws::S3::Bucket` resource (see http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Bucket.html).
+
+```ruby
+describe s3_bucket('my-bucket') do
+  its('acl.owner.display_name') { should eq 'my-bucket-owner' }
+end
+```
+
+or
+
+```ruby
+describe s3_bucket('my-bucket') do
+  its('resource.acl.owner.display_name') { should eq 'my-bucket-owner' }
+end
+```

data/doc/_resource_types/secretsmanager.md

@@ -0,0 +1,15 @@
+### exist
+
+```ruby
+describe secretsmanager('my-secret') do
+  it { should exist }
+end
+```
+
+### have_tag
+
+```ruby
+describe secretsmanager('my-secret') do
+  it { should have_tag('Name').value('my-secret') }
+end
+```

data/doc/_resource_types/security_group.md

@@ -0,0 +1,44 @@
+### exist
+
+```ruby
+describe security_group('my-security-group-name') do
+  it { should exist }
+end
+```
+
+### have_tag
+
+```ruby
+describe security_group('my-security-group-name') do
+  it { should have_tag('env').value('dev') }
+end
+```
+
+### its(:inbound), its(:outbound)
+
+```ruby
+describe security_group('my-security-group-name') do
+  its(:outbound) { should be_opened }
+  its(:inbound) { should be_opened(80) }
+  its(:inbound) { should be_opened(80).protocol('tcp').for('203.0.113.1/32') }
+  its(:inbound) { should be_opened(22).protocol('tcp').for('sg-5a6b7cd8') }
+end
+```
+
+### advanced
+
+`security_group` can use `Aws::EC2::SecurityGroup` resource (see http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/SecurityGroup.html).
+
+```ruby
+describe security_group('my-security-group-name') do
+  its('group_name') { should eq 'my-security-group-name' }
+end
+```
+
+or
+
+```ruby
+describe security_group('my-security-group-name') do
+  its('resource.group_name') { should eq 'my-security-group-name' }
+end
+```

data/doc/_resource_types/ses_identity.md

@@ -0,0 +1,17 @@
+### exist
+
+```ruby
+describe ses_identity('example.com') do
+  it { should exist }
+end
+```
+
+### have_dkim_tokens
+
+### have_identity_policy
+
+```ruby
+describe ses_identity('example.com') do
+  it { should have_identity_policy('my-identity-policy-name') }
+end
+```

data/doc/_resource_types/ses_send_quota.md

@@ -0,0 +1,9 @@
+### first
+
+```ruby
+describe ses_send_quota do
+  its(:max_24_hour_send) { should eq 200.0 }
+  its(:max_send_rate) { should eq 1.0 }
+  its(:sent_last_24_hours) { should eq 1.0 }
+end
+```

data/doc/_resource_types/sns_topic.md

@@ -0,0 +1,134 @@
+### Common arguments
+
+`topic_arn` is a string of the ARN of the SNS Topic.
+
+`subscribed` is a string of the SNS Topic subscription ARN.
+
+### exist
+
+```ruby
+describe sns_topic(topic_arn) do
+  it { should exist }
+end
+```
+
+### name
+
+```ruby
+describe sns_topic(topic_arn) do
+  its(:name) { should eq 'foobar' }
+end
+```
+
+### confirmed_subscriptions
+
+```ruby
+describe sns_topic(topic_arn) do
+  its(:confirmed_subscriptions) { should eq 1 }
+end
+```
+
+### pending_subscriptions
+
+```ruby
+describe sns_topic(topic_arn) do
+  its(:pending_subscriptions) { should eq 0 }
+end
+```
+
+### topic_arn
+
+```ruby
+describe sns_topic(topic_arn) do
+  its(:topic_arn) { should eq topic_arn }
+end
+```
+
+### display_name
+
+```ruby
+describe sns_topic(topic_arn) do
+  its(:display_name) { should eq 'ShortName' }
+end
+```
+
+### deleted_subscriptions
+
+```ruby
+describe sns_topic(topic_arn) do
+  its(:deleted_subscriptions) { should eq 0 }
+end
+```
+
+### subscriptions
+
+More like a helper method for fixtures. You could add any logic required to
+identify a specific method.
+
+```ruby
+let (:subscriber) do
+  all = subject.subscriptions
+  return all[0].to_s # keys are stored as symbols
+end
+```
+
+### include_subscribed
+
+```ruby
+describe sns_topic(topic_arn) do
+  it { should include_subscribed(subscribed) }
+end
+```
+
+### have_subscription
+
+```ruby
+describe sns_topic(topic_arn) do
+  let(:subscription_arn) do
+      subscription_arn: subscribed, # this is required
+  end
+
+  describe '#subscribed' do
+    it do
+      should have_subscription(subscribed)
+    end
+  end
+end
+```
+
+An [automatic matcher](https://www.rubydoc.info/github/rspec/rspec-expectations/RSpec/Matchers) created due the predicate `has_subscription?` existing method of `Awspec::Type::SnsTopic` class.
+
+It validates if a given AWS SNS ARN subscription exists in the SNS Topic.
+
+### have_subscription_attributes
+
+```ruby
+describe sns_topic(topic_arn) do
+  let(:expected_attribs) do
+    { protocol: 'lambda',
+      owner: '123456789',
+      subscription_arn: subscribed, # this is required
+      endpoint: 'arn:aws:lambda:us-east-1:123456789:function:foobar' }
+  end
+
+  describe '#subscribed' do
+    it do
+      should have_subscription_attributes(expected_attribs)
+    end
+  end
+end
+```
+
+Where `:expected_attribs` is a hash with keys as properties that are part of a SNS Topic subscription:
+
+* subscription_arn
+* owner
+* protocol
+* endpoint
+* topic_arn
+
+You can use any combinations of key/values that will be used by `have_subscription_attributes`, but the `subscription_arn` is required and if it is missing, an exception will be generated.
+
+### advanced
+
+You may want to validate the subscriptions too. For that, you probably will want to  use the methods `subscriptions` (that will return a list of the subscriptions ARN as symbols) and `has_subscription?` (that expects a SNS Topic subscription as parameter and will return `true` of `false` if it exists as a subscription) of the class `Awspec::Type::SnsTopic` to build the fixture in order to use the matcher `have_subscription_attributes`.