Merge branch 'feature/add-support-for-services-configuration' into 'master'

Add support for services configuration in .gitlab-ci.yml

See merge request !8578

7 files changed, 395 insertions, 124 deletions

diff --git a/spec/lib/ci/gitlab_ci_yaml_processor_spec.rb b/spec/lib/ci/gitlab_ci_yaml_processor_spec.rb
index 2ca0773ad1d..af0e7855a9b 100644
--- a/spec/lib/ci/gitlab_ci_yaml_processor_spec.rb
+++ b/spec/lib/ci/gitlab_ci_yaml_processor_spec.rb
@@ -596,62 +596,117 @@ module Ci
     end
 
     describe "Image and service handling" do
-      it "returns image and service when defined" do
-        config = YAML.dump({
-                             image: "ruby:2.1",
-                             services: ["mysql"],
-                             before_script: ["pwd"],
-                             rspec: { script: "rspec" }
-                           })
+      context "when extended docker configuration is used" do
+        it "returns image and service when defined" do
+          config = YAML.dump({ image: { name: "ruby:2.1" },
+                               services: ["mysql", { name: "docker:dind", alias: "docker" }],
+                               before_script: ["pwd"],
+                               rspec: { script: "rspec" } })
 
-        config_processor = GitlabCiYamlProcessor.new(config, path)
+          config_processor = GitlabCiYamlProcessor.new(config, path)
 
-        expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(1)
-        expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
-          stage: "test",
-          stage_idx: 1,
-          name: "rspec",
-          commands: "pwd\nrspec",
-          coverage_regex: nil,
-          tag_list: [],
-          options: {
-            image: "ruby:2.1",
-            services: ["mysql"]
-          },
-          allow_failure: false,
-          when: "on_success",
-          environment: nil,
-          yaml_variables: []
-        })
+          expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(1)
+          expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
+            stage: "test",
+            stage_idx: 1,
+            name: "rspec",
+            commands: "pwd\nrspec",
+            coverage_regex: nil,
+            tag_list: [],
+            options: {
+                image: { name: "ruby:2.1" },
+                services: [{ name: "mysql" }, { name: "docker:dind", alias: "docker" }]
+            },
+            allow_failure: false,
+            when: "on_success",
+            environment: nil,
+            yaml_variables: []
+          })
+        end
+
+        it "returns image and service when overridden for job" do
+          config = YAML.dump({ image: "ruby:2.1",
+                               services: ["mysql"],
+                               before_script: ["pwd"],
+                               rspec: { image: { name: "ruby:2.5" },
+                                        services: [{ name: "postgresql", alias: "db-pg" }, "docker:dind"], script: "rspec" } })
+
+          config_processor = GitlabCiYamlProcessor.new(config, path)
+
+          expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(1)
+          expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
+            stage: "test",
+            stage_idx: 1,
+            name: "rspec",
+            commands: "pwd\nrspec",
+            coverage_regex: nil,
+            tag_list: [],
+            options: {
+                image: { name: "ruby:2.5" },
+                services: [{ name: "postgresql", alias: "db-pg" }, { name: "docker:dind" }]
+            },
+            allow_failure: false,
+            when: "on_success",
+            environment: nil,
+            yaml_variables: []
+          })
+        end
       end
 
-      it "returns image and service when overridden for job" do
-        config = YAML.dump({
-                             image:         "ruby:2.1",
-                             services:      ["mysql"],
-                             before_script: ["pwd"],
-                             rspec:         { image: "ruby:2.5", services: ["postgresql"], script: "rspec" }
-                           })
+      context "when etended docker configuration is not used" do
+        it "returns image and service when defined" do
+          config = YAML.dump({ image: "ruby:2.1",
+                               services: ["mysql", "docker:dind"],
+                               before_script: ["pwd"],
+                               rspec: { script: "rspec" } })
 
-        config_processor = GitlabCiYamlProcessor.new(config, path)
+          config_processor = GitlabCiYamlProcessor.new(config, path)
 
-        expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(1)
-        expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
-          stage: "test",
-          stage_idx: 1,
-          name: "rspec",
-          commands: "pwd\nrspec",
-          coverage_regex: nil,
-          tag_list: [],
-          options: {
-            image: "ruby:2.5",
-            services: ["postgresql"]
-          },
-          allow_failure: false,
-          when: "on_success",
-          environment: nil,
-          yaml_variables: []
-        })
+          expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(1)
+          expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
+            stage: "test",
+            stage_idx: 1,
+            name: "rspec",
+            commands: "pwd\nrspec",
+            coverage_regex: nil,
+            tag_list: [],
+            options: {
+              image: { name: "ruby:2.1" },
+              services: [{ name: "mysql" }, { name: "docker:dind" }]
+            },
+            allow_failure: false,
+            when: "on_success",
+            environment: nil,
+            yaml_variables: []
+          })
+        end
+
+        it "returns image and service when overridden for job" do
+          config = YAML.dump({ image: "ruby:2.1",
+                               services: ["mysql"],
+                               before_script: ["pwd"],
+                               rspec: { image: "ruby:2.5", services: ["postgresql", "docker:dind"], script: "rspec" } })
+
+          config_processor = GitlabCiYamlProcessor.new(config, path)
+
+          expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq(1)
+          expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
+            stage: "test",
+            stage_idx: 1,
+            name: "rspec",
+            commands: "pwd\nrspec",
+            coverage_regex: nil,
+            tag_list: [],
+            options: {
+                image: { name: "ruby:2.5" },
+                services: [{ name: "postgresql" }, { name: "docker:dind" }]
+            },
+            allow_failure: false,
+            when: "on_success",
+            environment: nil,
+            yaml_variables: []
+          })
+        end
       end
     end
 
@@ -884,8 +939,8 @@ module Ci
           coverage_regex: nil,
           tag_list: [],
           options: {
-            image: "ruby:2.1",
-            services: ["mysql"],
+            image: { name: "ruby:2.1" },
+            services: [{ name: "mysql" }],
             artifacts: {
               name: "custom_name",
               paths: ["logs/", "binaries/"],
@@ -1261,7 +1316,7 @@ EOT
         config = YAML.dump({ image: ["test"], rspec: { script: "test" } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "image config should be a string")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "image config should be a hash or a string")
       end
 
       it "returns errors if job name is blank" do
@@ -1282,35 +1337,35 @@ EOT
         config = YAML.dump({ rspec: { script: "test", image: ["test"] } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:rspec:image config should be a string")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:rspec:image config should be a hash or a string")
       end
 
       it "returns errors if services parameter is not an array" do
         config = YAML.dump({ services: "test", rspec: { script: "test" } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "services config should be an array of strings")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "services config should be a array")
       end
 
       it "returns errors if services parameter is not an array of strings" do
         config = YAML.dump({ services: [10, "test"], rspec: { script: "test" } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "services config should be an array of strings")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "service config should be a hash or a string")
       end
 
       it "returns errors if job services parameter is not an array" do
         config = YAML.dump({ rspec: { script: "test", services: "test" } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:rspec:services config should be an array of strings")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:rspec:services config should be a array")
       end
 
       it "returns errors if job services parameter is not an array of strings" do
         config = YAML.dump({ rspec: { script: "test", services: [10, "test"] } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:rspec:services config should be an array of strings")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "service config should be a hash or a string")
       end
 
       it "returns error if job configuration is invalid" do
@@ -1324,7 +1379,7 @@ EOT
         config = YAML.dump({ extra: { script: 'rspec', services: "test" } })
         expect do
           GitlabCiYamlProcessor.new(config, path)
-        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:extra:services config should be an array of strings")
+        end.to raise_error(GitlabCiYamlProcessor::ValidationError, "jobs:extra:services config should be a array")
       end
 
       it "returns errors if there are no jobs defined" do
diff --git a/spec/lib/gitlab/ci/build/image_spec.rb b/spec/lib/gitlab/ci/build/image_spec.rb
index 382385dfd6b..773a52cdfbc 100644
--- a/spec/lib/gitlab/ci/build/image_spec.rb
+++ b/spec/lib/gitlab/ci/build/image_spec.rb
@@ -10,12 +10,28 @@ describe Gitlab::Ci::Build::Image do
       let(:image_name) { 'ruby:2.1' }
       let(:job) { create(:ci_build, options: { image: image_name } ) }
 
-      it 'fabricates an object of the proper class' do
-        is_expected.to be_kind_of(described_class)
+      context 'when image is defined as string' do
+        it 'fabricates an object of the proper class' do
+          is_expected.to be_kind_of(described_class)
+        end
+
+        it 'populates fabricated object with the proper name attribute' do
+          expect(subject.name).to eq(image_name)
+        end
       end
 
-      it 'populates fabricated object with the proper name attribute' do
-        expect(subject.name).to eq(image_name)
+      context 'when image is defined as hash' do
+        let(:entrypoint) { '/bin/sh' }
+        let(:job) { create(:ci_build, options: { image: { name: image_name, entrypoint: entrypoint } } ) }
+
+        it 'fabricates an object of the proper class' do
+          is_expected.to be_kind_of(described_class)
+        end
+
+        it 'populates fabricated object with the proper attributes' do
+          expect(subject.name).to eq(image_name)
+          expect(subject.entrypoint).to eq(entrypoint)
+        end
       end
 
       context 'when image name is empty' do
@@ -41,10 +57,39 @@ describe Gitlab::Ci::Build::Image do
       let(:service_image_name) { 'postgres' }
       let(:job) { create(:ci_build, options: { services: [service_image_name] }) }
 
-      it 'fabricates an non-empty array of objects' do
-        is_expected.to be_kind_of(Array)
-        is_expected.not_to be_empty
-        expect(subject.first.name).to eq(service_image_name)
+      context 'when service is defined as string' do
+        it 'fabricates an non-empty array of objects' do
+          is_expected.to be_kind_of(Array)
+          is_expected.not_to be_empty
+        end
+
+        it 'populates fabricated objects with the proper name attributes' do
+          expect(subject.first).to be_kind_of(described_class)
+          expect(subject.first.name).to eq(service_image_name)
+        end
+      end
+
+      context 'when service is defined as hash' do
+        let(:service_entrypoint) { '/bin/sh' }
+        let(:service_alias) { 'db' }
+        let(:service_command) { 'sleep 30' }
+        let(:job) do
+          create(:ci_build, options: { services: [{ name: service_image_name, entrypoint: service_entrypoint,
+                                                    alias: service_alias, command: service_command }] })
+        end
+
+        it 'fabricates an non-empty array of objects' do
+          is_expected.to be_kind_of(Array)
+          is_expected.not_to be_empty
+          expect(subject.first).to be_kind_of(described_class)
+        end
+
+        it 'populates fabricated objects with the proper attributes' do
+          expect(subject.first.name).to eq(service_image_name)
+          expect(subject.first.entrypoint).to eq(service_entrypoint)
+          expect(subject.first.alias).to eq(service_alias)
+          expect(subject.first.command).to eq(service_command)
+        end
       end
 
       context 'when service image name is empty' do
diff --git a/spec/lib/gitlab/ci/config/entry/global_spec.rb b/spec/lib/gitlab/ci/config/entry/global_spec.rb
index 23270ad5053..e5f85c712ca 100644
--- a/spec/lib/gitlab/ci/config/entry/global_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/global_spec.rb
@@ -95,13 +95,13 @@ describe Gitlab::Ci::Config::Entry::Global do
 
         describe '#image_value' do
           it 'returns valid image' do
-            expect(global.image_value).to eq 'ruby:2.2'
+            expect(global.image_value).to eq(name: 'ruby:2.2')
           end
         end
 
         describe '#services_value' do
           it 'returns array of services' do
-            expect(global.services_value).to eq ['postgres:9.1', 'mysql:5.5']
+            expect(global.services_value).to eq [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }]
           end
         end
 
@@ -150,8 +150,8 @@ describe Gitlab::Ci::Config::Entry::Global do
                        script: %w[rspec ls],
                        before_script: %w(ls pwd),
                        commands: "ls\npwd\nrspec\nls",
-                       image: 'ruby:2.2',
-                       services: ['postgres:9.1', 'mysql:5.5'],
+                       image: { name: 'ruby:2.2' },
+                       services: [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }],
                        stage: 'test',
                        cache: { key: 'k', untracked: true, paths: ['public/'] },
                        variables: { 'VAR' => 'value' },
@@ -161,8 +161,8 @@ describe Gitlab::Ci::Config::Entry::Global do
                          before_script: [],
                          script: %w[spinach],
                          commands: 'spinach',
-                         image: 'ruby:2.2',
-                         services: ['postgres:9.1', 'mysql:5.5'],
+                         image: { name: 'ruby:2.2' },
+                         services: [{ name: 'postgres:9.1' }, { name: 'mysql:5.5' }],
                          stage: 'test',
                          cache: { key: 'k', untracked: true, paths: ['public/'] },
                          variables: {},
diff --git a/spec/lib/gitlab/ci/config/entry/image_spec.rb b/spec/lib/gitlab/ci/config/entry/image_spec.rb
index 3c99cb0a1ee..bca22e39500 100644
--- a/spec/lib/gitlab/ci/config/entry/image_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/image_spec.rb
@@ -3,43 +3,104 @@ require 'spec_helper'
 describe Gitlab::Ci::Config::Entry::Image do
   let(:entry) { described_class.new(config) }
 
-  describe 'validation' do
-    context 'when entry config value is correct' do
-      let(:config) { 'ruby:2.2' }
+  context 'when configuration is a string' do
+    let(:config) { 'ruby:2.2' }
 
-      describe '#value' do
-        it 'returns image string' do
-          expect(entry.value).to eq 'ruby:2.2'
-        end
+    describe '#value' do
+      it 'returns image hash' do
+        expect(entry.value).to eq({ name: 'ruby:2.2' })
       end
+    end
+
+    describe '#errors' do
+      it 'does not append errors' do
+        expect(entry.errors).to be_empty
+      end
+    end
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).to be_valid
+      end
+    end
+
+    describe '#image' do
+      it "returns image's name" do
+        expect(entry.name).to eq 'ruby:2.2'
+      end
+    end
 
-      describe '#errors' do
-        it 'does not append errors' do
-          expect(entry.errors).to be_empty
-        end
+    describe '#entrypoint' do
+      it "returns image's entrypoint" do
+        expect(entry.entrypoint).to be_nil
       end
+    end
+  end
 
-      describe '#valid?' do
-        it 'is valid' do
-          expect(entry).to be_valid
-        end
+  context 'when configuration is a hash' do
+    let(:config) { { name: 'ruby:2.2', entrypoint: '/bin/sh' } }
+
+    describe '#value' do
+      it 'returns image hash' do
+        expect(entry.value).to eq(config)
       end
     end
 
-    context 'when entry value is not correct' do
-      let(:config) { ['ruby:2.2'] }
+    describe '#errors' do
+      it 'does not append errors' do
+        expect(entry.errors).to be_empty
+      end
+    end
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).to be_valid
+      end
+    end
 
-      describe '#errors' do
-        it 'saves errors' do
-          expect(entry.errors)
-            .to include 'image config should be a string'
-        end
+    describe '#image' do
+      it "returns image's name" do
+        expect(entry.name).to eq 'ruby:2.2'
       end
+    end
+
+    describe '#entrypoint' do
+      it "returns image's entrypoint" do
+        expect(entry.entrypoint).to eq '/bin/sh'
+      end
+    end
+  end
+
+  context 'when entry value is not correct' do
+    let(:config) { ['ruby:2.2'] }
+
+    describe '#errors' do
+      it 'saves errors' do
+        expect(entry.errors)
+          .to include 'image config should be a hash or a string'
+      end
+    end
+
+    describe '#valid?' do
+      it 'is not valid' do
+        expect(entry).not_to be_valid
+      end
+    end
+  end
+
+  context 'when unexpected key is specified' do
+    let(:config) { { name: 'ruby:2.2', non_existing: 'test' } }
+
+    describe '#errors' do
+      it 'saves errors' do
+        expect(entry.errors)
+            .to include 'image config contains unknown keys: non_existing'
+      end
+    end
 
-      describe '#valid?' do
-        it 'is not valid' do
-          expect(entry).not_to be_valid
-        end
+    describe '#valid?' do
+      it 'is not valid' do
+        expect(entry).not_to be_valid
       end
     end
   end
diff --git a/spec/lib/gitlab/ci/config/entry/job_spec.rb b/spec/lib/gitlab/ci/config/entry/job_spec.rb
index 9249bb9c172..8dc94a4eb33 100644
--- a/spec/lib/gitlab/ci/config/entry/job_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/job_spec.rb
@@ -104,7 +104,7 @@ describe Gitlab::Ci::Config::Entry::Job do
       end
 
       it 'overrides global config' do
-        expect(entry[:image].value).to eq 'some_image'
+        expect(entry[:image].value).to eq(name: 'some_image')
         expect(entry[:cache].value).to eq(key: 'test')
       end
     end
diff --git a/spec/lib/gitlab/ci/config/entry/service_spec.rb b/spec/lib/gitlab/ci/config/entry/service_spec.rb
new file mode 100644
index 00000000000..2376de74554
--- /dev/null
+++ b/spec/lib/gitlab/ci/config/entry/service_spec.rb
@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Config::Entry::Service do
+  let(:entry) { described_class.new(config) }
+
+  before { entry.compose! }
+
+  context 'when configuration is a string' do
+    let(:config) { 'postgresql:9.5' }
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).to be_valid
+      end
+    end
+
+    describe '#value' do
+      it 'returns valid hash' do
+        expect(entry.value).to include(name: 'postgresql:9.5')
+      end
+    end
+
+    describe '#image' do
+      it "returns service's image name" do
+        expect(entry.name).to eq 'postgresql:9.5'
+      end
+    end
+
+    describe '#alias' do
+      it "returns service's alias" do
+        expect(entry.alias).to be_nil
+      end
+    end
+
+    describe '#command' do
+      it "returns service's command" do
+        expect(entry.command).to be_nil
+      end
+    end
+  end
+
+  context 'when configuration is a hash' do
+    let(:config) do
+      { name: 'postgresql:9.5', alias: 'db', command: 'cmd', entrypoint: '/bin/sh' }
+    end
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).to be_valid
+      end
+    end
+
+    describe '#value' do
+      it 'returns valid hash' do
+        expect(entry.value).to eq config
+      end
+    end
+
+    describe '#image' do
+      it "returns service's image name" do
+        expect(entry.name).to eq 'postgresql:9.5'
+      end
+    end
+
+    describe '#alias' do
+      it "returns service's alias" do
+        expect(entry.alias).to eq 'db'
+      end
+    end
+
+    describe '#command' do
+      it "returns service's command" do
+        expect(entry.command).to eq 'cmd'
+      end
+    end
+
+    describe '#entrypoint' do
+      it "returns service's entrypoint" do
+        expect(entry.entrypoint).to eq '/bin/sh'
+      end
+    end
+  end
+
+  context 'when entry value is not correct' do
+    let(:config) { ['postgresql:9.5'] }
+
+    describe '#errors' do
+      it 'saves errors' do
+        expect(entry.errors)
+            .to include 'service config should be a hash or a string'
+      end
+    end
+
+    describe '#valid?' do
+      it 'is not valid' do
+        expect(entry).not_to be_valid
+      end
+    end
+  end
+
+  context 'when unexpected key is specified' do
+    let(:config) { { name: 'postgresql:9.5', non_existing: 'test' } }
+
+    describe '#errors' do
+      it 'saves errors' do
+        expect(entry.errors)
+            .to include 'service config contains unknown keys: non_existing'
+      end
+    end
+
+    describe '#valid?' do
+      it 'is not valid' do
+        expect(entry).not_to be_valid
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/config/entry/services_spec.rb b/spec/lib/gitlab/ci/config/entry/services_spec.rb
index 66fad3b6b16..b32e52f8f26 100644
--- a/spec/lib/gitlab/ci/config/entry/services_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/services_spec.rb
@@ -3,37 +3,30 @@ require 'spec_helper'
 describe Gitlab::Ci::Config::Entry::Services do
   let(:entry) { described_class.new(config) }
 
-  describe 'validations' do
-    context 'when entry config value is correct' do
-      let(:config) { ['postgres:9.1', 'mysql:5.5'] }
+  before { entry.compose! }
 
-      describe '#value' do
-        it 'returns array of services as is' do
-          expect(entry.value).to eq config
-        end
-      end
+  context 'when configuration is valid' do
+    let(:config) { ['postgresql:9.5', { name: 'postgresql:9.1', alias: 'postgres_old' }] }
 
-      describe '#valid?' do
-        it 'is valid' do
-          expect(entry).to be_valid
-        end
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).to be_valid
       end
     end
 
-    context 'when entry value is not correct' do
-      let(:config) { 'ls' }
-
-      describe '#errors' do
-        it 'saves errors' do
-          expect(entry.errors)
-            .to include 'services config should be an array of strings'
-        end
+    describe '#value' do
+      it 'returns valid array' do
+        expect(entry.value).to eq([{ name: 'postgresql:9.5' }, { name: 'postgresql:9.1', alias: 'postgres_old' }])
       end
+    end
+  end
+
+  context 'when configuration is invalid' do
+    let(:config) { 'postgresql:9.5' }
 
-      describe '#valid?' do
-        it 'is not valid' do
-          expect(entry).not_to be_valid
-        end
+    describe '#valid?' do
+      it 'is invalid' do
+        expect(entry).not_to be_valid
       end
     end
   end