diff options
author | Sean McGivern <sean@mcgivern.me.uk> | 2018-11-07 18:11:30 +0300 |
---|---|---|
committer | Sean McGivern <sean@mcgivern.me.uk> | 2018-11-07 18:11:30 +0300 |
commit | 6d8810a64f944ff96af54e5c759f866bb68a7453 (patch) | |
tree | 8a7f19772e7f38c498cba6b73ca43b5e911705b3 /spec | |
parent | f323d6148b7b71609cbd32ab9db4724fc108729d (diff) | |
parent | 28cbb2acfe413148ff23b8ed4b3293e09ab376f5 (diff) |
Merge branch 'fj-41213-api-update-submodule-commit' into 'master'
Add endpoint to update a git submodule reference
Closes #41213
See merge request gitlab-org/gitlab-ce!20949
Diffstat (limited to 'spec')
-rw-r--r-- | spec/requests/api/submodules_spec.rb | 99 | ||||
-rw-r--r-- | spec/services/submodules/update_service_spec.rb | 212 | ||||
-rw-r--r-- | spec/support/helpers/test_env.rb | 3 |
3 files changed, 313 insertions, 1 deletions
diff --git a/spec/requests/api/submodules_spec.rb b/spec/requests/api/submodules_spec.rb new file mode 100644 index 00000000000..fa447c028c2 --- /dev/null +++ b/spec/requests/api/submodules_spec.rb @@ -0,0 +1,99 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe API::Submodules do + let(:user) { create(:user) } + let!(:project) { create(:project, :repository, namespace: user.namespace ) } + let(:guest) { create(:user) { |u| project.add_guest(u) } } + let(:submodule) { 'six' } + let(:commit_sha) { 'e25eda1fece24ac7a03624ed1320f82396f35bd8' } + let(:branch) { 'master' } + let(:commit_message) { 'whatever' } + + let(:params) do + { + submodule: submodule, + commit_sha: commit_sha, + branch: branch, + commit_message: commit_message + } + end + + before do + project.add_developer(user) + end + + def route(submodule = nil) + "/projects/#{project.id}/repository/submodules/#{submodule}" + end + + describe "PUT /projects/:id/repository/submodule/:submodule" do + context 'when unauthenticated' do + it 'returns 401' do + put api(route(submodule)), params + + expect(response).to have_gitlab_http_status(401) + end + end + + context 'when authenticated', 'as a guest' do + it 'returns 403' do + put api(route(submodule), guest), params + + expect(response).to have_gitlab_http_status(403) + end + end + + context 'when authenticated', 'as a developer' do + it 'returns 400 if params is missing' do + put api(route(submodule), user) + + expect(response).to have_gitlab_http_status(400) + end + + it 'returns 400 if branch is missing' do + put api(route(submodule), user), params.except(:branch) + + expect(response).to have_gitlab_http_status(400) + end + + it 'returns 400 if commit_sha is missing' do + put api(route(submodule), user), params.except(:commit_sha) + + expect(response).to have_gitlab_http_status(400) + end + + it 'returns the commmit' do + head_commit = project.repository.commit.id + + put api(route(submodule), user), params + + expect(response).to have_gitlab_http_status(200) + expect(json_response['message']).to eq commit_message + expect(json_response['author_name']).to eq user.name + expect(json_response['committer_name']).to eq user.name + expect(json_response['parent_ids'].first).to eq head_commit + end + + context 'when the submodule name is urlencoded' do + let(:submodule) { 'test_inside_folder/another_folder/six' } + let(:branch) { 'submodule_inside_folder' } + let(:encoded_submodule) { CGI.escape(submodule) } + + it 'returns the commmit' do + expect(Submodules::UpdateService) + .to receive(:new) + .with(any_args, hash_including(submodule: submodule)) + .and_call_original + + put api(route(encoded_submodule), user), params + + expect(response).to have_gitlab_http_status(200) + expect(json_response['id']).to eq project.repository.commit(branch).id + expect(project.repository.blob_at(branch, submodule).id).to eq commit_sha + end + end + end + end +end diff --git a/spec/services/submodules/update_service_spec.rb b/spec/services/submodules/update_service_spec.rb new file mode 100644 index 00000000000..cf92350c1b2 --- /dev/null +++ b/spec/services/submodules/update_service_spec.rb @@ -0,0 +1,212 @@ +# frozen_string_literal: true +require 'spec_helper' + +describe Submodules::UpdateService do + let(:project) { create(:project, :repository) } + let(:repository) { project.repository } + let(:user) { create(:user, :commit_email) } + let(:branch_name) { project.default_branch } + let(:submodule) { 'six' } + let(:commit_sha) { 'e25eda1fece24ac7a03624ed1320f82396f35bd8' } + let(:commit_message) { 'whatever' } + let(:current_sha) { repository.blob_at('HEAD', submodule).id } + let(:commit_params) do + { + submodule: submodule, + commit_message: commit_message, + commit_sha: commit_sha, + branch_name: branch_name + } + end + + subject { described_class.new(project, user, commit_params) } + + describe "#execute" do + shared_examples 'returns error result' do + it do + result = subject.execute + + expect(result[:status]).to eq :error + expect(result[:message]).to eq error_message + end + end + + context 'when the user is not authorized' do + it_behaves_like 'returns error result' do + let(:error_message) { 'You are not allowed to push into this branch' } + end + end + + context 'when the user is authorized' do + before do + project.add_maintainer(user) + end + + context 'when the branch is protected' do + before do + create(:protected_branch, :no_one_can_push, project: project, name: branch_name) + end + + it_behaves_like 'returns error result' do + let(:error_message) { 'You are not allowed to push into this branch' } + end + end + + context 'validations' do + context 'when submodule' do + context 'is empty' do + let(:submodule) { '' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid parameters' } + end + end + + context 'is not present' do + let(:submodule) { nil } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid parameters' } + end + end + + context 'is invalid' do + let(:submodule) { 'VERSION' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid submodule path' } + end + end + + context 'does not exist' do + let(:submodule) { 'non-existent-submodule' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid submodule path' } + end + end + + context 'has traversal path' do + let(:submodule) { '../six' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid parameters' } + end + end + end + + context 'commit_sha' do + context 'is empty' do + let(:commit_sha) { '' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid parameters' } + end + end + + context 'is not present' do + let(:commit_sha) { nil } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid parameters' } + end + end + + context 'is invalid' do + let(:commit_sha) { '1' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'Invalid parameters' } + end + end + + context 'is the same as the current ref' do + let(:commit_sha) { current_sha } + + it_behaves_like 'returns error result' do + let(:error_message) { "The submodule #{submodule} is already at #{commit_sha}" } + end + end + end + + context 'branch_name' do + context 'is empty' do + let(:branch_name) { '' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'You can only create or edit files when you are on a branch' } + end + end + + context 'is not present' do + let(:branch_name) { nil } + + it_behaves_like 'returns error result' do + let(:error_message) { 'You can only create or edit files when you are on a branch' } + end + end + + context 'does not exist' do + let(:branch_name) { 'non/existent-branch' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'You can only create or edit files when you are on a branch' } + end + end + + context 'when commit message is empty' do + let(:commit_message) { '' } + + it 'a default commit message is set' do + message = "Update submodule #{submodule} with oid #{commit_sha}" + + expect(repository).to receive(:update_submodule).with(any_args, hash_including(message: message)) + + subject.execute + end + end + end + end + + context 'when there is an unexpected error' do + before do + allow(repository).to receive(:update_submodule).and_raise(StandardError, 'error message') + end + + it_behaves_like 'returns error result' do + let(:error_message) { 'error message' } + end + end + + it 'updates the submodule reference' do + result = subject.execute + + expect(result[:status]).to eq :success + expect(result[:result]).to eq repository.head_commit.id + expect(repository.blob_at('HEAD', submodule).id).to eq commit_sha + end + + context 'when submodule is inside a directory' do + let(:submodule) { 'test_inside_folder/another_folder/six' } + let(:branch_name) { 'submodule_inside_folder' } + + it 'updates the submodule reference' do + expect(repository.blob_at(branch_name, submodule).id).not_to eq commit_sha + + subject.execute + + expect(repository.blob_at(branch_name, submodule).id).to eq commit_sha + end + end + + context 'when repository is empty' do + let(:project) { create(:project, :empty_repo) } + let(:branch_name) { 'master' } + + it_behaves_like 'returns error result' do + let(:error_message) { 'The repository is empty' } + end + end + end + end +end diff --git a/spec/support/helpers/test_env.rb b/spec/support/helpers/test_env.rb index 80b96f20e3f..9e87b877b93 100644 --- a/spec/support/helpers/test_env.rb +++ b/spec/support/helpers/test_env.rb @@ -58,7 +58,8 @@ module TestEnv 'before-create-delete-modify-move' => '845009f', 'between-create-delete-modify-move' => '3f5f443', 'after-create-delete-modify-move' => 'ba3faa7', - 'with-codeowners' => '219560e' + 'with-codeowners' => '219560e', + 'submodule_inside_folder' => 'b491b92' }.freeze # gitlab-test-fork is a fork of gitlab-fork, but we don't necessarily |