summaryrefslogtreecommitdiff
path: root/lib/api/builds.rb
blob: bed20ac383a77c7e2c44c715c8e3c14f06440ed1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
module API
  # Builds API
  class Builds < Grape::API
    resource :builds do
      # Runs oldest pending build by runner - Runners only
      #
      # Parameters:
      #   token (required) - The uniq token of runner
      #
      # Example Request:
      #   POST /builds/register
      post "register" do
        authenticate_runner!
        update_runner_last_contact
        required_attributes! [:token]
        not_found! unless current_runner.active?

        build = RegisterBuildService.new.execute(current_runner)

        if build
          present build, with: Entities::Build
        else
          not_found!
        end
      end

      # Update an existing build - Runners only
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   state (optional) - The state of a build
      #   trace (optional) - The trace of a build
      # Example Request:
      #   PUT /builds/:id
      put ":id" do
        authenticate_runner!
        update_runner_last_contact
        build = Build.where(runner_id: current_runner.id).running.find(params[:id])
        build.update_attributes(trace: params[:trace]) if params[:trace]

        case params[:state].to_s
        when 'success'
          build.success
        when 'failed'
          build.drop
        end
      end

      # TODO: Remove it after 5.2 release
      #
      # THIS API IS DEPRECATED.
      # Now builds are created by commit. In order to test specific commit you
      # need to create Commit entity via Commit API
      #
      # Create a build
      #
      # Parameters:
      #   project_id (required) - The ID of a project
      #   project_token (requires) - Project token
      #   data (required) - GitLab push data
      #
      #   Sample GitLab push data:
      #   {
      #     "before": "95790bf891e76fee5e1747ab589903a6a1f80f22",
      #     "after": "da1560886d4f094c3e6c9ef40349f7d38b5d27d7",
      #     "ref": "refs/heads/master",
      #     "commits": [
      #       {
      #         "id": "b6568db1bc1dcd7f8b4d5a946b0b91f9dacd7327",
      #         "message": "Update Catalan translation to e38cb41.",
      #         "timestamp": "2011-12-12T14:27:31+02:00",
      #         "url": "http://localhost/diaspora/commits/b6568db1bc1dcd7f8b4d5a946b0b91f9dacd7327",
      #         "author": {
      #           "name": "Jordi Mallach",
      #           "email": "jordi@softcatala.org",
      #         }
      #       }, .... more commits
      #     ]
      #   }
      #
      # Example Request:
      #   POST /builds
      post do
        required_attributes! [:project_id, :data, :project_token]
        project = Project.find(params[:project_id])
        authenticate_project_token!(project)
        commit = CreateCommitService.new.execute(project, params[:data])

        # Temporary solution to keep api compatibility
        build = commit.builds.first

        if build.persisted?
          present build, with: Entities::Build
        else
          errors = build.errors.full_messages.join(", ")
          render_api_error!(errors, 400)
        end
      end
    end
  end
end