Port remaining differences from CE

app/models/repository.rb

@@ -1004,14 +1004,6 @@ class Repository
                                        remote_branch: merge_request.target_branch)
   end
 
-  def blob_data_at(sha, path)
-    blob = blob_at(sha, path)
-    return unless blob
-
-    blob.load_all_data!
-    blob.data
-  end
-
   def squash(user, merge_request)
     raw.squash(user, merge_request.id, branch: merge_request.target_branch,
                                        start_sha: merge_request.diff_start_sha,
@@ -1020,6 +1012,14 @@ class Repository
                                        message: merge_request.title)
   end
 
+  def blob_data_at(sha, path)
+    blob = blob_at(sha, path)
+    return unless blob
+
+    blob.load_all_data!
+    blob.data
+  end
+
   private
 
   # TODO Generice finder, later split this on finders by Ref or Oid

lib/gitlab/ci/external/file/base.rb

+module Gitlab
+  module Ci
+    module External
+      module File
+        class Base
+          YAML_WHITELIST_EXTENSION = /(yml|yaml)$/i.freeze
+
+          def initialize(location, opts = {})
+            @location = location
+          end
+
+          def valid?
+            location.match(YAML_WHITELIST_EXTENSION) && content
+          end
+
+          def content
+            raise NotImplementedError, 'content must be implemented and return a string or nil'
+          end
+
+          def error_message
+            raise NotImplementedError, 'error_message must be implemented and return a string'
+          end
+        end
+      end
+    end
+  end
+end

lib/gitlab/ci/external/file/local.rb

+module Gitlab
+  module Ci
+    module External
+      module File
+        class Local < Base
+          attr_reader :location, :project, :sha
+
+          def initialize(location, opts = {})
+            super
+
+            @project = opts.fetch(:project)
+            @sha = opts.fetch(:sha)
+          end
+
+          def content
+            @content ||= fetch_local_content
+          end
+
+          def error_message
+            "Local file '#{location}' is not valid."
+          end
+
+          private
+
+          def fetch_local_content
+            project.repository.blob_data_at(sha, location)
+          end
+        end
+      end
+    end
+  end
+end

lib/gitlab/ci/external/file/remote.rb

+module Gitlab
+  module Ci
+    module External
+      module File
+        class Remote < Base
+          include Gitlab::Utils::StrongMemoize
+          attr_reader :location
+
+          def content
+            return @content if defined?(@content)
+
+            @content = strong_memoize(:content) do
+              begin
+                Gitlab::HTTP.get(location)
+              rescue Gitlab::HTTP::Error, Timeout::Error, SocketError, Gitlab::HTTP::BlockedUrlError
+                nil
+              end
+            end
+          end
+
+          def error_message
+            "Remote file '#{location}' is not valid."
+          end
+        end
+      end
+    end
+  end
+end

lib/gitlab/ci/external/mapper.rb

+module Gitlab
+  module Ci
+    module External
+      class Mapper
+        def initialize(values, project, sha)
+          @locations = Array(values.fetch(:include, []))
+          @project = project
+          @sha = sha
+        end
+
+        def process
+          locations.map { |location| build_external_file(location) }
+        end
+
+        private
+
+        attr_reader :locations, :project, :sha
+
+        def build_external_file(location)
+          if ::Gitlab::UrlSanitizer.valid?(location)
+            Gitlab::Ci::External::File::Remote.new(location)
+          else
+            options = { project: project, sha: sha }
+            Gitlab::Ci::External::File::Local.new(location, options)
+          end
+        end
+      end
+    end
+  end
+end

lib/gitlab/ci/external/processor.rb

+module Gitlab
+  module Ci
+    module External
+      class Processor
+        FileError = Class.new(StandardError)
+
+        def initialize(values, project, sha)
+          @values = values
+          @external_files = Gitlab::Ci::External::Mapper.new(values, project, sha).process
+          @content = {}
+        end
+
+        def perform
+          return values if external_files.empty?
+
+          external_files.each do |external_file|
+            validate_external_file(external_file)
+            @content.deep_merge!(content_of(external_file))
+          end
+
+          append_inline_content
+          remove_include_keyword
+        end
+
+        private
+
+        attr_reader :values, :external_files, :content
+
+        def validate_external_file(external_file)
+          unless external_file.valid?
+            raise FileError, external_file.error_message
+          end
+        end
+
+        def content_of(external_file)
+          Gitlab::Ci::Config::Loader.new(external_file.content).load!
+        end
+
+        def append_inline_content
+          @content.deep_merge!(@values)
+        end
+
+        def remove_include_keyword
+          content.delete(:include)
+          content
+        end
+      end
+    end
+  end
+end

spec/fixtures/gitlab/ci/external_files/.gitlab-ci-template-1.yml

+before_script:
+  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec

spec/lib/gitlab/ci/external/file/local_spec.rb

+require 'spec_helper'
+
+describe Gitlab::Ci::External::File::Local do
+  let(:project) { create(:project, :repository) }
+  let(:local_file) { described_class.new(location, { project: project, sha: '12345' }) }
+
+  describe '#valid?' do
+    context 'when is a valid local path' do
+      let(:location) { '/vendor/gitlab-ci-yml/existent-file.yml' }
+
+      before do
+        allow_any_instance_of(described_class).to receive(:fetch_local_content).and_return("image: 'ruby2:2'")
+      end
+
+      it 'should return true' do
+        expect(local_file.valid?).to be_truthy
+      end
+    end
+
+    context 'when is not a valid local path' do
+      let(:location) { '/vendor/gitlab-ci-yml/non-existent-file.yml' }
+
+      it 'should return false' do
+        expect(local_file.valid?).to be_falsy
+      end
+    end
+
+    context 'when is not a yaml file' do
+      let(:location) { '/config/application.rb' }
+
+      it 'should return false' do
+        expect(local_file.valid?).to be_falsy
+      end
+    end
+  end
+
+  describe '#content' do
+    context 'with a a valid file' do
+      let(:local_file_content) do
+        <<~HEREDOC
+          before_script:
+            - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+            - ruby -v
+            - which ruby
+            - gem install bundler --no-ri --no-rdoc
+            - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+        HEREDOC
+      end
+      let(:location) { '/vendor/gitlab-ci-yml/existent-file.yml' }
+
+      before do
+        allow_any_instance_of(described_class).to receive(:fetch_local_content).and_return(local_file_content)
+      end
+
+      it 'should return the content of the file' do
+        expect(local_file.content).to eq(local_file_content)
+      end
+    end
+
+    context 'with an invalid file' do
+      let(:location) { '/vendor/gitlab-ci-yml/non-existent-file.yml' }
+
+      it 'should be nil' do
+        expect(local_file.content).to be_nil
+      end
+    end
+  end
+
+  describe '#error_message' do
+    let(:location) { '/vendor/gitlab-ci-yml/non-existent-file.yml' }
+
+    it 'should return an error message' do
+      expect(local_file.error_message).to eq("Local file '#{location}' is not valid.")
+    end
+  end
+end

spec/lib/gitlab/ci/external/file/remote_spec.rb

+require 'spec_helper'
+
+describe Gitlab::Ci::External::File::Remote do
+  let(:remote_file) { described_class.new(location) }
+  let(:location) { 'https://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+  let(:remote_file_content) do
+    <<~HEREDOC
+      before_script:
+        - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+        - ruby -v
+        - which ruby
+        - gem install bundler --no-ri --no-rdoc
+        - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+    HEREDOC
+  end
+
+  describe "#valid?" do
+    context 'when is a valid remote url' do
+      before do
+        WebMock.stub_request(:get, location).to_return(body: remote_file_content)
+      end
+
+      it 'should return true' do
+        expect(remote_file.valid?).to be_truthy
+      end
+    end
+
+    context 'with an irregular url' do
+      let(:location) { 'not-valid://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+
+      it 'should return false' do
+        expect(remote_file.valid?).to be_falsy
+      end
+    end
+
+    context 'with a timeout' do
+      before do
+        allow(Gitlab::HTTP).to receive(:get).and_raise(Timeout::Error)
+      end
+
+      it 'should be falsy' do
+        expect(remote_file.valid?).to be_falsy
+      end
+    end
+
+    context 'when is not a yaml file' do
+      let(:location) { 'https://asdasdasdaj48ggerexample.com' }
+
+      it 'should be falsy' do
+        expect(remote_file.valid?).to be_falsy
+      end
+    end
+
+    context 'with an internal url' do
+      let(:location) { 'http://localhost:8080' }
+
+      it 'should be falsy' do
+        expect(remote_file.valid?).to be_falsy
+      end
+    end
+  end
+
+  describe "#content" do
+    context 'with a valid remote file' do
+      before do
+        WebMock.stub_request(:get, location).to_return(body: remote_file_content)
+      end
+
+      it 'should return the content of the file' do
+        expect(remote_file.content).to eql(remote_file_content)
+      end
+    end
+
+    context 'with a timeout' do
+      before do
+        allow(Gitlab::HTTP).to receive(:get).and_raise(Timeout::Error)
+      end
+
+      it 'should be falsy' do
+        expect(remote_file.content).to be_falsy
+      end
+    end
+
+    context 'with an invalid remote url' do
+      let(:location) { 'https://asdasdasdaj48ggerexample.com' }
+
+      before do
+        WebMock.stub_request(:get, location).to_raise(SocketError.new('Some HTTP error'))
+      end
+
+      it 'should be nil' do
+        expect(remote_file.content).to be_nil
+      end
+    end
+
+    context 'with an internal url' do
+      let(:location) { 'http://localhost:8080' }
+
+      it 'should be nil' do
+        expect(remote_file.content).to be_nil
+      end
+    end
+  end
+
+  describe "#error_message" do
+    let(:location) { 'not-valid://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+
+    it 'should return an error message' do
+      expect(remote_file.error_message).to eq("Remote file '#{location}' is not valid.")
+    end
+  end
+end

spec/lib/gitlab/ci/external/mapper_spec.rb

+require 'spec_helper'
+
+describe Gitlab::Ci::External::Mapper do
+  let(:project) { create(:project, :repository) }
+  let(:file_content) do
+    <<~HEREDOC
+    image: 'ruby:2.2'
+    HEREDOC
+  end
+
+  describe '#process' do
+    subject { described_class.new(values, project, '123456').process }
+
+    context "when 'include' keyword is defined as string" do
+      context 'when the string is a local file' do
+        let(:values) do
+          {
+            include: '/vendor/gitlab-ci-yml/non-existent-file.yml',
+            image: 'ruby:2.2'
+          }
+        end
+
+        it 'returns an array' do
+          expect(subject).to be_an(Array)
+        end
+
+        it 'returns File instances' do
+          expect(subject.first).to be_an_instance_of(Gitlab::Ci::External::File::Local)
+        end
+      end
+
+      context 'when the string is a remote file' do
+        let(:remote_url) { 'https://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+        let(:values) do
+          {
+            include: remote_url,
+            image: 'ruby:2.2'
+          }
+        end
+
+        before do
+          WebMock.stub_request(:get, remote_url).to_return(body: file_content)
+        end
+
+        it 'returns an array' do
+          expect(subject).to be_an(Array)
+        end
+
+        it 'returns File instances' do
+          expect(subject.first).to be_an_instance_of(Gitlab::Ci::External::File::Remote)
+        end
+      end
+    end
+
+    context "when 'include' is defined as an array" do
+      let(:remote_url) { 'https://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+      let(:values) do
+        {
+          include:
+          [
+            remote_url,
+            '/vendor/gitlab-ci-yml/template.yml'
+          ],
+          image: 'ruby:2.2'
+        }
+      end
+
+      before do
+        WebMock.stub_request(:get, remote_url).to_return(body: file_content)
+      end
+
+      it 'returns an array' do
+        expect(subject).to be_an(Array)
+      end
+
+      it 'returns Files instances' do
+        expect(subject).to all(respond_to(:valid?))
+        expect(subject).to all(respond_to(:content))
+      end
+    end
+
+    context "when 'include' is not defined" do
+      let(:values) do
+        {
+          image: 'ruby:2.2'
+        }
+      end
+
+      it 'returns an empty array' do
+        expect(subject).to be_empty
+      end
+    end
+  end
+end

spec/lib/gitlab/ci/external/processor_spec.rb

+require 'spec_helper'
+
+describe Gitlab::Ci::External::Processor do
+  let(:project) { create(:project, :repository) }
+  let(:processor) { described_class.new(values, project, '12345') }
+
+  describe "#perform" do
+    context 'when no external files defined' do
+      let(:values) { { image: 'ruby:2.2' } }
+
+      it 'should return the same values' do
+        expect(processor.perform).to eq(values)
+      end
+    end
+
+    context 'when an invalid local file is defined' do
+      let(:values) { { include: '/vendor/gitlab-ci-yml/non-existent-file.yml', image: 'ruby:2.2' } }
+
+      it 'should raise an error' do
+        expect { processor.perform }.to raise_error(
+          described_class::FileError,
+          "Local file '/vendor/gitlab-ci-yml/non-existent-file.yml' is not valid."
+        )
+      end
+    end
+
+    context 'when an invalid remote file is defined' do
+      let(:remote_file) { 'http://doesntexist.com/.gitlab-ci-1.yml' }
+      let(:values) { { include: remote_file, image: 'ruby:2.2' } }
+
+      before do
+        WebMock.stub_request(:get, remote_file).to_raise(SocketError.new('Some HTTP error'))
+      end
+
+      it 'should raise an error' do
+        expect { processor.perform }.to raise_error(
+          described_class::FileError,
+          "Remote file '#{remote_file}' is not valid."
+        )
+      end
+    end
+
+    context 'with a valid remote external file is defined' do
+      let(:remote_file) { 'https://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+      let(:values) { { include: remote_file, image: 'ruby:2.2' } }
+      let(:external_file_content) do
+        <<-HEREDOC
+        before_script:
+          - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+          - ruby -v
+          - which ruby
+          - gem install bundler --no-ri --no-rdoc
+          - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+        rspec:
+          script:
+            - bundle exec rspec
+
+        rubocop:
+          script:
+            - bundle exec rubocop
+        HEREDOC
+      end
+
+      before do
+        WebMock.stub_request(:get, remote_file).to_return(body: external_file_content)
+      end
+
+      it 'should append the file to the values' do
+        output = processor.perform
+        expect(output.keys).to match_array([:image, :before_script, :rspec, :rubocop])
+      end
+
+      it "should remove the 'include' keyword" do
+        expect(processor.perform[:include]).to be_nil
+      end
+    end
+
+    context 'with a valid local external file is defined' do
+      let(:values) { { include: '/vendor/gitlab-ci-yml/template.yml', image: 'ruby:2.2' } }
+      let(:local_file_content) do
+        <<-HEREDOC
+        before_script:
+          - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+          - ruby -v
+          - which ruby
+          - gem install bundler --no-ri --no-rdoc
+          - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+        HEREDOC
+      end
+
+      before do
+        allow_any_instance_of(Gitlab::Ci::External::File::Local).to receive(:fetch_local_content).and_return(local_file_content)
+      end
+
+      it 'should append the file to the values' do
+        output = processor.perform
+        expect(output.keys).to match_array([:image, :before_script])
+      end
+
+      it "should remove the 'include' keyword" do
+        expect(processor.perform[:include]).to be_nil
+      end
+    end
+
+    context 'with multiple external files are defined' do
+      let(:remote_file) { 'https://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+      let(:external_files) do
+        [
+          '/ee/spec/fixtures/gitlab/ci/external_files/.gitlab-ci-template-1.yml',
+          remote_file
+        ]
+      end
+      let(:values) do
+        {
+          include: external_files,
+          image: 'ruby:2.2'
+        }
+      end
+
+      let(:remote_file_content) do
+        <<-HEREDOC
+        stages:
+          - build
+          - review
+          - cleanup
+        HEREDOC
+      end
+
+      before do
+        local_file_content = File.read(Rails.root.join('ee/spec/fixtures/gitlab/ci/external_files/.gitlab-ci-template-1.yml'))
+        allow_any_instance_of(Gitlab::Ci::External::File::Local).to receive(:fetch_local_content).and_return(local_file_content)
+        WebMock.stub_request(:get, remote_file).to_return(body: remote_file_content)
+      end
+
+      it 'should append the files to the values' do
+        expect(processor.perform.keys).to match_array([:image, :stages, :before_script, :rspec])
+      end
+
+      it "should remove the 'include' keyword" do
+        expect(processor.perform[:include]).to be_nil
+      end
+    end
+
+    context 'when external files are defined but not valid' do
+      let(:values) { { include: '/vendor/gitlab-ci-yml/template.yml', image: 'ruby:2.2' } }
+
+      let(:local_file_content) { 'invalid content file ////' }
+
+      before do
+        allow_any_instance_of(Gitlab::Ci::External::File::Local).to receive(:fetch_local_content).and_return(local_file_content)
+      end
+
+      it 'should raise an error' do
+        expect { processor.perform }.to raise_error(Gitlab::Ci::Config::Loader::FormatError)
+      end
+    end
+
+    context "when both external files and values defined the same key" do
+      let(:remote_file) { 'https://gitlab.com/gitlab-org/gitlab-ce/blob/1234/.gitlab-ci-1.yml' }
+      let(:values) do
+        {
+          include: remote_file,
+          image: 'ruby:2.2'
+        }
+      end
+
+      let(:remote_file_content) do
+        <<~HEREDOC
+        image: php:5-fpm-alpine
+        HEREDOC
+      end
+
+      it 'should take precedence' do
+        WebMock.stub_request(:get, remote_file).to_return(body: remote_file_content)
+        expect(processor.perform[:image]).to eq('ruby:2.2')
+      end
+    end
+  end
+end