From e25f26e5503a5aa07f5cfc436e10b92254185f9a Mon Sep 17 00:00:00 2001 From: Tomasz Maczukin Date: Thu, 16 Feb 2017 01:30:46 +0100 Subject: Rename API::Ci to API::Runner --- lib/api/api.rb | 2 +- lib/api/ci.rb | 52 -------------- lib/api/helpers/ci.rb | 23 ------ lib/api/helpers/runner.rb | 23 ++++++ lib/api/runner.rb | 52 ++++++++++++++ spec/requests/api/ci_spec.rb | 148 --------------------------------------- spec/requests/api/runner_spec.rb | 148 +++++++++++++++++++++++++++++++++++++++ 7 files changed, 224 insertions(+), 224 deletions(-) delete mode 100644 lib/api/ci.rb delete mode 100644 lib/api/helpers/ci.rb create mode 100644 lib/api/helpers/runner.rb create mode 100644 lib/api/runner.rb delete mode 100644 spec/requests/api/ci_spec.rb create mode 100644 spec/requests/api/runner_spec.rb diff --git a/lib/api/api.rb b/lib/api/api.rb index 6d7eb3eb84f..016b9572649 100644 --- a/lib/api/api.rb +++ b/lib/api/api.rb @@ -52,7 +52,6 @@ module API mount ::API::Branches mount ::API::BroadcastMessages mount ::API::Builds - mount ::API::Ci mount ::API::Commits mount ::API::CommitStatuses mount ::API::DeployKeys @@ -77,6 +76,7 @@ module API mount ::API::Projects mount ::API::ProjectSnippets mount ::API::Repositories + mount ::API::Runner mount ::API::Runners mount ::API::Services mount ::API::Session diff --git a/lib/api/ci.rb b/lib/api/ci.rb deleted file mode 100644 index 635116cc88d..00000000000 --- a/lib/api/ci.rb +++ /dev/null @@ -1,52 +0,0 @@ -module API - class Ci < Grape::API - helpers ::API::Helpers::Ci - - resource :runners do - desc 'Registers a new Runner' do - success Entities::RunnerRegistrationDetails - http_codes [[201, 'Runner was created'], [403, 'Forbidden']] - end - params do - requires :token, type: String, desc: 'Registration token' - optional :description, type: String, desc: %q(Runner's description) - optional :info, type: Hash, desc: %q(Runner's metadata) - optional :locked, type: Boolean, desc: 'Should Runner be locked for current project' - optional :run_untagged, type: Boolean, desc: 'Should Runner handle untagged jobs' - optional :tag_list, type: Array[String], desc: %q(List of Runner's tags) - end - post '/' do - attributes = attributes_for_keys [:description, :locked, :run_untagged, :tag_list] - - runner = - if runner_registration_token_valid? - # Create shared runner. Requires admin access - ::Ci::Runner.create(attributes.merge(is_shared: true)) - elsif project = Project.find_by(runners_token: params[:token]) - # Create a specific runner for project. - project.runners.create(attributes) - end - - return forbidden! unless runner - - if runner.id - runner.update(get_runner_version_from_params) - present runner, with: Entities::RunnerRegistrationDetails - else - not_found! - end - end - - desc 'Deletes a registered Runner' do - http_codes [[200, 'Runner was deleted'], [403, 'Forbidden']] - end - params do - requires :token, type: String, desc: %q(Runner's authentication token) - end - delete '/' do - authenticate_runner! - ::Ci::Runner.find_by_token(params[:token]).destroy - end - end - end -end diff --git a/lib/api/helpers/ci.rb b/lib/api/helpers/ci.rb deleted file mode 100644 index e928d7c874a..00000000000 --- a/lib/api/helpers/ci.rb +++ /dev/null @@ -1,23 +0,0 @@ -module API - module Helpers - module Ci - def runner_registration_token_valid? - ActiveSupport::SecurityUtils.variable_size_secure_compare(params[:token], - current_application_settings.runners_registration_token) - end - - def get_runner_version_from_params - return unless params['info'].present? - attributes_for_keys(%w(name version revision platform architecture), params['info']) - end - - def authenticate_runner! - forbidden! unless current_runner - end - - def current_runner - @runner ||= ::Ci::Runner.find_by_token(params[:token].to_s) - end - end - end -end diff --git a/lib/api/helpers/runner.rb b/lib/api/helpers/runner.rb new file mode 100644 index 00000000000..119ca81b883 --- /dev/null +++ b/lib/api/helpers/runner.rb @@ -0,0 +1,23 @@ +module API + module Helpers + module Runner + def runner_registration_token_valid? + ActiveSupport::SecurityUtils.variable_size_secure_compare(params[:token], + current_application_settings.runners_registration_token) + end + + def get_runner_version_from_params + return unless params['info'].present? + attributes_for_keys(%w(name version revision platform architecture), params['info']) + end + + def authenticate_runner! + forbidden! unless current_runner + end + + def current_runner + @runner ||= ::Ci::Runner.find_by_token(params[:token].to_s) + end + end + end +end diff --git a/lib/api/runner.rb b/lib/api/runner.rb new file mode 100644 index 00000000000..804b27d40a7 --- /dev/null +++ b/lib/api/runner.rb @@ -0,0 +1,52 @@ +module API + class Runner < Grape::API + helpers ::API::Helpers::Runner + + resource :runners do + desc 'Registers a new Runner' do + success Entities::RunnerRegistrationDetails + http_codes [[201, 'Runner was created'], [403, 'Forbidden']] + end + params do + requires :token, type: String, desc: 'Registration token' + optional :description, type: String, desc: %q(Runner's description) + optional :info, type: Hash, desc: %q(Runner's metadata) + optional :locked, type: Boolean, desc: 'Should Runner be locked for current project' + optional :run_untagged, type: Boolean, desc: 'Should Runner handle untagged jobs' + optional :tag_list, type: Array[String], desc: %q(List of Runner's tags) + end + post '/' do + attributes = attributes_for_keys [:description, :locked, :run_untagged, :tag_list] + + runner = + if runner_registration_token_valid? + # Create shared runner. Requires admin access + Ci::Runner.create(attributes.merge(is_shared: true)) + elsif project = Project.find_by(runners_token: params[:token]) + # Create a specific runner for project. + project.runners.create(attributes) + end + + return forbidden! unless runner + + if runner.id + runner.update(get_runner_version_from_params) + present runner, with: Entities::RunnerRegistrationDetails + else + not_found! + end + end + + desc 'Deletes a registered Runner' do + http_codes [[200, 'Runner was deleted'], [403, 'Forbidden']] + end + params do + requires :token, type: String, desc: %q(Runner's authentication token) + end + delete '/' do + authenticate_runner! + Ci::Runner.find_by_token(params[:token]).destroy + end + end + end +end diff --git a/spec/requests/api/ci_spec.rb b/spec/requests/api/ci_spec.rb deleted file mode 100644 index 4eef78dd1c2..00000000000 --- a/spec/requests/api/ci_spec.rb +++ /dev/null @@ -1,148 +0,0 @@ -require 'spec_helper' - -describe API::Ci do - include ApiHelpers - include StubGitlabCalls - - let(:registration_token) { 'abcdefg123456' } - - before do - stub_gitlab_calls - stub_application_setting(runners_registration_token: registration_token) - end - - describe '/api/v4/runners' do - describe 'POST /api/v4/runners' do - context 'when no token is provided' do - it 'returns 400 error' do - post api('/runners') - expect(response).to have_http_status 400 - end - end - - context 'when invalid token is provided' do - it 'returns 403 error' do - post api('/runners'), token: 'invalid' - expect(response).to have_http_status 403 - end - end - - context 'when valid token is provided' do - it 'creates runner with default values' do - post api('/runners'), token: registration_token - - runner = Ci::Runner.first - - expect(response).to have_http_status 201 - expect(json_response['id']).to eq(runner.id) - expect(json_response['token']).to eq(runner.token) - expect(runner.run_untagged).to be true - end - - context 'when project token is used' do - let(:project) { create(:empty_project) } - - it 'creates runner' do - post api('/runners'), token: project.runners_token - - expect(response).to have_http_status 201 - expect(project.runners.size).to eq(1) - end - end - end - - context 'when runner description is provided' do - it 'creates runner' do - post api('/runners'), token: registration_token, - description: 'server.hostname' - - expect(response).to have_http_status 201 - expect(Ci::Runner.first.description).to eq('server.hostname') - end - end - - context 'when runner tags are provided' do - it 'creates runner' do - post api('/runners'), token: registration_token, - tag_list: 'tag1, tag2' - - expect(response).to have_http_status 201 - expect(Ci::Runner.first.tag_list.sort).to eq(%w(tag1 tag2)) - end - end - - context 'when option for running untagged jobs is provided' do - context 'when tags are provided' do - it 'creates runner' do - post api('/runners'), token: registration_token, - run_untagged: false, - tag_list: ['tag'] - - expect(response).to have_http_status 201 - expect(Ci::Runner.first.run_untagged).to be false - expect(Ci::Runner.first.tag_list.sort).to eq(['tag']) - end - end - - context 'when tags are not provided' do - it 'returns 404 error' do - post api('/runners'), token: registration_token, - run_untagged: false - - expect(response).to have_http_status 404 - end - end - end - - context 'when option for locking Runner is provided' do - it 'creates runner' do - post api('/runners'), token: registration_token, - locked: true - - expect(response).to have_http_status 201 - expect(Ci::Runner.first.locked).to be true - end - end - - %w(name version revision platform architecture).each do |param| - context "when info parameter '#{param}' info is present" do - let(:value) { "#{param}_value" } - - it %q(updates provided Runner's parameter) do - post api('/runners'), token: registration_token, - info: { param => value } - - expect(response).to have_http_status 201 - expect(Ci::Runner.first.read_attribute(param.to_sym)).to eq(value) - end - end - end - end - - describe 'DELETE /api/v4/runners' do - context 'when no token is provided' do - it 'returns 400 error' do - delete api('/runners') - expect(response).to have_http_status 400 - end - end - - context 'when invalid token is provided' do - it 'returns 403 error' do - delete api('/runners'), token: 'invalid' - expect(response).to have_http_status 403 - end - end - - context 'when valid token is provided' do - let(:runner) { create(:ci_runner) } - - it 'deletes Runner' do - delete api('/runners'), token: runner.token - expect(response).to have_http_status 200 - expect(Ci::Runner.count).to eq(0) - end - end - end - end -end diff --git a/spec/requests/api/runner_spec.rb b/spec/requests/api/runner_spec.rb new file mode 100644 index 00000000000..73e82647ca0 --- /dev/null +++ b/spec/requests/api/runner_spec.rb @@ -0,0 +1,148 @@ +require 'spec_helper' + +describe API::Runner do + include ApiHelpers + include StubGitlabCalls + + let(:registration_token) { 'abcdefg123456' } + + before do + stub_gitlab_calls + stub_application_setting(runners_registration_token: registration_token) + end + + describe '/api/v4/runners' do + describe 'POST /api/v4/runners' do + context 'when no token is provided' do + it 'returns 400 error' do + post api('/runners') + expect(response).to have_http_status 400 + end + end + + context 'when invalid token is provided' do + it 'returns 403 error' do + post api('/runners'), token: 'invalid' + expect(response).to have_http_status 403 + end + end + + context 'when valid token is provided' do + it 'creates runner with default values' do + post api('/runners'), token: registration_token + + runner = Ci::Runner.first + + expect(response).to have_http_status 201 + expect(json_response['id']).to eq(runner.id) + expect(json_response['token']).to eq(runner.token) + expect(runner.run_untagged).to be true + end + + context 'when project token is used' do + let(:project) { create(:empty_project) } + + it 'creates runner' do + post api('/runners'), token: project.runners_token + + expect(response).to have_http_status 201 + expect(project.runners.size).to eq(1) + end + end + end + + context 'when runner description is provided' do + it 'creates runner' do + post api('/runners'), token: registration_token, + description: 'server.hostname' + + expect(response).to have_http_status 201 + expect(Ci::Runner.first.description).to eq('server.hostname') + end + end + + context 'when runner tags are provided' do + it 'creates runner' do + post api('/runners'), token: registration_token, + tag_list: 'tag1, tag2' + + expect(response).to have_http_status 201 + expect(Ci::Runner.first.tag_list.sort).to eq(%w(tag1 tag2)) + end + end + + context 'when option for running untagged jobs is provided' do + context 'when tags are provided' do + it 'creates runner' do + post api('/runners'), token: registration_token, + run_untagged: false, + tag_list: ['tag'] + + expect(response).to have_http_status 201 + expect(Ci::Runner.first.run_untagged).to be false + expect(Ci::Runner.first.tag_list.sort).to eq(['tag']) + end + end + + context 'when tags are not provided' do + it 'returns 404 error' do + post api('/runners'), token: registration_token, + run_untagged: false + + expect(response).to have_http_status 404 + end + end + end + + context 'when option for locking Runner is provided' do + it 'creates runner' do + post api('/runners'), token: registration_token, + locked: true + + expect(response).to have_http_status 201 + expect(Ci::Runner.first.locked).to be true + end + end + + %w(name version revision platform architecture).each do |param| + context "when info parameter '#{param}' info is present" do + let(:value) { "#{param}_value" } + + it %q(updates provided Runner's parameter) do + post api('/runners'), token: registration_token, + info: { param => value } + + expect(response).to have_http_status 201 + expect(Ci::Runner.first.read_attribute(param.to_sym)).to eq(value) + end + end + end + end + + describe 'DELETE /api/v4/runners' do + context 'when no token is provided' do + it 'returns 400 error' do + delete api('/runners') + expect(response).to have_http_status 400 + end + end + + context 'when invalid token is provided' do + it 'returns 403 error' do + delete api('/runners'), token: 'invalid' + expect(response).to have_http_status 403 + end + end + + context 'when valid token is provided' do + let(:runner) { create(:ci_runner) } + + it 'deletes Runner' do + delete api('/runners'), token: runner.token + expect(response).to have_http_status 200 + expect(Ci::Runner.count).to eq(0) + end + end + end + end +end -- cgit v1.2.1