2012-05-26 06:37:49 -04:00
|
|
|
module Gitlab
|
2013-02-04 08:07:56 -05:00
|
|
|
class Shell
|
2015-11-11 10:22:51 -05:00
|
|
|
class Error < StandardError; end
|
2012-09-07 01:16:29 -04:00
|
|
|
|
2015-12-14 21:53:52 -05:00
|
|
|
KeyAdder = Struct.new(:io) do
|
2014-03-13 13:32:30 -04:00
|
|
|
def add_key(id, key)
|
2015-10-08 20:34:50 -04:00
|
|
|
key.gsub!(/[[:space:]]+/, ' ').strip!
|
|
|
|
io.puts("#{id}\t#{key}")
|
2014-03-13 13:32:30 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2014-11-05 11:14:22 -05:00
|
|
|
class << self
|
|
|
|
def version_required
|
|
|
|
@version_required ||= File.read(Rails.root.
|
|
|
|
join('GITLAB_SHELL_VERSION')).strip
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2013-02-04 08:07:56 -05:00
|
|
|
# Init new repository
|
2013-01-28 14:02:10 -05:00
|
|
|
#
|
2013-02-04 08:07:56 -05:00
|
|
|
# name - project path with namespace
|
2013-01-28 10:39:02 -05:00
|
|
|
#
|
|
|
|
# Ex.
|
2013-02-04 08:07:56 -05:00
|
|
|
# add_repository("gitlab/gitlab-ci")
|
2013-01-28 10:39:02 -05:00
|
|
|
#
|
2013-02-04 08:07:56 -05:00
|
|
|
def add_repository(name)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path,
|
|
|
|
'add-project', "#{name}.git"])
|
2012-11-21 00:54:05 -05:00
|
|
|
end
|
|
|
|
|
2013-02-11 12:41:02 -05:00
|
|
|
# Import repository
|
|
|
|
#
|
|
|
|
# name - project path with namespace
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# import_repository("gitlab/gitlab-ci", "https://github.com/randx/six.git")
|
|
|
|
#
|
|
|
|
def import_repository(name, url)
|
2015-11-11 10:22:51 -05:00
|
|
|
output, status = Popen::popen([gitlab_shell_projects_path, 'import-project', "#{name}.git", url, '240'])
|
|
|
|
raise Error, output unless status.zero?
|
|
|
|
true
|
2013-02-11 12:41:02 -05:00
|
|
|
end
|
|
|
|
|
2013-03-12 06:37:53 -04:00
|
|
|
# Move repository
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# new_path - new project path with namespace
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# mv_repository("gitlab/gitlab-ci", "randx/gitlab-ci-new.git")
|
|
|
|
#
|
|
|
|
def mv_repository(path, new_path)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'mv-project',
|
|
|
|
"#{path}.git", "#{new_path}.git"])
|
2013-03-12 06:37:53 -04:00
|
|
|
end
|
|
|
|
|
2013-06-25 10:05:39 -04:00
|
|
|
# Update HEAD for repository
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# branch - repository branch name
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# update_repository_head("gitlab/gitlab-ci", "3-1-stable")
|
|
|
|
#
|
|
|
|
def update_repository_head(path, branch)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'update-head',
|
|
|
|
"#{path}.git", branch])
|
2013-06-25 10:05:39 -04:00
|
|
|
end
|
|
|
|
|
2013-03-19 11:37:50 -04:00
|
|
|
# Fork repository to new namespace
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# fork_namespace - namespace for forked project
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# fork_repository("gitlab/gitlab-ci", "randx")
|
|
|
|
#
|
|
|
|
def fork_repository(path, fork_namespace)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'fork-project',
|
|
|
|
"#{path}.git", fork_namespace])
|
2013-03-19 11:37:50 -04:00
|
|
|
end
|
|
|
|
|
2013-02-04 07:28:10 -05:00
|
|
|
# Remove repository from file system
|
2013-01-28 10:22:45 -05:00
|
|
|
#
|
2013-11-01 10:25:06 -04:00
|
|
|
# name - project path with namespace
|
2013-01-28 10:22:45 -05:00
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# remove_repository("gitlab/gitlab-ci")
|
|
|
|
#
|
2013-11-01 10:25:06 -04:00
|
|
|
def remove_repository(name)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path,
|
|
|
|
'rm-project', "#{name}.git"])
|
2012-03-05 17:26:40 -05:00
|
|
|
end
|
|
|
|
|
2013-07-16 15:18:14 -04:00
|
|
|
# Add repository branch from passed ref
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# branch_name - new branch name
|
|
|
|
# ref - HEAD for new branch
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# add_branch("gitlab/gitlab-ci", "4-0-stable", "master")
|
|
|
|
#
|
|
|
|
def add_branch(path, branch_name, ref)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'create-branch',
|
|
|
|
"#{path}.git", branch_name, ref])
|
2013-07-16 15:18:14 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Remove repository branch
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# branch_name - branch name to remove
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# rm_branch("gitlab/gitlab-ci", "4-0-stable")
|
|
|
|
#
|
|
|
|
def rm_branch(path, branch_name)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'rm-branch',
|
|
|
|
"#{path}.git", branch_name])
|
2013-07-16 15:18:14 -04:00
|
|
|
end
|
|
|
|
|
2013-07-16 16:12:52 -04:00
|
|
|
# Add repository tag from passed ref
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# tag_name - new tag name
|
|
|
|
# ref - HEAD for new tag
|
2014-06-23 21:35:36 -04:00
|
|
|
# message - optional message for tag (annotated tag)
|
2013-07-16 16:12:52 -04:00
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# add_tag("gitlab/gitlab-ci", "v4.0", "master")
|
2014-06-23 21:35:36 -04:00
|
|
|
# add_tag("gitlab/gitlab-ci", "v4.0", "master", "message")
|
2013-07-16 16:12:52 -04:00
|
|
|
#
|
2014-06-23 21:35:36 -04:00
|
|
|
def add_tag(path, tag_name, ref, message = nil)
|
|
|
|
cmd = %W(#{gitlab_shell_path}/bin/gitlab-projects create-tag #{path}.git
|
|
|
|
#{tag_name} #{ref})
|
|
|
|
cmd << message unless message.nil? || message.empty?
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent(cmd)
|
2013-07-16 16:12:52 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Remove repository tag
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
# tag_name - tag name to remove
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# rm_tag("gitlab/gitlab-ci", "v4.0")
|
|
|
|
#
|
|
|
|
def rm_tag(path, tag_name)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'rm-tag',
|
|
|
|
"#{path}.git", tag_name])
|
2013-07-16 16:12:52 -04:00
|
|
|
end
|
|
|
|
|
2015-10-21 09:15:54 -04:00
|
|
|
# Gc repository
|
|
|
|
#
|
|
|
|
# path - project path with namespace
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# gc("gitlab/gitlab-ci")
|
|
|
|
#
|
|
|
|
def gc(path)
|
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_projects_path, 'gc',
|
|
|
|
"#{path}.git"])
|
|
|
|
end
|
|
|
|
|
2013-02-04 08:07:56 -05:00
|
|
|
# Add new key to gitlab-shell
|
2013-02-04 07:28:10 -05:00
|
|
|
#
|
2013-02-04 08:07:56 -05:00
|
|
|
# Ex.
|
2013-02-05 04:12:15 -05:00
|
|
|
# add_key("key-42", "sha-rsa ...")
|
2013-02-04 08:07:56 -05:00
|
|
|
#
|
2013-02-05 04:12:15 -05:00
|
|
|
def add_key(key_id, key_content)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_keys_path,
|
|
|
|
'add-key', key_id, key_content])
|
2013-02-04 08:07:56 -05:00
|
|
|
end
|
|
|
|
|
2014-03-13 13:32:30 -04:00
|
|
|
# Batch-add keys to authorized_keys
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# batch_add_keys { |adder| adder.add_key("key-42", "sha-rsa ...") }
|
|
|
|
def batch_add_keys(&block)
|
|
|
|
IO.popen(%W(#{gitlab_shell_path}/bin/gitlab-keys batch-add-keys), 'w') do |io|
|
|
|
|
block.call(KeyAdder.new(io))
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2013-02-04 08:07:56 -05:00
|
|
|
# Remove ssh key from gitlab shell
|
2013-01-28 10:39:02 -05:00
|
|
|
#
|
|
|
|
# Ex.
|
2013-02-05 04:12:15 -05:00
|
|
|
# remove_key("key-342", "sha-rsa ...")
|
2013-01-28 10:39:02 -05:00
|
|
|
#
|
2013-02-05 04:12:15 -05:00
|
|
|
def remove_key(key_id, key_content)
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_keys_path,
|
|
|
|
'rm-key', key_id, key_content])
|
2013-01-28 10:39:02 -05:00
|
|
|
end
|
|
|
|
|
2013-07-18 06:55:01 -04:00
|
|
|
# Remove all ssh keys from gitlab shell
|
|
|
|
#
|
|
|
|
# Ex.
|
2013-07-29 06:46:00 -04:00
|
|
|
# remove_all_keys
|
2013-07-18 06:55:01 -04:00
|
|
|
#
|
|
|
|
def remove_all_keys
|
2014-11-03 18:50:07 -05:00
|
|
|
Gitlab::Utils.system_silent([gitlab_shell_keys_path, 'clear'])
|
2013-07-18 06:55:01 -04:00
|
|
|
end
|
|
|
|
|
2013-03-21 16:11:08 -04:00
|
|
|
# Add empty directory for storing repositories
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# add_namespace("gitlab")
|
|
|
|
#
|
|
|
|
def add_namespace(name)
|
|
|
|
FileUtils.mkdir(full_path(name), mode: 0770) unless exists?(name)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Remove directory from repositories storage
|
|
|
|
# Every repository inside this directory will be removed too
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# rm_namespace("gitlab")
|
|
|
|
#
|
|
|
|
def rm_namespace(name)
|
|
|
|
FileUtils.rm_r(full_path(name), force: true)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Move namespace directory inside repositories storage
|
|
|
|
#
|
|
|
|
# Ex.
|
|
|
|
# mv_namespace("gitlab", "gitlabhq")
|
|
|
|
#
|
|
|
|
def mv_namespace(old_name, new_name)
|
|
|
|
return false if exists?(new_name) || !exists?(old_name)
|
|
|
|
|
|
|
|
FileUtils.mv(full_path(old_name), full_path(new_name))
|
|
|
|
end
|
|
|
|
|
2014-09-25 18:07:40 -04:00
|
|
|
def url_to_repo(path)
|
2013-02-11 12:16:59 -05:00
|
|
|
Gitlab.config.gitlab_shell.ssh_path_prefix + "#{path}.git"
|
2012-08-28 17:04:06 -04:00
|
|
|
end
|
2013-03-12 06:37:53 -04:00
|
|
|
|
2013-11-20 06:41:41 -05:00
|
|
|
# Return GitLab shell version
|
|
|
|
def version
|
2013-12-09 12:32:37 -05:00
|
|
|
gitlab_shell_version_file = "#{gitlab_shell_path}/VERSION"
|
2013-11-20 06:41:41 -05:00
|
|
|
|
|
|
|
if File.readable?(gitlab_shell_version_file)
|
2015-04-06 08:02:49 -04:00
|
|
|
File.read(gitlab_shell_version_file).chomp
|
2013-11-20 06:41:41 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-06-03 05:50:08 -04:00
|
|
|
# Check if such directory exists in repositories.
|
|
|
|
#
|
|
|
|
# Usage:
|
|
|
|
# exists?('gitlab')
|
|
|
|
# exists?('gitlab/cookies.git')
|
|
|
|
#
|
|
|
|
def exists?(dir_name)
|
|
|
|
File.exists?(full_path(dir_name))
|
|
|
|
end
|
|
|
|
|
2013-03-21 16:11:08 -04:00
|
|
|
protected
|
|
|
|
|
2013-12-09 12:32:37 -05:00
|
|
|
def gitlab_shell_path
|
|
|
|
Gitlab.config.gitlab_shell.path
|
|
|
|
end
|
|
|
|
|
2013-02-14 18:10:18 -05:00
|
|
|
def gitlab_shell_user_home
|
|
|
|
File.expand_path("~#{Gitlab.config.gitlab_shell.ssh_user}")
|
|
|
|
end
|
|
|
|
|
2013-03-21 16:11:08 -04:00
|
|
|
def repos_path
|
|
|
|
Gitlab.config.gitlab_shell.repos_path
|
|
|
|
end
|
|
|
|
|
|
|
|
def full_path(dir_name)
|
|
|
|
raise ArgumentError.new("Directory name can't be blank") if dir_name.blank?
|
|
|
|
|
|
|
|
File.join(repos_path, dir_name)
|
|
|
|
end
|
|
|
|
|
2014-10-31 08:00:50 -04:00
|
|
|
def gitlab_shell_projects_path
|
|
|
|
File.join(gitlab_shell_path, 'bin', 'gitlab-projects')
|
|
|
|
end
|
|
|
|
|
|
|
|
def gitlab_shell_keys_path
|
|
|
|
File.join(gitlab_shell_path, 'bin', 'gitlab-keys')
|
|
|
|
end
|
2011-12-03 18:44:59 -05:00
|
|
|
end
|
|
|
|
end
|