debian-mirror-gitlab/spec/requests/api/resource_access_tokens_spec.rb

361 lines
13 KiB
Ruby
Raw Normal View History

2021-03-11 19:13:27 +05:30
# frozen_string_literal: true
require "spec_helper"
RSpec.describe API::ResourceAccessTokens do
2022-03-02 08:16:31 +05:30
let_it_be(:user) { create(:user) }
let_it_be(:user_non_priviledged) { create(:user) }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
shared_examples 'resource access token API' do |source_type|
context "GET #{source_type}s/:id/access_tokens" do
subject(:get_tokens) { get api("/#{source_type}s/#{resource_id}/access_tokens", user) }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
context "when the user has valid permissions" do
2021-03-11 19:13:27 +05:30
let_it_be(:project_bot) { create(:user, :project_bot) }
let_it_be(:access_tokens) { create_list(:personal_access_token, 3, user: project_bot) }
2022-03-02 08:16:31 +05:30
let_it_be(:resource_id) { resource.id }
2021-03-11 19:13:27 +05:30
before do
2022-03-02 08:16:31 +05:30
if source_type == 'project'
resource.add_maintainer(project_bot)
else
resource.add_owner(project_bot)
end
2021-03-11 19:13:27 +05:30
end
2022-03-02 08:16:31 +05:30
it "gets a list of access tokens for the specified #{source_type}" do
2021-03-11 19:13:27 +05:30
get_tokens
token_ids = json_response.map { |token| token['id'] }
expect(response).to have_gitlab_http_status(:ok)
expect(token_ids).to match_array(access_tokens.pluck(:id))
end
2021-04-17 20:07:23 +05:30
it "exposes the correct token information", :aggregate_failures do
get_tokens
token = access_tokens.last
api_get_token = json_response.last
expect(api_get_token["name"]).to eq(token.name)
expect(api_get_token["scopes"]).to eq(token.scopes)
2022-03-02 08:16:31 +05:30
if source_type == 'project'
expect(api_get_token["access_level"]).to eq(resource.team.max_member_access(token.user.id))
else
expect(api_get_token["access_level"]).to eq(resource.max_member_access_for_user(token.user))
end
2021-04-17 20:07:23 +05:30
expect(api_get_token["expires_at"]).to eq(token.expires_at.to_date.iso8601)
expect(api_get_token).not_to have_key('token')
end
2022-03-02 08:16:31 +05:30
context "when using a #{source_type} access token to GET other #{source_type} access tokens" do
2021-03-11 19:13:27 +05:30
let_it_be(:token) { access_tokens.first }
2022-03-02 08:16:31 +05:30
it "gets a list of access tokens for the specified #{source_type}" do
get api("/#{source_type}s/#{resource_id}/access_tokens", personal_access_token: token)
2021-03-11 19:13:27 +05:30
token_ids = json_response.map { |token| token['id'] }
expect(response).to have_gitlab_http_status(:ok)
expect(token_ids).to match_array(access_tokens.pluck(:id))
end
end
2022-03-02 08:16:31 +05:30
context "when tokens belong to a different #{source_type}" do
2021-03-11 19:13:27 +05:30
let_it_be(:bot) { create(:user, :project_bot) }
let_it_be(:token) { create(:personal_access_token, user: bot) }
before do
2022-03-02 08:16:31 +05:30
other_resource.add_maintainer(bot)
2021-03-11 19:13:27 +05:30
end
2022-03-02 08:16:31 +05:30
it "does not return tokens from a different #{source_type}" do
2021-03-11 19:13:27 +05:30
get_tokens
token_ids = json_response.map { |token| token['id'] }
expect(token_ids).not_to include(token.id)
end
end
2022-03-02 08:16:31 +05:30
context "when the #{source_type} has no access tokens" do
let(:resource_id) { other_resource.id }
2021-03-11 19:13:27 +05:30
it 'returns an empty array' do
get_tokens
expect(response).to have_gitlab_http_status(:ok)
expect(json_response).to eq([])
end
end
2022-03-02 08:16:31 +05:30
context "when trying to get the tokens of a different #{source_type}" do
let_it_be(:resource_id) { unknown_resource.id }
2021-03-11 19:13:27 +05:30
it "returns 404" do
get_tokens
expect(response).to have_gitlab_http_status(:not_found)
end
end
2022-03-02 08:16:31 +05:30
context "when the #{source_type} does not exist" do
let(:resource_id) { non_existing_record_id }
2021-03-11 19:13:27 +05:30
it "returns 404" do
get_tokens
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
context "when the user does not have valid permissions" do
2022-03-02 08:16:31 +05:30
let_it_be(:user) { user_non_priviledged }
2021-03-11 19:13:27 +05:30
let_it_be(:project_bot) { create(:user, :project_bot) }
let_it_be(:access_tokens) { create_list(:personal_access_token, 3, user: project_bot) }
2022-03-02 08:16:31 +05:30
let_it_be(:resource_id) { resource.id }
2021-03-11 19:13:27 +05:30
before do
2022-03-02 08:16:31 +05:30
resource.add_maintainer(project_bot)
2021-03-11 19:13:27 +05:30
end
it "returns 401" do
get_tokens
expect(response).to have_gitlab_http_status(:unauthorized)
end
end
end
2022-03-02 08:16:31 +05:30
context "DELETE #{source_type}s/:id/access_tokens/:token_id", :sidekiq_inline do
subject(:delete_token) { delete api("/#{source_type}s/#{resource_id}/access_tokens/#{token_id}", user) }
2021-03-11 19:13:27 +05:30
let_it_be(:project_bot) { create(:user, :project_bot) }
let_it_be(:token) { create(:personal_access_token, user: project_bot) }
2022-03-02 08:16:31 +05:30
let_it_be(:resource_id) { resource.id }
2021-03-11 19:13:27 +05:30
let_it_be(:token_id) { token.id }
before do
2022-03-02 08:16:31 +05:30
resource.add_maintainer(project_bot)
2021-03-11 19:13:27 +05:30
end
2022-03-02 08:16:31 +05:30
context "when the user has valid permissions" do
it "deletes the #{source_type} access token from the #{source_type}" do
2021-03-11 19:13:27 +05:30
delete_token
expect(response).to have_gitlab_http_status(:no_content)
expect(User.exists?(project_bot.id)).to be_falsy
end
2022-03-02 08:16:31 +05:30
context "when using #{source_type} access token to DELETE other #{source_type} access token" do
2021-04-29 21:17:54 +05:30
let_it_be(:other_project_bot) { create(:user, :project_bot) }
let_it_be(:other_token) { create(:personal_access_token, user: other_project_bot) }
let_it_be(:token_id) { other_token.id }
before do
2022-03-02 08:16:31 +05:30
resource.add_maintainer(other_project_bot)
2021-04-29 21:17:54 +05:30
end
2022-03-02 08:16:31 +05:30
it "deletes the #{source_type} access token from the #{source_type}" do
2021-04-29 21:17:54 +05:30
delete_token
expect(response).to have_gitlab_http_status(:no_content)
expect(User.exists?(other_project_bot.id)).to be_falsy
end
end
2022-03-02 08:16:31 +05:30
context "when attempting to delete a non-existent #{source_type} access token" do
2021-03-11 19:13:27 +05:30
let_it_be(:token_id) { non_existing_record_id }
it "does not delete the token, and returns 404" do
delete_token
expect(response).to have_gitlab_http_status(:not_found)
2022-03-02 08:16:31 +05:30
expect(response.body).to include("Could not find #{source_type} access token with token_id: #{token_id}")
2021-03-11 19:13:27 +05:30
end
end
2022-03-02 08:16:31 +05:30
context "when attempting to delete a token that does not belong to the specified #{source_type}" do
let_it_be(:resource_id) { other_resource.id }
2021-03-11 19:13:27 +05:30
it "does not delete the token, and returns 404" do
delete_token
expect(response).to have_gitlab_http_status(:not_found)
2022-03-02 08:16:31 +05:30
expect(response.body).to include("Could not find #{source_type} access token with token_id: #{token_id}")
2021-03-11 19:13:27 +05:30
end
end
end
context "when the user does not have valid permissions" do
2022-03-02 08:16:31 +05:30
let_it_be(:user) { user_non_priviledged }
2021-03-11 19:13:27 +05:30
it "does not delete the token, and returns 400", :aggregate_failures do
delete_token
expect(response).to have_gitlab_http_status(:bad_request)
expect(User.exists?(project_bot.id)).to be_truthy
expect(response.body).to include("#{user.name} cannot delete #{token.user.name}")
end
end
end
2022-03-02 08:16:31 +05:30
context "POST #{source_type}s/:id/access_tokens" do
2021-09-30 23:02:18 +05:30
let(:params) { { name: "test", scopes: ["api"], expires_at: expires_at, access_level: access_level } }
2021-04-17 20:07:23 +05:30
let(:expires_at) { 1.month.from_now }
2021-09-30 23:02:18 +05:30
let(:access_level) { 20 }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
subject(:create_token) { post api("/#{source_type}s/#{resource_id}/access_tokens", user), params: params }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
context "when the user has valid permissions" do
let_it_be(:resource_id) { resource.id }
2021-03-11 19:13:27 +05:30
context "with valid params" do
context "with full params" do
2022-03-02 08:16:31 +05:30
it "creates a #{source_type} access token with the params", :aggregate_failures do
2021-03-11 19:13:27 +05:30
create_token
expect(response).to have_gitlab_http_status(:created)
expect(json_response["name"]).to eq("test")
expect(json_response["scopes"]).to eq(["api"])
2021-09-30 23:02:18 +05:30
expect(json_response["access_level"]).to eq(20)
2021-03-11 19:13:27 +05:30
expect(json_response["expires_at"]).to eq(expires_at.to_date.iso8601)
2021-04-17 20:07:23 +05:30
expect(json_response["token"]).to be_present
2021-03-11 19:13:27 +05:30
end
end
context "when 'expires_at' is not set" do
2021-04-17 20:07:23 +05:30
let(:expires_at) { nil }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
it "creates a #{source_type} access token with the params", :aggregate_failures do
2021-03-11 19:13:27 +05:30
create_token
expect(response).to have_gitlab_http_status(:created)
expect(json_response["name"]).to eq("test")
expect(json_response["scopes"]).to eq(["api"])
expect(json_response["expires_at"]).to eq(nil)
end
end
2021-09-30 23:02:18 +05:30
context "when 'access_level' is not set" do
let(:access_level) { nil }
2022-03-02 08:16:31 +05:30
it "creates a #{source_type} access token with the default access level", :aggregate_failures do
2021-09-30 23:02:18 +05:30
create_token
expect(response).to have_gitlab_http_status(:created)
expect(json_response["name"]).to eq("test")
expect(json_response["scopes"]).to eq(["api"])
expect(json_response["access_level"]).to eq(40)
expect(json_response["expires_at"]).to eq(expires_at.to_date.iso8601)
expect(json_response["token"]).to be_present
end
end
2021-03-11 19:13:27 +05:30
end
context "with invalid params" do
context "when missing the 'name' param" do
let_it_be(:params) { { scopes: ["api"], expires_at: 5.days.from_now } }
2022-03-02 08:16:31 +05:30
it "does not create a #{source_type} access token without 'name'" do
2021-03-11 19:13:27 +05:30
create_token
expect(response).to have_gitlab_http_status(:bad_request)
expect(response.body).to include("name is missing")
end
end
context "when missing the 'scopes' param" do
let_it_be(:params) { { name: "test", expires_at: 5.days.from_now } }
2022-03-02 08:16:31 +05:30
it "does not create a #{source_type} access token without 'scopes'" do
2021-03-11 19:13:27 +05:30
create_token
expect(response).to have_gitlab_http_status(:bad_request)
expect(response.body).to include("scopes is missing")
end
end
end
2022-03-02 08:16:31 +05:30
context "when trying to create a token in a different #{source_type}" do
let_it_be(:resource_id) { unknown_resource.id }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
it "does not create the token, and returns the #{source_type} not found error" do
2021-03-11 19:13:27 +05:30
create_token
expect(response).to have_gitlab_http_status(:not_found)
2022-03-02 08:16:31 +05:30
expect(response.body).to include("#{source_type.capitalize} Not Found")
2021-03-11 19:13:27 +05:30
end
end
end
context "when the user does not have valid permissions" do
2022-03-02 08:16:31 +05:30
let_it_be(:resource_id) { resource.id }
2021-03-11 19:13:27 +05:30
2022-03-02 08:16:31 +05:30
context "when the user role is too low" do
let_it_be(:user) { user_non_priviledged }
2021-03-11 19:13:27 +05:30
it "does not create the token, and returns the permission error" do
create_token
expect(response).to have_gitlab_http_status(:bad_request)
2022-03-02 08:16:31 +05:30
expect(response.body).to include("User does not have permission to create #{source_type} access token")
2021-03-11 19:13:27 +05:30
end
end
2022-03-02 08:16:31 +05:30
context "when a #{source_type} access token tries to create another #{source_type} access token" do
2021-03-11 19:13:27 +05:30
let_it_be(:project_bot) { create(:user, :project_bot) }
let_it_be(:user) { project_bot }
before do
2022-03-02 08:16:31 +05:30
if source_type == 'project'
resource.add_maintainer(project_bot)
else
resource.add_owner(project_bot)
end
2021-03-11 19:13:27 +05:30
end
2022-03-02 08:16:31 +05:30
it "does not allow a #{source_type} access token to create another #{source_type} access token" do
2021-03-11 19:13:27 +05:30
create_token
expect(response).to have_gitlab_http_status(:bad_request)
2022-03-02 08:16:31 +05:30
expect(response.body).to include("User does not have permission to create #{source_type} access token")
2021-03-11 19:13:27 +05:30
end
end
end
end
end
2022-03-02 08:16:31 +05:30
context 'when the resource is a project' do
let_it_be(:resource) { create(:project) }
let_it_be(:other_resource) { create(:project) }
let_it_be(:unknown_resource) { create(:project) }
before_all do
resource.add_maintainer(user)
other_resource.add_maintainer(user)
resource.add_developer(user_non_priviledged)
end
it_behaves_like 'resource access token API', 'project'
end
context 'when the resource is a group' do
let_it_be(:resource) { create(:group) }
let_it_be(:other_resource) { create(:group) }
let_it_be(:unknown_resource) { create(:project) }
before_all do
resource.add_owner(user)
other_resource.add_owner(user)
resource.add_maintainer(user_non_priviledged)
end
it_behaves_like 'resource access token API', 'group'
end
2021-03-11 19:13:27 +05:30
end