Add latest changes from gitlab-org/gitlab@master

1 files changed, 314 insertions, 45 deletions

diff --git a/spec/lib/gitlab/ci/variables/collection_spec.rb b/spec/lib/gitlab/ci/variables/collection_spec.rb
index 16ba3c32fc4..7b77754190a 100644
--- a/spec/lib/gitlab/ci/variables/collection_spec.rb
+++ b/spec/lib/gitlab/ci/variables/collection_spec.rb
@@ -166,51 +166,6 @@ RSpec.describe Gitlab::Ci::Variables::Collection do
     end
   end
 
-  describe '#sorted_collection' do
-    let!(:project) { create(:project) }
-
-    subject { collection.sorted_collection(project) }
-
-    context 'when FF :variable_inside_variable is disabled' do
-      before do
-        stub_feature_flags(variable_inside_variable: false)
-      end
-
-      let(:collection) do
-        described_class.new
-          .append(key: 'A', value: 'test-$B')
-          .append(key: 'B', value: 'test-$C')
-          .append(key: 'C', value: 'test')
-      end
-
-      it { is_expected.to be(collection) }
-    end
-
-    context 'when FF :variable_inside_variable is enabled' do
-      before do
-        stub_feature_flags(variable_inside_variable: [project])
-      end
-
-      let(:collection) do
-        described_class.new
-          .append(key: 'A', value: 'test-$B')
-          .append(key: 'B', value: 'test-$C')
-          .append(key: 'C', value: 'test')
-      end
-
-      it { is_expected.to be_a(Gitlab::Ci::Variables::Collection) }
-
-      it 'returns sorted collection' do
-        expect(subject.to_a).to eq(
-          [
-            { key: 'C', value: 'test', masked: false, public: true },
-            { key: 'B', value: 'test-$C', masked: false, public: true },
-            { key: 'A', value: 'test-$B', masked: false, public: true }
-          ])
-      end
-    end
-  end
-
   describe '#reject' do
     let(:collection) do
       described_class.new
@@ -230,4 +185,318 @@ RSpec.describe Gitlab::Ci::Variables::Collection do
       expect(subject.to_runner_variables).to eq(comp)
     end
   end
+
+  describe '#expand_value' do
+    let(:collection) do
+      Gitlab::Ci::Variables::Collection.new
+                     .append(key: 'CI_JOB_NAME', value: 'test-1')
+                     .append(key: 'CI_BUILD_ID', value: '1')
+                     .append(key: 'RAW_VAR', value: '$TEST1', raw: true)
+                     .append(key: 'TEST1', value: 'test-3')
+    end
+
+    context 'table tests' do
+      using RSpec::Parameterized::TableSyntax
+
+      where do
+        {
+          "empty value": {
+            value: '',
+            result: '',
+            keep_undefined: false
+          },
+          "simple expansions": {
+            value: 'key$TEST1-$CI_BUILD_ID',
+            result: 'keytest-3-1',
+            keep_undefined: false
+          },
+          "complex expansion": {
+            value: 'key${TEST1}-${CI_JOB_NAME}',
+            result: 'keytest-3-test-1',
+            keep_undefined: false
+          },
+          "complex expansions with raw variable": {
+            value: 'key${RAW_VAR}-${CI_JOB_NAME}',
+            result: 'key$TEST1-test-1',
+            keep_undefined: false
+          },
+          "missing variable not keeping original": {
+            value: 'key${MISSING_VAR}-${CI_JOB_NAME}',
+            result: 'key-test-1',
+            keep_undefined: false
+          },
+          "missing variable keeping original": {
+            value: 'key${MISSING_VAR}-${CI_JOB_NAME}',
+            result: 'key${MISSING_VAR}-test-1',
+            keep_undefined: true
+          }
+        }
+      end
+
+      with_them do
+        subject { collection.expand_value(value, keep_undefined: keep_undefined) }
+
+        it 'matches expected expansion' do
+          is_expected.to eq(result)
+        end
+      end
+    end
+  end
+
+  describe '#sort_and_expand_all' do
+    context 'when FF :variable_inside_variable is disabled' do
+      let_it_be(:project_with_flag_disabled) { create(:project) }
+      let_it_be(:project_with_flag_enabled) { create(:project) }
+
+      before do
+        stub_feature_flags(variable_inside_variable: [project_with_flag_enabled])
+      end
+
+      context 'table tests' do
+        using RSpec::Parameterized::TableSyntax
+
+        where do
+          {
+            "empty array": {
+              variables: [],
+              keep_undefined: false
+            },
+            "simple expansions": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'key$variable$variable2' }
+              ],
+              keep_undefined: false
+            },
+            "complex expansion": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'key${variable}' }
+              ],
+              keep_undefined: false
+            },
+            "out-of-order variable reference": {
+              variables: [
+                { key: 'variable2', value: 'key${variable}' },
+                { key: 'variable', value: 'value' }
+              ],
+              keep_undefined: false
+            },
+            "complex expansions with raw variable": {
+              variables: [
+                { key: 'variable3', value: 'key_${variable}_${variable2}' },
+                { key: 'variable', value: '$variable2', raw: true },
+                { key: 'variable2', value: 'value2' }
+              ],
+              keep_undefined: false
+            },
+            "array with cyclic dependency": {
+              variables: [
+                { key: 'variable', value: '$variable2' },
+                { key: 'variable2', value: '$variable3' },
+                { key: 'variable3', value: 'key$variable$variable2' }
+              ],
+              keep_undefined: true
+            }
+          }
+        end
+
+        with_them do
+          let(:collection) { Gitlab::Ci::Variables::Collection.new(variables, keep_undefined: keep_undefined) }
+
+          subject { collection.sort_and_expand_all(project_with_flag_disabled) }
+
+          it 'returns Collection' do
+            is_expected.to be_an_instance_of(Gitlab::Ci::Variables::Collection)
+          end
+
+          it 'does not expand variables' do
+            var_hash = variables.pluck(:key, :value).to_h
+            expect(subject.to_hash).to eq(var_hash)
+          end
+        end
+      end
+    end
+
+    context 'when FF :variable_inside_variable is enabled' do
+      let_it_be(:project_with_flag_disabled) { create(:project) }
+      let_it_be(:project_with_flag_enabled) { create(:project) }
+
+      before do
+        stub_feature_flags(variable_inside_variable: [project_with_flag_enabled])
+      end
+
+      context 'table tests' do
+        using RSpec::Parameterized::TableSyntax
+
+        where do
+          {
+            "empty array": {
+              variables: [],
+              keep_undefined: false,
+              result: []
+            },
+            "simple expansions": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'key$variable$variable2' },
+                { key: 'variable4', value: 'key$variable$variable3' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'keyvalueresult' },
+                { key: 'variable4', value: 'keyvaluekeyvalueresult' }
+              ]
+            },
+            "complex expansion": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'key${variable}' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'keyvalue' }
+              ]
+            },
+            "unused variables": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result2' },
+                { key: 'variable3', value: 'result3' },
+                { key: 'variable4', value: 'key$variable$variable3' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result2' },
+                { key: 'variable3', value: 'result3' },
+                { key: 'variable4', value: 'keyvalueresult3' }
+              ]
+            },
+            "complex expansions": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'key${variable}${variable2}' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'keyvalueresult' }
+              ]
+            },
+            "out-of-order expansion": {
+              variables: [
+                { key: 'variable3', value: 'key$variable2$variable' },
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable2', value: 'result' },
+                { key: 'variable', value: 'value' },
+                { key: 'variable3', value: 'keyresultvalue' }
+              ]
+            },
+            "out-of-order complex expansion": {
+              variables: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'key${variable2}${variable}' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable2', value: 'result' },
+                { key: 'variable3', value: 'keyresultvalue' }
+              ]
+            },
+            "missing variable": {
+              variables: [
+                { key: 'variable2', value: 'key$variable' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable2', value: 'key' }
+              ]
+            },
+            "missing variable keeping original": {
+              variables: [
+                { key: 'variable2', value: 'key$variable' }
+              ],
+              keep_undefined: true,
+              result: [
+                { key: 'variable2', value: 'key$variable' }
+              ]
+            },
+            "complex expansions with missing variable keeping original": {
+              variables: [
+                { key: 'variable4', value: 'key${variable}${variable2}${variable3}' },
+                { key: 'variable', value: 'value' },
+                { key: 'variable3', value: 'value3' }
+              ],
+              keep_undefined: true,
+              result: [
+                { key: 'variable', value: 'value' },
+                { key: 'variable3', value: 'value3' },
+                { key: 'variable4', value: 'keyvalue${variable2}value3' }
+              ]
+            },
+            "complex expansions with raw variable": {
+              variables: [
+                { key: 'variable3', value: 'key_${variable}_${variable2}' },
+                { key: 'variable', value: '$variable2', raw: true },
+                { key: 'variable2', value: 'value2' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: '$variable2', raw: true },
+                { key: 'variable2', value: 'value2' },
+                { key: 'variable3', value: 'key_$variable2_value2' }
+              ]
+            },
+            "cyclic dependency causes original array to be returned": {
+              variables: [
+                { key: 'variable', value: '$variable2' },
+                { key: 'variable2', value: '$variable3' },
+                { key: 'variable3', value: 'key$variable$variable2' }
+              ],
+              keep_undefined: false,
+              result: [
+                { key: 'variable', value: '$variable2' },
+                { key: 'variable2', value: '$variable3' },
+                { key: 'variable3', value: 'key$variable$variable2' }
+              ]
+            }
+          }
+        end
+
+        with_them do
+          let(:collection) { Gitlab::Ci::Variables::Collection.new(variables) }
+
+          subject { collection.sort_and_expand_all(project_with_flag_enabled, keep_undefined: keep_undefined) }
+
+          it 'returns Collection' do
+            is_expected.to be_an_instance_of(Gitlab::Ci::Variables::Collection)
+          end
+
+          it 'expands variables' do
+            var_hash = result.to_h { |env| [env.fetch(:key), env.fetch(:value)] }
+              .with_indifferent_access
+            expect(subject.to_hash).to eq(var_hash)
+          end
+
+          it 'preserves raw attribute' do
+            expect(subject.pluck(:key, :raw).to_h).to eq(collection.pluck(:key, :raw).to_h)
+          end
+        end
+      end
+    end
+  end
 end