shell.rb 6.1 KB
Newer Older
1
module Gitlab
2
  class Shell
D
Dmitriy Zaporozhets 已提交
3
    class AccessDenied < StandardError; end
4

5
    # Init new repository
6
    #
7
    # name - project path with namespace
8 9
    #
    # Ex.
10
    #   add_repository("gitlab/gitlab-ci")
11
    #
12
    def add_repository(name)
D
Dmitriy Zaporozhets 已提交
13
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "add-project", "#{name}.git"
14 15
    end

16 17 18 19 20 21 22 23
    # Import repository
    #
    # name - project path with namespace
    #
    # Ex.
    #   import_repository("gitlab/gitlab-ci", "https://github.com/randx/six.git")
    #
    def import_repository(name, url)
D
Dmitriy Zaporozhets 已提交
24
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "import-project", "#{name}.git", url
25 26
    end

27 28 29 30 31 32 33 34 35
    # 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)
D
Dmitriy Zaporozhets 已提交
36
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "mv-project", "#{path}.git", "#{new_path}.git"
37 38
    end

39 40 41 42 43 44 45 46 47
    # 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)
D
Dmitriy Zaporozhets 已提交
48
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "update-head", "#{path}.git", branch
49 50
    end

51 52 53 54 55 56 57 58 59
    # 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)
D
Dmitriy Zaporozhets 已提交
60
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "fork-project", "#{path}.git", fork_namespace
61 62
    end

D
Dmitriy Zaporozhets 已提交
63
    # Remove repository from file system
64
    #
65
    # name - project path with namespace
66 67 68 69
    #
    # Ex.
    #   remove_repository("gitlab/gitlab-ci")
    #
70
    def remove_repository(name)
D
Dmitriy Zaporozhets 已提交
71
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "rm-project", "#{name}.git"
D
Dmitriy Zaporozhets 已提交
72 73
    end

74 75 76 77 78 79 80 81 82 83
    # 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)
D
Dmitriy Zaporozhets 已提交
84
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "create-branch", "#{path}.git", branch_name, ref
85 86 87 88 89 90 91 92 93 94 95
    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)
D
Dmitriy Zaporozhets 已提交
96
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "rm-branch", "#{path}.git", branch_name
97 98
    end

99 100 101 102 103 104 105 106 107 108
    # Add repository tag from passed ref
    #
    # path - project path with namespace
    # tag_name - new tag name
    # ref - HEAD for new tag
    #
    # Ex.
    #   add_tag("gitlab/gitlab-ci", "v4.0", "master")
    #
    def add_tag(path, tag_name, ref)
D
Dmitriy Zaporozhets 已提交
109
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "create-tag", "#{path}.git", tag_name, ref
110 111 112 113 114 115 116 117 118 119 120
    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)
D
Dmitriy Zaporozhets 已提交
121
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-projects", "rm-tag", "#{path}.git", tag_name
122 123
    end

124
    # Add new key to gitlab-shell
D
Dmitriy Zaporozhets 已提交
125
    #
126
    # Ex.
127
    #   add_key("key-42", "sha-rsa ...")
128
    #
129
    def add_key(key_id, key_content)
D
Dmitriy Zaporozhets 已提交
130
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-keys", "add-key", key_id, key_content
131 132 133
    end

    # Remove ssh key from gitlab shell
134 135
    #
    # Ex.
136
    #   remove_key("key-342", "sha-rsa ...")
137
    #
138
    def remove_key(key_id, key_content)
D
Dmitriy Zaporozhets 已提交
139
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-keys", "rm-key", key_id, key_content
140 141
    end

142 143 144
    # Remove all ssh keys from gitlab shell
    #
    # Ex.
J
Johannes Schleifenbaum 已提交
145
    #   remove_all_keys
146 147 148 149 150
    #
    def remove_all_keys
      system "#{gitlab_shell_user_home}/gitlab-shell/bin/gitlab-keys", "clear"
    end

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
    # 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

    # Remove GitLab Satellites for provided path (namespace or repo dir)
    #
    # Ex.
    #   rm_satellites("gitlab")
    #
    #   rm_satellites("gitlab/gitlab-ci.git")
    #
    def rm_satellites(path)
      raise ArgumentError.new("Path can't be blank") if path.blank?

      satellites_path = File.join(Gitlab.config.satellites.path, path)
      FileUtils.rm_r(satellites_path, force: true)
    end

R
randx 已提交
195
    def url_to_repo path
196
      Gitlab.config.gitlab_shell.ssh_path_prefix + "#{path}.git"
R
randx 已提交
197
    end
198

199 200 201 202 203 204 205 206 207
    # Return GitLab shell version
    def version
      gitlab_shell_version_file = "#{gitlab_shell_user_home}/gitlab-shell/VERSION"

      if File.readable?(gitlab_shell_version_file)
        File.read(gitlab_shell_version_file)
      end
    end

208 209
    protected

210 211 212 213
    def gitlab_shell_user_home
      File.expand_path("~#{Gitlab.config.gitlab_shell.ssh_user}")
    end

214 215 216 217 218 219 220 221 222 223 224 225 226
    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

    def exists?(dir_name)
      File.exists?(full_path(dir_name))
    end
D
Dmitriy Zaporozhets 已提交
227 228
  end
end