File: resource_event_shared_examples.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (214 lines) | stat: -rw-r--r-- 6,857 bytes parent folder | download
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# frozen_string_literal: true

require 'spec_helper'

RSpec.shared_examples 'a resource event' do
  let_it_be(:user1) { create(:user) }
  let_it_be(:user2) { create(:user) }

  let_it_be(:issue1) { create(:issue, author: user1) }
  let_it_be(:issue2) { create(:issue, author: user1) }
  let_it_be(:issue3) { create(:issue, author: user2) }

  let(:resource_event) { described_class.name.demodulize.underscore.to_sym }

  describe 'importable' do
    it { is_expected.to respond_to(:importing?) }
  end

  describe 'validations' do
    it { is_expected.not_to allow_value(nil).for(:user) }

    context 'when importing' do
      before do
        allow(subject).to receive(:importing?).and_return(true)
      end

      it { is_expected.to allow_value(nil).for(:user) }
    end
  end

  describe 'associations' do
    it { is_expected.to belong_to(:user) }
  end

  describe '.created_after' do
    let!(:created_at1) { 1.day.ago }
    let!(:created_at2) { 2.days.ago }
    let!(:created_at3) { 3.days.ago }

    let!(:event1) { create(resource_event, issue: issue1, created_at: created_at1) }
    let!(:event2) { create(resource_event, issue: issue2, created_at: created_at2) }
    let!(:event3) { create(resource_event, issue: issue2, created_at: created_at3) }

    it 'returns the expected events' do
      events = described_class.created_after(created_at3)

      expect(events).to contain_exactly(event1, event2)
    end

    it 'returns no events if time is after last record time' do
      events = described_class.created_after(1.minute.ago)

      expect(events).to be_empty
    end
  end

  describe '#synthetic_note_class' do
    it 'must implement #synthetic_note_class method' do
      expect { described_class.new.synthetic_note_class }
        .not_to raise_error
    end
  end
end

RSpec.shared_examples 'a resource event that responds to imported' do
  describe 'import source' do
    it { is_expected.to respond_to(:imported?) }
    it { is_expected.to respond_to(:imported_from) }
  end
end

RSpec.shared_examples 'a resource event for issues' do
  let_it_be(:user1) { create(:user) }
  let_it_be(:user2) { create(:user) }

  let_it_be(:issue1) { create(:issue, author: user1) }
  let_it_be(:issue2) { create(:issue, author: user1) }
  let_it_be(:issue3) { create(:issue, author: user2) }

  let_it_be(:resource_event) { described_class.name.demodulize.underscore.to_sym }
  let_it_be(:event1) { create(resource_event, issue: issue1) }
  let_it_be(:event2) { create(resource_event, issue: issue2) }
  let_it_be(:event3) { create(resource_event, issue: issue1) }

  describe 'associations' do
    it { is_expected.to belong_to(:issue) }
  end

  describe '.by_issue' do
    it 'returns the expected records for an issue with events' do
      events = described_class.by_issue(issue1)

      expect(events).to contain_exactly(event1, event3)
    end

    it 'returns the expected records for an issue with no events' do
      events = described_class.by_issue(issue3)

      expect(events).to be_empty
    end
  end

  describe '.by_issue_ids' do
    it 'returns the expected events' do
      events = described_class.by_issue_ids([issue1.id])

      expect(events).to contain_exactly(event1, event3)
    end
  end

  describe '.by_created_at_earlier_or_equal_to' do
    let_it_be(:event1) { create(resource_event, issue: issue1, created_at: '2020-03-10') }
    let_it_be(:event2) { create(resource_event, issue: issue2, created_at: '2020-03-10') }
    let_it_be(:event3) { create(resource_event, issue: issue1, created_at: '2020-03-12') }

    it 'returns the expected events' do
      events = described_class.by_created_at_earlier_or_equal_to('2020-03-11 23:59:59')

      expect(events).to contain_exactly(event1, event2)
    end

    it 'returns the expected events' do
      events = described_class.by_created_at_earlier_or_equal_to('2020-03-12')

      expect(events).to contain_exactly(event1, event2, event3)
    end
  end

  if described_class.method_defined?(:issuable)
    describe '#issuable' do
      let_it_be(:event1) { create(resource_event, issue: issue2) }

      it 'returns the expected issuable' do
        expect(event1.issuable).to eq(issue2)
      end
    end
  end
end

RSpec.shared_examples 'a resource event for merge requests' do
  let_it_be(:user1) { create(:user) }
  let_it_be(:user2) { create(:user) }

  let_it_be(:resource_event) { described_class.name.demodulize.underscore.to_sym }
  let_it_be(:merge_request1) { create(:merge_request, author: user1) }
  let_it_be(:merge_request2) { create(:merge_request, author: user1) }
  let_it_be(:merge_request3) { create(:merge_request, author: user2) }

  describe 'associations' do
    it { is_expected.to belong_to(:merge_request) }
  end

  describe '.by_merge_request' do
    let_it_be(:event1) { create(resource_event, merge_request: merge_request1) }
    let_it_be(:event2) { create(resource_event, merge_request: merge_request2) }
    let_it_be(:event3) { create(resource_event, merge_request: merge_request1) }

    it 'returns the expected records for an issue with events' do
      events = described_class.by_merge_request(merge_request1)

      expect(events).to contain_exactly(event1, event3)
    end

    it 'returns the expected records for an issue with no events' do
      events = described_class.by_merge_request(merge_request3)

      expect(events).to be_empty
    end
  end

  if described_class.method_defined?(:issuable)
    describe '#issuable' do
      let_it_be(:event1) { create(resource_event, merge_request: merge_request2) }

      it 'returns the expected issuable' do
        expect(event1.issuable).to eq(merge_request2)
      end
    end
  end

  context 'on callbacks' do
    it 'does not trigger note created subscription' do
      event = build(resource_event, merge_request: merge_request1)

      expect(GraphqlTriggers).not_to receive(:work_item_note_created)
      expect(event).not_to receive(:trigger_note_subscription_create)
      event.save!
    end
  end
end

RSpec.shared_examples 'a note for work item resource event' do
  let_it_be(:user) { create(:user) }
  let_it_be(:project) { create(:project) }
  let_it_be(:work_item) { create(:work_item, :task, project: project, author: user) }

  let(:resource_event) { described_class.name.demodulize.underscore.to_sym }

  it 'builds synthetic note with correct synthetic_note_class' do
    event = build(resource_event, issue: work_item)

    expect(event.work_item_synthetic_system_note.class.name).to eq(event.synthetic_note_class.name)
  end

  context 'on callbacks' do
    it 'triggers note created subscription' do
      event = build(resource_event, issue: work_item)

      expect(GraphqlTriggers).to receive(:work_item_note_created)
      expect(event).to receive(:trigger_note_subscription_create).and_call_original
      event.save!
    end
  end
end