diff --git a/lib/travis/api/v3/queries/build.rb b/lib/travis/api/v3/queries/build.rb index f151d77c..6cd5cee4 100644 --- a/lib/travis/api/v3/queries/build.rb +++ b/lib/travis/api/v3/queries/build.rb @@ -12,5 +12,11 @@ module Travis::API::V3 perform_async(:build_cancellation, type: 'api'.freeze, payload: JSON.dump(payload)) payload end + + def restart(user) + payload = {build: {id: id, user_id: user.id, source: 'api'}} + perform_async(:build_restart, type: 'api'.freeze, payload: JSON.dump(payload)) + payload + end end end diff --git a/lib/travis/api/v3/routes.rb b/lib/travis/api/v3/routes.rb index 8d1d3584..ca4e4988 100644 --- a/lib/travis/api/v3/routes.rb +++ b/lib/travis/api/v3/routes.rb @@ -19,7 +19,7 @@ module Travis::API::V3 get :find post :cancel, '/cancel' - # post :restart, '/restart' + post :restart, '/restart' end resource :job do diff --git a/lib/travis/api/v3/services/build/restart.rb b/lib/travis/api/v3/services/build/restart.rb new file mode 100644 index 00000000..acb49727 --- /dev/null +++ b/lib/travis/api/v3/services/build/restart.rb @@ -0,0 +1,13 @@ +module Travis::API::V3 + class Services::Build::Restart < Service + + def run + raise LoginRequired unless access_control.logged_in? or access_control.full_access? + raise NotFound unless build = find(:build) + access_control.permissions(build).restart! + + query.restart(access_control.user) + accepted(build: build, state_change: :restart) + end + end +end diff --git a/spec/v3/services/build/restart_spec.rb b/spec/v3/services/build/restart_spec.rb new file mode 100644 index 00000000..a5d4d662 --- /dev/null +++ b/spec/v3/services/build/restart_spec.rb @@ -0,0 +1,156 @@ +require 'spec_helper' + +describe Travis::API::V3::Services::Build::Restart do + let(:repo) { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first } + let(:build) { repo.builds.first } + let(:sidekiq_payload) { JSON.load(Sidekiq::Client.last['args'].last[:payload]) } + let(:sidekiq_params) { Sidekiq::Client.last['args'].last.deep_symbolize_keys } + + before do + Travis::Features.stubs(:owner_active?).returns(true) + @original_sidekiq = Sidekiq::Client + Sidekiq.send(:remove_const, :Client) # to avoid a warning + Sidekiq::Client = [] + end + + after do + Sidekiq.send(:remove_const, :Client) # to avoid a warning + Sidekiq::Client = @original_sidekiq + end + + describe "not authenticated" do + before { post("/v3/build/#{build.id}/restart") } + example { expect(last_response.status).to be == 403 } + example { expect(JSON.load(body)).to be == { + "@type" => "error", + "error_type" => "login_required", + "error_message" => "login required" + }} + end + + describe "missing build, authenticated" do + let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) } + let(:headers) {{ 'HTTP_AUTHORIZATION' => "token #{token}" }} + before { post("/v3/build/9999999999/restart", {}, headers) } + + example { expect(last_response.status).to be == 404 } + example { expect(JSON.load(body)).to be == { + "@type" => "error", + "error_type" => "not_found", + "error_message" => "build not found (or insufficient access)", + "resource_type" => "build" + }} + end + + describe "existing repository, no push access" do + let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) } + let(:headers) {{ 'HTTP_AUTHORIZATION' => "token #{token}" }} + before { post("/v3/build/#{build.id}/restart", {}, headers) } + + example { expect(last_response.status).to be == 403 } + example { expect(JSON.load(body).to_s).to include( + "@type", + "error_type", + "insufficient_access", + "error_message", + "operation requires restart access to build", + "resource_type", + "build", + "permission", + "restart") + } + end + + describe "private repository, no access" do + let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) } + let(:headers) {{ 'HTTP_AUTHORIZATION' => "token #{token}" }} + before { repo.update_attribute(:private, true) } + before { post("/v3/build/#{build.id}/restart", {}, headers) } + after { repo.update_attribute(:private, false) } + + example { expect(last_response.status).to be == 404 } + example { expect(JSON.load(body)).to be == { + "@type" => "error", + "error_type" => "not_found", + "error_message" => "build not found (or insufficient access)", + "resource_type" => "build" + }} + end + + describe "existing repository, push access" do + let(:params) {{}} + let(:token) { Travis::Api::App::AccessToken.create(user: repo.owner, app_id: 1) } + let(:headers) {{ 'HTTP_AUTHORIZATION' => "token #{token}" }} + before { Travis::API::V3::Models::Permission.create(repository: repo, user: repo.owner, push: true) } + before { post("/v3/build/#{build.id}/restart", params, headers) } + + example { expect(last_response.status).to be == 202 } + example { expect(JSON.load(body).to_s).to include( + "@type", + "pending", + "build", + "@href", + "@representation", + "minimal", + "restart", + "id", + "state_change") + } + + example { expect(sidekiq_payload).to be == { + "build" => { + "id" => "#{build.id}", + "user_id"=> repo.owner_id, + "source" => "api"} + }} + + example { expect(Sidekiq::Client.last['queue']).to be == 'build_restarts' } + example { expect(Sidekiq::Client.last['class']).to be == 'Travis::Sidekiq::BuildRestart' } + + describe "setting id has no effect" do + let(:params) {{ id: 42 }} + example { expect(sidekiq_payload).to be == { + "build" => { + "id" => "#{build.id}", + "user_id"=> repo.owner_id, + "source" => "api"} + }} + end + end + + # TODO decided to discuss further with rkh as this use case doesn't really exist at the moment + # and 'fixing' the query requires modifying workers that v2 uses, thereby running the risk of breaking v2, + # and also because in 6 months or so travis-hub will be able to cancel builds without using travis-core at all. + # + # describe "existing repository, application with full access" do + # let(:app_name) { 'travis-example' } + # let(:app_secret) { '12345678' } + # let(:sign_opts) { "a=#{app_name}" } + # let(:signature) { OpenSSL::HMAC.hexdigest('sha256', app_secret, sign_opts) } + # let(:headers) {{ 'HTTP_AUTHORIZATION' => "signature #{sign_opts}:#{signature}" }} + # before { Travis.config.applications = { app_name => { full_access: true, secret: app_secret }}} + # before { post("/v3/build/#{build.id}/restart", params, headers) } + # + # describe 'without setting user' do + # let(:params) {{}} + # example { expect(last_response.status).to be == 400 } + # example { expect(JSON.load(body)).to be == { + # "@type" => "error", + # "error_type" => "wrong_params", + # "error_message" => "missing user" + # }} + # end + # + # describe 'setting user' do + # let(:params) {{ user: { id: repo.owner.id } }} + # example { expect(last_response.status).to be == 202 } + # example { expect(sidekiq_payload).to be == { + # # repository: { id: repo.id, owner_name: 'svenfuchs', name: 'minimal' }, + # # user: { id: repo.owner.id }, + # # message: nil, + # # branch: 'master', + # # config: {} + # }} + # end + # end +end