Class: Bosh::Cli::Command::Release

Inherits:
Base show all
Includes:
DependencyHelper, VersionCalc
Defined in:
lib/cli/commands/release.rb

Constant Summary collapse

DEFAULT_RELEASE_NAME = 
"bosh-release"

Constants inherited from Base

Base::BLOBS_DIR, Base::BLOBS_INDEX_FILE

Instance Attribute Summary

Attributes inherited from Base

#cache, #config, #options, #out, #usage, #work_dir

Instance Method Summary collapse

Methods included from VersionCalc

#major_version, #minor_version, #version_cmp, #version_greater, #version_less, #version_same

Methods included from DependencyHelper

#tsort_packages

Methods inherited from Base

#blob_manager, #blobstore, command, #confirmed?, #director, #dry_run?, #exit_code, #full_target_name, #initialize, #interactive?, #logged_in?, #non_interactive?, #redirect, #release, #run, #show_usage, #target_name, #target_version, #task_report, #verbose?

Constructor Details

This class inherits a constructor from Bosh::Cli::Command::Base

Instance Method Details

#create(*options) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/cli/commands/release.rb', line 194

def create(*options)
  check_if_release_dir
  if options.size == 1 && File.file?(options[0])
    create_from_manifest(options[0])
    release_filename = options[0]
  else
    release_filename = create_from_spec(*options)
  end

  if release_filename
    release.latest_release_filename = release_filename
    release.save_config
  end
end

#create_from_manifest(manifest_file) ⇒ Object 



209
210
211
212
 
# File 'lib/cli/commands/release.rb', line 209

def create_from_manifest(manifest_file)
  say("Recreating release from the manifest")
  Bosh::Cli::ReleaseCompiler.compile(manifest_file, release.blobstore)
end

#create_from_spec(*options) ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/cli/commands/release.rb', line 214

def create_from_spec(*options)
  flags = options.inject({}) { |h, option| h[option] = true; h }

  final = flags.delete("--final")
  force = flags.delete("--force")
  manifest_only = !flags.delete("--with-tarball")
  dry_run = flags.delete("--dry-run")

  if final && !release.has_blobstore_secret?
    say("Can't create final release without blobstore secret".red)
    exit(1)
  end

  if flags.size > 0
    say("Unknown flags: #{flags.keys.join(", ")}".red)
    show_usage
    exit(1)
  end

  blob_manager.sync
  if blob_manager.dirty?
    blob_manager.print_status
    if force
      say("Proceeding with dirty blobs as '--force' is given".red)
    else
      err("Please use '--force' or upload new blobs")
    end
  end

  check_if_dirty_state unless force

  confirmation = "Are you sure you want to " +
                 "generate #{'final'.red} version? "

  if final && !dry_run && !confirmed?(confirmation)
    say("Canceled release generation".green)
    exit(1)
  end

  packages = []
  jobs = []

  if final
    header("Building FINAL release".green)
    release_name = release.final_name
  else
    release_name = release.dev_name
    header("Building DEV release".green)
  end

  if version_greater(release.min_cli_version, Bosh::Cli::VERSION)
    err("You should use CLI >= #{release.min_cli_version} " +
        "with this release, you have #{Bosh::Cli::VERSION}")
  end

  if release_name.blank?
    confirmation = "Please enter %s release name: " % [
        final ? "final" : "development"]
    name = interactive? ? ask(confirmation).to_s : DEFAULT_RELEASE_NAME
    err("Canceled release creation, no name given") if name.blank?
    if final
      release.final_name = name
    else
      release.dev_name = name
    end
    release.save_config
  end

  header("Building packages")
  Dir[File.join(work_dir, "packages", "*", "spec")].each do |package_spec|
    package = Bosh::Cli::PackageBuilder.new(package_spec, work_dir,
                                            final, release.blobstore)
    package.dry_run = dry_run
    say("Building #{package.name.green}...")
    package.build
    packages << package
    nl
  end

  if packages.size > 0
    package_index = packages.inject({}) do |index, package|
      index[package.name] = package.dependencies
      index
    end
    sorted_packages = tsort_packages(package_index)
    header("Resolving dependencies")
    say("Dependencies resolved, correct build order is:")
    for package_name in sorted_packages
      say("- %s" % [package_name])
    end
    nl
  end

  built_package_names = packages.map { |package| package.name }

  header("Building jobs")
  Dir[File.join(work_dir, "jobs", "*")].each do |job_dir|
    next unless File.directory?(job_dir)
    prepare_script = File.join(job_dir, "prepare")
    job_spec = File.join(job_dir, "spec")

    if File.exists?(prepare_script)
      say("Found prepare script in `#{File.basename(job_dir)}'")
      Bosh::Cli::JobBuilder.run_prepare_script(prepare_script)
    end

    job = Bosh::Cli::JobBuilder.new(job_spec, work_dir, final,
                                    release.blobstore, built_package_names)
    job.dry_run = dry_run
    say("Building #{job.name.green}...")
    job.build
    jobs << job
    nl
  end

  builder = Bosh::Cli::ReleaseBuilder.new(release, packages,
                                          jobs, :final => final)

  unless dry_run
    if manifest_only
      builder.build(:generate_tarball => false)
    else
      builder.build(:generate_tarball => true)
    end
  end

  header("Release summary")
  show_summary(builder)
  nl

  return nil if dry_run

  say("Release version: #{builder.version.to_s.green}")
  say("Release manifest: #{builder.manifest_path.green}")

  unless manifest_only
    say("Release tarball (#{pretty_size(builder.tarball_path)}): " +
        builder.tarball_path.green)
  end

  release.min_cli_version = Bosh::Cli::VERSION
  release.save_config

  builder.manifest_path
end

#delete(name, *options) ⇒ Object 



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/cli/commands/release.rb', line 404

def delete(name, *options)
  auth_required
  force = options.include?("--force")
  options.delete("--force")
  version = options.shift

  desc = "release `#{name}'"
  desc << " version #{version}" if version

  if force
    say("Deleting #{desc} (FORCED DELETE, WILL IGNORE ERRORS)".red)
  elsif options.size > 0
    err("Unknown option, currently only '--force' is supported")
  else
    say("Deleting #{desc}".red)
  end

  if confirmed?
    status, _ = director.delete_release(name, :force => force,
                                           :version => version)
    task_report(status, "Deleted #{desc}")
  else
    say("Canceled deleting release".green)
  end
end

#get_remote_packages(manifest_yaml, remote_release) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cli/commands/release.rb', line 110

def get_remote_packages(manifest_yaml, remote_release)
  remote_packages_sha1 = match_remote_packages(manifest_yaml)

  # Older directors may not match packages. For such
  # cases we select packages from the existing release.
  if remote_packages_sha1.size == 0 && remote_release
    remote_packages_sha1 = remote_release["packages"].map do |pkg|
      pkg["sha1"]
    end
  end
  remote_packages_sha1
end

#git_init ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/cli/commands/release.rb', line 38

def git_init
  out = %x{git init 2>&1}
  if $? != 0
    say("error running 'git init':\n#{out}")
  else
    File.open(".gitignore", "w") do |f|
      f << <<-EOS.gsub(/^\s{10}/, '')
      config/dev.yml
      config/private.yml
      releases/*.tgz
      dev_releases
      .blobs
      blobs
      .dev_builds
      .idea
      .DS_Store
      .final_builds/jobs/**/*.tgz
      .final_builds/packages/**/*.tgz
      *.swp
      *~
      *#
      #*
      EOS
    end
  end
rescue Errno::ENOENT
  say("Unable to run 'git init'".red)
end

#init(base = nil, *options) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/cli/commands/release.rb', line 10

def init(base=nil, *options)
  if base[0..0] == "-"
    # TODO: need to add some option parsing helpers to avoid that
    options.unshift(base)
    base = nil
  end
  git = options.include?("--git")

  if base
    FileUtils.mkdir_p(base) unless Dir.exist?(base)
    Dir.chdir(base)
  end

  err("Release already initialized") if in_release_dir?
  git_init if git

  %w[config jobs packages src blobs].each do |dir|
    FileUtils.mkdir(dir)
  end

  # Initialize an empty blobs index
  File.open(File.join("config", "blobs.yml"), "w") do |f|
    YAML.dump({}, f)
  end

  say("Release directory initialized".green)
end

#list ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/cli/commands/release.rb', line 379

def list
  auth_required
  releases = director.list_releases.sort do |r1, r2|
    r1["name"] <=> r2["name"]
  end

  err("No releases") if releases.empty?

  releases_table = table do |t|
    t.headings = "Name", "Versions"
    releases.each do |r|
      versions = r["versions"].sort do |v1, v2|
        version_cmp(v1, v2)
      end

      t << [r["name"], versions.join(", ")]
    end
  end

  nl
  say(releases_table)
  nl
  say("Releases total: %d" % releases.size)
end

#reset ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/cli/commands/release.rb', line 360

def reset
  check_if_release_dir

  say("Your dev release environment will be completely reset".red)
  if confirmed?
    say("Removing dev_builds index...")
    FileUtils.rm_rf(".dev_builds")
    say("Clearing dev name...")
    release.dev_name = nil
    release.save_config
    say("Removing dev tarballs...")
    FileUtils.rm_rf("dev_releases")

    say("Release has been reset".green)
  else
    say("Canceled")
  end
end

#upload(release_file = nil) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/cli/commands/release.rb', line 84

def upload(release_file = nil)
  auth_required

  if release_file.nil?
    check_if_release_dir
    release_file = release.latest_release_filename
    if release_file.nil?
      err("The information about latest generated release is missing, " +
          "please provide release filename")
    end
    unless confirmed?("Upload release " +
                      "`#{File.basename(release_file).green}' " +
                      "to `#{target_name.green}'")
      err("Canceled upload")
    end
  end

  file_type = `file --mime-type -b '#{release_file}'`

  if file_type =~ /text\/(plain|yaml)/
    upload_manifest(release_file)
  else # Just assume tarball
    upload_tarball(release_file)
  end
end

#upload_manifest(manifest_path) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/cli/commands/release.rb', line 123

def upload_manifest(manifest_path)
  manifest = load_yaml_file(manifest_path)
  remote_release = get_remote_release(manifest["name"]) rescue nil
  remote_jobs = remote_release["jobs"] if remote_release
  remote_packages_sha1 = get_remote_packages(File.read(manifest_path),
                                             remote_release)
  blobstore = release.blobstore
  tmpdir = Dir.mktmpdir

  at_exit { FileUtils.rm_rf(tmpdir) }

  compiler = Bosh::Cli::ReleaseCompiler.new(manifest_path, blobstore,
                                            remote_jobs,
                                            remote_packages_sha1)
  need_repack = true

  unless compiler.exists?
    compiler.tarball_path = File.join(tmpdir, "release.tgz")
    compiler.compile
    need_repack = false
  end
  upload_tarball(compiler.tarball_path, :repack => need_repack)
end

#upload_tarball(tarball_path, options = {}) ⇒ Object 



147
148
149
150
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
 
# File 'lib/cli/commands/release.rb', line 147

def upload_tarball(tarball_path, options = {})
  tarball = Bosh::Cli::ReleaseTarball.new(tarball_path)
  # Trying to repack release by default
  repack  = options.has_key?(:repack) ? !!options[:repack] : true

  say("\nVerifying release...")
  tarball.validate(:allow_sparse => true)
  nl

  unless tarball.valid?
    err("Release is invalid, please fix, verify and upload again")
  end

  begin
    remote_release = get_remote_release(tarball.release_name) rescue nil
    if remote_release
      if remote_release["versions"].include?(tarball.version)
        err("This release version has already been uploaded")
      end
      remote_jobs = remote_release["jobs"]
    end

    if repack
      remote_packages_sha1 = get_remote_packages(tarball.manifest,
                                                 remote_release)

      say("Checking if can repack release for faster upload...")
      repacked_path = tarball.repack(remote_jobs, remote_packages_sha1)
      if repacked_path.nil?
        say("Uploading the whole release".green)
      else
        say("Release repacked " +
            "(new size is #{pretty_size(repacked_path)})".green)
        tarball_path = repacked_path
      end
    end
  rescue Bosh::Cli::DirectorError
    # It's OK for director to choke on getting
    # a release info (think new releases)
  end

  say("\nUploading release...\n")
  status, _ = director.upload_release(tarball_path)

  task_report(status, "Release uploaded")
end

#verify(tarball_path, *options) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cli/commands/release.rb', line 67

def verify(tarball_path, *options)
  tarball = Bosh::Cli::ReleaseTarball.new(tarball_path)

  say("\nVerifying release...")
  tarball.validate
  nl

  if tarball.valid?
    say("'%s' is a valid release" % [tarball_path] )
  else
    say("'%s' is not a valid release:" % [tarball_path] )
    for error in tarball.errors
      say("- %s" % [error])
    end
  end
end