Merge branch '37970-timestamped-ci' into 'master'

Hide CI section markers from job trace

See merge request gitlab-org/gitlab-ce!14393

6 files changed, 51 insertions, 1 deletions

diff --git a/app/models/ci/build.rb b/app/models/ci/build.rb
index ee544d8ac56..dd315866e60 100644
--- a/app/models/ci/build.rb
+++ b/app/models/ci/build.rb
@@ -229,6 +229,10 @@ module Ci
       variables
     end
 
+    def features
+      { trace_sections: true }
+    end
+
     def merge_request
       return @merge_request if defined?(@merge_request)
 
diff --git a/changelogs/unreleased/37970-timestamped-ci.yml b/changelogs/unreleased/37970-timestamped-ci.yml
new file mode 100644
index 00000000000..2a4797f069a
--- /dev/null
+++ b/changelogs/unreleased/37970-timestamped-ci.yml
@@ -0,0 +1,5 @@
+---
+title: Strip gitlab-runner section markers in build trace HTML view
+merge_request: 14393
+author:
+type: added
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index 5d45b14f592..7082f31b5b8 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -1022,6 +1022,7 @@ module API
         expose :cache, using: Cache
         expose :credentials, using: Credentials
         expose :dependencies, using: Dependency
+        expose :features
       end
     end
 
diff --git a/lib/gitlab/ci/ansi2html.rb b/lib/gitlab/ci/ansi2html.rb
index ad78ae244b2..088adbdd267 100644
--- a/lib/gitlab/ci/ansi2html.rb
+++ b/lib/gitlab/ci/ansi2html.rb
@@ -155,7 +155,9 @@ module Gitlab
           stream.each_line do |line|
             s = StringScanner.new(line)
             until s.eos?
-              if s.scan(/\e([@-_])(.*?)([@-~])/)
+              if s.scan(/section_((?:start)|(?:end)):(\d+):([^\r]+)\r\033\[0K/)
+                handle_section(s)
+              elsif s.scan(/\e([@-_])(.*?)([@-~])/)
                 handle_sequence(s)
               elsif s.scan(/\e(([@-_])(.*?)?)?$/)
                 break
@@ -183,6 +185,15 @@ module Gitlab
           )
         end
 
+        def handle_section(s)
+          action = s[1]
+          timestamp = s[2]
+          section = s[3]
+          line = s.matched()[0...-5] # strips \r\033[0K
+
+          @out << %{<div class="hidden" data-action="#{action}" data-timestamp="#{timestamp}" data-section="#{section}">#{line}</div>}
+        end
+
         def handle_sequence(s)
           indicator = s[1]
           commands = s[2].split ';'
diff --git a/spec/lib/gitlab/ci/ansi2html_spec.rb b/spec/lib/gitlab/ci/ansi2html_spec.rb
index e6645985ba4..33540eab5d6 100644
--- a/spec/lib/gitlab/ci/ansi2html_spec.rb
+++ b/spec/lib/gitlab/ci/ansi2html_spec.rb
@@ -195,6 +195,32 @@ describe Gitlab::Ci::Ansi2html do
     end
   end
 
+  context "with section markers" do
+    let(:section_name) { 'test_section' }
+    let(:section_start_time) { Time.new(2017, 9, 20).utc }
+    let(:section_duration) { 3.seconds }
+    let(:section_end_time) { section_start_time + section_duration }
+    let(:section_start) { "section_start:#{section_start_time.to_i}:#{section_name}\r\033[0K"}
+    let(:section_end) { "section_end:#{section_end_time.to_i}:#{section_name}\r\033[0K"}
+    let(:section_start_html) do
+      '<div class="hidden" data-action="start"'\
+      " data-timestamp=\"#{section_start_time.to_i}\" data-section=\"#{section_name}\">"\
+      "#{section_start[0...-5]}</div>"
+    end
+    let(:section_end_html) do
+      '<div class="hidden" data-action="end"'\
+      " data-timestamp=\"#{section_end_time.to_i}\" data-section=\"#{section_name}\">"\
+      "#{section_end[0...-5]}</div>"
+    end
+
+    it "prints light red" do
+      text = "#{section_start}\e[91mHello\e[0m\n#{section_end}"
+      html = %{#{section_start_html}<span class="term-fg-l-red">Hello</span><br>#{section_end_html}}
+
+      expect(convert_html(text)).to eq(html)
+    end
+  end
+
   describe "truncates" do
     let(:text) { "Hello World" }
     let(:stream) { StringIO.new(text) }
diff --git a/spec/requests/api/runner_spec.rb b/spec/requests/api/runner_spec.rb
index 12720355a6d..5068df5b43a 100644
--- a/spec/requests/api/runner_spec.rb
+++ b/spec/requests/api/runner_spec.rb
@@ -360,6 +360,8 @@ describe API::Runner do
                'policy' => 'pull-push' }]
           end
 
+          let(:expected_features) { { 'trace_sections' => true } }
+
           it 'picks a job' do
             request_job info: { platform: :darwin }
 
@@ -379,6 +381,7 @@ describe API::Runner do
             expect(json_response['artifacts']).to eq(expected_artifacts)
             expect(json_response['cache']).to eq(expected_cache)
             expect(json_response['variables']).to include(*expected_variables)
+            expect(json_response['features']).to eq(expected_features)
           end
 
           context 'when job is made for tag' do