Merge branch 'fix/gb/fix-variables-collection-item-file' into 'master'

Fix file-specific variables collection item option

Closes gitlab-ee#5444

See merge request gitlab-org/gitlab-ce!18307

2 files changed, 32 insertions, 10 deletions

diff --git a/lib/gitlab/ci/variables/collection/item.rb b/lib/gitlab/ci/variables/collection/item.rb
index 23ed71db8b0..d00e5b07f95 100644
--- a/lib/gitlab/ci/variables/collection/item.rb
+++ b/lib/gitlab/ci/variables/collection/item.rb
@@ -3,12 +3,9 @@ module Gitlab
     module Variables
       class Collection
         class Item
-          def initialize(**options)
+          def initialize(key:, value:, public: true, file: false)
             @variable = {
-              key: options.fetch(:key),
-              value: options.fetch(:value),
-              public: options.fetch(:public, true),
-              file: options.fetch(:files, false)
+              key: key, value: value, public: public, file: file
             }
           end
 
diff --git a/spec/lib/gitlab/ci/variables/collection/item_spec.rb b/spec/lib/gitlab/ci/variables/collection/item_spec.rb
index bf9208f1ff4..e79f0a7f257 100644
--- a/spec/lib/gitlab/ci/variables/collection/item_spec.rb
+++ b/spec/lib/gitlab/ci/variables/collection/item_spec.rb
@@ -5,6 +5,18 @@ describe Gitlab::Ci::Variables::Collection::Item do
     { key: 'VAR', value: 'something', public: true }
   end
 
+  describe '.new' do
+    it 'raises error if unknown key i specified' do
+      expect { described_class.new(key: 'VAR', value: 'abc', files: true) }
+        .to raise_error ArgumentError, 'unknown keyword: files'
+    end
+
+    it 'raises error when required keywords are not specified' do
+      expect { described_class.new(key: 'VAR') }
+        .to raise_error ArgumentError, 'missing keyword: value'
+    end
+  end
+
   describe '.fabricate' do
     it 'supports using a hash' do
       resource = described_class.fabricate(variable)
@@ -47,12 +59,25 @@ describe Gitlab::Ci::Variables::Collection::Item do
   end
 
   describe '#to_runner_variable' do
-    it 'returns a runner-compatible hash representation' do
-      runner_variable = described_class
-        .new(**variable)
-        .to_runner_variable
+    context 'when variable is not a file-related' do
+      it 'returns a runner-compatible hash representation' do
+        runner_variable = described_class
+          .new(**variable)
+          .to_runner_variable
+
+        expect(runner_variable).to eq variable
+      end
+    end
+
+    context 'when variable is file-related' do
+      it 'appends file description component' do
+        runner_variable = described_class
+          .new(key: 'VAR', value: 'value', file: true)
+          .to_runner_variable
 
-      expect(runner_variable).to eq variable
+        expect(runner_variable)
+          .to eq(key: 'VAR', value: 'value', public: true, file: true)
+      end
     end
   end
 end