esp_sdk 1.1.0 → 2.0.0.rc1

data/test/esp/resources/alert_test.rb

@@ -0,0 +1,263 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class AlertTest < ActiveSupport::TestCase
+    context ESP::Alert do
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Alert.create(name: 'test')
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          cloud_trail_event = build(:cloud_trail_event)
+          assert_raises ESP::NotImplementedError do
+            cloud_trail_event.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          cloud_trail_event = build(:cloud_trail_event)
+          assert_raises ESP::NotImplementedError do
+            cloud_trail_event.destroy
+          end
+        end
+      end
+
+      context '#external_account' do
+        should 'call the api' do
+          alert = build(:alert, external_account_id: 3)
+          stubbed_external_account = stub_request(:get, %r{external_accounts/#{alert.external_account_id}.json*}).to_return(body: json(:external_account))
+
+          alert.external_account
+
+          assert_requested(stubbed_external_account)
+        end
+      end
+
+      context '#region' do
+        should 'call the api' do
+          alert = build(:alert, region_id: 3)
+          stubbed_region = stub_request(:get, %r{regions/#{alert.region_id}.json*}).to_return(body: json(:region))
+
+          alert.region
+
+          assert_requested(stubbed_region)
+        end
+      end
+
+      context '#signature' do
+        should 'call the api' do
+          alert = build(:alert, signature_id: 3)
+          stubbed_signature = stub_request(:get, %r{signatures/#{alert.signature_id}.json*}).to_return(body: json(:signature))
+
+          alert.signature
+
+          assert_requested(stubbed_signature)
+        end
+      end
+
+      context '#custom_signature' do
+        should 'call the api' do
+          alert = build(:alert, custom_signature_id: 3)
+          stubbed_custom_signature = stub_request(:get, %r{custom_signatures/#{alert.custom_signature_id}.json*}).to_return(body: json(:custom_signature))
+
+          alert.custom_signature
+
+          assert_requested(stubbed_custom_signature)
+        end
+      end
+
+      context '#suppression' do
+        should 'call the api' do
+          alert = build(:alert, suppression_id: 3)
+          stubbed_suppression = stub_request(:get, %r{suppressions/#{alert.suppression_id}.json*}).to_return(body: json(:suppression))
+
+          alert.suppression
+
+          assert_requested(stubbed_suppression)
+        end
+      end
+
+      context '#cloud_trail_events' do
+        should 'call the api for the alert' do
+          alert = build(:alert)
+          stubbed_events = stub_request(:get, %r{alerts/#{alert.id}/cloud_trail_events.json*}).to_return(body: json_list(:cloud_trail_event, 2))
+
+          alert.cloud_trail_events
+
+          assert_requested(stubbed_events)
+        end
+      end
+
+      context '#tags' do
+        should 'call the api for the alert' do
+          alert = build(:alert)
+          stubbed_tags = stub_request(:get, %r{alerts/#{alert.id}/tags.json*}).to_return(body: json_list(:tag, 2))
+
+          alert.tags
+
+          assert_requested(stubbed_tags)
+        end
+      end
+
+      context '.for_report' do
+        should 'throw an error if report_id is not supplied' do
+          error = assert_raises ArgumentError do
+            ESP::Alert.for_report
+          end
+          assert_equal 'You must supply a report id.', error.message
+        end
+
+        should 'call the api and pass params' do
+          stub_request(:get, %r{reports/5/alerts.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = ESP::Alert.for_report(5, status: 'pass')
+
+          assert_requested(:get, %r{reports/5/alerts.json*}) do |req|
+            assert_equal "filter[status]=pass", URI.unescape(req.uri.query)
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+      end
+
+      context '.find' do
+        should 'throw an error if report_id is not supplied' do
+          error = assert_raises ArgumentError do
+            ESP::Alert.find(:all, params: { id: 3 })
+          end
+          assert_equal 'You must supply a report id.', error.message
+        end
+
+        should 'call the show api and return an alert if searching by id' do
+          stub_alert = stub_request(:get, %r{alerts/5.json*}).to_return(body: json(:alert))
+
+          alert = ESP::Alert.find(5)
+
+          assert_requested(stub_alert)
+          assert_equal ESP::Alert, alert.class
+        end
+
+        should 'call the api and return alerts when report_id is supplied' do
+          stub_alert = stub_request(:get, %r{reports/5/alerts.json*}).to_return(body: json_list(:alert, 2))
+
+          alert = ESP::Alert.find(:all, params: { report_id: 5 })
+
+          assert_requested(stub_alert)
+          assert_equal ESP::Alert, alert.resource_class
+        end
+      end
+
+      context '#suppress_signature' do
+        should 'throw an error if reason is not supplied' do
+          alert = build(:alert)
+
+          error = assert_raises ArgumentError do
+            alert.suppress_signature
+          end
+          assert_equal 'You must specify the reason.', error.message
+        end
+
+        should 'call Suppression::Signature.create' do
+          alert = build(:alert)
+          Suppression::Signature.stubs(:create)
+
+          alert.suppress_signature('the reason')
+
+          assert_received(Suppression::Signature, :create) do |expects|
+            expects.with do |params|
+              assert_equal alert.id, params[:alert_id]
+              assert_equal 'the reason', params[:reason]
+            end
+          end
+        end
+      end
+
+      context '#suppress_region' do
+        should 'throw an error if reason is not supplied' do
+          alert = build(:alert)
+
+          error = assert_raises ArgumentError do
+            alert.suppress_region
+          end
+          assert_equal 'You must specify the reason.', error.message
+        end
+
+        should 'call Suppression::Region.create' do
+          alert = build(:alert)
+          Suppression::Region.stubs(:create)
+
+          alert.suppress_region('the reason')
+
+          assert_received(Suppression::Region, :create) do |expects|
+            expects.with do |params|
+              assert_equal alert.id, params[:alert_id]
+              assert_equal 'the reason', params[:reason]
+            end
+          end
+        end
+      end
+
+      context '#suppress_unique_identifier' do
+        should 'throw an error if reason is not supplied' do
+          alert = build(:alert)
+
+          error = assert_raises ArgumentError do
+            alert.suppress_unique_identifier
+          end
+          assert_equal 'You must specify the reason.', error.message
+        end
+
+        should 'call Suppression::UniqueIdentifier.create' do
+          alert = build(:alert)
+          Suppression::UniqueIdentifier.stubs(:create)
+
+          alert.suppress_unique_identifier('the reason')
+
+          assert_received(Suppression::UniqueIdentifier, :create) do |expects|
+            expects.with do |params|
+              assert_equal alert.id, params[:alert_id]
+              assert_equal 'the reason', params[:reason]
+            end
+          end
+        end
+      end
+
+      context 'live calls' do
+        setup do
+          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
+          WebMock.allow_net_connect!
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '.for_report' do
+          should 'return events for report id' do
+            report = ESP::Report.last
+            alerts = ESP::Alert.for_report(report.id)
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+        end
+
+        context '.find' do
+          should 'return an alert by id' do
+            report = ESP::Report.last
+            alert_id = report.alerts.last.id
+            alert = ESP::Alert.find(alert_id.to_i)
+
+            assert_equal ESP::Alert, alert.class
+            assert_equal alert_id, alert.id
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/cloud_trail_event_test.rb

@@ -0,0 +1,98 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class CloudTrailEventTest < ActiveSupport::TestCase
+    context ESP::CloudTrailEvent do
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::CloudTrailEvent.create(name: 'test')
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          cloud_trail_event = build(:cloud_trail_event)
+          assert_raises ESP::NotImplementedError do
+            cloud_trail_event.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          cloud_trail_event = build(:cloud_trail_event)
+          assert_raises ESP::NotImplementedError do
+            cloud_trail_event.destroy
+          end
+        end
+      end
+
+      context '.for_alert' do
+        should 'throw an error if alert id is not supplied' do
+          error = assert_raises ArgumentError do
+            ESP::CloudTrailEvent.for_alert
+          end
+          assert_equal 'You must supply an alert id.', error.message
+        end
+
+        should 'call the api' do
+          stub_event = stub_request(:get, %r{alerts/5/cloud_trail_events.json*}).to_return(body: json_list(:cloud_trail_event, 2))
+
+          events = ESP::CloudTrailEvent.for_alert(5)
+
+          assert_requested(stub_event)
+          assert_equal ESP::CloudTrailEvent, events.resource_class
+        end
+      end
+
+      context '.find' do
+        should 'throw an error if alert_id is not supplied' do
+          error = assert_raises ArgumentError do
+            ESP::CloudTrailEvent.find(:all, params: { id: 3 })
+          end
+          assert_equal 'You must supply an alert id.', error.message
+        end
+
+        should 'call the show api and return an event if searching by id' do
+          stub_event = stub_request(:get, %r{cloud_trail_events/5.json*}).to_return(body: json(:cloud_trail_event))
+
+          event = ESP::CloudTrailEvent.find(5)
+
+          assert_requested(stub_event)
+          assert_equal ESP::CloudTrailEvent, event.class
+        end
+
+        should 'call the api and return events when alert_id is supplied' do
+          stub_event = stub_request(:get, %r{alerts/5/cloud_trail_events.json*}).to_return(body: json_list(:cloud_trail_event, 2))
+
+          events = ESP::CloudTrailEvent.find(:all, params: { alert_id: 5 })
+
+          assert_requested(stub_event)
+          assert_equal ESP::CloudTrailEvent, events.resource_class
+        end
+      end
+
+      context 'live calls' do
+        setup do
+          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
+          WebMock.allow_net_connect!
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '.for_alert' do
+          should 'return events for alert id' do
+            report = ESP::Report.last
+            events = ESP::CloudTrailEvent.for_alert(report.alerts.last.id)
+
+            assert_equal ESP::CloudTrailEvent, events.resource_class
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/contact_request_test.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class ContactRequestTest < ActiveSupport::TestCase
+    context ESP::ContactRequest do
+      context '#find' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::ContactRequest.find(4)
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          s = ESP::ContactRequest.new
+          assert_raises ESP::NotImplementedError do
+            s.update
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          s = ESP::ContactRequest.new
+          assert_raises ESP::NotImplementedError do
+            s.destroy
+          end
+        end
+      end
+
+      context '#create' do
+        should 'call the api' do
+          stub_request(:post, /contact_requests.json*/).to_return(body: json(:contact_request))
+
+          contact_request = ESP::ContactRequest.create(user_id: 5, request_type: 'feature', title: 'My great feature idea', description: 'This is my idea for a really useful feature...')
+
+          assert_requested(:post, /contact_requests.json*/) do |req|
+            body = JSON.parse(req.body)
+            assert_equal 5, body['data']['attributes']['user_id']
+            assert_equal 'feature', body['data']['attributes']['request_type']
+            assert_equal 'My great feature idea', body['data']['attributes']['title']
+            assert_equal 'This is my idea for a really useful feature...', body['data']['attributes']['description']
+          end
+          assert_equal ESP::ContactRequest, contact_request.class
+        end
+      end
+
+      context 'live calls' do
+        setup do
+          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
+          WebMock.allow_net_connect!
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            contact_request = ESP::ContactRequest.new(user_id: 5, request_type: 'feature', title: 'My great feature idea', description: 'This is my idea for a really useful feature...')
+
+            assert_predicate contact_request, :new?
+
+            contact_request.save
+
+            refute_predicate contact_request, :new?
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/custom_signature_test.rb

@@ -0,0 +1,241 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class CustomSignatureTest < ActiveSupport::TestCase
+    context ESP::CustomSignature do
+      context '#organization' do
+        should 'call the api' do
+          custom_signature = build(:custom_signature, organization_id: 4)
+          stubbed_organization = stub_request(:get, %r{organizations/#{custom_signature.organization_id}.json*}).to_return(body: json(:organization))
+
+          custom_signature.organization
+
+          assert_requested(stubbed_organization)
+        end
+      end
+
+      context '.run_sanity_test!' do
+        should 'call the api and pass params' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          stub_request(:post, %r{custom_signatures/run.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = ESP::CustomSignature.run!(external_account_id: 3, regions: 'param2', language: custom_signature.language, signature: custom_signature.signature)
+
+          assert_requested(:post, %r{custom_signatures/run.json*}) do |req|
+            body = JSON.parse req.body
+            assert_equal false, body['data'].key?('id')
+            assert_equal ['param2'], body['data']['attributes']['regions']
+            assert_equal custom_signature.language, body['data']['attributes']['language']
+            assert_equal custom_signature.signature, body['data']['attributes']['signature']
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+
+        should 'throw an error if an error is returned' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          error = ActiveResource::BadRequest.new('')
+          error_response = json(:error)
+          response = mock(body: error_response, code: '400')
+          error.stubs(:response).returns(response)
+          ActiveResource::Connection.any_instance.expects(:post).raises(error)
+          stub_request(:post, %r{custom_signatures/run.json*}).to_return(body: json_list(:alert, 2))
+
+          error = assert_raises ActiveResource::ResourceInvalid do
+            ESP::CustomSignature.run!(external_account_id: 3, regions: 'param2', language: custom_signature.language, signature: custom_signature.signature)
+          end
+          assert_equal "Failed.  Response code = 400.  Response message = #{JSON.parse(error_response)['errors'].first['title']}.", error.message
+        end
+      end
+
+      context '.run_sanity_test' do
+        should 'call the api and pass params' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          stub_request(:post, %r{custom_signatures/run.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = ESP::CustomSignature.run(external_account_id: 3, regions: 'param2', language: custom_signature.language, signature: custom_signature.signature)
+
+          assert_requested(:post, %r{custom_signatures/run.json*}) do |req|
+            body = JSON.parse req.body
+            assert_equal false, body['data'].key?('id')
+            assert_equal ['param2'], body['data']['attributes']['regions']
+            assert_equal custom_signature.language, body['data']['attributes']['language']
+            assert_equal custom_signature.signature, body['data']['attributes']['signature']
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+
+        should 'not throw an error if an error is returned' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          error = ActiveResource::BadRequest.new('')
+          error_response = json(:error)
+          response = mock(body: error_response, code: '400')
+          error.stubs(:response).returns(response)
+          ActiveResource::Connection.any_instance.expects(:post).raises(error)
+          stub_request(:post, %r{custom_signatures/run.json*}).to_return(body: json_list(:alert, 2))
+
+          assert_nothing_raised do
+            result = ESP::CustomSignature.run(external_account_id: 3, regions: 'param2', language: custom_signature.language, signature: custom_signature.signature)
+            assert_equal JSON.parse(error_response)['errors'].first['title'], result.errors.full_messages.first
+          end
+        end
+      end
+
+      context '#run!' do
+        should 'call the api and pass params' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          stub_request(:post, %r{custom_signatures/#{custom_signature.id}/run.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = custom_signature.run!(regions: 'param2')
+
+          assert_requested(:post, %r{custom_signatures/#{custom_signature.id}/run.json*}) do |req|
+            body = JSON.parse req.body
+            assert_equal custom_signature.id, body['data']['id']
+            assert_equal ['param2'], body['data']['attributes']['regions']
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+
+        should 'throw an error if an error is returned' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          error = ActiveResource::BadRequest.new('')
+          error_response = json(:error)
+          response = mock(body: error_response, code: '400')
+          error.stubs(:response).returns(response)
+          ActiveResource::Connection.any_instance.expects(:post).raises(error)
+          stub_request(:post, %r{custom_signatures/#{custom_signature.id}/run.json*}).to_return(body: json_list(:alert, 2))
+
+          error = assert_raises ActiveResource::ResourceInvalid do
+            custom_signature.run!(regions: 'param2')
+          end
+          assert_equal "Failed.  Response code = 400.  Response message = #{JSON.parse(error_response)['errors'].first['title']}.", error.message
+        end
+      end
+
+      context '#run' do
+        should 'call the api and pass params' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          stub_request(:post, %r{custom_signatures/#{custom_signature.id}/run.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = custom_signature.run(regions: 'param2')
+
+          assert_requested(:post, %r{custom_signatures/#{custom_signature.id}/run.json*}) do |req|
+            body = JSON.parse req.body
+            assert_equal custom_signature.id, body['data']['id']
+            assert_equal ['param2'], body['data']['attributes']['regions']
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+
+        should 'not throw an error if an error is returned' do
+          custom_signature = build(:custom_signature, external_account_id: 3)
+          error = ActiveResource::BadRequest.new('')
+          error_response = json(:error)
+          response = mock(body: error_response, code: '400')
+          error.stubs(:response).returns(response)
+          ActiveResource::Connection.any_instance.expects(:post).raises(error)
+          stub_request(:post, %r{custom_signatures/#{custom_signature.id}/run.json*}).to_return(body: json_list(:alert, 2))
+
+          assert_nothing_raised do
+            custom_signature.run(regions: 'param2')
+            assert_equal JSON.parse(error_response)['errors'].first['title'], custom_signature.errors.full_messages.first
+          end
+        end
+      end
+
+      context '#suppress' do
+        should 'call the api' do
+          stub_request(:post, %r{suppressions/signatures.json*}).to_return(body: json(:suppression_signature))
+          custom_signature = build(:custom_signature)
+
+          suppression = custom_signature.suppress(regions: ['us_east_1'], external_account_ids: [5], reason: 'because')
+
+          assert_requested(:post, %r{suppressions/signatures.json*}) do |req|
+            body = JSON.parse(req.body)
+            assert_equal 'because', body['data']['attributes']['reason']
+            assert_equal [custom_signature.id], body['data']['attributes']['custom_signature_ids']
+            assert_equal ['us_east_1'], body['data']['attributes']['regions']
+            assert_equal [5], body['data']['attributes']['external_account_ids']
+          end
+          assert_equal ESP::Suppression::Signature, suppression.class
+        end
+      end
+
+      context 'live calls' do
+        setup do
+          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
+          WebMock.allow_net_connect!
+          @custom_signature = ESP::CustomSignature.last
+          skip "Live DB does not have any custom_signatures.  Add a custom_signature and run tests again." if @custom_signature.blank?
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '#organization' do
+          should 'return an organization' do
+            organization = @custom_signature.organization
+
+            assert_equal @custom_signature.organization_id, organization.id
+            assert_equal ESP::Organization, organization.class
+          end
+        end
+
+        context '.run' do
+          should 'return alerts' do
+            external_account_id = ESP::ExternalAccount.last.id
+            alerts = ESP::CustomSignature.run(external_account_id: external_account_id, regions: 'us_east_1', language: @custom_signature.language, signature: @custom_signature.signature)
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+
+          should 'return errors' do
+            signature = ESP::CustomSignature.run(external_account_id: 999, regions: 'us_east_1', language: @custom_signature.language, signature: @custom_signature.signature)
+
+            assert_equal "Couldn't find ExternalAccount", signature.errors.full_messages.first
+          end
+        end
+
+        context '#run' do
+          should 'return alerts' do
+            external_account_id = ESP::ExternalAccount.last.id
+            alerts = @custom_signature.run(external_account_id: external_account_id, regions: ['us_east_1'])
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+
+          should 'return errors' do
+            @custom_signature.run(external_account_id: 999)
+
+            assert_equal "Couldn't find ExternalAccount", @custom_signature.errors.full_messages.first
+          end
+        end
+
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            custom_signature = ESP::CustomSignature.new(@custom_signature.attributes)
+
+            assert_predicate custom_signature, :new?
+
+            custom_signature.save
+
+            refute_predicate custom_signature, :new?
+
+            custom_signature.identifier = 'new identifier'
+            custom_signature.save
+
+            assert_nothing_raised do
+              ESP::CustomSignature.find(custom_signature.id)
+            end
+
+            custom_signature.destroy
+
+            assert_raises ActiveResource::ResourceNotFound do
+              ESP::CustomSignature.find(custom_signature.id)
+            end
+          end
+        end
+      end
+    end
+  end
+end