Skip to content

G
gitlab-ce
Commit 4c6e2eee authored by Brian Kabiro's avatar Brian Kabiro Committed by Jan Provaznik
Browse files
Options

Remove ManagedLicenses controller 

Projects::ManagedLicensesController and API::ManagedLicenses
duplicate each other but only API::ManagedLicenses is in use.

This change removes:
- the Managed Licenses Controller
- the Managed Licenses Controller test file
- the controller's route in `config/routes/projects`
parent b39f34e9
Show whitespace changes
Inline Side-by-side
Showing with 5 additions and 625 deletions
ee/app/controllers/projects/managed_licenses_controller.rb deleted 100644 → 0
View file @ b39f34e9
# frozen_string_literal: true
class Projects::ManagedLicensesController < Projects::ApplicationController
before_action :software_license_policy, only: [:show, :edit, :update, :destroy]
before_action :authorize_can_read!, only: [:index, :show]
before_action :authorize_can_admin!, only: [:new, :create, :edit, :update, :destroy]
def index
respond_to do |format|
format.json do
render_software_license_policies
end
end
end
def show
respond_to do |format|
format.json do
render_software_license_policy
end
end
end
def new
@software_license_policy = @project.software_license_policies.new
end
def create
result = SoftwareLicensePolicies::CreateService.new(
@project,
current_user,
software_license_policies_params.to_h
).execute
if result[:status] == :success
@software_license_policy = result[:software_license_policy]
respond_to do |format|
format.json { render_software_license_policy }
end
else
respond_to do |format|
format.json { render_error(result[:message], 400) }
end
end
end
def edit
end
def update
result = SoftwareLicensePolicies::UpdateService.new(
@project,
current_user,
software_license_policies_params.to_h
).execute(@software_license_policy)
if result[:status] == :success
respond_to do |format|
format.json { render_software_license_policy }
end
else
respond_to do |format|
format.json { render_error(result[:message], 400) }
end
end
end
def destroy
@software_license_policy.destroy!
respond_to do |format|
format.json { render_ok }
end
end
private
def respond_400
head :bad_request
end
# Fetch the existing software license policy when given an id or name
def software_license_policy
id = params[:id]
id = CGI.unescape(id) unless id.is_a?(Integer) || id =~ /^\d+$/
@software_license_policy ||= SoftwareLicensePoliciesFinder.new(current_user, project, name_or_id: id).find
if @software_license_policy.nil?
# The license was not found
render_404
end
end
def render_ok
head :ok
end
def render_software_license_policy
render status: :ok, json: ManagedLicenseSerializer.new.represent(@software_license_policy)
end
def render_software_license_policies
render status: :ok, json: { software_license_policies: ManagedLicenseSerializer.new.represent(@project.software_license_policies) }
end
def render_error(error, status = 400)
render json: error, status: status
end
def software_license_policies_params
# Require the presence of an hash containing the software license policy fields
params.require(:managed_license).permit(:name, :approval_status)
end
def authorize_can_read!
render_404 unless can?(current_user, :read_software_license_policy, @project)
end
def authorize_can_admin!
authorize_can_read!
render_403 unless can?(current_user, :admin_software_license_policy, @project)
end
end
ee/changelogs/unreleased/10076-remove-managed-licenses-controller.yml 0 → 100644
View file @ 4c6e2eee
---
title: Remove redundant ManagedLicenses controller
merge_request: 20131
author: briankabiro
type: other
ee/config/routes/project.rb
View file @ 4c6e2eee
......@@ -185,7 +185,6 @@ constraints(::Constraints::ProjectUrlConstrainer.new) do
resource :dependencies, only: [:show]
resource :licenses, only: [:show]
resources :managed_licenses, only: [:index, :show, :new, :create, :edit, :update, :destroy]
resources :environments, only: [] do
member do
......
ee/spec/controllers/projects/managed_licenses_controller_spec.rb deleted 100644 → 0
View file @ b39f34e9
# frozen_string_literal: true
require 'spec_helper'
describe Projects::ManagedLicensesController do
let(:project) do
create(:project).tap do |p|
@software_license_policy = create(:software_license_policy, project: p)
end
end
let(:maintainer_user) do
create(:user).tap do |u|
project.add_maintainer(u)
end
end
let(:dev_user) do
create(:user).tap do |u|
project.add_developer(u)
end
end
let(:reporter_user) do
create(:user).tap do |u|
create(:project_member, :reporter, user: u, project: project)
end
end
let(:other_user) { create(:user) }
let(:unlogged_user) { nil }
let(:software_license_policy) do
@software_license_policy ||= create(:software_license_policy, project: project)
end
before do
stub_licensed_features(license_management: true)
end
describe 'GET #index' do
subject do
allow(controller).to receive(:current_user).and_return(user)
get :index, params: { namespace_id: project.namespace.to_param, project_id: project }, format: :json
end
context 'with license management not available' do
before do
stub_licensed_features(license_management: false)
end
let(:user) { dev_user }
it 'returns a not found status' do
subject
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with a user without read permission' do
let(:user) { other_user }
it 'returns a not found status' do
subject
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with no logged in user' do
let(:user) { unlogged_user }
it 'returns a redirect' do
subject
expect(response).to have_gitlab_http_status(:redirect)
end
end
context 'with a user with read permissions' do
let(:user) { dev_user }
it 'renders the software license policies as json' do
subject
expect(response).to match_response_schema('software_license_policies', dir: 'ee')
end
it 'has only one software license policy' do
subject
expect(json_response['software_license_policies'].count).to eq(1)
end
end
end
describe 'GET #show' do
subject do
allow(controller).to receive(:current_user).and_return(user)
get :show,
params: {
namespace_id: project.namespace.to_param,
project_id: project,
id: software_license_policy.id
},
format: :json
end
context 'with a user without read permission' do
let(:user) { other_user }
it 'returns a not found status' do
subject
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with no logged in user' do
let(:user) { unlogged_user }
it 'returns a redirect' do
subject
expect(response).to have_gitlab_http_status(:redirect)
end
end
context 'with a user with read permissions' do
let(:user) { dev_user }
it 'renders the software license policy as json' do
subject
expect(response).to match_response_schema('software_license_policy', dir: 'ee')
end
it 'has correct values for its fields' do
subject
expect(json_response['name']).to eq(software_license_policy.name)
expect(json_response['approval_status']).to eq(software_license_policy.approval_status)
end
end
end
describe 'GET #show with license name as identifier' do
let(:user) { dev_user }
subject do
allow(controller).to receive(:current_user).and_return(user)
get :show,
params: {
namespace_id: project.namespace.to_param,
project_id: project,
id: CGI.escape(software_license_policy.name)
},
format: :json
end
it 'renders the software license policy as json' do
subject
expect(response).to match_response_schema('software_license_policy', dir: 'ee')
end
it 'has correct values for its fields' do
subject
expect(json_response['name']).to eq(software_license_policy.name)
expect(json_response['approval_status']).to eq(software_license_policy.approval_status)
end
end
describe 'POST #create' do
let(:software_license_policy_attributes) do
{ id: software_license_policy.id,
name: software_license_policy.name,
approval_status: software_license_policy.approval_status }
end
let(:new_software_license_policy_attributes) do
{ name: 'new_name',
approval_status: 'blacklisted' }
end
subject do
allow(controller).to receive(:current_user).and_return(user)
post :create,
params: {
namespace_id: project.namespace.to_param,
project_id: project,
managed_license: to_create_software_license_policy_attributes
},
format: :json
end
context 'with a user without admin permission' do
let(:user) { dev_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a forbidden status' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'with a user without read permission' do
let(:user) { other_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a not found status' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with no logged in user' do
let(:user) { unlogged_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a redirect' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:redirect)
end
end
context 'with a user with admin permissions' do
let(:user) { maintainer_user }
context 'with duplicate new software license policy parameters' do
let(:to_create_software_license_policy_attributes) do
software_license_policy_attributes.merge(approval_status: 'blacklisted')
end
it 'does not update the existing software license policy' do
expect { subject }.not_to change { software_license_policy.reload.approval_status }
end
it 'does not create the new software license policy' do
expect { subject }.not_to change { project.software_license_policies.count }
end
it 'returns a bad request status' do
subject
expect(response).to have_gitlab_http_status(:bad_request)
end
end
context 'with new software license policy parameters' do
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'creates the new software license policy' do
expect { subject }.to change { project.software_license_policies.count }.by(1)
end
it 'returns an ok status' do
subject
expect(response).to have_gitlab_http_status(:ok)
end
end
end
end
describe 'PATCH #update' do
let(:software_license_policy_attributes) do
{ id: software_license_policy.id,
name: software_license_policy.name,
approval_status: software_license_policy.approval_status }
end
let(:new_software_license_policy_attributes) do
{ name: 'new_name',
approval_status: 'blacklisted' }
end
let(:modified_software_license_policy_attributes) do
software_license_policy_attributes.merge(approval_status: 'blacklisted')
end
subject do
allow(controller).to receive(:current_user).and_return(user)
patch :update,
params: {
namespace_id: project.namespace.to_param,
project_id: project,
id: software_license_policy.id,
managed_license: modified_software_license_policy_attributes
},
format: :json
end
context 'with a user without admin permission' do
let(:user) { dev_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a forbidden status' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'with a user without read permission' do
let(:user) { other_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a not found status' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with no logged in user' do
let(:user) { unlogged_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a redirect' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:redirect)
end
end
context 'with a user with admin permissions' do
let(:user) { maintainer_user }
context 'with invalid new software license policy parameters' do
let(:modified_software_license_policy_attributes) do
software_license_policy_attributes.merge(approval_status: 3)
end
it 'does not update the existing software license policy' do
expect { subject }.not_to change { software_license_policy.reload.approval_status }
end
it 'does not create the new software license policy' do
expect { subject }.not_to change { project.software_license_policies.count }
end
it 'returns a bad request status' do
subject
expect(response).to have_gitlab_http_status(:bad_request)
end
end
context 'with valid updated software license policy parameters' do
it 'updates the existing software license policy' do
expect { subject }.to change { software_license_policy.reload.approval_status }.to('blacklisted')
end
it 'does not create a new software license policy' do
expect { subject }.not_to change { project.software_license_policies.count }
end
it 'returns an ok status' do
subject
expect(response).to have_gitlab_http_status(:ok)
end
it 'has the updated software license policies in response' do
subject
expect(response).to match_response_schema('software_license_policy', dir: 'ee')
expect(json_response).to eq(modified_software_license_policy_attributes.with_indifferent_access)
end
end
end
end
describe 'DELETE #destroy' do
let(:id_to_destroy) { software_license_policy.id }
subject do
allow(controller).to receive(:current_user).and_return(user)
delete :destroy,
params: {
namespace_id: project.namespace.to_param,
project_id: project,
id: id_to_destroy
},
format: :json
end
context 'with a user without admin permission' do
let(:user) { dev_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a forbidden status' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:forbidden)
end
end
context 'with a user without read permission' do
let(:user) { other_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a not found status' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:not_found)
end
end
context 'with no logged in user' do
let(:user) { unlogged_user }
let(:to_create_software_license_policy_attributes) do
new_software_license_policy_attributes
end
it 'returns a redirect' do
expect { subject }.not_to change { project.software_license_policies.count }
expect(response).to have_gitlab_http_status(:redirect)
end
end
context 'with a user with admin permissions' do
let(:user) { maintainer_user }
context 'with an existing software license policy' do
it 'destroys the software license policy' do
expect { subject }.to change { project.software_license_policies.count }.by(-1)
expect { software_license_policy.reload }.to raise_error ActiveRecord::RecordNotFound
end
it 'returns an ok status' do
subject
expect(response).to have_gitlab_http_status(:ok)
end
it 'has an empty response body' do
subject
expect(response.body).to eq("")
end
end
context 'with an unknown software license policy' do
let(:id_to_destroy) { 12341234 }
it 'does not destroy any software license policy' do
expect { subject }.not_to change { project.software_license_policies.count }
expect { software_license_policy.reload }.not_to raise_error
end
it 'returns a not found status' do
subject
expect(response).to have_gitlab_http_status(:not_found)
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