gitlab-ce/spec/lib/gitlab/diff/highlight_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Diff::Highlight, feature_category: :source_code_management do
  include RepoHelpers

  let_it_be(:project) { create(:project, :repository) }

  let(:commit) { project.commit(sample_commit.id) }
  let(:diff) { commit.raw_diffs.first }
  let(:diff_file) { Gitlab::Diff::File.new(diff, diff_refs: commit.diff_refs, repository: project.repository) }

  shared_examples 'without inline diffs' do
    let(:code) { '<h2 onmouseover="alert(2)">Test</h2>' }

    before do
      allow_any_instance_of(Gitlab::Diff::Line).to receive(:text).and_return(code)
    end

    it 'returns html escaped diff text' do
      expect(subject[1].rich_text).to eq html_escape(code)
      expect(subject[1].rich_text).to be_html_safe
    end
  end

  describe '#highlight' do
    shared_examples_for 'diff highlighter' do
      context "with a diff file" do
        let(:subject) { described_class.new(diff_file, repository: project.repository).highlight }

        it 'returns Gitlab::Diff::Line elements' do
          expect(subject.first).to be_an_instance_of(Gitlab::Diff::Line)
        end

        it 'does not modify "match" lines' do
          expect(subject[0].text).to eq('@@ -6,12 +6,18 @@ module Popen')
          expect(subject[22].text).to eq('@@ -19,6 +25,7 @@ module Popen')
        end

        it 'highlights and marks unchanged lines' do
          code = %{ <span class="line" data-lang="ruby">  <span class="k">def</span> <span class="nf">popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="kp">nil</span><span class="p">)</span></span>\n}

          expect(subject[2].rich_text).to eq(code)
        end

        it 'highlights and marks removed lines' do
          code = %(-<span class="line" data-lang="ruby">      <span class="k">raise</span> <span class="s2">"System commands must be given as an array of strings"</span></span>\n)

          expect(subject[4].rich_text).to eq(code)
        end

        it 'highlights and marks added lines' do
          code = %(+<span class="line" data-lang="ruby">      <span class="k">raise</span> <span class="no"><span class="idiff left addition">RuntimeError</span></span><span class="p"><span class="idiff addition">,</span></span><span class="idiff right addition"> </span><span class="s2">"System commands must be given as an array of strings"</span></span>\n)

          expect(subject[5].rich_text).to eq(code)
        end

        context 'when no diff_refs' do
          before do
            allow(diff_file).to receive(:diff_refs).and_return(nil)
          end

          context 'when no inline diffs' do
            it_behaves_like 'without inline diffs'
          end
        end
      end

      context "with diff lines" do
        let(:subject) { described_class.new(diff_file.diff_lines, repository: project.repository).highlight }

        it 'returns Gitlab::Diff::Line elements' do
          expect(subject.first).to be_an_instance_of(Gitlab::Diff::Line)
        end

        it 'does not modify "match" lines' do
          expect(subject[0].text).to eq('@@ -6,12 +6,18 @@ module Popen')
          expect(subject[22].text).to eq('@@ -19,6 +25,7 @@ module Popen')
        end

        it 'marks unchanged lines' do
          code = %q{   def popen(cmd, path=nil)}

          expect(subject[2].text).to eq(code)
          expect(subject[2].text).not_to be_html_safe
        end

        it 'marks removed lines' do
          code = %q(-      raise "System commands must be given as an array of strings")

          expect(subject[4].text).to eq(code)
          expect(subject[4].text).not_to be_html_safe
        end

        it 'marks added lines' do
          code = %q(+      raise <span class="idiff left right addition">RuntimeError, </span>&quot;System commands must be given as an array of strings&quot;)

          expect(subject[5].rich_text).to eq(code)
          expect(subject[5].rich_text).to be_html_safe
        end

        context 'when the inline diff marker has an invalid range' do
          before do
            allow_any_instance_of(Gitlab::Diff::InlineDiffMarker).to receive(:mark).and_raise(RangeError)
          end

          it 'keeps the original rich line' do
            allow(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)

            code = %q(+      raise RuntimeError, "System commands must be given as an array of strings")

            expect(subject[5].text).to eq(code)
            expect(subject[5].text).not_to be_html_safe
          end

          it 'reports to Sentry if configured' do
            expect(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception).and_call_original

            expect { subject }.to raise_exception(RangeError)
          end
        end

        context 'when no inline diffs' do
          it_behaves_like 'without inline diffs'
        end
      end

      context 'when blob is too large' do
        let(:subject) { described_class.new(diff_file, repository: project.repository).highlight }

        before do
          allow(Gitlab::Highlight).to receive(:too_large?).and_return(true)
        end

        it 'blobs are highlighted as plain text without loading all data' do
          expect(diff_file.blob).not_to receive(:load_all_data!)

          expect(subject[2].rich_text).to eq(%{ <span class="line">  def popen(cmd, path=nil)</span>\n})
          expect(subject[2].rich_text).to be_html_safe
        end
      end

      context 'when blob highlight is plain' do
        let(:subject) { described_class.new(diff_file, repository: project.repository, plain: true).highlight }

        it 'blobs are highlighted as plain text without loading all data' do
          expect(diff_file.blob).not_to receive(:load_all_data!)

          expect(subject[2].rich_text).to eq(%{ <span class="line">  def popen(cmd, path=nil)</span>\n})
          expect(subject[2].rich_text).to be_html_safe
        end
      end
    end

    it_behaves_like 'diff highlighter'

    context 'when diff_line_syntax_highlighting feature flag is disabled' do
      before do
        stub_feature_flags(diff_line_syntax_highlighting: false)
      end

      it_behaves_like 'diff highlighter'
    end
  end
end