summaryrefslogtreecommitdiff
path: root/spec/serializers/pipeline_entity_spec.rb
blob: c8308a0ae8537456de6b9d003857b2264b5a9976 (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
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
require 'spec_helper'

describe PipelineEntity do
  include Gitlab::Routing

  set(:project) { create(:project) }
  set(:user) { create(:user) }
  set(:project) { create(:project) }
  let(:request) { double('request') }

  before do
    stub_not_protect_default_branch

    allow(request).to receive(:current_user).and_return(user)
    allow(request).to receive(:project).and_return(project)
  end

  let(:entity) do
    described_class.represent(pipeline, request: request)
  end

  describe '#as_json' do
    subject { entity.as_json }

    context 'when pipeline is empty' do
      let(:pipeline) { create(:ci_empty_pipeline) }

      it 'contains required fields' do
        expect(subject).to include :id, :user, :path, :coverage, :source
        expect(subject).to include :ref, :commit
        expect(subject).to include :updated_at, :created_at
      end

      it 'excludes coverage data when disabled' do
        entity = described_class
          .represent(pipeline, request: request, disable_coverage: true)

        expect(entity.as_json).not_to include(:coverage)
      end

      it 'contains details' do
        expect(subject).to include :details
        expect(subject[:details])
          .to include :duration, :finished_at
        expect(subject[:details][:status]).to include :icon, :favicon, :text, :label, :tooltip
      end

      it 'contains flags' do
        expect(subject).to include :flags
        expect(subject[:flags])
          .to include :latest, :stuck, :auto_devops,
                      :yaml_errors, :retryable, :cancelable, :merge_request
      end
    end

    context 'when pipeline is retryable' do
      let(:project) { create(:project) }

      let(:pipeline) do
        create(:ci_pipeline, status: :success, project: project)
      end

      before do
        create(:ci_build, :failed, pipeline: pipeline)
      end

      context 'user has ability to retry pipeline' do
        before do
          project.add_developer(user)
        end

        it 'contains retry path' do
          expect(subject[:retry_path]).to be_present
        end
      end

      context 'user does not have ability to retry pipeline' do
        it 'does not contain retry path' do
          expect(subject).not_to have_key(:retry_path)
        end
      end
    end

    context 'when pipeline is cancelable' do
      let(:project) { create(:project) }

      let(:pipeline) do
        create(:ci_pipeline, status: :running, project: project)
      end

      before do
        create(:ci_build, :pending, pipeline: pipeline)
      end

      context 'user has ability to cancel pipeline' do
        before do
          project.add_developer(user)
        end

        it 'contains cancel path' do
          expect(subject[:cancel_path]).to be_present
        end
      end

      context 'user does not have ability to cancel pipeline' do
        it 'does not contain cancel path' do
          expect(subject).not_to have_key(:cancel_path)
        end
      end
    end

    context 'when pipeline ref is empty' do
      let(:pipeline) { create(:ci_empty_pipeline) }

      before do
        allow(pipeline).to receive(:ref).and_return(nil)
      end

      it 'does not generate branch path' do
        expect(subject[:ref][:path]).to be_nil
      end
    end

    context 'when pipeline has a failure reason set' do
      let(:pipeline) { create(:ci_empty_pipeline) }

      before do
        pipeline.drop!(:config_error)
      end

      it 'has a correct failure reason' do
        expect(subject[:failure_reason])
          .to eq 'CI/CD YAML configuration error!'
      end
    end

    context 'when pipeline is detached merge request pipeline' do
      let(:merge_request) { create(:merge_request, :with_detached_merge_request_pipeline) }
      let(:project) { merge_request.target_project }
      let(:pipeline) { merge_request.merge_request_pipelines.first }

      it 'makes detached flag true' do
        expect(subject[:flags][:detached_merge_request_pipeline]).to be_truthy
      end

      context 'when user is a developer' do
        before do
          project.add_developer(user)
        end

        it 'has merge request information' do
          expect(subject[:merge_request][:iid]).to eq(merge_request.iid)

          expect(project_merge_request_path(project, merge_request))
            .to include(subject[:merge_request][:path])

          expect(subject[:merge_request][:title]).to eq(merge_request.title)

          expect(subject[:merge_request][:source_branch])
            .to eq(merge_request.source_branch)

          expect(project_branch_path(project, merge_request.source_branch))
            .to include(subject[:merge_request][:source_branch_path])

          expect(subject[:merge_request][:target_branch])
            .to eq(merge_request.target_branch)

          expect(project_branch_path(project, merge_request.target_branch))
            .to include(subject[:merge_request][:target_branch_path])
        end
      end

      context 'when user is an external user' do
        it 'has no merge request information' do
          expect(subject[:merge_request]).to be_nil
        end
      end
    end

    context 'when pipeline is merge request pipeline' do
      let(:merge_request) { create(:merge_request, :with_merge_request_pipeline, merge_sha: 'abc') }
      let(:project) { merge_request.target_project }
      let(:pipeline) { merge_request.merge_request_pipelines.first }

      it 'makes detached flag false' do
        expect(subject[:flags][:detached_merge_request_pipeline]).to be_falsy
      end

      it 'makes atached flag true' do
        expect(subject[:flags][:merge_request_pipeline]).to be_truthy
      end
    end
  end
end