Class: Bosh::Cli::ReleaseBuilder

Inherits:
Object
  • Object
show all
Includes:
DependencyHelper, VersionCalc
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 VersionCalc

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

Methods included from DependencyHelper

#tsort_packages

Constructor Details

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

Returns a new instance of ReleaseBuilder.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/cli/release_builder.rb', line 16

def initialize(release, packages, jobs, options = { })
  @release = release
  @final = options.has_key?(:final) ? !!options[:final] : false
  @packages = packages
  @jobs = jobs

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

  @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.



10
11
12
 
# File 'lib/cli/release_builder.rb', line 10

def build_dir
  @build_dir
end

#jobs ⇒ Object (readonly)

Returns the value of attribute jobs.



10
11
12
 
# File 'lib/cli/release_builder.rb', line 10

def jobs
  @jobs
end

#packages ⇒ Object (readonly)

Returns the value of attribute packages.



10
11
12
 
# File 'lib/cli/release_builder.rb', line 10

def packages
  @packages
end

#release ⇒ Object (readonly)

Returns the value of attribute release.



10
11
12
 
# File 'lib/cli/release_builder.rb', line 10

def release
  @release
end

#version ⇒ String

Returns Release version.

Returns:

  • (String) —

    Release version



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

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.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cli/release_builder.rb', line 52

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



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cli/release_builder.rb', line 70

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



95
96
97
98
99
100
101
102
103
 
# File 'lib/cli/release_builder.rb', line 95

def copy_jobs
  jobs.each do |job|
    say("%-40s %s" % [job.name.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



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cli/release_builder.rb', line 83

def copy_packages
  packages.each do |package|
    say("%-40s %s" % [package.name.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 



196
197
198
 
# File 'lib/cli/release_builder.rb', line 196

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

#final? ⇒ Boolean

Returns Is release final?.

Returns:

  • (Boolean) —

    Is release final?



46
47
48
 
# File 'lib/cli/release_builder.rb', line 46

def final?
  @final
end

#final_releases_dir ⇒ Object 



192
193
194
 
# File 'lib/cli/release_builder.rb', line 192

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

#generate_manifest ⇒ Object

Generates release manifest



106
107
108
109
110
111
112
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
 
# File 'lib/cli/release_builder.rb', line 106

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["name"] = release_name

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

  fingerprint = make_fingerprint(manifest)

  if @index[fingerprint]
    old_version = @index[fingerprint]["version"]
    say("This version is no different from version #{old_version}")
    @version = old_version
  else
    @version = assign_version
    @index.add_version(fingerprint, { "version" => @version })
  end

  manifest["version"] = @version
  manifest_yaml = YAML.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 



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

def generate_tarball
  generate_manifest unless @manifest_generated
  return if @index.version_exists?(@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

#make_fingerprint(item) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/cli/release_builder.rb', line 208

def make_fingerprint(item)
  case item
  when Array
    source = item.map { |e| make_fingerprint(e) }.sort.join("")
  when Hash
    source = item.keys.sort.map{ |k| make_fingerprint(item[k]) }.join("")
  else
    source = item.to_s
  end
  Digest::SHA1.hexdigest(source)
end

#manifest_path ⇒ Object 



204
205
206
 
# File 'lib/cli/release_builder.rb', line 204

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

#release_name ⇒ String

Returns Release name.

Returns:



35
36
37
38
 
# File 'lib/cli/release_builder.rb', line 35

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

#releases_dir ⇒ Object 



188
189
190
 
# File 'lib/cli/release_builder.rb', line 188

def releases_dir
  @final ? final_releases_dir : dev_releases_dir
end

#tarball_path ⇒ Object 



200
201
202
 
# File 'lib/cli/release_builder.rb', line 200

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