Merge branch 'eb-skip-cobertura-sources' into 'master'

Ignore sources node from cobertura XML

See merge request gitlab-org/gitlab!39385

changelogs/unreleased/eb-skip-cobertura-sources.yml

+---
+title: Ignore the sources node from the cobertura XML
+merge_request: 39385
+author:
+type: fixed

doc/user/project/merge_requests/test_coverage_visualization.md

@@ -54,6 +54,10 @@ from any job in any stage in the pipeline. The coverage will be displayed for ea
 Hovering over the coverage bar will provide further information, such as the number
 of times the line was checked by tests.
 
+NOTE: **Note:**
+The Cobertura XML parser currently does not support the `sources` element and ignores it. It is assumed that
+the `filename` of a `class` element contains the full path relative to the project root.
+
 ## Example test coverage configuration
 
 The following [`gitlab-ci.yml`](../../../ci/yaml/README.md) example uses [Mocha](https://mochajs.org/)

lib/gitlab/ci/parsers/coverage/cobertura.rb

@@ -28,6 +28,8 @@ module Gitlab
           end
 
           def parse_node(key, value, coverage_report)
+            return if key == 'sources'
+
             if key == 'class'
               Array.wrap(value).each do |item|
                 parse_class(item, coverage_report)

spec/lib/gitlab/ci/parsers/coverage/cobertura_spec.rb

@@ -19,6 +19,41 @@ RSpec.describe Gitlab::Ci::Parsers::Coverage::Cobertura do
         end
       end
 
+      context 'when there is a <sources>' do
+        shared_examples_for 'ignoring sources' do
+          it 'parses XML without errors' do
+            expect { subject }.not_to raise_error
+
+            expect(coverage_report.files).to eq({})
+          end
+        end
+
+        context 'and has a single source' do
+          let(:cobertura) do
+            <<-EOF.strip_heredoc
+            <sources>
+              <source>project/src</source>
+            </sources>
+            EOF
+          end
+
+          it_behaves_like 'ignoring sources'
+        end
+
+        context 'and has multiple sources' do
+          let(:cobertura) do
+            <<-EOF.strip_heredoc
+            <sources>
+              <source>project/src/foo</source>
+              <source>project/src/bar</source>
+            </sources>
+            EOF
+          end
+
+          it_behaves_like 'ignoring sources'
+        end
+      end
+
       context 'when there is a single <class>' do
         context 'with no lines' do
           let(:cobertura) do