diff options
Diffstat (limited to 'spec/lib/gitlab/ci/reports/codequality_reports_comparer_spec.rb')
| -rw-r--r-- | spec/lib/gitlab/ci/reports/codequality_reports_comparer_spec.rb | 308 |
1 files changed, 308 insertions, 0 deletions
diff --git a/spec/lib/gitlab/ci/reports/codequality_reports_comparer_spec.rb b/spec/lib/gitlab/ci/reports/codequality_reports_comparer_spec.rb new file mode 100644 index 00000000000..7053d54381b --- /dev/null +++ b/spec/lib/gitlab/ci/reports/codequality_reports_comparer_spec.rb @@ -0,0 +1,308 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::Ci::Reports::CodequalityReportsComparer do + let(:comparer) { described_class.new(base_report, head_report) } + let(:base_report) { Gitlab::Ci::Reports::CodequalityReports.new } + let(:head_report) { Gitlab::Ci::Reports::CodequalityReports.new } + let(:degradation_1) do + { + "categories": [ + "Complexity" + ], + "check_name": "argument_count", + "content": { + "body": "" + }, + "description": "Method `new_array` has 12 arguments (exceeds 4 allowed). Consider refactoring.", + "fingerprint": "15cdb5c53afd42bc22f8ca366a08d547", + "location": { + "path": "foo.rb", + "lines": { + "begin": 10, + "end": 10 + } + }, + "other_locations": [], + "remediation_points": 900000, + "severity": "major", + "type": "issue", + "engine_name": "structure" + }.with_indifferent_access + end + + let(:degradation_2) do + { + "type": "Issue", + "check_name": "Rubocop/Metrics/ParameterLists", + "description": "Avoid parameter lists longer than 5 parameters. [12/5]", + "categories": [ + "Complexity" + ], + "remediation_points": 550000, + "location": { + "path": "foo.rb", + "positions": { + "begin": { + "column": 14, + "line": 10 + }, + "end": { + "column": 39, + "line": 10 + } + } + }, + "content": { + "body": "This cop checks for methods with too many parameters.\nThe maximum number of parameters is configurable.\nKeyword arguments can optionally be excluded from the total count." + }, + "engine_name": "rubocop", + "fingerprint": "ab5f8b935886b942d621399f5a2ca16e", + "severity": "minor" + }.with_indifferent_access + end + + describe '#status' do + subject(:report_status) { comparer.status } + + context 'when head report has an error' do + before do + head_report.add_degradation(degradation_1) + end + + it 'returns status failed' do + expect(report_status).to eq(described_class::STATUS_FAILED) + end + end + + context 'when head report does not have errors' do + it 'returns status success' do + expect(report_status).to eq(described_class::STATUS_SUCCESS) + end + end + end + + describe '#errors_count' do + subject(:errors_count) { comparer.errors_count } + + context 'when head report has an error' do + before do + head_report.add_degradation(degradation_1) + end + + it 'returns the number of new errors' do + expect(errors_count).to eq(1) + end + end + + context 'when head report does not have an error' do + it 'returns zero' do + expect(errors_count).to be_zero + end + end + end + + describe '#resolved_count' do + subject(:resolved_count) { comparer.resolved_count } + + context 'when base report has an error and head has a different error' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'counts the base report error as resolved' do + expect(resolved_count).to eq(1) + end + end + + context 'when base report has errors head has no errors' do + before do + base_report.add_degradation(degradation_1) + end + + it 'counts the base report errors as resolved' do + expect(resolved_count).to eq(1) + end + end + + context 'when base report has errors and head has the same error' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_1) + end + + it 'returns zero' do + expect(resolved_count).to eq(0) + end + end + + context 'when base report does not have errors and head has errors' do + before do + head_report.add_degradation(degradation_1) + end + + it 'returns zero' do + expect(resolved_count).to be_zero + end + end + end + + describe '#total_count' do + subject(:total_count) { comparer.total_count } + + context 'when base report has an error' do + before do + base_report.add_degradation(degradation_1) + end + + it 'returns zero' do + expect(total_count).to be_zero + end + end + + context 'when head report has an error' do + before do + head_report.add_degradation(degradation_1) + end + + it 'includes the head report error in the count' do + expect(total_count).to eq(1) + end + end + + context 'when base report has errors and head report has errors' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'includes errors in the count' do + expect(total_count).to eq(1) + end + end + + context 'when base report has errors and head report has the same error' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'includes errors in the count' do + expect(total_count).to eq(2) + end + end + end + + describe '#existing_errors' do + subject(:existing_errors) { comparer.existing_errors } + + context 'when base report has errors and head has the same error' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'includes the base report errors' do + expect(existing_errors).to contain_exactly(degradation_1) + end + end + + context 'when base report has errors and head has a different error' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'returns an empty array' do + expect(existing_errors).to be_empty + end + end + + context 'when base report does not have errors and head has errors' do + before do + head_report.add_degradation(degradation_1) + end + + it 'returns an empty array' do + expect(existing_errors).to be_empty + end + end + end + + describe '#new_errors' do + subject(:new_errors) { comparer.new_errors } + + context 'when base report has errors and head has more errors' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'includes errors not found in the base report' do + expect(new_errors).to eq([degradation_2]) + end + end + + context 'when base report has an error and head has no errors' do + before do + base_report.add_degradation(degradation_1) + end + + it 'returns an empty array' do + expect(new_errors).to be_empty + end + end + + context 'when base report does not have errors and head has errors' do + before do + head_report.add_degradation(degradation_1) + end + + it 'returns the head report error' do + expect(new_errors).to eq([degradation_1]) + end + end + end + + describe '#resolved_errors' do + subject(:resolved_errors) { comparer.resolved_errors } + + context 'when base report errors are still found in the head report' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'returns an empty array' do + expect(resolved_errors).to be_empty + end + end + + context 'when base report has errors and head has a different error' do + before do + base_report.add_degradation(degradation_1) + head_report.add_degradation(degradation_2) + end + + it 'returns the base report error' do + expect(resolved_errors).to eq([degradation_1]) + end + end + + context 'when base report does not have errors and head has errors' do + before do + head_report.add_degradation(degradation_1) + end + + it 'returns an empty array' do + expect(resolved_errors).to be_empty + end + end + end +end |