Welcome to mirror list, hosted at ThFree Co, Russian Federation.

find_tests_spec.rb « tooling « lib « tooling « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 905f81c4bbdc3a92949c88188f15fc4069aed6c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# frozen_string_literal: true

require 'tempfile'
require_relative '../../../../tooling/lib/tooling/find_tests'
require_relative '../../../support/helpers/stub_env'

RSpec.describe Tooling::FindTests, feature_category: :tooling do
  include StubENV

  attr_accessor :changed_files_file, :predictive_tests_file

  let(:instance)                     { described_class.new(changed_files_pathname, predictive_tests_pathname) }
  let(:mock_test_file_finder)        { instance_double(TestFileFinder::FileFinder) }
  let(:new_matching_tests)           { ["new_matching_spec.rb"] }
  let(:changed_files_pathname)       { changed_files_file.path }
  let(:predictive_tests_pathname)    { predictive_tests_file.path }
  let(:changed_files_content)        { "changed_file1 changed_file2" }
  let(:predictive_tests_content)     { "previously_matching_spec.rb" }

  around do |example|
    self.changed_files_file    = Tempfile.new('changed_files_file')
    self.predictive_tests_file = Tempfile.new('predictive_tests_file')

    # See https://ruby-doc.org/stdlib-1.9.3/libdoc/tempfile/rdoc/
    #     Tempfile.html#class-Tempfile-label-Explicit+close
    begin
      example.run
    ensure
      changed_files_file.close
      predictive_tests_file.close
      changed_files_file.unlink
      predictive_tests_file.unlink
    end
  end

  before do
    allow(mock_test_file_finder).to receive(:use)
    allow(mock_test_file_finder).to receive(:test_files).and_return(new_matching_tests)
    allow(TestFileFinder::FileFinder).to receive(:new).and_return(mock_test_file_finder)

    stub_env(
      'RSPEC_TESTS_MAPPING_ENABLED' => nil,
      'RSPEC_TESTS_MAPPING_PATH' => '/tmp/does-not-exist.out'
    )

    # We write into the temp files initially, to later check how the code modified those files
    File.write(changed_files_pathname, changed_files_content)
    File.write(predictive_tests_pathname, predictive_tests_content)
  end

  describe '#execute' do
    subject { instance.execute }

    context 'when the predictive_tests_pathname file does not exist' do
      let(:instance) { described_class.new(non_existing_output_pathname, predictive_tests_pathname) }
      let(:non_existing_output_pathname) { 'tmp/another_file.out' }

      around do |example|
        example.run
      ensure
        FileUtils.rm_rf(non_existing_output_pathname)
      end

      it 'creates the file' do
        expect { subject }.to change { File.exist?(non_existing_output_pathname) }.from(false).to(true)
      end
    end

    context 'when the predictive_tests_pathname file already exists' do
      it 'does not create an empty file' do
        expect(File).not_to receive(:write).with(predictive_tests_pathname, '')

        subject
      end
    end

    it 'does not modify the content of the input file' do
      expect { subject }.not_to change { File.read(changed_files_pathname) }
    end

    it 'does not overwrite the output file' do
      expect { subject }.to change { File.read(predictive_tests_pathname) }
                        .from(predictive_tests_content)
                        .to("#{predictive_tests_content} #{new_matching_tests.uniq.join(' ')}")
    end

    it 'loads the tests.yml file with a pattern matching mapping' do
      expect(TestFileFinder::MappingStrategies::PatternMatching).to receive(:load).with('tests.yml')

      subject
    end

    context 'when RSPEC_TESTS_MAPPING_ENABLED env variable is set' do
      before do
        stub_env(
          'RSPEC_TESTS_MAPPING_ENABLED' => 'true',
          'RSPEC_TESTS_MAPPING_PATH' => 'crystalball-test/mapping.json'
        )
      end

      it 'loads the direct matching pattern file' do
        expect(TestFileFinder::MappingStrategies::DirectMatching)
          .to receive(:load_json)
          .with('crystalball-test/mapping.json')

        subject
      end
    end

    context 'when RSPEC_TESTS_MAPPING_ENABLED env variable is not set' do
      let(:rspec_tests_mapping_enabled) { '' }

      before do
        stub_env(
          'RSPEC_TESTS_MAPPING_ENABLED' => rspec_tests_mapping_enabled,
          'RSPEC_TESTS_MAPPING_PATH' => rspec_tests_mapping_path
        )
      end

      context 'when RSPEC_TESTS_MAPPING_PATH is set' do
        let(:rspec_tests_mapping_path) { 'crystalball-test/mapping.json' }

        it 'does not load the direct matching pattern file' do
          expect(TestFileFinder::MappingStrategies::DirectMatching).not_to receive(:load_json)

          subject
        end
      end

      context 'when RSPEC_TESTS_MAPPING_PATH is not set' do
        let(:rspec_tests_mapping_path) { nil }

        it 'does not load the direct matching pattern file' do
          expect(TestFileFinder::MappingStrategies::DirectMatching).not_to receive(:load_json)

          subject
        end
      end
    end

    context 'when the same spec is matching multiple times' do
      let(:new_matching_tests) do
        [
          "new_matching_spec.rb",
          "duplicate_spec.rb",
          "duplicate_spec.rb"
        ]
      end

      it 'writes uniquely matching specs to the output' do
        subject

        expect(File.read(predictive_tests_pathname).split(' ')).to match_array(
          predictive_tests_content.split(' ') + new_matching_tests.uniq
        )
      end
    end
  end
end