Skip to content

G
gitlab-ce
Commit 6bd7e1b8 authored by Shinya Maeda's avatar Shinya Maeda
Browse files
Options

Add tests for Release Link API 

Add tests for the API and add a couple of tests

Add

revert

revert
parent 124905e2
Show whitespace changes
Inline Side-by-side
Showing with 477 additions and 52 deletions
lib/api/release/link.rb → lib/api/release/links.rb
View file @ 6bd7e1b8
...@@ -14,6 +14,9 @@ module API ...@@ -14,6 +14,9 @@ module API
requires :id, type: String, desc: 'The ID of a project' requires :id, type: String, desc: 'The ID of a project'
end end
resource 'projects/:id', requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do resource 'projects/:id', requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
params do
requires :tag_name, type: String, desc: 'The name of the tag', as: :tag
end
resource 'releases/:tag_name', requirements: RELEASE_ENDPOINT_REQUIREMETS do resource 'releases/:tag_name', requirements: RELEASE_ENDPOINT_REQUIREMETS do
resource :assets do resource :assets do
desc 'Get a list of links of a release' do desc 'Get a list of links of a release' do
...@@ -26,20 +29,7 @@ module API ...@@ -26,20 +29,7 @@ module API
get 'links' do get 'links' do
authorize! :read_release, release authorize! :read_release, release
present paginate(release.links), with: Entities::Releases::Link present paginate(release.links.sorted), with: Entities::Releases::Link
end
desc 'Get a link detail of a release' do
detail 'This feature was introduced in GitLab 11.7.'
success Entities::Releases::Link
end
params do
requires :link_id, type: String, desc: 'The id of the link'
end
get 'links/:link_id' do
authorize! :read_release, release
present link, with: Entities::Releases::Link
end end
desc 'Create a link of a release' do desc 'Create a link of a release' do
...@@ -58,27 +48,40 @@ module API ...@@ -58,27 +48,40 @@ module API
if new_link.persisted? if new_link.persisted?
present new_link, with: Entities::Releases::Link present new_link, with: Entities::Releases::Link
else else
render_api_error!(result[:message], result[:http_status]) render_api_error!(new_link.errors.messages, 400)
end end
end end
params do
requires :link_id, type: String, desc: 'The id of the link'
end
resource 'links/:link_id' do
desc 'Get a link detail of a release' do
detail 'This feature was introduced in GitLab 11.7.'
success Entities::Releases::Link
end
get do
authorize! :read_release, release
present link, with: Entities::Releases::Link
end
desc 'Update a link of a release' do desc 'Update a link of a release' do
detail 'This feature was introduced in GitLab 11.7.' detail 'This feature was introduced in GitLab 11.7.'
success Entities::Releases::Link success Entities::Releases::Link
end end
params do params do
requires :link_id, type: Integer, desc: 'The id of the link'
optional :name, type: String, desc: 'The name of the link' optional :name, type: String, desc: 'The name of the link'
optional :url, type: String, desc: 'The URL of the link' optional :url, type: String, desc: 'The URL of the link'
at_least_one_of :name, :url at_least_one_of :name, :url
end end
put 'links/:link_id' do put do
authorize! :update_release, release authorize! :update_release, release
if link.update(declared_params(include_missing: false)) if link.update(declared_params(include_missing: false))
present link, with: Entities::Releases::Link present link, with: Entities::Releases::Link
else else
render_api_error!(result[:message], result[:http_status]) render_api_error!(link.errors.messages, 400)
end end
end end
...@@ -86,16 +89,14 @@ module API ...@@ -86,16 +89,14 @@ module API
detail 'This feature was introduced in GitLab 11.7.' detail 'This feature was introduced in GitLab 11.7.'
success Entities::Releases::Link success Entities::Releases::Link
end end
params do delete do
requires :link_id, type: Integer, desc: 'The id of the link'
end
put 'links/:link_id' do
authorize! :destroy_release, release authorize! :destroy_release, release
if link.destroy if link.destroy
present link, with: Entities::Releases::Link present link, with: Entities::Releases::Link
else else
render_api_error!(result[:message], result[:http_status]) render_api_error!(link.errors.messages, 400)
end
end end
end end
end end
...@@ -104,7 +105,7 @@ module API ...@@ -104,7 +105,7 @@ module API
helpers do helpers do
def release def release
@release ||= user_project.releases.find_by_tag(params[:tag_name]) @release ||= user_project.releases.find_by_tag!(params[:tag])
end end
def link def link
......
spec/fixtures/api/schemas/release.json
View file @ 6bd7e1b8
...@@ -15,15 +15,7 @@ ...@@ -15,15 +15,7 @@
}, },
"assets": { "assets": {
"count": { "type": "integer" }, "count": { "type": "integer" },
"links": { "links": { "$ref": "release/links.json" },
"type": "array",
"items": {
"id": "integer",
"name": "string",
"url": "string",
"external": "boolean"
}
},
"sources": { "sources": {
"type": "array", "type": "array",
"items": { "items": {
......
spec/fixtures/api/schemas/release/link.json 0 → 100644
View file @ 6bd7e1b8
{
"type": "object",
"required": ["name", "url"],
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"url": { "type": "string" },
"external": { "type": "boolean" }
},
"additionalProperties": false
}
spec/fixtures/api/schemas/release/links.json 0 → 100644
View file @ 6bd7e1b8
{
"type": "array",
"items": { "$ref": "link.json" }
}
spec/requests/api/release/links_spec.rb 0 → 100644
View file @ 6bd7e1b8
# frozen_string_literal: true
require 'spec_helper'
describe API::Release::Links do
let(:project) { create(:project, :repository, :private) }
let(:maintainer) { create(:user) }
let(:reporter) { create(:user) }
let(:non_project_member) { create(:user) }
let(:commit) { create(:commit, project: project) }
let!(:release) do
create(:release,
project: project,
tag: 'v0.1',
author: maintainer)
end
before do
project.add_maintainer(maintainer)
project.add_reporter(reporter)
project.repository.add_tag(maintainer, 'v0.1', commit.id)
end
describe 'GET /projects/:id/releases/:tag_name/assets/links' do
context 'when there are two release links' do
let!(:release_link_1) { create(:release_link, release: release, created_at: 2.days.ago) }
let!(:release_link_2) { create(:release_link, release: release, created_at: 1.day.ago) }
it 'returns 200 HTTP status' do
get api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer)
expect(response).to have_gitlab_http_status(:ok)
end
it 'returns release links ordered by created_at' do
get api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer)
expect(json_response.count).to eq(2)
expect(json_response.first['name']).to eq(release_link_2.name)
expect(json_response.second['name']).to eq(release_link_1.name)
end
it 'matches response schema' do
get api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer)
expect(response).to match_response_schema('release/links')
end
end
context 'when release does not exist' do
let!(:release) { }
it_behaves_like '404 response' do
let(:request) { get api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer) }
let(:message) { '404 Not found' }
end
end
context 'when user is not a project member' do
it_behaves_like '404 response' do
let(:request) { get api("/projects/#{project.id}/releases/v0.1/assets/links", non_project_member) }
let(:message) { '404 Project Not Found' }
end
context 'when project is public' do
let(:project) { create(:project, :repository, :public) }
it 'allows the request' do
get api("/projects/#{project.id}/releases/v0.1/assets/links", non_project_member)
expect(response).to have_gitlab_http_status(:ok)
end
end
end
context 'when feature flag is disabled' do
before do
stub_feature_flags(releases_page: false)
end
it_behaves_like '404 response' do
let(:request) { get api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer) }
end
end
end
describe 'GET /projects/:id/releases/:tag_name/assets/links/:link_id' do
let!(:release_link) { create(:release_link, release: release) }
it 'returns 200 HTTP status' do
get api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
expect(response).to have_gitlab_http_status(:ok)
end
it 'returns a link entry' do
get api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
expect(json_response['name']).to eq(release_link.name)
expect(json_response['url']).to eq(release_link.url)
end
it 'matches response schema' do
get api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
expect(response).to match_response_schema('release/link')
end
context 'when specified tag is not found in the project' do
it_behaves_like '404 response' do
let(:request) { get api("/projects/#{project.id}/releases/non_existing_tag/assets/links/#{release_link.id}", maintainer) }
end
end
context 'when user is not a project member' do
it_behaves_like '404 response' do
let(:request) { get api("/projects/#{project.id}/releases/non_existing_tag/assets/links/#{release_link.id}", non_project_member) }
end
context 'when project is public' do
let(:project) { create(:project, :repository, :public) }
it 'allows the request' do
get api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", non_project_member)
expect(response).to have_gitlab_http_status(:ok)
end
end
end
context 'when feature flag is disabled' do
before do
stub_feature_flags(releases_page: false)
end
it_behaves_like '404 response' do
let(:request) { get api("/projects/#{project.id}/releases/non_existing_tag/assets/links/#{release_link.id}", maintainer) }
end
end
end
describe 'POST /projects/:id/releases/:tag_name/assets/links' do
let(:params) do
{
name: 'awesome-app.dmg',
url: 'https://example.com/download/awesome-app.dmg'
}
end
it 'accepts the request' do
post api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer), params: params
expect(response).to have_gitlab_http_status(:created)
end
it 'creates a new release' do
expect do
post api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer), params: params
end.to change { Releases::Link.count }.by(1)
release.reload
expect(release.links.last.name).to eq('awesome-app.dmg')
expect(release.links.last.url).to eq('https://example.com/download/awesome-app.dmg')
end
it 'matches response schema' do
post api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer), params: params
expect(response).to match_response_schema('release/link')
end
context 'when name is empty' do
let(:params) do
{
name: '',
url: 'https://example.com/download/awesome-app.dmg'
}
end
it_behaves_like '400 response' do
let(:request) do
post api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer),
params: params
end
end
end
context 'when user is a reporter' do
it_behaves_like '403 response' do
let(:request) do
post api("/projects/#{project.id}/releases/v0.1/assets/links", reporter),
params: params
end
end
end
context 'when user is not a project member' do
it 'forbids the request' do
post api("/projects/#{project.id}/releases/v0.1/assets/links", non_project_member),
params: params
expect(response).to have_gitlab_http_status(:not_found)
end
context 'when project is public' do
let(:project) { create(:project, :repository, :public) }
it 'forbids the request' do
post api("/projects/#{project.id}/releases/v0.1/assets/links", non_project_member),
params: params
expect(response).to have_gitlab_http_status(:forbidden)
end
end
end
context 'when the same link already exists' do
before do
create(:release_link,
release: release,
name: 'awesome-app.dmg',
url: 'https://example.com/download/awesome-app.dmg')
end
it_behaves_like '400 response' do
let(:request) do
post api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer),
params: params
end
end
end
context 'when feature flag is disabled' do
before do
stub_feature_flags(releases_page: false)
end
it_behaves_like '404 response' do
let(:request) do
post api("/projects/#{project.id}/releases/v0.1/assets/links", maintainer),
params: params
end
end
end
end
describe 'PUT /projects/:id/releases/:tag_name/assets/links/:link_id' do
let(:params) { { name: 'awesome-app.msi' } }
let!(:release_link) { create(:release_link, release: release) }
it 'accepts the request' do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer),
params: params
expect(response).to have_gitlab_http_status(:ok)
end
it 'updates the name' do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer),
params: params
expect(json_response['name']).to eq('awesome-app.msi')
end
it 'does not update the url' do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer),
params: params
expect(json_response['url']).to eq(release_link.url)
end
it 'matches response schema' do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer),
params: params
expect(response).to match_response_schema('release/link')
end
context 'when params is empty' do
let(:params) { {} }
it 'does not allow the request' do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer),
params: params
expect(response).to have_gitlab_http_status(:bad_request)
end
end
context 'when there are no corresponding release link' do
let!(:release_link) { }
it_behaves_like '404 response' do
let(:request) do
put api("/projects/#{project.id}/releases/v0.1/assets/links/1", maintainer),
params: params
end
end
end
context 'when user is a reporter' do
it_behaves_like '403 response' do
let(:request) do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", reporter),
params: params
end
end
end
context 'when user is not a project member' do
it_behaves_like '404 response' do
let(:request) do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", non_project_member),
params: params
end
end
context 'when project is public' do
let(:project) { create(:project, :repository, :public) }
it_behaves_like '403 response' do
let(:request) do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", non_project_member),
params: params
end
end
end
end
context 'when feature flag is disabled' do
before do
stub_feature_flags(releases_page: false)
end
it_behaves_like '404 response' do
let(:request) do
put api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer),
params: params
end
end
end
end
describe 'DELETE /projects/:id/releases/:tag_name/assets/links/:link_id' do
let!(:release_link) do
create(:release_link, release: release)
end
it 'accepts the request' do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
expect(response).to have_gitlab_http_status(:ok)
end
it 'destroys the release link' do
expect do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
end.to change { Releases::Link.count }.by(-1)
end
it 'matches response schema' do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
expect(response).to match_response_schema('release/link')
end
context 'when there are no corresponding release link' do
let!(:release_link) { }
it_behaves_like '404 response' do
let(:request) do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/1", maintainer)
end
end
end
context 'when user is a reporter' do
it_behaves_like '403 response' do
let(:request) do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", reporter)
end
end
end
context 'when user is not a project member' do
it_behaves_like '404 response' do
let(:request) do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", non_project_member)
end
end
context 'when project is public' do
let(:project) { create(:project, :repository, :public) }
it_behaves_like '403 response' do
let(:request) do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", non_project_member)
end
end
end
end
context 'when feature flag is disabled' do
before do
stub_feature_flags(releases_page: false)
end
it_behaves_like '404 response' do
let(:request) do
delete api("/projects/#{project.id}/releases/v0.1/assets/links/#{release_link.id}", maintainer)
end
end
end
end
end
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7