Commit 3eac491b authored by Maxime Orefice's avatar Maxime Orefice

Refactor coverage finder

This commits gets rid of our existing coverage finder and
the feature flag associated with our new coverage finder.
All codepaths will now use the new finder.
parent 48d4c300
...@@ -3,7 +3,6 @@ ...@@ -3,7 +3,6 @@
class Projects::Ci::DailyBuildGroupReportResultsController < Projects::ApplicationController class Projects::Ci::DailyBuildGroupReportResultsController < Projects::ApplicationController
include Gitlab::Utils::StrongMemoize include Gitlab::Utils::StrongMemoize
MAX_ITEMS = 1000
REPORT_WINDOW = 90.days REPORT_WINDOW = 90.days
before_action :authorize_read_build_report_results! before_action :authorize_read_build_report_results!
...@@ -40,17 +39,13 @@ class Projects::Ci::DailyBuildGroupReportResultsController < Projects::Applicati ...@@ -40,17 +39,13 @@ class Projects::Ci::DailyBuildGroupReportResultsController < Projects::Applicati
end end
def report_results def report_results
if ::Gitlab::Ci::Features.use_coverage_data_new_finder?(project) ::Ci::DailyBuildGroupReportResultsFinder.new(
::Ci::Testing::DailyBuildGroupReportResultsFinder.new( params: finder_params,
params: new_finder_params,
current_user: current_user current_user: current_user
).execute ).execute
else
Ci::DailyBuildGroupReportResultsFinder.new(**finder_params).execute
end
end end
def new_finder_params def finder_params
{ {
project: project, project: project,
coverage: true, coverage: true,
...@@ -61,17 +56,6 @@ class Projects::Ci::DailyBuildGroupReportResultsController < Projects::Applicati ...@@ -61,17 +56,6 @@ class Projects::Ci::DailyBuildGroupReportResultsController < Projects::Applicati
} }
end end
def finder_params
{
current_user: current_user,
project: project,
ref_path: params.require(:ref_path),
start_date: start_date,
end_date: end_date,
limit: MAX_ITEMS
}
end
def start_date def start_date
strong_memoize(:start_date) do strong_memoize(:start_date) do
start_date = Date.parse(params.require(:start_date)) start_date = Date.parse(params.require(:start_date))
......
# frozen_string_literal: true # frozen_string_literal: true
# DailyBuildGroupReportResultsFinder
#
# Used to filter DailyBuildGroupReportResults by set of params
#
# Arguments:
# current_user
# params:
# project: integer
# group: integer
# coverage: boolean
# ref_path: string
# start_date: date
# end_date: date
# sort: boolean
# limit: integer
module Ci module Ci
class DailyBuildGroupReportResultsFinder class DailyBuildGroupReportResultsFinder
include Gitlab::Allowable include Gitlab::Allowable
def initialize(current_user:, project:, ref_path: nil, start_date:, end_date:, limit: nil) MAX_ITEMS = 1_000
attr_reader :params, :current_user
def initialize(params: {}, current_user: nil)
@params = params
@current_user = current_user @current_user = current_user
@project = project
@ref_path = ref_path
@start_date = start_date
@end_date = end_date
@limit = limit
end end
def execute def execute
return none unless query_allowed? return Ci::DailyBuildGroupReportResult.none unless query_allowed?
collection = Ci::DailyBuildGroupReportResult.by_projects(params[:project])
collection = filter_report_results(collection)
collection
end
private
query def query_allowed?
can?(current_user, :read_build_report_results, params[:project])
end end
protected def filter_report_results(collection)
collection = by_coverage(collection)
collection = by_ref_path(collection)
collection = by_dates(collection)
attr_reader :current_user, :project, :ref_path, :start_date, :end_date, :limit collection = sort(collection)
collection = limit_by(collection)
collection
end
def query def by_coverage(items)
Ci::DailyBuildGroupReportResult.recent_results( params[:coverage].present? ? items.with_coverage : items
query_params,
limit: limit
)
end end
def query_allowed? def by_ref_path(items)
can?(current_user, :read_build_report_results, project) params[:ref_path].present? ? items.by_ref_path(params[:ref_path]) : items.with_default_branch
end end
def query_params def by_dates(items)
params = { params[:start_date].present? && params[:end_date].present? ? items.by_dates(params[:start_date], params[:end_date]) : items
project_id: project, end
date: start_date..end_date
}
if ref_path.present? def sort(items)
params[:ref_path] = ref_path params[:sort].present? ? items.ordered_by_date_and_group_name : items
else
params[:default_branch] = true
end end
params # rubocop: disable CodeReuse/ActiveRecord
def limit_by(items)
items.limit(limit)
end end
# rubocop: enable CodeReuse/ActiveRecord
def limit
return MAX_ITEMS unless params[:limit].present?
def none [params[:limit].to_i, MAX_ITEMS].min
Ci::DailyBuildGroupReportResult.none
end end
end end
end end
Ci::DailyBuildGroupReportResultsFinder.prepend_if_ee('::EE::Ci::DailyBuildGroupReportResultsFinder')
# frozen_string_literal: true
# DailyBuildGroupReportResultsFinder
#
# Used to filter DailyBuildGroupReportResults by set of params
#
# Arguments:
# current_user
# params:
# project: integer
# group: integer
# coverage: boolean
# ref_path: string
# start_date: date
# end_date: date
# sort: boolean
# limit: integer
module Ci
module Testing
class DailyBuildGroupReportResultsFinder
include Gitlab::Allowable
MAX_ITEMS = 1_000
attr_reader :params, :current_user
def initialize(params: {}, current_user: nil)
@params = params
@current_user = current_user
end
def execute
return Ci::DailyBuildGroupReportResult.none unless query_allowed?
collection = Ci::DailyBuildGroupReportResult.by_projects(params[:project])
collection = filter_report_results(collection)
collection
end
private
def query_allowed?
can?(current_user, :read_build_report_results, params[:project])
end
def filter_report_results(collection)
collection = by_coverage(collection)
collection = by_ref_path(collection)
collection = by_dates(collection)
collection = sort(collection)
collection = limit_by(collection)
collection
end
def by_coverage(items)
params[:coverage].present? ? items.with_coverage : items
end
def by_ref_path(items)
params[:ref_path].present? ? items.by_ref_path(params[:ref_path]) : items.with_default_branch
end
def by_dates(items)
params[:start_date].present? && params[:end_date].present? ? items.by_dates(params[:start_date], params[:end_date]) : items
end
def sort(items)
params[:sort].present? ? items.ordered_by_date_and_group_name : items
end
# rubocop: disable CodeReuse/ActiveRecord
def limit_by(items)
items.limit(limit)
end
# rubocop: enable CodeReuse/ActiveRecord
def limit
return MAX_ITEMS unless params[:limit].present?
[params[:limit].to_i, MAX_ITEMS].min
end
end
end
end
Ci::Testing::DailyBuildGroupReportResultsFinder.prepend_if_ee('::EE::Ci::Testing::DailyBuildGroupReportResultsFinder')
...@@ -30,10 +30,6 @@ module Ci ...@@ -30,10 +30,6 @@ module Ci
upsert_all(data, unique_by: :index_daily_build_group_report_results_unique_columns) if data.any? upsert_all(data, unique_by: :index_daily_build_group_report_results_unique_columns) if data.any?
end end
def recent_results(attrs, limit: nil)
where(attrs).order(date: :desc, group_name: :asc).limit(limit)
end
def report_window(start_date) def report_window(start_date)
default_date = REPORT_WINDOW.ago.to_date default_date = REPORT_WINDOW.ago.to_date
date = Date.parse(start_date) rescue default_date date = Date.parse(start_date) rescue default_date
......
---
title: Remove coverage_data_new_finder feature flag
merge_request: 54486
author:
type: performance
---
name: coverage_data_new_finder
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53670
rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/301093
milestone: '13.9'
type: development
group: group::testing
default_enabled: false
...@@ -32,17 +32,13 @@ class Groups::Analytics::CoverageReportsController < Groups::Analytics::Applicat ...@@ -32,17 +32,13 @@ class Groups::Analytics::CoverageReportsController < Groups::Analytics::Applicat
end end
def report_results def report_results
if ::Gitlab::Ci::Features.use_coverage_data_new_finder?(@group) ::Ci::DailyBuildGroupReportResultsFinder.new(
::Ci::Testing::DailyBuildGroupReportResultsFinder.new( params: finder_params,
params: new_finder_params,
current_user: current_user current_user: current_user
).execute ).execute
else
Ci::DailyBuildGroupReportResultsByGroupFinder.new(**finder_params).execute
end
end end
def new_finder_params def finder_params
{ {
group: @group, group: @group,
coverage: true, coverage: true,
...@@ -53,17 +49,6 @@ class Groups::Analytics::CoverageReportsController < Groups::Analytics::Applicat ...@@ -53,17 +49,6 @@ class Groups::Analytics::CoverageReportsController < Groups::Analytics::Applicat
} }
end end
def finder_params
{
current_user: current_user,
group: @group,
project_ids: params.permit(project_ids: [])[:project_ids],
ref_path: params[:ref_path],
start_date: Date.parse(params.require(:start_date)),
end_date: Date.parse(params.require(:end_date))
}
end
def download_tracker_params def download_tracker_params
{ {
label: 'group_id', label: 'group_id',
......
# frozen_string_literal: true
module Ci
class DailyBuildGroupReportResultsByGroupFinder < Ci::DailyBuildGroupReportResultsFinder
include Gitlab::Allowable
# We currently impose a maximum of 1000 returned records for performance reasons.
# This limit is subject to future removal.
# See thread: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/37768#note_386839633
GROUP_QUERY_RESULT_LIMIT = 1000.freeze
def initialize(current_user:, group:, project_ids: [], ref_path: nil, start_date:, end_date:, limit: nil)
super(current_user: current_user, project: nil, ref_path: ref_path, start_date: start_date, end_date: end_date, limit: limit)
@group = group
@project_ids = Array(project_ids)
@limit = GROUP_QUERY_RESULT_LIMIT unless limit && limit < GROUP_QUERY_RESULT_LIMIT
end
private
def query
Ci::DailyBuildGroupReportResult.with_included_projects.recent_results(
query_params,
limit: limit
)
end
def query_allowed?
can?(current_user, :read_group_build_report_results, @group)
end
def query_params
super.merge(project_id: project_id_subquery)
end
def project_id_subquery
if @project_ids.empty?
@group.projects.select(:id)
else
@group.projects.including_project(@project_ids).select(:id)
end
end
end
end
# frozen_string_literal: true
module EE
module Ci
# DailyBuildGroupReportResultsFinder
#
# Extends DailyBuildGroupReportResultsFinder
#
# Added arguments:
# params:
# group: integer
module DailyBuildGroupReportResultsFinder
extend ::Gitlab::Utils::Override
override :execute
def execute
return super unless params[:group]
return ::Ci::DailyBuildGroupReportResult.none unless query_allowed?
collection = ::Ci::DailyBuildGroupReportResult.by_group(params[:group])
collection = filter_report_results(collection)
collection
end
private
override :query_allowed?
def query_allowed?
return super unless params[:group]
can?(current_user, :read_group_build_report_results, params[:group])
end
end
end
end
# frozen_string_literal: true
module EE
module Ci
module Testing
# DailyBuildGroupReportResultsFinder
#
# Extends DailyBuildGroupReportResultsFinder
#
# Added arguments:
# params:
# group: integer
module DailyBuildGroupReportResultsFinder
extend ::Gitlab::Utils::Override
override :execute
def execute
return super unless params[:group]
return ::Ci::DailyBuildGroupReportResult.none unless query_allowed?
collection = ::Ci::DailyBuildGroupReportResult.by_group(params[:group])
collection = filter_report_results(collection)
collection
end
private
override :query_allowed?
def query_allowed?
return super unless params[:group]
can?(current_user, :read_group_build_report_results, params[:group])
end
end
end
end
end
...@@ -59,28 +59,6 @@ RSpec.describe Groups::Analytics::CoverageReportsController do ...@@ -59,28 +59,6 @@ RSpec.describe Groups::Analytics::CoverageReportsController do
stub_licensed_features(group_coverage_reports: true) stub_licensed_features(group_coverage_reports: true)
end end
context 'when feature coverage_data_new_finder is enabled' do
before do
stub_feature_flags(coverage_data_new_finder: true)
end
it 'responds 200 with CSV coverage data' do
get :index, params: valid_request_params
expect(response).to have_gitlab_http_status(:ok)
expect(csv_response).to eq([
%w[date group_name project_name coverage],
[last_coverage.date.to_s, last_coverage.group_name, project.name, last_coverage.data['coverage'].to_s],
[first_coverage.date.to_s, first_coverage.group_name, project.name, first_coverage.data['coverage'].to_s]
])
end
end
context 'when feature coverage_data_new_finder is disabled' do
before do
stub_feature_flags(coverage_data_new_finder: false)
end
it 'responds 200 with CSV coverage data', :snowplow do it 'responds 200 with CSV coverage data', :snowplow do
get :index, params: valid_request_params get :index, params: valid_request_params
...@@ -99,25 +77,6 @@ RSpec.describe Groups::Analytics::CoverageReportsController do ...@@ -99,25 +77,6 @@ RSpec.describe Groups::Analytics::CoverageReportsController do
]) ])
end end
context 'with a project_id filter' do
let(:params) { valid_request_params.merge(project_ids: [project.id]) }
it 'responds 200 with CSV coverage data' do
expect(Ci::DailyBuildGroupReportResultsByGroupFinder).to receive(:new).with({
group: group,
current_user: user,
project_ids: [project.id.to_s],
start_date: Date.parse('2020-03-01'),
end_date: Date.parse('2020-03-31'),
ref_path: ref_path
}).and_call_original
get :index, params: params
expect(response).to have_gitlab_http_status(:ok)
end
end
context 'when ref_path is nil' do context 'when ref_path is nil' do
let(:ref_path) { nil } let(:ref_path) { nil }
...@@ -136,7 +95,7 @@ RSpec.describe Groups::Analytics::CoverageReportsController do ...@@ -136,7 +95,7 @@ RSpec.describe Groups::Analytics::CoverageReportsController do
expect(CSV.parse(response.body).length).to eq(3) expect(CSV.parse(response.body).length).to eq(3)
create_daily_coverage('rspec', project, 79.0, '2020-03-10') create_daily_coverage('rspec', project, 79.0, '2020-03-10', group)
expect { get :index, params: valid_request_params }.not_to exceed_query_limit(control) expect { get :index, params: valid_request_params }.not_to exceed_query_limit(control)
...@@ -152,7 +111,6 @@ RSpec.describe Groups::Analytics::CoverageReportsController do ...@@ -152,7 +111,6 @@ RSpec.describe Groups::Analytics::CoverageReportsController do
end end
end end
end end
end
private private
......
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Ci::DailyBuildGroupReportResultsByGroupFinder do
describe '#execute' do
let_it_be(:user) { create(:user) }
let_it_be(:project) { create(:project, :private) }
let_it_be(:project_coverage) { create_daily_coverage('rspec', 95.0, '2020-03-10', project) }
let_it_be(:group) { create(:group, :private) }
let_it_be(:rspec_project) { create(:project, namespace: group) }
let_it_be(:rspec_project_coverage) { create_daily_coverage('rspec', 79.0, '2020-03-09', rspec_project) }
let_it_be(:karma_project) { create(:project, namespace: group) }
let_it_be(:karma_project_coverage) { create_daily_coverage('karma', 89.0, '2020-03-09', karma_project) }
let_it_be(:generic_project) { create(:project, namespace: group) }
let_it_be(:generic_coverage) { create_daily_coverage('unreported', 95.0, '2020-03-10', generic_project) }
let_it_be(:subgroup) { create(:group, :private, parent: group) }
let_it_be(:subgroup_project) { create(:project, namespace: subgroup) }
let_it_be(:subgroup_project_coverage) { create_daily_coverage('rspec', 89.0, '2020-03-09', subgroup_project) }
let(:limit) { nil }
let(:project_ids) { nil }
let(:attributes) do
{
current_user: user,
group: group,
project_ids: project_ids,
ref_path: 'refs/heads/master',
start_date: '2020-03-09',
end_date: '2020-03-10',
limit: limit
}
end
subject do
described_class.new(**attributes).execute
end
context 'when current user is allowed to :read_group_build_report_results' do
before do
group.add_reporter(user)
end
it 'returns only coverages belonging to the passed group' do
expect(subject).to include(rspec_project_coverage, karma_project_coverage)
expect(subject).not_to include(project_coverage)
expect(subject).not_to include(subgroup_project_coverage)
end
context 'with a limit below 1000' do
let(:limit) { 5 }
it 'uses the provided limit' do
expect(subject.limit_value).to eq(5)
end
end
context 'with a limit above 1000' do
let(:limit) { 1001 }
it 'uses the max constant' do
expect(subject.limit_value).to eq(Ci::DailyBuildGroupReportResultsByGroupFinder::GROUP_QUERY_RESULT_LIMIT)
end
end
context 'without a limit' do
it 'uses the max constant' do
expect(subject.limit_value).to eq(Ci::DailyBuildGroupReportResultsByGroupFinder::GROUP_QUERY_RESULT_LIMIT)
end
end
context 'with nil project_ids' do
it 'returns only coverages belonging to the passed group' do
expect(subject).to match_array([rspec_project_coverage, karma_project_coverage, generic_coverage])
expect(subject).not_to include(project_coverage)
expect(subject).not_to include(subgroup_project_coverage)
end
end
context 'with passed project_ids' do
let(:project_ids) { [rspec_project.id] }
it 'filters out non-specified projects' do
expect(subject).to match_array([rspec_project_coverage])
expect(subject).not_to include(karma_project_coverage, generic_coverage)
end
end
context 'with empty project_ids' do
let(:project_ids) { [] }
it 'returns all projects' do
expect(subject).to match_array([rspec_project_coverage, karma_project_coverage, generic_coverage])
end
end
end
context 'without permmissions' do
it 'returns an empty result' do
expect(subject).to be_empty
end
end
end
private
def create_daily_coverage(group_name, coverage, date, project)
create(
:ci_daily_build_group_report_result,
project: project,
ref_path: 'refs/heads/master',
group_name: group_name,
data: { 'coverage' => coverage },
date: date
)
end
end
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
require 'spec_helper' require 'spec_helper'
RSpec.describe Ci::Testing::DailyBuildGroupReportResultsFinder do RSpec.describe Ci::DailyBuildGroupReportResultsFinder do
describe '#execute' do describe '#execute' do
let_it_be(:current_user) { create(:user) } let_it_be(:current_user) { create(:user) }
let_it_be(:group) { create(:group, :private) } let_it_be(:group) { create(:group, :private) }
...@@ -56,13 +56,13 @@ RSpec.describe Ci::Testing::DailyBuildGroupReportResultsFinder do ...@@ -56,13 +56,13 @@ RSpec.describe Ci::Testing::DailyBuildGroupReportResultsFinder do
let(:limit) { 1001 } let(:limit) { 1001 }
it 'returns MAX_ITEMS as a limit' do it 'returns MAX_ITEMS as a limit' do
expect(coverages.limit_value).to eq(Ci::Testing::DailyBuildGroupReportResultsFinder::MAX_ITEMS) expect(coverages.limit_value).to eq(Ci::DailyBuildGroupReportResultsFinder::MAX_ITEMS)
end end
end end
context 'without a limit' do context 'without a limit' do
it 'returns MAX_ITEMS as a limit' do it 'returns MAX_ITEMS as a limit' do
expect(coverages.limit_value).to eq(Ci::Testing::DailyBuildGroupReportResultsFinder::MAX_ITEMS) expect(coverages.limit_value).to eq(Ci::DailyBuildGroupReportResultsFinder::MAX_ITEMS)
end end
end end
end end
......
...@@ -75,10 +75,6 @@ module Gitlab ...@@ -75,10 +75,6 @@ module Gitlab
def self.display_codequality_backend_comparison?(project) def self.display_codequality_backend_comparison?(project)
::Feature.enabled?(:codequality_backend_comparison, project, default_enabled: :yaml) ::Feature.enabled?(:codequality_backend_comparison, project, default_enabled: :yaml)
end end
def self.use_coverage_data_new_finder?(record)
::Feature.enabled?(:coverage_data_new_finder, record, default_enabled: :yaml)
end
end end
end end
end end
...@@ -4,29 +4,25 @@ require 'spec_helper' ...@@ -4,29 +4,25 @@ require 'spec_helper'
RSpec.describe Projects::Ci::DailyBuildGroupReportResultsController do RSpec.describe Projects::Ci::DailyBuildGroupReportResultsController do
describe 'GET index' do describe 'GET index' do
let(:project) { create(:project, :public, :repository) } let_it_be(:project) { create(:project, :public, :repository) }
let(:ref_path) { 'refs/heads/master' } let_it_be(:ref_path) { 'refs/heads/master' }
let(:param_type) { 'coverage' } let_it_be(:param_type) { 'coverage' }
let(:start_date) { '2019-12-10' } let_it_be(:start_date) { '2019-12-10' }
let(:end_date) { '2020-03-09' } let_it_be(:end_date) { '2020-03-09' }
let(:allowed_to_read) { true } let_it_be(:allowed_to_read) { true }
let(:user) { create(:user) } let_it_be(:user) { create(:user) }
let(:feature_enabled?) { true } let_it_be(:rspec_coverage_1) { create_daily_coverage('rspec', 79.0, '2020-03-09') }
let_it_be(:rspec_coverage_2) { create_daily_coverage('rspec', 77.0, '2020-03-08') }
let_it_be(:karma_coverage) { create_daily_coverage('karma', 81.0, '2019-12-10') }
let_it_be(:minitest_coverage) { create_daily_coverage('minitest', 67.0, '2019-12-09') }
let_it_be(:mocha_coverage) { create_daily_coverage('mocha', 71.0, '2019-12-09') }
before do before do
create_daily_coverage('rspec', 79.0, '2020-03-09')
create_daily_coverage('rspec', 77.0, '2020-03-08')
create_daily_coverage('karma', 81.0, '2019-12-10')
create_daily_coverage('minitest', 67.0, '2019-12-09')
create_daily_coverage('mocha', 71.0, '2019-12-09')
sign_in(user) sign_in(user)
allow(Ability).to receive(:allowed?).and_call_original allow(Ability).to receive(:allowed?).and_call_original
allow(Ability).to receive(:allowed?).with(user, :read_build_report_results, project).and_return(allowed_to_read) allow(Ability).to receive(:allowed?).with(user, :read_build_report_results, project).and_return(allowed_to_read)
stub_feature_flags(coverage_data_new_finder: feature_enabled?)
get :index, params: { get :index, params: {
namespace_id: project.namespace, namespace_id: project.namespace,
project_id: project, project_id: project,
...@@ -140,34 +136,14 @@ RSpec.describe Projects::Ci::DailyBuildGroupReportResultsController do ...@@ -140,34 +136,14 @@ RSpec.describe Projects::Ci::DailyBuildGroupReportResultsController do
context 'when format is JSON' do context 'when format is JSON' do
let(:format) { :json } let(:format) { :json }
context 'when coverage_data_new_finder flag is enabled' do
let(:feature_enabled?) { true }
it_behaves_like 'JSON results' it_behaves_like 'JSON results'
end end
context 'when coverage_data_new_finder flag is disabled' do
let(:feature_enabled?) { false }
it_behaves_like 'JSON results'
end
end
context 'when format is CSV' do context 'when format is CSV' do
let(:format) { :csv } let(:format) { :csv }
context 'when coverage_data_new_finder flag is enabled' do
let(:feature_enabled?) { true }
it_behaves_like 'CSV results' it_behaves_like 'CSV results'
end end
context 'when coverage_data_new_finder flag is disabled' do
let(:feature_enabled?) { false }
it_behaves_like 'CSV results'
end
end
end end
def create_daily_coverage(group_name, coverage, date) def create_daily_coverage(group_name, coverage, date)
......
...@@ -5,10 +5,14 @@ require 'spec_helper' ...@@ -5,10 +5,14 @@ require 'spec_helper'
RSpec.describe Ci::DailyBuildGroupReportResultsFinder do RSpec.describe Ci::DailyBuildGroupReportResultsFinder do
describe '#execute' do describe '#execute' do
let_it_be(:project) { create(:project, :private) } let_it_be(:project) { create(:project, :private) }
let_it_be(:current_user) { project.owner } let(:user_without_permission) { create(:user) }
let_it_be(:user_with_permission) { project.owner }
let_it_be(:ref_path) { 'refs/heads/master' } let_it_be(:ref_path) { 'refs/heads/master' }
let(:limit) { nil } let(:limit) { nil }
let_it_be(:default_branch) { false } let_it_be(:default_branch) { false }
let(:start_date) { '2020-03-09' }
let(:end_date) { '2020-03-10' }
let(:sort) { true }
let_it_be(:rspec_coverage_1) { create_daily_coverage('rspec', 79.0, '2020-03-09') } let_it_be(:rspec_coverage_1) { create_daily_coverage('rspec', 79.0, '2020-03-09') }
let_it_be(:karma_coverage_1) { create_daily_coverage('karma', 89.0, '2020-03-09') } let_it_be(:karma_coverage_1) { create_daily_coverage('karma', 89.0, '2020-03-09') }
...@@ -17,24 +21,35 @@ RSpec.describe Ci::DailyBuildGroupReportResultsFinder do ...@@ -17,24 +21,35 @@ RSpec.describe Ci::DailyBuildGroupReportResultsFinder do
let_it_be(:rspec_coverage_3) { create_daily_coverage('rspec', 97.0, '2020-03-11') } let_it_be(:rspec_coverage_3) { create_daily_coverage('rspec', 97.0, '2020-03-11') }
let_it_be(:karma_coverage_3) { create_daily_coverage('karma', 99.0, '2020-03-11') } let_it_be(:karma_coverage_3) { create_daily_coverage('karma', 99.0, '2020-03-11') }
let(:attributes) do let(:finder) { described_class.new(params: params, current_user: current_user) }
let(:params) do
{ {
current_user: current_user,
project: project, project: project,
coverage: true,
ref_path: ref_path, ref_path: ref_path,
start_date: '2020-03-09', start_date: start_date,
end_date: '2020-03-10', end_date: end_date,
limit: limit limit: limit,
sort: sort
} }
end end
subject(:coverages) do subject(:coverages) { finder.execute }
described_class.new(**attributes).execute
context 'when params are provided' do
context 'when current user is not allowed to read data' do
let(:current_user) { user_without_permission }
it 'returns an empty collection' do
expect(coverages).to be_empty
end end
end
context 'when current user is allowed to read data' do
let(:current_user) { user_with_permission }
context 'when ref_path is present' do it 'returns matching coverages within the given date range' do
context 'when current user is allowed to read build report results' do
it 'returns all matching results within the given date range' do
expect(coverages).to match_array([ expect(coverages).to match_array([
karma_coverage_2, karma_coverage_2,
rspec_coverage_2, rspec_coverage_2,
...@@ -43,10 +58,21 @@ RSpec.describe Ci::DailyBuildGroupReportResultsFinder do ...@@ -43,10 +58,21 @@ RSpec.describe Ci::DailyBuildGroupReportResultsFinder do
]) ])
end end
context 'and limit is specified' do context 'when ref_path is nil' do
let(:default_branch) { true }
let(:ref_path) { nil }
it 'returns coverages for the default branch' do
rspec_coverage_4 = create_daily_coverage('rspec', 66.0, '2020-03-10')
expect(coverages).to contain_exactly(rspec_coverage_4)
end
end
context 'when limit is specified' do
let(:limit) { 2 } let(:limit) { 2 }
it 'returns limited number of matching results within the given date range' do it 'returns limited number of matching coverages within the given date range' do
expect(coverages).to match_array([ expect(coverages).to match_array([
karma_coverage_2, karma_coverage_2,
rspec_coverage_2 rspec_coverage_2
...@@ -54,28 +80,6 @@ RSpec.describe Ci::DailyBuildGroupReportResultsFinder do ...@@ -54,28 +80,6 @@ RSpec.describe Ci::DailyBuildGroupReportResultsFinder do
end end
end end
end end
context 'when current user is not allowed to read build report results' do
let(:current_user) { create(:user) }
it 'returns an empty result' do
expect(coverages).to be_empty
end
end
end
context 'when ref_path query parameter is not present' do
let(:ref_path) { nil }
context 'when records with cover data from the default branch exist' do
let(:default_branch) { true }
it 'returns records with default_branch:true, irrespective of ref_path' do
rspec_coverage_4 = create_daily_coverage('rspec', 66.0, '2020-03-10')
expect(coverages).to contain_exactly(rspec_coverage_4)
end
end
end end
end end
......
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Ci::Testing::DailyBuildGroupReportResultsFinder do
describe '#execute' do
let_it_be(:project) { create(:project, :private) }
let(:user_without_permission) { create(:user) }
let_it_be(:user_with_permission) { project.owner }
let_it_be(:ref_path) { 'refs/heads/master' }
let(:limit) { nil }
let_it_be(:default_branch) { false }
let(:start_date) { '2020-03-09' }
let(:end_date) { '2020-03-10' }
let(:sort) { true }
let_it_be(:rspec_coverage_1) { create_daily_coverage('rspec', 79.0, '2020-03-09') }
let_it_be(:karma_coverage_1) { create_daily_coverage('karma', 89.0, '2020-03-09') }
let_it_be(:rspec_coverage_2) { create_daily_coverage('rspec', 95.0, '2020-03-10') }
let_it_be(:karma_coverage_2) { create_daily_coverage('karma', 92.0, '2020-03-10') }
let_it_be(:rspec_coverage_3) { create_daily_coverage('rspec', 97.0, '2020-03-11') }
let_it_be(:karma_coverage_3) { create_daily_coverage('karma', 99.0, '2020-03-11') }
let(:finder) { described_class.new(params: params, current_user: current_user) }
let(:params) do
{
project: project,
coverage: true,
ref_path: ref_path,
start_date: start_date,
end_date: end_date,
limit: limit,
sort: sort
}
end
subject(:coverages) { finder.execute }
context 'when params are provided' do
context 'when current user is not allowed to read data' do
let(:current_user) { user_without_permission }
it 'returns an empty collection' do
expect(coverages).to be_empty
end
end
context 'when current user is allowed to read data' do
let(:current_user) { user_with_permission }
it 'returns matching coverages within the given date range' do
expect(coverages).to match_array([
karma_coverage_2,
rspec_coverage_2,
karma_coverage_1,
rspec_coverage_1
])
end
context 'when ref_path is nil' do
let(:default_branch) { true }
let(:ref_path) { nil }
it 'returns coverages for the default branch' do
rspec_coverage_4 = create_daily_coverage('rspec', 66.0, '2020-03-10')
expect(coverages).to contain_exactly(rspec_coverage_4)
end
end
context 'when limit is specified' do
let(:limit) { 2 }
it 'returns limited number of matching coverages within the given date range' do
expect(coverages).to match_array([
karma_coverage_2,
rspec_coverage_2
])
end
end
end
end
end
private
def create_daily_coverage(group_name, coverage, date)
create(
:ci_daily_build_group_report_result,
project: project,
ref_path: ref_path || 'feature-branch',
group_name: group_name,
data: { 'coverage' => coverage },
date: date,
default_branch: default_branch
)
end
end
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment