Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove required filters from event streams #112

Merged
merged 1 commit into from
Oct 6, 2017
Merged

Remove required filters from event streams #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions app/controllers/api/event_streams_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
module Api
class EventStreamsController < BaseController
before_action :validate_filters, :ensure_pagination, :only => :index
before_action :ensure_pagination, :only => :index

private

def validate_filters
messages = []
messages << "must specify target_type" unless filter_contains?("target_type")
messages << "must specify a minimum value for timestamp" unless filter_contains?("timestamp>")
raise BadRequestError, messages.join(", ").capitalize if messages.any?
end

def filter_contains?(filter)
Array(params["filter"]).any? { |f| f.start_with?(filter) }
end

def ensure_pagination
params["limit"] ||= Settings.api.event_streams_default_limit
params["offset"] ||= 0
Expand Down
94 changes: 17 additions & 77 deletions spec/requests/event_streams_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,11 @@
describe "GET /api/event_streams" do
around { |example| Timecop.freeze("2017-01-05 12:00 UTC") { example.run } }

specify "target_type is a required filter" do
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
FactoryGirl.create(:miq_event)

get(api_event_streams_url, :params => {:filter => ["timestamp>2017-01-01"]})

expect(response.parsed_body).to include_error_with_message("Must specify target_type")
expect(response).to have_http_status(:bad_request)
end

specify "event streams must be filtered by timestamp occurring after a certain date" do
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
FactoryGirl.create(:miq_event)

get(api_event_streams_url, :params => {:filter => ["target_type=VmOrTemplate"]})

expect(response.parsed_body).to include_error_with_message("Must specify a minimum value for timestamp")
expect(response).to have_http_status(:bad_request)
end

it "will aggregate required filter messages" do
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
FactoryGirl.create(:miq_event)

get(api_event_streams_url)

expect(response.parsed_body).to include_error_with_message("Must specify target_type, must specify a minimum value for timestamp")
expect(response).to have_http_status(:bad_request)
end

it "returns a list of event streams with the appropriate role" do
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
vm = FactoryGirl.create(:vm_vmware)
event_stream = FactoryGirl.create(:miq_event, :target => vm, :timestamp => Time.zone.now)
event_stream = FactoryGirl.create(:miq_event)

get(api_event_streams_url, :params => {:filter => ["target_type=VmOrTemplate", "timestamp>2017-01-01"]})
get(api_event_streams_url)

expected = {"resources" => [{"href" => api_event_stream_url(nil, event_stream)}]}
expect(response.parsed_body).to include(expected)
Expand All @@ -46,20 +15,10 @@

it "can filter by event type" do
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
vm = FactoryGirl.create(:vm_vmware)
start_event = FactoryGirl.create(:miq_event, :target => vm, :timestamp => Time.zone.now, :event_type => "vm_start")
_stop_event = FactoryGirl.create(:miq_event, :target => vm, :timestamp => Time.zone.now, :event_type => "vm_stop")
start_event = FactoryGirl.create(:miq_event, :event_type => "vm_start")
_stop_event = FactoryGirl.create(:miq_event, :event_type => "vm_stop")

get(
api_event_streams_url,
:params => {
:filter => [
"target_type=VmOrTemplate",
"timestamp>2017-01-01",
"event_type=vm_start"
]
}
)
get(api_event_streams_url, :params => {:filter => ["event_type=vm_start"]})

expected = {"resources" => [a_hash_including("href" => api_event_stream_url(nil, start_event))]}
expect(response.parsed_body).to include(expected)
Expand All @@ -68,22 +27,12 @@

it "can filter by timestamp" do
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
vm = FactoryGirl.create(:vm_vmware)
_event1 = FactoryGirl.create(:miq_event, :target => vm, :timestamp => 2.days.ago.end_of_day)
event2 = FactoryGirl.create(:miq_event, :target => vm, :timestamp => 1.day.ago.beginning_of_day)
event3 = FactoryGirl.create(:miq_event, :target => vm, :timestamp => 1.day.ago.end_of_day)
_event4 = FactoryGirl.create(:miq_event, :target => vm, :timestamp => Time.zone.today.beginning_of_day)
_event1 = FactoryGirl.create(:miq_event, :timestamp => 2.days.ago.end_of_day)
event2 = FactoryGirl.create(:miq_event, :timestamp => 1.day.ago.beginning_of_day)
event3 = FactoryGirl.create(:miq_event, :timestamp => 1.day.ago.end_of_day)
_event4 = FactoryGirl.create(:miq_event, :timestamp => Time.zone.today.beginning_of_day)

get(
api_event_streams_url,
:params => {
:filter => [
"target_type=VmOrTemplate",
"timestamp>2017-01-03",
"timestamp<2017-01-05"
]
}
)
get(api_event_streams_url, :params => {:filter => ["timestamp>2017-01-03", "timestamp<2017-01-05"]})

expected = {
"resources" => a_collection_containing_exactly(
Expand All @@ -99,18 +48,10 @@
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
vm = FactoryGirl.create(:vm_vmware)
host = FactoryGirl.create(:host_vmware)
vm_event = FactoryGirl.create(:miq_event, :timestamp => Time.zone.now, :target => vm)
_host_event = FactoryGirl.create(:miq_event, :timestamp => Time.zone.now, :target => host)
vm_event = FactoryGirl.create(:miq_event, :target => vm)
_host_event = FactoryGirl.create(:miq_event, :target => host)

get(
api_event_streams_url,
:params => {
:filter => [
"target_type=VmOrTemplate",
"timestamp>2017-01-01"
]
}
)
get(api_event_streams_url, :params => {:filter => ["target_type=VmOrTemplate"]})

expected = {"resources" => [a_hash_including("href" => api_event_stream_url(nil, vm_event))]}
expect(response.parsed_body).to include(expected)
Expand All @@ -121,17 +62,16 @@
api_basic_authorize(action_identifier(:event_streams, :read, :collection_actions, :get))
vm1, vm2 = FactoryGirl.create_list(:vm_vmware, 2)
host = FactoryGirl.create(:host_vmware)
vm1_event = FactoryGirl.create(:miq_event, :timestamp => Time.zone.now, :target => vm1)
_vm2_event = FactoryGirl.create(:miq_event, :timestamp => Time.zone.now, :target => vm2)
_host_event = FactoryGirl.create(:miq_event, :timestamp => Time.zone.now, :target => host)
vm1_event = FactoryGirl.create(:miq_event, :target => vm1)
_vm2_event = FactoryGirl.create(:miq_event, :target => vm2)
_host_event = FactoryGirl.create(:miq_event, :target => host)

get(
api_event_streams_url,
:params => {
:filter => [
"target_id=#{vm1.id}",
"target_type=VmOrTemplate",
"timestamp>2017-01-01"
"target_type=VmOrTemplate"
]
}
)
Expand Down