Add latest changes from gitlab-org/gitlab@master

1 files changed, 260 insertions, 0 deletions

diff --git a/spec/services/ci/parse_dotenv_artifact_service_spec.rb b/spec/services/ci/parse_dotenv_artifact_service_spec.rb
new file mode 100644
index 00000000000..fc4131d262b
--- /dev/null
+++ b/spec/services/ci/parse_dotenv_artifact_service_spec.rb
@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Ci::ParseDotenvArtifactService do
+  let_it_be(:project) { create(:project) }
+  let_it_be(:pipeline) { create(:ci_pipeline, project: project) }
+  let(:build) { create(:ci_build, pipeline: pipeline, project: project) }
+  let(:service) { described_class.new(project, nil) }
+
+  describe '#execute' do
+    subject { service.execute(artifact) }
+
+    context 'when build has a dotenv artifact' do
+      let!(:artifact) { create(:ci_job_artifact, :dotenv, job: build) }
+
+      it 'parses the artifact' do
+        expect(subject[:status]).to eq(:success)
+
+        expect(build.job_variables.as_json).to contain_exactly(
+          hash_including('key' => 'KEY1', 'value' => 'VAR1'),
+          hash_including('key' => 'KEY2', 'value' => 'VAR2'))
+      end
+
+      context 'when parse error happens' do
+        before do
+          allow(service).to receive(:scan_line!) { raise described_class::ParserError.new('Invalid Format') }
+        end
+
+        it 'returns error' do
+          expect(Gitlab::ErrorTracking).to receive(:track_exception)
+            .with(described_class::ParserError, job_id: build.id)
+
+          expect(subject[:status]).to eq(:error)
+          expect(subject[:message]).to eq('Invalid Format')
+          expect(subject[:http_status]).to eq(:bad_request)
+        end
+      end
+
+      context 'when artifact size is too big' do
+        before do
+          allow(artifact.file).to receive(:size) { 10.kilobytes }
+        end
+
+        it 'returns error' do
+          expect(subject[:status]).to eq(:error)
+          expect(subject[:message]).to eq("Dotenv Artifact Too Big. Maximum Allowable Size: #{described_class::MAX_ACCEPTABLE_DOTENV_SIZE}")
+          expect(subject[:http_status]).to eq(:bad_request)
+        end
+      end
+
+      context 'when artifact has the specified blob' do
+        before do
+          allow(artifact).to receive(:each_blob).and_yield(blob)
+        end
+
+        context 'when a white space trails the key' do
+          let(:blob) { 'KEY1 =VAR1' }
+
+          it 'trims the trailing space' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => 'VAR1'))
+          end
+        end
+
+        context 'when multiple key/value pairs exist in one line' do
+          let(:blob) { 'KEY1=VAR1KEY2=VAR1' }
+
+          it 'returns error' do
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to eq("Validation failed: Key can contain only letters, digits and '_'.")
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when key contains UNICODE' do
+          let(:blob) { '🛹=skateboard' }
+
+          it 'returns error' do
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to eq("Validation failed: Key can contain only letters, digits and '_'.")
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when value contains UNICODE' do
+          let(:blob) { 'skateboard=🛹' }
+
+          it 'parses the dotenv data' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'skateboard', 'value' => '🛹'))
+          end
+        end
+
+        context 'when key contains a space' do
+          let(:blob) { 'K E Y 1=VAR1' }
+
+          it 'returns error' do
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to eq("Validation failed: Key can contain only letters, digits and '_'.")
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when value contains a space' do
+          let(:blob) { 'KEY1=V A R 1' }
+
+          it 'parses the dotenv data' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => 'V A R 1'))
+          end
+        end
+
+        context 'when value is double quoated' do
+          let(:blob) { 'KEY1="VAR1"' }
+
+          it 'parses the value as-is' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => '"VAR1"'))
+          end
+        end
+
+        context 'when value is single quoated' do
+          let(:blob) { "KEY1='VAR1'" }
+
+          it 'parses the value as-is' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => "'VAR1'"))
+          end
+        end
+
+        context 'when value has white spaces in double quote' do
+          let(:blob) { 'KEY1="  VAR1  "' }
+
+          it 'parses the value as-is' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => '"  VAR1  "'))
+          end
+        end
+
+        context 'when key is missing' do
+          let(:blob) { '=VAR1' }
+
+          it 'returns error' do
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to match(/Key can't be blank/)
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when value is missing' do
+          let(:blob) { 'KEY1=' }
+
+          it 'parses the dotenv data' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => ''))
+          end
+        end
+
+        context 'when it is not dotenv format' do
+          let(:blob) { "{ 'KEY1': 'VAR1' }" }
+
+          it 'returns error' do
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to eq('Invalid Format')
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when more than limitated variables are specified in dotenv' do
+          let(:blob) do
+            StringIO.new.tap do |s|
+              (described_class::MAX_ACCEPTABLE_VARIABLES_COUNT + 1).times do |i|
+                s << "KEY#{i}=VAR#{i}\n"
+              end
+            end.string
+          end
+
+          it 'returns error' do
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to eq("Dotenv files cannot have more than #{described_class::MAX_ACCEPTABLE_VARIABLES_COUNT} variables")
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when variables are cross-referenced in dotenv' do
+          let(:blob) do
+            <<~EOS
+              KEY1=VAR1
+              KEY2=${KEY1}_Test
+            EOS
+          end
+
+          it 'does not support variable expansion in dotenv parser' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => 'VAR1'),
+              hash_including('key' => 'KEY2', 'value' => '${KEY1}_Test'))
+          end
+        end
+
+        context 'when there is an empty line' do
+          let(:blob) do
+            <<~EOS
+              KEY1=VAR1
+
+              KEY2=VAR2
+            EOS
+          end
+
+          it 'does not support empty line in dotenv parser' do
+            subject
+
+            expect(subject[:status]).to eq(:error)
+            expect(subject[:message]).to eq('Invalid Format')
+            expect(subject[:http_status]).to eq(:bad_request)
+          end
+        end
+
+        context 'when there is a comment' do
+          let(:blob) do
+            <<~EOS
+              KEY1=VAR1         # This is variable
+            EOS
+          end
+
+          it 'does not support comment in dotenv parser' do
+            subject
+
+            expect(build.job_variables.as_json).to contain_exactly(
+              hash_including('key' => 'KEY1', 'value' => 'VAR1         # This is variable'))
+          end
+        end
+      end
+    end
+
+    context 'when build does not have a dotenv artifact' do
+      let!(:artifact) { }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end