Merge branch 'refactor/project-badges-interface' into 'master'

Refactor builds badge, encapsulate inside a class

This merge requests attempts to introduce interface for all badges.
Currently we only have a build badge, but other badges are in plans,
like coverage badge.

See merge request !3403

3 files changed, 99 insertions, 2 deletions

diff --git a/app/controllers/projects/badges_controller.rb b/app/controllers/projects/badges_controller.rb
index 6ff47c4033a..6d4d4360988 100644
--- a/app/controllers/projects/badges_controller.rb
+++ b/app/controllers/projects/badges_controller.rb
@@ -2,11 +2,12 @@ class Projects::BadgesController < Projects::ApplicationController
   before_action :no_cache_headers
 
   def build
+    badge = Gitlab::Badge::Build.new(project, params[:ref])
+
     respond_to do |format|
       format.html { render_404 }
       format.svg do
-        image = Ci::ImageForBuildService.new.execute(project, ref: params[:ref])
-        send_file(image.path, filename: image.name, disposition: 'inline', type: 'image/svg+xml')
+        send_data(badge.data, type: badge.type, disposition: 'inline')
       end
     end
   end
diff --git a/lib/gitlab/badge/build.rb b/lib/gitlab/badge/build.rb
new file mode 100644
index 00000000000..28a2391dbf8
--- /dev/null
+++ b/lib/gitlab/badge/build.rb
@@ -0,0 +1,24 @@
+module Gitlab
+  module Badge
+    ##
+    # Build badge
+    #
+    class Build
+      def initialize(project, ref)
+        @image = ::Ci::ImageForBuildService.new.execute(project, ref: ref)
+      end
+
+      def to_s
+        @image[:name].sub(/\.svg$/, '')
+      end
+
+      def type
+        'image/svg+xml'
+      end
+
+      def data
+        File.read(@image[:path])
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/badge/build_spec.rb b/spec/lib/gitlab/badge/build_spec.rb
new file mode 100644
index 00000000000..b78c2b6224f
--- /dev/null
+++ b/spec/lib/gitlab/badge/build_spec.rb
@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Gitlab::Badge::Build do
+  let(:project) { create(:project) }
+  let(:sha) { project.commit.sha }
+  let(:badge) { described_class.new(project, 'master') }
+
+  describe '#type' do
+    subject { badge.type }
+    it { is_expected.to eq 'image/svg+xml' }
+  end
+
+  context 'build exists' do
+    let(:ci_commit) { create(:ci_commit, project: project, sha: sha) }
+    let!(:build) { create(:ci_build, commit: ci_commit) }
+
+
+    context 'build success' do
+      before { build.success! }
+
+      describe '#to_s' do
+        subject { badge.to_s }
+        it { is_expected.to eq 'build-success' }
+      end
+
+      describe '#data' do
+        let(:data) { badge.data }
+
+        it 'contains infromation about success' do
+          expect(status_node(data, 'success')).to be_truthy
+        end
+      end
+    end
+
+    context 'build failed' do
+      before { build.drop! }
+
+      describe '#to_s' do
+        subject { badge.to_s }
+        it { is_expected.to eq 'build-failed' }
+      end
+
+      describe '#data' do
+        let(:data) { badge.data }
+
+        it 'contains infromation about failure' do
+          expect(status_node(data, 'failed')).to be_truthy
+        end
+      end
+    end
+  end
+
+  context 'build does not exist' do
+    describe '#to_s' do
+      subject { badge.to_s }
+      it { is_expected.to eq 'build-unknown' }
+    end
+
+    describe '#data' do
+      let(:data) { badge.data }
+
+      it 'contains infromation about unknown build' do
+        expect(status_node(data, 'unknown')).to be_truthy
+      end
+    end
+  end
+
+  def status_node(data, status)
+    xml = Nokogiri::XML.parse(data)
+    xml.at(%Q{text:contains("#{status}")})
+  end
+end