require 'spec_helper' require 'stringio' describe Gitlab::Shell do let(:project) { double('Project', id: 7, path: 'diaspora') } let(:gitlab_shell) { described_class.new } let(:popen_vars) { { 'GIT_TERMINAL_PROMPT' => ENV['GIT_TERMINAL_PROMPT'] } } before do allow(Project).to receive(:find).and_return(project) end it { is_expected.to respond_to :add_key } it { is_expected.to respond_to :remove_key } it { is_expected.to respond_to :add_repository } it { is_expected.to respond_to :remove_repository } it { is_expected.to respond_to :fork_repository } it { is_expected.to respond_to :add_namespace } it { is_expected.to respond_to :rm_namespace } it { is_expected.to respond_to :mv_namespace } it { is_expected.to respond_to :exists? } it { expect(gitlab_shell.url_to_repo('diaspora')).to eq(Gitlab.config.gitlab_shell.ssh_path_prefix + "diaspora.git") } describe 'memoized secret_token' do let(:secret_file) { 'tmp/tests/.secret_shell_test' } let(:link_file) { 'tmp/tests/shell-secret-test/.gitlab_shell_secret' } before do allow(Gitlab.config.gitlab_shell).to receive(:secret_file).and_return(secret_file) allow(Gitlab.config.gitlab_shell).to receive(:path).and_return('tmp/tests/shell-secret-test') FileUtils.mkdir('tmp/tests/shell-secret-test') described_class.ensure_secret_token! end after do FileUtils.rm_rf('tmp/tests/shell-secret-test') FileUtils.rm_rf(secret_file) end it 'creates and links the secret token file' do secret_token = described_class.secret_token expect(File.exist?(secret_file)).to be(true) expect(File.read(secret_file).chomp).to eq(secret_token) expect(File.symlink?(link_file)).to be(true) expect(File.readlink(link_file)).to eq(secret_file) end end describe 'projects commands' do let(:gitlab_shell_path) { File.expand_path('tmp/tests/gitlab-shell') } let(:projects_path) { File.join(gitlab_shell_path, 'bin/gitlab-projects') } let(:gitlab_shell_hooks_path) { File.join(gitlab_shell_path, 'hooks') } before do allow(Gitlab.config.gitlab_shell).to receive(:path).and_return(gitlab_shell_path) allow(Gitlab.config.gitlab_shell).to receive(:hooks_path).and_return(gitlab_shell_hooks_path) allow(Gitlab.config.gitlab_shell).to receive(:git_timeout).and_return(800) end describe '#mv_repository' do it 'executes the command' do expect(gitlab_shell).to receive(:gitlab_shell_fast_execute).with( [projects_path, 'mv-project', 'storage/path', 'project/path.git', 'new/path.git'] ) gitlab_shell.mv_repository('storage/path', 'project/path', 'new/path') end end describe '#add_key' do it 'removes trailing garbage' do allow(gitlab_shell).to receive(:gitlab_shell_keys_path).and_return(:gitlab_shell_keys_path) expect(gitlab_shell).to receive(:gitlab_shell_fast_execute).with( [:gitlab_shell_keys_path, 'add-key', 'key-123', 'ssh-rsa foobar'] ) gitlab_shell.add_key('key-123', 'ssh-rsa foobar trailing garbage') end end end describe Gitlab::Shell::KeyAdder do describe '#add_key' do it 'removes trailing garbage' do io = spy(:io) adder = described_class.new(io) adder.add_key('key-42', "ssh-rsa foo bar\tbaz") expect(io).to have_received(:puts).with("key-42\tssh-rsa foo") end it 'handles multiple spaces in the key' do io = spy(:io) adder = described_class.new(io) adder.add_key('key-42', "ssh-rsa foo") expect(io).to have_received(:puts).with("key-42\tssh-rsa foo") end it 'raises an exception if the key contains a tab' do expect do described_class.new(StringIO.new).add_key('key-42', "ssh-rsa\tfoobar") end.to raise_error(Gitlab::Shell::Error) end it 'raises an exception if the key contains a newline' do expect do described_class.new(StringIO.new).add_key('key-42', "ssh-rsa foobar\nssh-rsa pawned") end.to raise_error(Gitlab::Shell::Error) end end end describe 'projects commands' do let(:gitlab_shell_path) { File.expand_path('tmp/tests/gitlab-shell') } let(:projects_path) { File.join(gitlab_shell_path, 'bin/gitlab-projects') } let(:gitlab_shell_hooks_path) { File.join(gitlab_shell_path, 'hooks') } before do allow(Gitlab.config.gitlab_shell).to receive(:path).and_return(gitlab_shell_path) allow(Gitlab.config.gitlab_shell).to receive(:hooks_path).and_return(gitlab_shell_hooks_path) allow(Gitlab.config.gitlab_shell).to receive(:git_timeout).and_return(800) end describe '#add_repository' do shared_examples '#add_repository' do let(:repository_storage) { 'default' } let(:repository_storage_path) { Gitlab.config.repositories.storages[repository_storage]['path'] } let(:repo_name) { 'project/path' } let(:created_path) { File.join(repository_storage_path, repo_name + '.git') } after do FileUtils.rm_rf(created_path) end it 'creates a repository' do expect(gitlab_shell.add_repository(repository_storage, repo_name)).to be_truthy expect(File.stat(created_path).mode & 0o777).to eq(0o770) hooks_path = File.join(created_path, 'hooks') expect(File.lstat(hooks_path)).to be_symlink expect(File.realpath(hooks_path)).to eq(gitlab_shell_hooks_path) end it 'returns false when the command fails' do FileUtils.mkdir_p(File.dirname(created_path)) # This file will block the creation of the repo's .git directory. That # should cause #add_repository to fail. FileUtils.touch(created_path) expect(gitlab_shell.add_repository(repository_storage, repo_name)).to be_falsy end end context 'with gitaly' do it_behaves_like '#add_repository' end context 'without gitaly', skip_gitaly_mock: true do it_behaves_like '#add_repository' end end describe '#remove_repository' do it 'returns true when the command succeeds' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'rm-project', 'current/storage', 'project/path.git'], nil, popen_vars).and_return([nil, 0]) expect(gitlab_shell.remove_repository('current/storage', 'project/path')).to be true end it 'returns false when the command fails' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'rm-project', 'current/storage', 'project/path.git'], nil, popen_vars).and_return(["error", 1]) expect(gitlab_shell.remove_repository('current/storage', 'project/path')).to be false end end describe '#mv_repository' do it 'returns true when the command succeeds' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'mv-project', 'current/storage', 'project/path.git', 'project/newpath.git'], nil, popen_vars).and_return([nil, 0]) expect(gitlab_shell.mv_repository('current/storage', 'project/path', 'project/newpath')).to be true end it 'returns false when the command fails' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'mv-project', 'current/storage', 'project/path.git', 'project/newpath.git'], nil, popen_vars).and_return(["error", 1]) expect(gitlab_shell.mv_repository('current/storage', 'project/path', 'project/newpath')).to be false end end describe '#fork_repository' do it 'returns true when the command succeeds' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'fork-project', 'current/storage', 'project/path.git', 'new/storage', 'new-namespace'], nil, popen_vars).and_return([nil, 0]) expect(gitlab_shell.fork_repository('current/storage', 'project/path', 'new/storage', 'new-namespace')).to be true end it 'return false when the command fails' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'fork-project', 'current/storage', 'project/path.git', 'new/storage', 'new-namespace'], nil, popen_vars).and_return(["error", 1]) expect(gitlab_shell.fork_repository('current/storage', 'project/path', 'new/storage', 'new-namespace')).to be false end end shared_examples 'fetch_remote' do |gitaly_on| let(:project2) { create(:project, :repository) } let(:repository) { project2.repository } def fetch_remote(ssh_auth = nil) gitlab_shell.fetch_remote(repository.raw_repository, 'new/storage', ssh_auth: ssh_auth) end def expect_popen(fail = false, vars = {}) popen_args = [ projects_path, 'fetch-remote', TestEnv.repos_path, repository.relative_path, 'new/storage', Gitlab.config.gitlab_shell.git_timeout.to_s ] return_value = fail ? ["error", 1] : [nil, 0] expect(Gitlab::Popen).to receive(:popen).with(popen_args, nil, popen_vars.merge(vars)).and_return(return_value) end def expect_gitaly_call(fail, vars = {}) receive_fetch_remote = if fail receive(:fetch_remote).and_raise(GRPC::NotFound) else receive(:fetch_remote).and_return(true) end expect_any_instance_of(Gitlab::GitalyClient::RepositoryService).to receive_fetch_remote end if gitaly_on def expect_call(fail, vars = {}) expect_gitaly_call(fail, vars) end else def expect_call(fail, vars = {}) expect_popen(fail, vars) end end def build_ssh_auth(opts = {}) defaults = { ssh_import?: true, ssh_key_auth?: false, ssh_known_hosts: nil, ssh_private_key: nil } double(:ssh_auth, defaults.merge(opts)) end it 'returns true when the command succeeds' do expect_call(false) expect(fetch_remote).to be_truthy end it 'raises an exception when the command fails' do expect_call(true) expect { fetch_remote }.to raise_error(Gitlab::Shell::Error) end context 'SSH auth' do it 'passes the SSH key if specified' do expect_call(false, 'GITLAB_SHELL_SSH_KEY' => 'foo') ssh_auth = build_ssh_auth(ssh_key_auth?: true, ssh_private_key: 'foo') expect(fetch_remote(ssh_auth)).to be_truthy end it 'does not pass an empty SSH key' do expect_call(false) ssh_auth = build_ssh_auth(ssh_key_auth: true, ssh_private_key: '') expect(fetch_remote(ssh_auth)).to be_truthy end it 'does not pass the key unless SSH key auth is to be used' do expect_call(false) ssh_auth = build_ssh_auth(ssh_key_auth: false, ssh_private_key: 'foo') expect(fetch_remote(ssh_auth)).to be_truthy end it 'passes the known_hosts data if specified' do expect_call(false, 'GITLAB_SHELL_KNOWN_HOSTS' => 'foo') ssh_auth = build_ssh_auth(ssh_known_hosts: 'foo') expect(fetch_remote(ssh_auth)).to be_truthy end it 'does not pass empty known_hosts data' do expect_call(false) ssh_auth = build_ssh_auth(ssh_known_hosts: '') expect(fetch_remote(ssh_auth)).to be_truthy end it 'does not pass known_hosts data unless SSH is to be used' do expect_call(false, popen_vars) ssh_auth = build_ssh_auth(ssh_import?: false, ssh_known_hosts: 'foo') expect(fetch_remote(ssh_auth)).to be_truthy end end end describe '#fetch_remote local', skip_gitaly_mock: true do it_should_behave_like 'fetch_remote', false end describe '#fetch_remote gitaly' do it_should_behave_like 'fetch_remote', true end describe '#import_repository' do it 'returns true when the command succeeds' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'import-project', 'current/storage', 'project/path.git', 'https://gitlab.com/gitlab-org/gitlab-ce.git', "800"], nil, popen_vars).and_return([nil, 0]) expect(gitlab_shell.import_repository('current/storage', 'project/path', 'https://gitlab.com/gitlab-org/gitlab-ce.git')).to be true end it 'raises an exception when the command fails' do expect(Gitlab::Popen).to receive(:popen) .with([projects_path, 'import-project', 'current/storage', 'project/path.git', 'https://gitlab.com/gitlab-org/gitlab-ce.git', "800"], nil, popen_vars).and_return(["error", 1]) expect { gitlab_shell.import_repository('current/storage', 'project/path', 'https://gitlab.com/gitlab-org/gitlab-ce.git') }.to raise_error(Gitlab::Shell::Error, "error") end end end end