summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/ci/variables/collection/sort_spec.rb
blob: 73cf0e19d004364b1815851d0724f1d11c13fa19 (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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Ci::Variables::Collection::Sort do
  describe '#initialize with non-Collection value' do
    context 'when FF :variable_inside_variable is disabled' do
      subject { Gitlab::Ci::Variables::Collection::Sort.new([]) }

      it 'raises ArgumentError' do
        expect { subject }.to raise_error(ArgumentError, /Collection object was expected/)
      end
    end

    context 'when FF :variable_inside_variable is enabled' do
      subject { Gitlab::Ci::Variables::Collection::Sort.new([]) }

      it 'raises ArgumentError' do
        expect { subject }.to raise_error(ArgumentError, /Collection object was expected/)
      end
    end
  end

  describe '#errors' do
    context 'table tests' do
      using RSpec::Parameterized::TableSyntax

      where do
        {
          "empty array": {
            variables: [],
            expected_errors: nil
          },
          "simple expansions": {
            variables: [
              { key: 'variable', value: 'value' },
              { key: 'variable2', value: 'result' },
              { key: 'variable3', value: 'key$variable$variable2' }
            ],
            expected_errors: nil
          },
          "cyclic dependency": {
            variables: [
              { key: 'variable', value: '$variable2' },
              { key: 'variable2', value: '$variable3' },
              { key: 'variable3', value: 'key$variable$variable2' }
            ],
            expected_errors: 'circular variable reference detected: ["variable", "variable2", "variable3"]'
          },
          "array with raw variable": {
            variables: [
              { key: 'variable', value: '$variable2' },
              { key: 'variable2', value: '$variable3' },
              { key: 'variable3', value: 'key$variable$variable2', raw: true }
            ],
            expected_errors: nil
          },
          "variable containing escaped variable reference": {
            variables: [
              { key: 'variable_a', value: 'value' },
              { key: 'variable_b', value: '$$variable_a' },
              { key: 'variable_c', value: '$variable_b' }
            ],
            expected_errors: nil
          }
        }
      end

      with_them do
        let(:collection) { Gitlab::Ci::Variables::Collection.new(variables) }

        subject { Gitlab::Ci::Variables::Collection::Sort.new(collection) }

        it 'errors matches expected errors' do
          expect(subject.errors).to eq(expected_errors)
        end

        it 'valid? matches expected errors' do
          expect(subject.valid?).to eq(expected_errors.nil?)
        end

        it 'does not raise' do
          expect { subject }.not_to raise_error
        end
      end
    end
  end

  describe '#tsort' do
    context 'table tests' do
      using RSpec::Parameterized::TableSyntax

      where do
        {
          "empty array": {
            variables: [],
            result: []
          },
          "simple expansions, no reordering needed": {
            variables: [
              { key: 'variable', value: 'value' },
              { key: 'variable2', value: 'result' },
              { key: 'variable3', value: 'key$variable$variable2' }
            ],
            result: %w[variable variable2 variable3]
          },
          "complex expansion, reordering needed": {
            variables: [
              { key: 'variable2', value: 'key${variable}' },
              { key: 'variable', value: 'value' }
            ],
            result: %w[variable variable2]
          },
          "unused variables": {
            variables: [
              { key: 'variable', value: 'value' },
              { key: 'variable4', value: 'key$variable$variable3' },
              { key: 'variable2', value: 'result2' },
              { key: 'variable3', value: 'result3' }
            ],
            result: %w[variable variable3 variable4 variable2]
          },
          "missing variable": {
            variables: [
              { key: 'variable2', value: 'key$variable' }
            ],
            result: %w[variable2]
          },
          "complex expansions with missing variable": {
            variables: [
              { key: 'variable4', value: 'key${variable}${variable2}${variable3}' },
              { key: 'variable', value: 'value' },
              { key: 'variable3', value: 'value3' }
            ],
            result: %w[variable variable3 variable4]
          },
          "raw variable does not get resolved": {
            variables: [
              { key: 'variable', value: '$variable2' },
              { key: 'variable2', value: '$variable3' },
              { key: 'variable3', value: 'key$variable$variable2', raw: true }
            ],
            result: %w[variable3 variable2 variable]
          },
          "variable containing escaped variable reference": {
            variables: [
              { key: 'variable_c', value: '$variable_b' },
              { key: 'variable_b', value: '$$variable_a' },
              { key: 'variable_a', value: 'value' }
            ],
            result: %w[variable_a variable_b variable_c]
          }
        }
      end

      with_them do
        let(:collection) { Gitlab::Ci::Variables::Collection.new(variables) }

        subject { Gitlab::Ci::Variables::Collection::Sort.new(collection).tsort }

        it 'returns correctly sorted variables' do
          expect(subject.pluck(:key)).to eq(result)
        end
      end
    end

    context 'cyclic dependency' do
      let(:variables) do
        [
          { key: 'variable2', value: '$variable3' },
          { key: 'variable3', value: 'key$variable$variable2' },
          { key: 'variable', value: '$variable2' }
        ]
      end

      let(:collection) { Gitlab::Ci::Variables::Collection.new(variables) }

      subject { Gitlab::Ci::Variables::Collection::Sort.new(collection).tsort }

      it 'raises TSort::Cyclic' do
        expect { subject }.to raise_error(TSort::Cyclic)
      end
    end
  end
end