##// END OF EJS Templates
Adds an option to reposman for reading the API key from a file....
Jean-Philippe Lang -
r7837:a26db9f08c23
parent child
Show More
@@ -1,309 +1,321
1 1 #!/usr/bin/env ruby
2 2
3 3 # == Synopsis
4 4 #
5 5 # reposman: manages your repositories with Redmine
6 6 #
7 7 # == Usage
8 8 #
9 9 # reposman [OPTIONS...] -s [DIR] -r [HOST]
10 10 #
11 11 # Examples:
12 12 # reposman --svn-dir=/var/svn --redmine-host=redmine.example.net --scm subversion
13 13 # reposman -s /var/git -r redmine.example.net -u http://svn.example.net --scm git
14 14 #
15 15 # == Arguments (mandatory)
16 16 #
17 17 # -s, --svn-dir=DIR use DIR as base directory for svn repositories
18 18 # -r, --redmine-host=HOST assume Redmine is hosted on HOST. Examples:
19 19 # -r redmine.example.net
20 20 # -r http://redmine.example.net
21 21 # -r https://example.net/redmine
22 # -k, --key=KEY use KEY as the Redmine API key
22 # -k, --key=KEY use KEY as the Redmine API key (you can use the
23 # --key-file option as an alternative)
23 24 #
24 25 # == Options
25 26 #
26 27 # -o, --owner=OWNER owner of the repository. using the rails login
27 28 # allow user to browse the repository within
28 29 # Redmine even for private project. If you want to
29 30 # share repositories through Redmine.pm, you need
30 31 # to use the apache owner.
31 32 # -g, --group=GROUP group of the repository. (default: root)
32 33 # --scm=SCM the kind of SCM repository you want to create (and
33 34 # register) in Redmine (default: Subversion).
34 35 # reposman is able to create Git and Subversion
35 36 # repositories. For all other kind, you must specify
36 37 # a --command option
37 38 # -u, --url=URL the base url Redmine will use to access your
38 39 # repositories. This option is used to automatically
39 40 # register the repositories in Redmine. The project
40 41 # identifier will be appended to this url. Examples:
41 42 # -u https://example.net/svn
42 43 # -u file:///var/svn/
43 44 # if this option isn't set, reposman won't register
44 45 # the repositories in Redmine
45 46 # -c, --command=COMMAND use this command instead of "svnadmin create" to
46 47 # create a repository. This option can be used to
47 48 # create repositories other than subversion and git
48 49 # kind.
49 50 # This command override the default creation for git
50 51 # and subversion.
51 52 # -f, --force force repository creation even if the project
52 53 # repository is already declared in Redmine
54 # --key-file=PATH path to a file that contains the Redmine API key
55 # (use this option instead of --key if you don't
56 # the key to appear in the command line)
53 57 # -t, --test only show what should be done
54 58 # -h, --help show help and exit
55 59 # -v, --verbose verbose
56 60 # -V, --version print version and exit
57 61 # -q, --quiet no log
58 62 #
59 63 # == References
60 64 #
61 65 # You can find more information on the redmine's wiki : http://www.redmine.org/wiki/redmine/HowTos
62 66
63 67
64 68 require 'getoptlong'
65 69 require 'rdoc/usage'
66 70 require 'find'
67 71 require 'etc'
68 72
69 73 Version = "1.3"
70 74 SUPPORTED_SCM = %w( Subversion Darcs Mercurial Bazaar Git Filesystem )
71 75
72 76 opts = GetoptLong.new(
73 77 ['--svn-dir', '-s', GetoptLong::REQUIRED_ARGUMENT],
74 78 ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
75 79 ['--key', '-k', GetoptLong::REQUIRED_ARGUMENT],
80 ['--key-file', GetoptLong::REQUIRED_ARGUMENT],
76 81 ['--owner', '-o', GetoptLong::REQUIRED_ARGUMENT],
77 82 ['--group', '-g', GetoptLong::REQUIRED_ARGUMENT],
78 83 ['--url', '-u', GetoptLong::REQUIRED_ARGUMENT],
79 84 ['--command' , '-c', GetoptLong::REQUIRED_ARGUMENT],
80 85 ['--scm', GetoptLong::REQUIRED_ARGUMENT],
81 86 ['--test', '-t', GetoptLong::NO_ARGUMENT],
82 87 ['--force', '-f', GetoptLong::NO_ARGUMENT],
83 88 ['--verbose', '-v', GetoptLong::NO_ARGUMENT],
84 89 ['--version', '-V', GetoptLong::NO_ARGUMENT],
85 90 ['--help' , '-h', GetoptLong::NO_ARGUMENT],
86 91 ['--quiet' , '-q', GetoptLong::NO_ARGUMENT]
87 92 )
88 93
89 94 $verbose = 0
90 95 $quiet = false
91 96 $redmine_host = ''
92 97 $repos_base = ''
93 98 $svn_owner = 'root'
94 99 $svn_group = 'root'
95 100 $use_groupid = true
96 101 $svn_url = false
97 102 $test = false
98 103 $force = false
99 104 $scm = 'Subversion'
100 105
101 106 def log(text, options={})
102 107 level = options[:level] || 0
103 108 puts text unless $quiet or level > $verbose
104 109 exit 1 if options[:exit]
105 110 end
106 111
107 112 def system_or_raise(command)
108 113 raise "\"#{command}\" failed" unless system command
109 114 end
110 115
111 116 module SCM
112 117
113 118 module Subversion
114 119 def self.create(path)
115 120 system_or_raise "svnadmin create #{path}"
116 121 end
117 122 end
118 123
119 124 module Git
120 125 def self.create(path)
121 126 Dir.mkdir path
122 127 Dir.chdir(path) do
123 128 system_or_raise "git --bare init --shared"
124 129 system_or_raise "git update-server-info"
125 130 end
126 131 end
127 132 end
128 133
129 134 end
130 135
131 136 begin
132 137 opts.each do |opt, arg|
133 138 case opt
134 139 when '--svn-dir'; $repos_base = arg.dup
135 140 when '--redmine-host'; $redmine_host = arg.dup
136 141 when '--key'; $api_key = arg.dup
142 when '--key-file'
143 begin
144 $api_key = File.read(arg).strip
145 rescue Exception => e
146 $stderr.puts "Unable to read the key from #{arg}: #{e.message}"
147 exit 1
148 end
137 149 when '--owner'; $svn_owner = arg.dup; $use_groupid = false;
138 150 when '--group'; $svn_group = arg.dup; $use_groupid = false;
139 151 when '--url'; $svn_url = arg.dup
140 152 when '--scm'; $scm = arg.dup.capitalize; log("Invalid SCM: #{$scm}", :exit => true) unless SUPPORTED_SCM.include?($scm)
141 153 when '--command'; $command = arg.dup
142 154 when '--verbose'; $verbose += 1
143 155 when '--test'; $test = true
144 156 when '--force'; $force = true
145 157 when '--version'; puts Version; exit
146 158 when '--help'; RDoc::usage
147 159 when '--quiet'; $quiet = true
148 160 end
149 161 end
150 162 rescue
151 163 exit 1
152 164 end
153 165
154 166 if $test
155 167 log("running in test mode")
156 168 end
157 169
158 170 # Make sure command is overridden if SCM vendor is not handled internally (for the moment Subversion and Git)
159 171 if $command.nil?
160 172 begin
161 173 scm_module = SCM.const_get($scm)
162 174 rescue
163 175 log("Please use --command option to specify how to create a #{$scm} repository.", :exit => true)
164 176 end
165 177 end
166 178
167 179 $svn_url += "/" if $svn_url and not $svn_url.match(/\/$/)
168 180
169 181 if ($redmine_host.empty? or $repos_base.empty?)
170 182 RDoc::usage
171 183 end
172 184
173 185 unless File.directory?($repos_base)
174 186 log("directory '#{$repos_base}' doesn't exists", :exit => true)
175 187 end
176 188
177 189 begin
178 190 require 'active_resource'
179 191 rescue LoadError
180 192 log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true)
181 193 end
182 194
183 195 class Project < ActiveResource::Base
184 196 self.headers["User-agent"] = "Redmine repository manager/#{Version}"
185 197 self.format = :xml
186 198 end
187 199
188 200 log("querying Redmine for projects...", :level => 1);
189 201
190 202 $redmine_host.gsub!(/^/, "http://") unless $redmine_host.match("^https?://")
191 203 $redmine_host.gsub!(/\/$/, '')
192 204
193 205 Project.site = "#{$redmine_host}/sys";
194 206
195 207 begin
196 208 # Get all active projects that have the Repository module enabled
197 209 projects = Project.find(:all, :params => {:key => $api_key})
198 210 rescue => e
199 211 log("Unable to connect to #{Project.site}: #{e}", :exit => true)
200 212 end
201 213
202 214 if projects.nil?
203 215 log('no project found, perhaps you forgot to "Enable WS for repository management"', :exit => true)
204 216 end
205 217
206 218 log("retrieved #{projects.size} projects", :level => 1)
207 219
208 220 def set_owner_and_rights(project, repos_path, &block)
209 221 if mswin?
210 222 yield if block_given?
211 223 else
212 224 uid, gid = Etc.getpwnam($svn_owner).uid, ($use_groupid ? Etc.getgrnam(project.identifier).gid : Etc.getgrnam($svn_group).gid)
213 225 right = project.is_public ? 0775 : 0770
214 226 yield if block_given?
215 227 Find.find(repos_path) do |f|
216 228 File.chmod right, f
217 229 File.chown uid, gid, f
218 230 end
219 231 end
220 232 end
221 233
222 234 def other_read_right?(file)
223 235 (File.stat(file).mode & 0007).zero? ? false : true
224 236 end
225 237
226 238 def owner_name(file)
227 239 mswin? ?
228 240 $svn_owner :
229 241 Etc.getpwuid( File.stat(file).uid ).name
230 242 end
231 243
232 244 def mswin?
233 245 (RUBY_PLATFORM =~ /(:?mswin|mingw)/) || (RUBY_PLATFORM == 'java' && (ENV['OS'] || ENV['os']) =~ /windows/i)
234 246 end
235 247
236 248 projects.each do |project|
237 249 log("treating project #{project.name}", :level => 1)
238 250
239 251 if project.identifier.empty?
240 252 log("\tno identifier for project #{project.name}")
241 253 next
242 254 elsif not project.identifier.match(/^[a-z0-9\-]+$/)
243 255 log("\tinvalid identifier for project #{project.name} : #{project.identifier}");
244 256 next;
245 257 end
246 258
247 259 repos_path = File.join($repos_base, project.identifier).gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
248 260
249 261 if File.directory?(repos_path)
250 262 # we must verify that repository has the good owner and the good
251 263 # rights before leaving
252 264 other_read = other_read_right?(repos_path)
253 265 owner = owner_name(repos_path)
254 266 next if project.is_public == other_read and owner == $svn_owner
255 267
256 268 if $test
257 269 log("\tchange mode on #{repos_path}")
258 270 next
259 271 end
260 272
261 273 begin
262 274 set_owner_and_rights(project, repos_path)
263 275 rescue Errno::EPERM => e
264 276 log("\tunable to change mode on #{repos_path} : #{e}\n")
265 277 next
266 278 end
267 279
268 280 log("\tmode change on #{repos_path}");
269 281
270 282 else
271 283 # if repository is already declared in redmine, we don't create
272 284 # unless user use -f with reposman
273 285 if $force == false and project.respond_to?(:repository)
274 286 log("\trepository for project #{project.identifier} already exists in Redmine", :level => 1)
275 287 next
276 288 end
277 289
278 290 project.is_public ? File.umask(0002) : File.umask(0007)
279 291
280 292 if $test
281 293 log("\tcreate repository #{repos_path}")
282 294 log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}") if $svn_url;
283 295 next
284 296 end
285 297
286 298 begin
287 299 set_owner_and_rights(project, repos_path) do
288 300 if scm_module.nil?
289 301 system_or_raise "#{$command} #{repos_path}"
290 302 else
291 303 scm_module.create(repos_path)
292 304 end
293 305 end
294 306 rescue => e
295 307 log("\tunable to create #{repos_path} : #{e}\n")
296 308 next
297 309 end
298 310
299 311 if $svn_url
300 312 begin
301 313 project.post(:repository, :vendor => $scm, :repository => {:url => "#{$svn_url}#{project.identifier}"}, :key => $api_key)
302 314 log("\trepository #{repos_path} registered in Redmine with url #{$svn_url}#{project.identifier}");
303 315 rescue => e
304 316 log("\trepository #{repos_path} not registered in Redmine: #{e.message}");
305 317 end
306 318 end
307 319 log("\trepository #{repos_path} created");
308 320 end
309 321 end
General Comments 0
You need to be logged in to leave comments. Login now