Merge branch 'ci/api-builds' into 'master'

Add builds API

References #4264

See merge request !2207

3 files changed, 177 insertions, 0 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 098dd975840..7efe0a0262f 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -54,6 +54,7 @@ module API
     mount Keys
     mount Tags
     mount Triggers
+    mount Builds
     mount Variables
   end
 end
diff --git a/lib/api/builds.rb b/lib/api/builds.rb
new file mode 100644
index 00000000000..d293f988165
--- /dev/null
+++ b/lib/api/builds.rb
@@ -0,0 +1,149 @@
+module API
+  # Projects builds API
+  class Builds < Grape::API
+    before { authenticate! }
+
+    resource :projects do
+      # Get a project builds
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   scope (optional) - The scope of builds to show (one or array of: pending, running, failed, success, canceled;
+      #                      if none provided showing all builds)
+      # Example Request:
+      #   GET /projects/:id/builds
+      get ':id/builds' do
+        builds = user_project.builds.order('id DESC')
+        builds = filter_builds(builds, params[:scope])
+
+        present paginate(builds), with: Entities::Build,
+                                  user_can_download_artifacts: can?(current_user, :download_build_artifacts, user_project)
+      end
+
+      # Get builds for a specific commit of a project
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   sha (required) - The SHA id of a commit
+      #   scope (optional) - The scope of builds to show (one or array of: pending, running, failed, success, canceled;
+      #                      if none provided showing all builds)
+      # Example Request:
+      #   GET /projects/:id/repository/commits/:sha/builds
+      get ':id/repository/commits/:sha/builds' do
+        commit = user_project.ci_commits.find_by_sha(params[:sha])
+        return not_found! unless commit
+
+        builds = commit.builds.order('id DESC')
+        builds = filter_builds(builds, params[:scope])
+
+        present paginate(builds), with: Entities::Build,
+                                  user_can_download_artifacts: can?(current_user, :download_build_artifacts, user_project)
+      end
+
+      # Get a specific build of a project
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   build_id (required) - The ID of a build
+      # Example Request:
+      #   GET /projects/:id/builds/:build_id
+      get ':id/builds/:build_id' do
+        build = get_build(params[:build_id])
+        return not_found!(build) unless build
+
+        present build, with: Entities::Build,
+                       user_can_download_artifacts: can?(current_user, :download_build_artifacts, user_project)
+      end
+
+      # Get a trace of a specific build of a project
+      #
+      # Parameters:
+      #   id (required) - The ID of a project
+      #   build_id (required) - The ID of a build
+      # Example Request:
+      #   GET /projects/:id/build/:build_id/trace
+      #
+      # TODO: We should use `present_file!` and leave this implementation for backward compatibility (when build trace
+      #       is saved in the DB instead of file). But before that, we need to consider how to replace the value of
+      #       `runners_token` with some mask (like `xxxxxx`) when sending trace file directly by workhorse.
+      get ':id/builds/:build_id/trace' do
+        build = get_build(params[:build_id])
+        return not_found!(build) unless build
+
+        header 'Content-Disposition', "infile; filename=\"#{build.id}.log\""
+        content_type 'text/plain'
+        env['api.format'] = :binary
+
+        trace = build.trace
+        body trace
+      end
+
+      # Cancel a specific build of a project
+      #
+      # parameters:
+      #   id (required) - the id of a project
+      #   build_id (required) - the id of a build
+      # example request:
+      #   post /projects/:id/build/:build_id/cancel
+      post ':id/builds/:build_id/cancel' do
+        authorize_manage_builds!
+
+        build = get_build(params[:build_id])
+        return not_found!(build) unless build
+
+        build.cancel
+
+        present build, with: Entities::Build,
+                       user_can_download_artifacts: can?(current_user, :download_build_artifacts, user_project)
+      end
+
+      # Retry a specific build of a project
+      #
+      # parameters:
+      #   id (required) - the id of a project
+      #   build_id (required) - the id of a build
+      # example request:
+      #   post /projects/:id/build/:build_id/retry
+      post ':id/builds/:build_id/retry' do
+        authorize_manage_builds!
+
+        build = get_build(params[:build_id])
+        return forbidden!('Build is not retryable') unless build && build.retryable?
+
+        build = Ci::Build.retry(build)
+
+        present build, with: Entities::Build,
+                       user_can_download_artifacts: can?(current_user, :download_build_artifacts, user_project)
+      end
+    end
+
+    helpers do
+      def get_build(id)
+        user_project.builds.find_by(id: id.to_i)
+      end
+
+      def filter_builds(builds, scope)
+        return builds if scope.nil? || scope.empty?
+
+        available_statuses = ::CommitStatus::AVAILABLE_STATUSES
+        scope =
+          if scope.is_a?(String)
+            [scope]
+          elsif scope.is_a?(Hashie::Mash)
+            scope.values
+          else
+            ['unknown']
+          end
+
+        unknown = scope - available_statuses
+        render_api_error!('Scope contains invalid value(s)', 400) unless unknown.empty?
+
+        builds.where(status: available_statuses && scope)
+      end
+
+      def authorize_manage_builds!
+        authorize! :manage_builds, user_project
+      end
+    end
+  end
+end
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index e2feb7bb6d9..cce46886672 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -367,6 +367,33 @@ module API
       expose :id, :variables
     end
 
+    class Runner < Grape::Entity
+      expose :id
+      expose :description
+      expose :active
+      expose :is_shared
+      expose :name
+    end
+
+    class Build < Grape::Entity
+      expose :id, :status, :stage, :name, :ref, :tag, :coverage
+      expose :created_at, :started_at, :finished_at
+      expose :user, with: User
+      # TODO: download_url in Ci:Build model is an GitLab Web Interface URL, not API URL. We should think on some API
+      #       for downloading of artifacts (see: https://gitlab.com/gitlab-org/gitlab-ce/issues/4255)
+      expose :download_url do |repo_obj, options|
+        if options[:user_can_download_artifacts]
+          repo_obj.download_url
+        end
+      end
+      expose :commit, with: RepoCommit do |repo_obj, _options|
+        if repo_obj.respond_to?(:commit)
+          repo_obj.commit.commit_data
+        end
+      end
+      expose :runner, with: Runner
+    end
+
     class Variable < Grape::Entity
       expose :key, :value
     end