New Skeletal Resource aws_sns_subscription #2697
Conversation
Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
clintoncwolfe
added
Platform: AWS
…ns_subscription
Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
There was a problem hiding this comment.
Great work @dromazmj ! A few docs changes, and one matcher I'd like to see aliased for better fluency, but no substantial code changes. Unit and integration tests pass. Great contribution!
|
|
||
| Provides the Subscriptions protocol used. For example http, https, email, email-json, sqs, etc. For more information about protocols please visit https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html | ||
|
|
||
| # Inspect the endpoint |
There was a problem hiding this comment.
Protocol, not endpoint
|
|
||
| # Inspect the endpoint | ||
| describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do | ||
| its('endpoint') { should cmp 'arn:aws:sns:us-east-1::test-topic-02' } |
There was a problem hiding this comment.
I don't think SNS Topics are valid as endpoints - see the AWS docs. You might give a few examples that vary based on protocol:
# If protocol is 'sms', this should be a phone number:
its('endpoint') { should cmp '+16105551234' }
# If protocol is 'email', endpoint should be an email address
its('endpoint') { should cmp 'nobody@example.com' }
| it { should_not exist } | ||
| end | ||
|
|
||
| ### be_confirmation_authenticated |
There was a problem hiding this comment.
I think it would read better as require_authenticated_confirmation. You'd have to use `RSpec::Matcher.alias_matcher to get the name right (see an example).
There was a problem hiding this comment.
I think this matcher is saying whether or not the confirmation was authenticated not exactly required. Maybe be_authenticated or has_been_authenticated
There was a problem hiding this comment.
| def fetch_from_api | ||
| backend = BackendFactory.create(inspec_runner) | ||
|
|
||
| @aws_response = backend.get_subscription_attributes(subscription_arn: @subscription_arn).attributes |
There was a problem hiding this comment.
Don't make aws_response an instance variable - it's a local utility variable, not a property of the AwsSnsSubscription object.
| it { should exist } | ||
| end | ||
|
|
||
| # describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1:721741954427:NonExistentSubscrtiption:bf007420-6-45-96-9c2bf144') do |
There was a problem hiding this comment.
Why is this commented out?
| data "aws_caller_identity" "current" {} | ||
|
|
||
| output "account_id" { |
There was a problem hiding this comment.
I think this is already available - check aws.tf
| }), | ||
| }), | ||
| }) | ||
| # require 'pry' |
* Clarifies documentation * Wraps calls to aws api in catch_aws_errors metho * Fixes integration tests Signed-off-by: Matthew Dromazos <dromazmj@dukes.jmu.edu>
| # If protocal is 'http', endpoint should be a URL beginning with 'https://' | ||
| its('endpoint') { should cmp 'https://www.exampleurl.com' } | ||
| # If the protocol is 'lambda', its endpoint should be the ARN of a AWS Lambda function | ||
| its('endpoint') { should cmp 'rn:aws:lambda:us-east-1:account-id:function:myfunction' } |
This PR adds functionality for a new resource that allows testing against a SNS Subscription.
Signed-off-by: Matthew Dromazos dromazmj@dukes.jmu.edu