Add tests for build_trace_section_regex

lib/gitlab/regex.rb

@@ -220,8 +220,27 @@ module Gitlab
       "Must start with a letter, and cannot end with '-'"
     end
 
+    # The section start, e.g. section_start:12345678:NAME
+    def logs_section_prefix_regex
+      /section_((?:start)|(?:end)):(\d+):([a-zA-Z0-9_.-]+)/
+    end
+    
+    # The optional section options, e.g. [collapsed=true]
+    def logs_section_options_regex
+      /(\[(?:\w+=\w+)(?:, ?(?:\w+=\w+))*\])?/
+    end
+
+    # The region end, always: \r\e\[0K
+    def logs_section_suffix_regex
+      /\r\033\[0K/
+    end
+
     def build_trace_section_regex
-      @build_trace_section_regexp ||= /section_((?:start)|(?:end)):(\d+):([a-zA-Z0-9_.-]+)(\[(?:\w+=\w+)(?:, ?(?:\w+=\w+))*\])?\r\033\[0K/.freeze
+      @build_trace_section_regexp ||= %r{
+        #{logs_section_prefix_regex}
+        #{logs_section_options_regex}
+        #{logs_section_suffix_regex}
+      }x.freeze
     end
 
     def markdown_code_or_html_blocks

spec/lib/gitlab/regex_spec.rb

@@ -99,6 +99,37 @@ RSpec.describe Gitlab::Regex do
     it { is_expected.not_to match('foo-') }
   end
 
+  describe '.build_trace_section_regex' do
+    subject { described_class.build_trace_section_regex }
+
+    
+    context 'without options' do
+      example = "section_start:1600445393032:NAME\r\033\[0K"
+
+      it { is_expected.to match(example) }
+      it { is_expected.to match("section_end:12345678:aBcDeFg1234\r\033\[0K") }
+      it { is_expected.to match("section_start:0:sect_for_alpha-v1.0\r\033\[0K") }
+      it { is_expected.not_to match("section_start:section:0\r\033\[0K") }
+      it { is_expected.not_to match("section_:1600445393032:NAME\r\033\[0K") }
+      it { is_expected.not_to match(example.upcase) }
+    end
+
+    context 'with options' do
+      it { is_expected.to match("section_start:1600445393032:NAME[collapsed=true]\r\033\[0K") }
+      it { is_expected.to match("section_start:1600445393032:NAME[collapsed=true, example_option=false]\r\033\[0K") }
+      it { is_expected.to match("section_start:1600445393032:NAME[collapsed=true,example_option=false]\r\033\[0K") }
+      it { is_expected.to match("section_start:1600445393032:NAME[numeric_option=1234567]\r\033\[0K") }
+      # Without splitting the regex in one for start and one for end,
+      # this is possible, however, it is ignored for section_end.
+      it { is_expected.to match("section_end:1600445393032:NAME[collapsed=true]\r\033\[0K") }
+      it { is_expected.not_to match("section_start:1600445393032:NAME[collapsed=[]]]\r\033\[0K") }
+      it { is_expected.not_to match("section_start:1600445393032:NAME[collapsed = true]\r\033\[0K") }
+      it { is_expected.not_to match("section_start:1600445393032:NAME[collapsed = true, example_option=false]\r\033\[0K") }
+      it { is_expected.not_to match("section_start:1600445393032:NAME[collapsed=true,  example_option=false]\r\033\[0K") }
+      it { is_expected.not_to match("section_start:1600445393032:NAME[]\r\033\[0K") }
+    end
+  end
+
   describe '.container_repository_name_regex' do
     subject { described_class.container_repository_name_regex }