Class: Bosh::Cli::ReleaseBuilder

Inherits:
Object
  • Object
show all
Includes:
DependencyHelper
Defined in:
lib/cli/release_builder.rb

Constant Summary collapse

DEFAULT_RELEASE_NAME = 
"bosh_release"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DependencyHelper

#tsort_packages

Constructor Details

#initialize(release, packages, jobs, options = { }) ⇒ ReleaseBuilder

Returns a new instance of ReleaseBuilder.

Parameters:

Raises:



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/cli/release_builder.rb', line 13

def initialize(release, packages, jobs, options = { })
  @release = release
  @final = options.has_key?(:final) ? !!options[:final] : false
  @commit_hash = options.fetch(:commit_hash, '00000000')
  @uncommitted_changes = options.fetch(:uncommitted_changes, true)
  @packages = packages
  @jobs = jobs
  @version = options.fetch(:version, nil)

  raise ReleaseVersionError.new('Version numbers cannot be specified for dev releases') if (@version && !@final)

  @final_index = VersionsIndex.new(final_releases_dir)
  @dev_index = VersionsIndex.new(dev_releases_dir)
  @index = @final ? @final_index : @dev_index
  @release_storage = LocalVersionStorage.new(@index.storage_dir, release_name)

  if @version && @release_storage.has_file?(@version)
    raise ReleaseVersionError.new('Release version already exists')
  end

  @build_dir = Dir.mktmpdir

  in_build_dir do
    FileUtils.mkdir("packages")
    FileUtils.mkdir("jobs")
  end
end

Instance Attribute Details

#build_dir ⇒ Object (readonly)

Returns the value of attribute build_dir.



7
8
9
 
# File 'lib/cli/release_builder.rb', line 7

def build_dir
  @build_dir
end

#commit_hash ⇒ Object (readonly)

Returns the value of attribute commit_hash.



7
8
9
 
# File 'lib/cli/release_builder.rb', line 7

def commit_hash
  @commit_hash
end

#jobs ⇒ Object (readonly)

Returns the value of attribute jobs.



7
8
9
 
# File 'lib/cli/release_builder.rb', line 7

def jobs
  @jobs
end

#packages ⇒ Object (readonly)

Returns the value of attribute packages.



7
8
9
 
# File 'lib/cli/release_builder.rb', line 7

def packages
  @packages
end

#release ⇒ Object (readonly)

Returns the value of attribute release.



7
8
9
 
# File 'lib/cli/release_builder.rb', line 7

def release
  @release
end

#uncommitted_changes ⇒ Object (readonly)

Returns the value of attribute uncommitted_changes.



7
8
9
 
# File 'lib/cli/release_builder.rb', line 7

def uncommitted_changes
  @uncommitted_changes
end

#version ⇒ String (readonly)

Returns Release version.

Returns:

  • (String) —

    Release version



48
49
50
 
# File 'lib/cli/release_builder.rb', line 48

def version
  @version
end

Instance Method Details

#affected_jobs ⇒ Array

Returns List of jobs affected by this release compared to the previous one.

Returns:

  • (Array) —

    List of jobs affected by this release compared to the previous one.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cli/release_builder.rb', line 59

def affected_jobs
  result = Set.new(@jobs.select { |job| job.new_version? })
  return result if @packages.empty?

  new_package_names = @packages.inject([]) do |list, package|
    list << package.name if package.new_version?
    list
  end

  @jobs.each do |job|
    result << job if (new_package_names & job.packages).size > 0
  end

  result.to_a
end

#build(options = {}) ⇒ Object

Builds release

Parameters:

  • options (Hash) (defaults to: {}) —

    Release build options



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cli/release_builder.rb', line 77

def build(options = {})
  options = { :generate_tarball => true }.merge(options)

  header("Generating manifest...")
  generate_manifest
  if options[:generate_tarball]
    header("Generating tarball...")
    generate_tarball
  end
  @build_complete = true
end

#copy_jobs ⇒ Object

Copies jobs into release



102
103
104
105
106
107
108
109
110
 
# File 'lib/cli/release_builder.rb', line 102

def copy_jobs
  jobs.each do |job|
    say("%-40s %s" % [job.name.make_green, pretty_size(job.tarball_path)])
    FileUtils.cp(job.tarball_path,
                 File.join(build_dir, "jobs", "#{job.name}.tgz"),
                 :preserve => true)
  end
  @jobs_copied = true
end

#copy_packages ⇒ Object

Copies packages into release



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cli/release_builder.rb', line 90

def copy_packages
  packages.each do |package|
    say("%-40s %s" % [package.name.make_green,
                       pretty_size(package.tarball_path)])
    FileUtils.cp(package.tarball_path,
                 File.join(build_dir, "packages", "#{package.name}.tgz"),
                 :preserve => true)
  end
  @packages_copied = true
end

#dev_releases_dir ⇒ Object 



198
199
200
 
# File 'lib/cli/release_builder.rb', line 198

def dev_releases_dir
  File.join(@release.dir, "dev_releases")
end

#final? ⇒ Boolean

Returns Is release final?.

Returns:

  • (Boolean) —

    Is release final?



53
54
55
 
# File 'lib/cli/release_builder.rb', line 53

def final?
  @final
end

#final_releases_dir ⇒ Object 



194
195
196
 
# File 'lib/cli/release_builder.rb', line 194

def final_releases_dir
  File.join(@release.dir, "releases")
end

#generate_manifest ⇒ Object

Generates release manifest



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/cli/release_builder.rb', line 113

def generate_manifest
  manifest = {}
  manifest["packages"] = []

  manifest["packages"] = packages.map do |package|
    {
      "name" => package.name,
      "version" => package.version,
      "sha1" => package.checksum,
      "fingerprint" => package.fingerprint,
      "dependencies" => package.dependencies
    }
  end

  manifest["jobs"] = jobs.map do |job|
    {
      "name" => job.name,
      "version" => job.version,
      "fingerprint" => job.fingerprint,
      "sha1" => job.checksum,
    }
  end

  manifest["commit_hash"] = commit_hash
  manifest["uncommitted_changes"] = uncommitted_changes

  manifest["name"] = release_name

  unless manifest["name"].bosh_valid_id?
    raise InvalidRelease, "Release name `#{manifest["name"]}' is not a valid BOSH identifier"
  end

  # New release versions are allowed to have the same fingerprint as old versions.
  # For reverse compatibility, random uuids are stored instead.
  @index.add_version(SecureRandom.uuid, { "version" => version })

  manifest["version"] = version
  manifest_yaml = Psych.dump(manifest)

  say("Writing manifest...")
  File.open(File.join(build_dir, "release.MF"), "w") do |f|
    f.write(manifest_yaml)
  end

  File.open(manifest_path, "w") do |f|
    f.write(manifest_yaml)
  end

  @manifest_generated = true
end

#generate_tarball ⇒ Object 



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
 
# File 'lib/cli/release_builder.rb', line 164

def generate_tarball
  generate_manifest unless @manifest_generated
  return if @release_storage.has_file?(@version)

  unless @jobs_copied
    header("Copying jobs...")
    copy_jobs
    nl
  end
  unless @packages_copied
    header("Copying packages...")
    copy_packages
    nl
  end

  FileUtils.mkdir_p(File.dirname(tarball_path))

  in_build_dir do
    `tar -czf #{tarball_path} . 2>&1`
    unless $?.exitstatus == 0
      raise InvalidRelease, "Cannot create release tarball"
    end
    say("Generated #{tarball_path}")
  end
end

#manifest_path ⇒ Object 



206
207
208
 
# File 'lib/cli/release_builder.rb', line 206

def manifest_path
  File.join(releases_dir, "#{release_name}-#{version}.yml")
end

#release_name ⇒ String

Returns Release name.

Returns:



42
43
44
45
 
# File 'lib/cli/release_builder.rb', line 42

def release_name
  name = @final ? @release.final_name : @release.dev_name
  name.blank? ? DEFAULT_RELEASE_NAME : name
end

#releases_dir ⇒ Object 



190
191
192
 
# File 'lib/cli/release_builder.rb', line 190

def releases_dir
  @final ? final_releases_dir : dev_releases_dir
end

#tarball_path ⇒ Object 



202
203
204
 
# File 'lib/cli/release_builder.rb', line 202

def tarball_path
  File.join(releases_dir, "#{release_name}-#{version}.tgz")
end