-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(APIv2): RHINENG-2149 implement reports endpoint
- Loading branch information
1 parent
f463bd3
commit 99a73e6
Showing
18 changed files
with
4,558 additions
and
3,487 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# frozen_string_literal: true | ||
|
||
module V2 | ||
# API for Reports (rule results) | ||
class ReportsController < ApplicationController | ||
def index | ||
render_json reports | ||
end | ||
permission_for_action :index, Rbac::REPORT_READ | ||
|
||
def show | ||
render_json report | ||
end | ||
permission_for_action :show, Rbac::REPORT_READ | ||
|
||
private | ||
|
||
def reports | ||
@reports ||= authorize(fetch_collection) | ||
end | ||
|
||
def report | ||
@report ||= authorize(expand_resource.find(permitted_params[:id])) | ||
end | ||
|
||
def resource | ||
V2::Report | ||
end | ||
|
||
def serializer | ||
V2::ReportSerializer | ||
end | ||
|
||
def extra_fields | ||
%i[account_id] | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# frozen_string_literal: true | ||
|
||
module V2 | ||
# Policies for accessing Reports | ||
class ReportPolicy < V2::ApplicationPolicy | ||
def index? | ||
true # FIXME: this is handled in scoping | ||
end | ||
|
||
def show? | ||
match_account? | ||
end | ||
|
||
# Only show Reports in our user account | ||
class Scope < V2::ApplicationPolicy::Scope | ||
def resolve | ||
return scope.where('1=0') if user&.account_id.blank? | ||
|
||
scope.where(account_id: user.account_id) | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# frozen_string_literal: true | ||
|
||
module V2 | ||
# JSON serialization for Reports | ||
class ReportSerializer < V2::ApplicationSerializer | ||
attributes :title, :description, :business_objective, :compliance_threshold | ||
|
||
derived_attribute :os_major_version, security_guide: [:os_major_version] | ||
derived_attribute :profile_title, profile: [:title] | ||
derived_attribute :ref_id, profile: [:ref_id] | ||
|
||
aggregated_attribute :system_count, :systems, V2::Report::SYSTEM_COUNT | ||
# aggregated_attribute :test_result_system_count, :test_results, V2::Report::TEST_RESULT_SYSTEM_COUNT | ||
# aggregated_attribute :compliant_system_count, :test_results, V2::Report::COMPLIANT_SYSTEM_COUNT | ||
# aggregated_attribute :unsupported_system_count, :test_results, V2::Report::UNSUPPORTED_SYSTEM_COUNT | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# frozen_string_literal: true | ||
|
||
require './spec/api/v2/schemas/util' | ||
|
||
module Api | ||
module V2 | ||
module Schemas | ||
# :nodoc: | ||
module Report | ||
extend Api::V2::Schemas::Util | ||
|
||
REPORT = { | ||
type: :object, | ||
required: %w[compliance_threshold profile_id], | ||
properties: { | ||
id: ref_schema('id'), | ||
type: { | ||
type: :string, | ||
enum: ['report'], | ||
readOnly: true | ||
}, | ||
title: { | ||
type: :string, | ||
examples: ['CIS Red Hat Enterprise Linux 7 Benchmark'], | ||
description: 'Short title of the Report' | ||
}, | ||
business_objective: { | ||
type: :string, | ||
examples: ['Guide to the Secure Configuration of Red Hat Enterprise Linux 7'], | ||
description: 'The Business Objective associated to the Policy' | ||
}, | ||
compliance_threshold: { | ||
type: :number, | ||
examples: [90], | ||
maximum: 100, | ||
minimum: 0, | ||
description: 'The percentage above which the Policy meets compliance requirements' | ||
}, | ||
os_major_version: { | ||
type: :number, | ||
minimum: 6, | ||
examples: [7], | ||
description: 'Major version of the Operating System that the Report covers', | ||
readOnly: true | ||
}, | ||
ref_id: { | ||
type: :string, | ||
examples: ['xccdf_org.ssgproject.content_profile_pci-dss'], | ||
description: 'Identificator of the Profile', | ||
readOnly: true | ||
}, | ||
profile_title: { | ||
type: :string, | ||
examples: ['CIS Red Hat Enterprise Linux 7 Benchmark'], | ||
description: 'Title of the associated Profile', | ||
readOnly: true | ||
}, | ||
total_system_count: { | ||
type: :number, | ||
minium: 0, | ||
examples: [3], | ||
description: 'The number of Systems assigned to this Report', | ||
readOnly: true | ||
} | ||
# TODO: total_system_count: { | ||
# type: :number, | ||
# minium: 0, | ||
# examples: [3], | ||
# description: 'The number of Systems assigned to this Policy', | ||
# readOnly: true | ||
# }, | ||
# TODO: total_system_count: { | ||
# type: :number, | ||
# minium: 0, | ||
# examples: [3], | ||
# description: 'The number of Systems assigned to this Policy', | ||
# readOnly: true | ||
# }, | ||
# TODO: total_system_count: { | ||
# type: :number, | ||
# minium: 0, | ||
# examples: [3], | ||
# description: 'The number of Systems assigned to this Policy', | ||
# readOnly: true | ||
# } | ||
} | ||
}.freeze | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'rails_helper' | ||
|
||
describe V2::ReportsController do | ||
before do | ||
stub_rbac_permissions( | ||
Rbac::INVENTORY_HOSTS_READ, | ||
Rbac::SYSTEM_READ, | ||
Rbac::REPORT_READ | ||
) | ||
end | ||
|
||
let(:attributes) do | ||
{ | ||
title: :title, | ||
os_major_version: :os_major_version, | ||
ref_id: :ref_id, | ||
description: :description, | ||
profile_title: :profile_title, | ||
business_objective: :business_objective, | ||
system_count: -> { 3 }, | ||
# TODO: compliant_system_count: -> { 0 }, | ||
# TODO: test_result_system_count: -> { 0 }, | ||
# TODO: unsupported_system_count: -> { 0 }, | ||
compliance_threshold: :compliance_threshold | ||
} | ||
end | ||
|
||
let(:current_user) { FactoryBot.create(:v2_user) } | ||
let(:rbac_allowed?) { true } | ||
|
||
before do | ||
request.headers['X-RH-IDENTITY'] = current_user.account.identity_header.raw | ||
allow(StrongerParameters::InvalidValue).to receive(:new) { |value, _| value.to_sym } | ||
allow(controller).to receive(:rbac_allowed?).and_return(rbac_allowed?) | ||
end | ||
|
||
context '/reports' do | ||
describe 'GET index' do | ||
let(:attributes) do | ||
{ | ||
title: :title, | ||
os_major_version: :os_major_version, | ||
ref_id: :ref_id, | ||
description: :description, | ||
profile_title: :profile_title, | ||
business_objective: :business_objective, | ||
system_count: -> { 2 }, | ||
# TODO: compliant_system_count: -> { 0 }, | ||
# TODO: test_result_system_count: -> { 0 }, | ||
# TODO: unsupported_system_count: -> { 0 }, | ||
compliance_threshold: :compliance_threshold | ||
} | ||
end | ||
let(:extra_params) { { account: current_user.account } } | ||
let(:parents) { nil } | ||
|
||
let(:items) do | ||
FactoryBot.create_list( | ||
:v2_report, item_count, | ||
os_major_version: 8, | ||
supports_minors: [0, 1], | ||
account: current_user.account | ||
).sort_by(&:id) | ||
end | ||
|
||
it_behaves_like 'collection' | ||
include_examples 'with metadata' | ||
it_behaves_like 'paginable' | ||
it_behaves_like 'sortable' | ||
it_behaves_like 'searchable' | ||
end | ||
|
||
describe 'GET show' do | ||
let(:attributes) do | ||
{ | ||
title: :title, | ||
os_major_version: :os_major_version, | ||
ref_id: :ref_id, | ||
description: :description, | ||
profile_title: :profile_title, | ||
business_objective: :business_objective, | ||
system_count: -> { 3 }, | ||
# TODO: compliant_system_count: -> { 0 }, | ||
# TODO: test_result_system_count: -> { 0 }, | ||
# TODO: unsupported_system_count: -> { 0 }, | ||
compliance_threshold: :compliance_threshold | ||
} | ||
end | ||
let(:extra_params) { { account: current_user.account, id: item.id } } | ||
let(:parent) { nil } | ||
|
||
let(:item) do | ||
FactoryBot.create( | ||
:v2_report, | ||
os_major_version: 9, | ||
supports_minors: [0, 1, 2], | ||
account: current_user.account | ||
) | ||
end | ||
|
||
it_behaves_like 'individual' | ||
end | ||
end | ||
end |
Oops, something went wrong.