Merge branch 'commit_status' into 'master'

Implement Commit Status API

This is preliminary implementation of Commit Status API, pretty much compatible with GitHub.

1. The Commit Statuses are stored in separate table: ci_commit_status.
2. The POST inserts a new row.
3. To POST execute GitLab API `post :id/repository/commits/:sha/status`. This accepts dual authorization:
- Using authorized user
- Using ci-token to allow easy posting from CI Services
4. This adds predefined variable to GitLab CI build environment: CI_BUILD_STATUS_URL, allowing to easy post status from within build (ex. with code coverage or other metrics).
5. This adds statuses to commit's builds view.
6. The commit's status is calculated taking into account status of all builds and all posted statuses.
7. The commit statuses doesn't trigger notifications.
8. The commit status API introduces two new privileges: `read_commit_statuses` and `create_commit_status`.
9. We still miss a few tests and documentation updates for API and CI.

@dzaporozhets @sytses What do you think?




See merge request !1530

3 files changed, 88 insertions, 0 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index c09488d3547..afc0402f9e1 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -46,6 +46,7 @@ module API
     mount Services
     mount Files
     mount Commits
+    mount CommitStatus
     mount Namespaces
     mount Branches
     mount Labels
diff --git a/lib/api/commit_statuses.rb b/lib/api/commit_statuses.rb
new file mode 100644
index 00000000000..2c0596c9dfb
--- /dev/null
+++ b/lib/api/commit_statuses.rb
@@ -0,0 +1,80 @@
+require 'mime/types'
+
+module API
+  # Project commit statuses API
+  class CommitStatus < Grape::API
+    resource :projects do
+      before { authenticate! }
+
+      # Get a commit's statuses
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   sha (required) - The commit hash
+      #   ref (optional) - The ref
+      #   stage (optional) - The stage
+      #   name (optional) - The name
+      #   all (optional) - Show all statuses, default: false
+      # Examples:
+      #   GET /projects/:id/repository/commits/:sha/statuses
+      get ':id/repository/commits/:sha/statuses' do
+        authorize! :read_commit_statuses, user_project
+        sha = params[:sha]
+        ci_commit = user_project.ci_commit(sha)
+        not_found! 'Commit' unless ci_commit
+        statuses = ci_commit.statuses
+        statuses = statuses.latest unless parse_boolean(params[:all])
+        statuses = statuses.where(ref: params[:ref]) if params[:ref].present?
+        statuses = statuses.where(stage: params[:stage]) if params[:stage].present?
+        statuses = statuses.where(name: params[:name]) if params[:name].present?
+        present paginate(statuses), with: Entities::CommitStatus
+      end
+
+      # Post status to commit
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   sha (required) - The commit hash
+      #   ref (optional) - The ref
+      #   state (required) - The state of the status. Can be: pending, running, success, error or failure
+      #   target_url (optional) - The target URL to associate with this status
+      #   description (optional) - A short description of the status
+      #   name or context (optional) - A string label to differentiate this status from the status of other systems. Default: "default"
+      # Examples:
+      #   POST /projects/:id/statuses/:sha
+      post ':id/statuses/:sha' do
+        authorize! :create_commit_status, user_project
+        required_attributes! [:state]
+        attrs = attributes_for_keys [:ref, :target_url, :description, :context, :name]
+        commit = @project.commit(params[:sha])
+        not_found! 'Commit' unless commit
+
+        ci_commit = @project.ensure_ci_commit(commit.sha)
+
+        name = params[:name] || params[:context]
+        status = GenericCommitStatus.running_or_pending.find_by(commit: ci_commit, name: name, ref: params[:ref])
+        status ||= GenericCommitStatus.new(commit: ci_commit, user: current_user)
+        status.update(attrs)
+
+        case params[:state].to_s
+        when 'running'
+          status.run
+        when 'success'
+          status.success
+        when 'failed'
+          status.drop
+        when 'canceled'
+          status.cancel
+        else
+          status.status = params[:state].to_s
+        end
+
+        if status.save
+          present status, with: Entities::CommitStatus
+        else
+          render_validation_error!(status)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index 9620d36ac41..519072d0157 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -149,6 +149,7 @@ module API
 
     class RepoCommitDetail < RepoCommit
       expose :parent_ids, :committed_date, :authored_date
+      expose :status
     end
 
     class ProjectSnippet < Grape::Entity
@@ -228,6 +229,12 @@ module API
       expose :created_at
     end
 
+    class CommitStatus < Grape::Entity
+      expose :id, :sha, :ref, :status, :name, :target_url, :description,
+             :created_at, :started_at, :finished_at
+      expose :author, using: Entities::UserBasic
+    end
+
     class Event < Grape::Entity
       expose :title, :project_id, :action_name
       expose :target_id, :target_type, :author_id