Add port section to CI Image object

In order to implement https://gitlab.com/gitlab-org/gitlab-ee/issues/10179
we need several modifications on the CI config file. We are
adding a new ports section in the default Image object.

Each of these ports will accept: number, protocol and name.

By default this new configuration will be only enabled in
the Web IDE config file.

5 files changed, 438 insertions, 8 deletions

diff --git a/spec/lib/gitlab/ci/config/entry/image_spec.rb b/spec/lib/gitlab/ci/config/entry/image_spec.rb
index 1a4d9ed5517..1ebdda398b9 100644
--- a/spec/lib/gitlab/ci/config/entry/image_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/image_spec.rb
@@ -35,6 +35,12 @@ describe Gitlab::Ci::Config::Entry::Image do
         expect(entry.entrypoint).to be_nil
       end
     end
+
+    describe '#ports' do
+      it "returns image's ports" do
+        expect(entry.ports).to be_nil
+      end
+    end
   end
 
   context 'when configuration is a hash' do
@@ -69,6 +75,38 @@ describe Gitlab::Ci::Config::Entry::Image do
         expect(entry.entrypoint).to eq %w(/bin/sh run)
       end
     end
+
+    context 'when configuration has ports' do
+      let(:ports) { [{ number: 80, protocol: 'http', name: 'foobar' }] }
+      let(:config) { { name: 'ruby:2.2', entrypoint: %w(/bin/sh run), ports: ports } }
+      let(:entry) { described_class.new(config, { with_image_ports: image_ports }) }
+      let(:image_ports) { false }
+
+      context 'when with_image_ports metadata is not enabled' do
+        describe '#valid?' do
+          it 'is not valid' do
+            expect(entry).not_to be_valid
+            expect(entry.errors).to include("image config contains disallowed keys: ports")
+          end
+        end
+      end
+
+      context 'when with_image_ports metadata is enabled' do
+        let(:image_ports) { true }
+
+        describe '#valid?' do
+          it 'is valid' do
+            expect(entry).to be_valid
+          end
+        end
+
+        describe '#ports' do
+          it "returns image's ports" do
+            expect(entry.ports).to eq ports
+          end
+        end
+      end
+    end
   end
 
   context 'when entry value is not correct' do
@@ -76,8 +114,8 @@ describe Gitlab::Ci::Config::Entry::Image do
 
     describe '#errors' do
       it 'saves errors' do
-        expect(entry.errors)
-          .to include 'image config should be a hash or a string'
+        expect(entry.errors.first)
+          .to match /config should be a hash or a string/
       end
     end
 
@@ -93,8 +131,8 @@ describe Gitlab::Ci::Config::Entry::Image do
 
     describe '#errors' do
       it 'saves errors' do
-        expect(entry.errors)
-            .to include 'image config contains unknown keys: non_existing'
+        expect(entry.errors.first)
+          .to match /config contains unknown keys: non_existing/
       end
     end
 
diff --git a/spec/lib/gitlab/ci/config/entry/port_spec.rb b/spec/lib/gitlab/ci/config/entry/port_spec.rb
new file mode 100644
index 00000000000..5f8f294334e
--- /dev/null
+++ b/spec/lib/gitlab/ci/config/entry/port_spec.rb
@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Ci::Config::Entry::Port do
+  let(:entry) { described_class.new(config) }
+
+  before do
+    entry.compose!
+  end
+
+  context 'when configuration is a string' do
+    let(:config) { 80 }
+
+    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(number: 80)
+      end
+    end
+
+    describe '#number' do
+      it "returns port number" do
+        expect(entry.number).to eq 80
+      end
+    end
+
+    describe '#protocol' do
+      it "is nil" do
+        expect(entry.protocol).to be_nil
+      end
+    end
+
+    describe '#name' do
+      it "is nil" do
+        expect(entry.name).to be_nil
+      end
+    end
+  end
+
+  context 'when configuration is a hash' do
+    context 'with the complete hash' do
+      let(:config) do
+        { number: 80,
+          protocol: 'http',
+          name:  'foobar' }
+      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 '#number' do
+        it "returns port number" do
+          expect(entry.number).to eq 80
+        end
+      end
+
+      describe '#protocol' do
+        it "returns port protocol" do
+          expect(entry.protocol).to eq 'http'
+        end
+      end
+
+      describe '#name' do
+        it "returns port name" do
+          expect(entry.name).to eq 'foobar'
+        end
+      end
+    end
+
+    context 'with only the port number' do
+      let(:config) { { number: 80 } }
+
+      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(number: 80)
+        end
+      end
+
+      describe '#number' do
+        it "returns port number" do
+          expect(entry.number).to eq 80
+        end
+      end
+
+      describe '#protocol' do
+        it "is nil" do
+          expect(entry.protocol).to be_nil
+        end
+      end
+
+      describe '#name' do
+        it "is nil" do
+          expect(entry.name).to be_nil
+        end
+      end
+    end
+
+    context 'without the number' do
+      let(:config) { { protocol: 'http' } }
+
+      describe '#valid?' do
+        it 'is not valid' do
+          expect(entry).not_to be_valid
+        end
+      end
+    end
+  end
+
+  context 'when configuration is invalid' do
+    let(:config) { '80' }
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).not_to be_valid
+      end
+    end
+  end
+
+  context 'when protocol' do
+    let(:config) { { number: 80, protocol: protocol, name: 'foobar' } }
+
+    context 'is http' do
+      let(:protocol) { 'http' }
+
+      describe '#valid?' do
+        it 'is valid' do
+          expect(entry).to be_valid
+        end
+      end
+    end
+
+    context 'is https' do
+      let(:protocol) { 'https' }
+
+      describe '#valid?' do
+        it 'is valid' do
+          expect(entry).to be_valid
+        end
+      end
+    end
+
+    context 'is neither http nor https' do
+      let(:protocol) { 'foo' }
+
+      describe '#valid?' do
+        it 'is invalid' do
+          expect(entry.errors).to include("port protocol should be http or https")
+        end
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/config/entry/ports_spec.rb b/spec/lib/gitlab/ci/config/entry/ports_spec.rb
new file mode 100644
index 00000000000..2063bd1d86c
--- /dev/null
+++ b/spec/lib/gitlab/ci/config/entry/ports_spec.rb
@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Ci::Config::Entry::Ports do
+  let(:entry) { described_class.new(config) }
+
+  before do
+    entry.compose!
+  end
+
+  context 'when configuration is valid' do
+    let(:config) { [{ number: 80, protocol: 'http', name: 'foobar' }] }
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(entry).to be_valid
+      end
+    end
+
+    describe '#value' do
+      it 'returns valid array' do
+        expect(entry.value).to eq(config)
+      end
+    end
+  end
+
+  context 'when configuration is invalid' do
+    let(:config) { 'postgresql:9.5' }
+
+    describe '#valid?' do
+      it 'is invalid' do
+        expect(entry).not_to be_valid
+      end
+    end
+
+    context 'when any of the ports' do
+      before do
+        expect(entry).not_to be_valid
+        expect(entry.errors.count).to eq 1
+      end
+
+      context 'have the same name' do
+        let(:config) do
+          [{ number: 80, protocol: 'http', name: 'foobar' },
+           { number: 81, protocol: 'http', name: 'foobar' }]
+        end
+
+        describe '#valid?' do
+          it 'is invalid' do
+            expect(entry.errors.first).to match /each port name must be different/
+          end
+        end
+      end
+
+      context 'have the same port' do
+        let(:config) do
+          [{ number: 80, protocol: 'http', name: 'foobar' },
+           { number: 80, protocol: 'http', name: 'foobar1' }]
+        end
+
+        describe '#valid?' do
+          it 'is invalid' do
+            expect(entry.errors.first).to match /each port number can only be referenced once/
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/config/entry/service_spec.rb b/spec/lib/gitlab/ci/config/entry/service_spec.rb
index 9ebf947a751..d5bd139b5f1 100644
--- a/spec/lib/gitlab/ci/config/entry/service_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/service_spec.rb
@@ -39,6 +39,12 @@ describe Gitlab::Ci::Config::Entry::Service do
         expect(entry.command).to be_nil
       end
     end
+
+    describe '#ports' do
+      it "returns service's ports" do
+        expect(entry.ports).to be_nil
+      end
+    end
   end
 
   context 'when configuration is a hash' do
@@ -81,6 +87,40 @@ describe Gitlab::Ci::Config::Entry::Service do
         expect(entry.entrypoint).to eq %w(/bin/sh run)
       end
     end
+
+    context 'when configuration has ports' do
+      let(:ports) { [{ number: 80, protocol: 'http', name: 'foobar' }] }
+      let(:config) do
+        { name: 'postgresql:9.5', alias: 'db', command: %w(cmd run), entrypoint: %w(/bin/sh run), ports: ports }
+      end
+      let(:entry) { described_class.new(config, { with_image_ports: image_ports }) }
+      let(:image_ports) { false }
+
+      context 'when with_image_ports metadata is not enabled' do
+        describe '#valid?' do
+          it 'is not valid' do
+            expect(entry).not_to be_valid
+            expect(entry.errors).to include("service config contains disallowed keys: ports")
+          end
+        end
+      end
+
+      context 'when with_image_ports metadata is enabled' do
+        let(:image_ports) { true }
+
+        describe '#valid?' do
+          it 'is valid' do
+            expect(entry).to be_valid
+          end
+        end
+
+        describe '#ports' do
+          it "returns image's ports" do
+            expect(entry.ports).to eq ports
+          end
+        end
+      end
+    end
   end
 
   context 'when entry value is not correct' do
@@ -88,8 +128,8 @@ describe Gitlab::Ci::Config::Entry::Service do
 
     describe '#errors' do
       it 'saves errors' do
-        expect(entry.errors)
-            .to include 'service config should be a hash or a string'
+        expect(entry.errors.first)
+            .to match /config should be a hash or a string/
       end
     end
 
@@ -105,8 +145,8 @@ describe Gitlab::Ci::Config::Entry::Service do
 
     describe '#errors' do
       it 'saves errors' do
-        expect(entry.errors)
-            .to include 'service config contains unknown keys: non_existing'
+        expect(entry.errors.first)
+            .to match /config contains unknown keys: non_existing/
       end
     end
 
@@ -116,4 +156,26 @@ describe Gitlab::Ci::Config::Entry::Service do
       end
     end
   end
+
+  context 'when service has ports' do
+    let(:ports) { [{ number: 80, protocol: 'http', name: 'foobar' }] }
+    let(:config) do
+      { name: 'postgresql:9.5', command: %w(cmd run), entrypoint: %w(/bin/sh run), ports: ports }
+    end
+
+    it 'alias field is mandatory' do
+      expect(entry).not_to be_valid
+      expect(entry.errors).to include("service alias can't be blank")
+    end
+  end
+
+  context 'when service does not have ports' do
+    let(:config) do
+      { name: 'postgresql:9.5', alias: 'db', command: %w(cmd run), entrypoint: %w(/bin/sh run) }
+    end
+
+    it 'alias field is optional' do
+      expect(entry).to be_valid
+    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 7c4319aee63..d5a1316f665 100644
--- a/spec/lib/gitlab/ci/config/entry/services_spec.rb
+++ b/spec/lib/gitlab/ci/config/entry/services_spec.rb
@@ -32,4 +32,91 @@ describe Gitlab::Ci::Config::Entry::Services do
       end
     end
   end
+
+  context 'when configuration has ports' do
+    let(:ports) { [{ number: 80, protocol: 'http', name: 'foobar' }] }
+    let(:config) { ['postgresql:9.5', { name: 'postgresql:9.1', alias: 'postgres_old', ports: ports }] }
+    let(:entry) { described_class.new(config, { with_image_ports: image_ports }) }
+    let(:image_ports) { false }
+
+    context 'when with_image_ports metadata is not enabled' do
+      describe '#valid?' do
+        it 'is not valid' do
+          expect(entry).not_to be_valid
+          expect(entry.errors).to include("service config contains disallowed keys: ports")
+        end
+      end
+    end
+
+    context 'when with_image_ports metadata is enabled' do
+      let(:image_ports) { true }
+
+      describe '#valid?' do
+        it 'is valid' do
+          expect(entry).to be_valid
+        end
+      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', ports: ports }])
+        end
+      end
+
+      describe 'services alias' do
+        context 'when they are not unique' do
+          let(:config) do
+            ['postgresql:9.5',
+             { name: 'postgresql:9.1', alias: 'postgres_old', ports: [80] },
+             { name: 'ruby', alias: 'postgres_old', ports: [81] }]
+          end
+
+          describe '#valid?' do
+            it 'is invalid' do
+              expect(entry).not_to be_valid
+              expect(entry.errors).to include("services config alias must be unique in services with ports")
+            end
+          end
+        end
+
+        context 'when they are unique' do
+          let(:config) do
+            ['postgresql:9.5',
+             { name: 'postgresql:9.1', alias: 'postgres_old', ports: [80] },
+             { name: 'ruby', alias: 'ruby', ports: [81] }]
+          end
+
+          describe '#valid?' do
+            it 'is valid' do
+              expect(entry).to be_valid
+            end
+          end
+        end
+
+        context 'when one of the duplicated alias is in a service without ports' do
+          let(:config) do
+            ['postgresql:9.5',
+             { name: 'postgresql:9.1', alias: 'postgres_old', ports: [80] },
+             { name: 'ruby', alias: 'postgres_old' }]
+          end
+
+          it 'is valid' do
+            expect(entry).to be_valid
+          end
+        end
+
+        context 'when there are not any ports' do
+          let(:config) do
+            ['postgresql:9.5',
+             { name: 'postgresql:9.1', alias: 'postgres_old' },
+             { name: 'ruby', alias: 'postgres_old' }]
+          end
+
+          it 'is valid' do
+            expect(entry).to be_valid
+          end
+        end
+      end
+    end
+  end
 end