debian-mirror-gitlab/spec/tooling/danger/specs_spec.rb

# frozen_string_literal: true

require 'rspec-parameterized'
require 'gitlab-dangerfiles'
require 'danger'
require 'danger/plugins/internal/helper'
require 'gitlab/dangerfiles/spec_helper'

require_relative '../../../tooling/danger/specs'
require_relative '../../../tooling/danger/project_helper'

RSpec.describe Tooling::Danger::Specs, feature_category: :tooling do
  include_context "with dangerfile"

  let(:fake_danger) { DangerSpecHelper.fake_danger.include(described_class) }
  let(:fake_project_helper) { instance_double('Tooling::Danger::ProjectHelper') }
  let(:filename) { 'spec/foo_spec.rb' }

  let(:file_lines) do
    [
      " describe 'foo' do",
      " expect(foo).to match(['bar', 'baz'])",
      " end",
      " expect(foo).to match(['bar', 'baz'])", # same line as line 1 above, we expect two different suggestions
      " ",
      " expect(foo).to match ['bar', 'baz']",
      " expect(foo).to eq(['bar', 'baz'])",
      " expect(foo).to eq ['bar', 'baz']",
      " expect(foo).to(match(['bar', 'baz']))",
      " expect(foo).to(eq(['bar', 'baz']))",
      " expect(foo).to(eq([bar, baz]))",
      " expect(foo).to(eq(['bar']))",
      " foo.eq(['bar'])"
    ]
  end

  let(:matching_lines) do
    [
      "+ expect(foo).to match(['should not error'])",
      "+ expect(foo).to match(['bar', 'baz'])",
      "+ expect(foo).to match(['bar', 'baz'])",
      "+ expect(foo).to match ['bar', 'baz']",
      "+ expect(foo).to eq(['bar', 'baz'])",
      "+ expect(foo).to eq ['bar', 'baz']",
      "+ expect(foo).to(match(['bar', 'baz']))",
      "+ expect(foo).to(eq(['bar', 'baz']))",
      "+ expect(foo).to(eq([bar, baz]))"
    ]
  end

  let(:changed_lines) do
    [
      "  expect(foo).to match(['bar', 'baz'])",
      "  expect(foo).to match(['bar', 'baz'])",
      "  expect(foo).to match ['bar', 'baz']",
      "  expect(foo).to eq(['bar', 'baz'])",
      "  expect(foo).to eq ['bar', 'baz']",
      "- expect(foo).to match(['bar', 'baz'])",
      "- expect(foo).to match(['bar', 'baz'])",
      "- expect(foo).to match ['bar', 'baz']",
      "- expect(foo).to eq(['bar', 'baz'])",
      "- expect(foo).to eq ['bar', 'baz']",
      "- expect(foo).to eq [bar, foo]",
      "+ expect(foo).to eq([])"
    ] + matching_lines
  end

  subject(:specs) { fake_danger.new(helper: fake_helper) }

  before do
    allow(specs).to receive(:project_helper).and_return(fake_project_helper)
    allow(specs.helper).to receive(:changed_lines).with(filename).and_return(matching_lines)
    allow(specs.project_helper).to receive(:file_lines).and_return(file_lines)
  end

  describe '#changed_specs_files' do
    let(:base_expected_files) { %w[spec/foo_spec.rb ee/spec/foo_spec.rb spec/bar_spec.rb ee/spec/bar_spec.rb spec/zab_spec.rb ee/spec/zab_spec.rb] }

    before do
      all_changed_files = %w[
        app/workers/a.rb
        app/workers/b.rb
        app/workers/e.rb
        spec/foo_spec.rb
        ee/spec/foo_spec.rb
        spec/bar_spec.rb
        ee/spec/bar_spec.rb
        spec/zab_spec.rb
        ee/spec/zab_spec.rb
      ]

      allow(specs.helper).to receive(:all_changed_files).and_return(all_changed_files)
    end

    it 'returns added, modified, and renamed_after files by default' do
      expect(specs.changed_specs_files).to match_array(base_expected_files)
    end

    context 'with include_ee: :exclude' do
      it 'returns spec files without EE-specific files' do
        expect(specs.changed_specs_files(ee: :exclude)).not_to include(%w[ee/spec/foo_spec.rb ee/spec/bar_spec.rb ee/spec/zab_spec.rb])
      end
    end

    context 'with include_ee: :only' do
      it 'returns EE-specific spec files only' do
        expect(specs.changed_specs_files(ee: :only)).to match_array(%w[ee/spec/foo_spec.rb ee/spec/bar_spec.rb ee/spec/zab_spec.rb])
      end
    end
  end

  describe '#add_suggestions_for_match_with_array' do
    let(:template) do
      <<~MARKDOWN.chomp
      ```suggestion
      %<suggested_line>s
      ```

      If order of the result is not important, please consider using `match_array` to avoid flakiness.
      MARKDOWN
    end

    it 'adds suggestions at the correct lines' do
      [
        { suggested_line: " expect(foo).to match_array(['bar', 'baz'])", number: 2 },
        { suggested_line: " expect(foo).to match_array(['bar', 'baz'])", number: 4 },
        { suggested_line: " expect(foo).to match_array ['bar', 'baz']", number: 6 },
        { suggested_line: " expect(foo).to match_array(['bar', 'baz'])", number: 7 },
        { suggested_line: " expect(foo).to match_array ['bar', 'baz']", number: 8 },
        { suggested_line: " expect(foo).to(match_array(['bar', 'baz']))", number: 9 },
        { suggested_line: " expect(foo).to(match_array(['bar', 'baz']))", number: 10 },
        { suggested_line: " expect(foo).to(match_array([bar, baz]))", number: 11 }
      ].each do |test_case|
        comment = format(template, suggested_line: test_case[:suggested_line])
        expect(specs).to receive(:markdown).with(comment, file: filename, line: test_case[:number])
      end

      specs.add_suggestions_for_match_with_array(filename)
    end
  end

  describe '#add_suggestions_for_project_factory_usage' do
    let(:template) do
      <<~MARKDOWN.chomp
      ```suggestion
      %<suggested_line>s
      ```

      Project creations are very slow. Use `let_it_be`, `build` or `build_stubbed` if possible.
      See [testing best practices](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#optimize-factory-usage)
      for background information and alternative options.
      MARKDOWN
    end

    let(:file_lines) do
      [
        " let(:project) { create(:project) }",
        " let_it_be(:project) { create(:project, :repository)",
        " let!(:project) { create(:project) }",
        "   let(:var) { create(:project) }",
        " let(:merge_request) { create(:merge_request, project: project)",
        " context 'when merge request exists' do",
        "   it { is_expected.to be_success }",
        " end",
        "   let!(:var) { create(:project) }",
        " let(:project) { create(:thing) }",
        " let(:project) { build(:project) }",
        " let(:project) do",
        "   create(:project)",
        " end",
        " let(:project) { create(:project, :repository) }",
        " str = 'let(:project) { create(:project) }'",
        " let(:project) { create(:project_empty_repo) }",
        " let(:project) { create(:forked_project_with_submodules) }",
        " let(:project) { create(:project_with_design) }",
        " let(:authorization) { create(:project_authorization) }"
      ]
    end

    let(:matching_lines) do
      [
        "+ let(:should_not_error) { create(:project) }",
        "+ let(:project) { create(:project) }",
        "+ let!(:project) { create(:project) }",
        "+   let(:var) { create(:project) }",
        "+   let!(:var) { create(:project) }",
        "+ let(:project) { create(:project, :repository) }",
        "+ let(:project) { create(:project_empty_repo) }",
        "+ let(:project) { create(:forked_project_with_submodules) }",
        "+ let(:project) { create(:project_with_design) }"
      ]
    end

    let(:changed_lines) do
      [
        "+ line which doesn't exist in the file and should not cause an error",
        "+ let_it_be(:project) { create(:project, :repository)",
        "+ let(:project) { create(:thing) }",
        "+ let(:project) do",
        "+   create(:project)",
        "+ end",
        "+ str = 'let(:project) { create(:project) }'",
        "+ let(:authorization) { create(:project_authorization) }"
      ] + matching_lines
    end

    it 'adds suggestions at the correct lines', :aggregate_failures do
      [
        { suggested_line: " let_it_be(:project) { create(:project) }", number: 1 },
        { suggested_line: " let_it_be(:project) { create(:project) }", number: 3 },
        { suggested_line: "   let_it_be(:var) { create(:project) }", number: 4 },
        { suggested_line: "   let_it_be(:var) { create(:project) }", number: 9 },
        { suggested_line: " let_it_be(:project) { create(:project, :repository) }", number: 15 },
        { suggested_line: " let_it_be(:project) { create(:project_empty_repo) }", number: 17 },
        { suggested_line: " let_it_be(:project) { create(:forked_project_with_submodules) }", number: 18 },
        { suggested_line: " let_it_be(:project) { create(:project_with_design) }", number: 19 }
      ].each do |test_case|
        comment = format(template, suggested_line: test_case[:suggested_line])
        expect(specs).to receive(:markdown).with(comment, file: filename, line: test_case[:number])
      end

      specs.add_suggestions_for_project_factory_usage(filename)
    end
  end

  describe '#add_suggestions_for_feature_category' do
    let(:template) do
      <<~SUGGESTION_MARKDOWN.chomp
      ```suggestion
      %<suggested_line>s
      ```

      Consider adding `feature_category: <feature_category_name>` for this example if it is not set already.
      See [testing best practices](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#feature-category-metadata).
      SUGGESTION_MARKDOWN
    end

    let(:file_lines) do
      [
        " require 'spec_helper'",
        " \n",
        " RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController, feature_category: :planning_analytics do",
        " end",
        "RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController do",
        "  let_it_be(:user) { create(:user) }",
        " end",
        " describe 'GET \"time_summary\"' do",
        " end",
        " RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController do",
        "  let_it_be(:user) { create(:user) }",
        " end",
        " describe 'GET \"time_summary\"' do",
        " end",
        " \n",
        "RSpec.describe Projects :aggregate_failures,",
        "  feature_category: planning_analytics do",
        " \n",
        "RSpec.describe Epics :aggregate_failures,",
        "  ee: true do",
        "\n",
        "RSpec.describe Issues :aggregate_failures,",
        "  feature_category: :team_planning do"
      ]
    end

    let(:changed_lines) do
      [
        "+ RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController, feature_category: :planning_analytics do",
        "+RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController do",
        "+ let_it_be(:user) { create(:user) }",
        "- end",
        "+ describe 'GET \"time_summary\"' do",
        "+ RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController do",
        "+RSpec.describe Projects :aggregate_failures,",
        "+  feature_category: planning_analytics do",
        "+RSpec.describe Epics :aggregate_failures,",
        "+  ee: true do",
        "+RSpec.describe Issues :aggregate_failures,"
      ]
    end

    before do
      allow(specs.helper).to receive(:changed_lines).with(filename).and_return(changed_lines)
    end

    it 'adds suggestions at the correct lines', :aggregate_failures do
      [
        { suggested_line: "RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController do", number: 5 },
        { suggested_line: " RSpec.describe Projects::Analytics::CycleAnalytics::SummaryController do", number: 10 },
        { suggested_line: "RSpec.describe Epics :aggregate_failures,", number: 19 }

      ].each do |test_case|
        comment = format(template, suggested_line: test_case[:suggested_line])
        expect(specs).to receive(:markdown).with(comment, file: filename, line: test_case[:number])
      end

      specs.add_suggestions_for_feature_category(filename)
    end
  end
end