Class: Buildizer::Builder::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/buildizer/builder/base.rb

Direct Known Subclasses

Fpm, Native, Patch

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(buildizer) ⇒ Base

Returns a new instance of Base.



8
9
10
11
12
 
# File 'lib/buildizer/builder/base.rb', line 8

def initialize(buildizer)
  @buildizer = buildizer
  @work_path = buildizer.work_path.join('builder').expand_path
  @docker = Docker.new(self, cache: buildizer.docker_cache)
end

Instance Attribute Details

#buildizer ⇒ Object (readonly)

Returns the value of attribute buildizer.



4
5
6
 
# File 'lib/buildizer/builder/base.rb', line 4

def buildizer
  @buildizer
end

#docker ⇒ Object (readonly)

Returns the value of attribute docker.



6
7
8
 
# File 'lib/buildizer/builder/base.rb', line 6

def docker
  @docker
end

#work_path ⇒ Object (readonly)

Returns the value of attribute work_path.



5
6
7
 
# File 'lib/buildizer/builder/base.rb', line 5

def work_path
  @work_path
end

Instance Method Details

#_required_params!(required_params, params) ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/buildizer/builder/base.rb', line 108

def _required_params!(required_params, params)
  Array(required_params).each do |param|
    unless params[param] and not params[param].to_s.empty?
      raise Error, error: :input_error, message: "Buildizer #{param} is not defined"
    end
  end
end

#build ⇒ Object 



146
147
148
 
# File 'lib/buildizer/builder/base.rb', line 146

def build
  targets.each {|target| build_target(target)}
end

#build_dep(target) ⇒ Object 



25
26
 
# File 'lib/buildizer/builder/base.rb', line 25

def build_dep(target)
end

#build_instructions(target) ⇒ Object 



22
23
 
# File 'lib/buildizer/builder/base.rb', line 22

def build_instructions(target)
end

#build_jobs ⇒ Object 



116
117
118
 
# File 'lib/buildizer/builder/base.rb', line 116

def build_jobs
  File.open('/proc/cpuinfo').readlines.grep(/processor/).size
end

#build_target(target) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/buildizer/builder/base.rb', line 160

def build_target(target)
  cmd = [
    *Array(prepare_package_source_instructions(target)),
    "rm -rf #{docker.container_build_path.join('*')}",
    "cd #{docker.container_package_path}",
    *target.before_build,
    *Array(build_instructions(target)),
  ]

  docker.run_in_image! image: target.build_image,
                       cmd: cmd,
                       desc: "Run build in docker image '#{target.build_image.name}'"
end

#build_type ⇒ Object 



14
15
16
 
# File 'lib/buildizer/builder/base.rb', line 14

def build_type
  raise
end

#check_params!(params) ⇒ Object 



104
105
106
 
# File 'lib/buildizer/builder/base.rb', line 104

def check_params!(params)
  _required_params! :package_name, params
end

#deploy ⇒ Object 



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
 
# File 'lib/buildizer/builder/base.rb', line 263

def deploy
  if buildizer.package_version_tag_required_for_deploy? and
     not buildizer.package_version_tag
    puts "package_version_tag (env TRAVIS_TAG or CI_BUILD_TAG) required: ignoring deploy"
    return
  elsif buildizer.package_cloud.empty?
    buildizer.warn "No package cloud settings " +
                   "(PACKAGECLOUD, PACKAGECLOUD_TOKEN, PACKAGECLOUD_TOKEN_<ORG>)"
    return
  end

  buildizer.package_cloud_org.each do |org, token|
    unless token
      buildizer.warn "No package cloud token defined for org '#{org}' " +
                     "(PACKAGECLOUD_TOKEN or PACKAGECLOUD_TOKEN_#{org.upcase})"
    end
  end

  targets.map do |target|
    target.tap do
      if buildizer.package_version_tag_required_for_deploy? and
         buildizer.package_version_tag != target.package_version_tag
        raise(Error, error: :logical_error,
                     message: "#{target.package_version_tag_param_name} and "+
                              "package_version_tag (env TRAVIS_TAG or CI_BUILD_TAG) " +
                              "should be the same for target '#{target.name}'")
      end
    end
  end.each {|target| deploy_target(target)}
end

#deploy_target(target) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/buildizer/builder/base.rb', line 294

def deploy_target(target)
  cmd = Dir[target.image_build_path.join("*.#{target.os.fpm_output_type}")]
          .map {|p| Pathname.new(p)}.map {|package_path|
            package = package_path.basename
            target.package_cloud.map do |desc|
              desc.merge(
                package: package,
                yank: "package_cloud yank #{desc[:package_path]} #{package}",
                push: "package_cloud push #{desc[:package_path]} #{package_path}",
              )
            end
          }.flatten.each {|desc|
            buildizer.command desc[:yank],
              desc: ["Package cloud yank package '#{desc[:package]}'",
                     " of target '#{target.name}'"].join,
              environment: {'PACKAGECLOUD_TOKEN' => desc[:token]}

            buildizer.command desc[:push],
              desc: ["Package cloud push package '#{desc[:package]}'",
                     " of target '#{target.name}'"].join,
              environment: {'PACKAGECLOUD_TOKEN' =>desc[:token]}
          }
end

#do_merge_params(into, params) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/buildizer/builder/base.rb', line 87

def do_merge_params(into, params)
  {}.tap do |res|
    res[:package_name] = params['package_name'] || into[:package_name]
    res[:package_version] = params['package_version'] || into[:package_version]
    res[:package_cloud] = into[:package_cloud]
    res[:prepare] = into[:prepare] + Array(params['prepare'])
    res[:build_dep] = into[:build_dep] | Array(params['build_dep']).to_set
    res[:before_build] = into[:before_build] + Array(params['before_build'])
    res[:maintainer] = params['maintainer'] || into[:maintainer]

    res[:test_options] = into[:test_options].merge params['test_options'].to_h
    res[:test_env] = into[:test_env].merge(params['test_env'].to_h)
    res[:before_test] = into[:before_test] + Array(params['before_test'])
    res[:test] = into[:test] + Array(params['test'])
  end
end

#initial_target_params ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/buildizer/builder/base.rb', line 63

def initial_target_params
  {}.tap do |params|
    params[:package_name] = buildizer.buildizer_conf['package_name']
    params[:package_version] = buildizer.buildizer_conf['package_version']
    params[:package_cloud] = buildizer.package_cloud
    params[:prepare] = Array(buildizer.buildizer_conf['prepare'])
    params[:build_dep] = Array(buildizer.buildizer_conf['build_dep']).to_set
    params[:before_build] = Array(buildizer.buildizer_conf['before_build'])
    params[:maintainer] = buildizer.buildizer_conf['maintainer']

    params[:test_options] = Hash(buildizer.buildizer_conf['test_options'])
    params[:test_env] = buildizer.buildizer_conf['test_env'].to_h
    params[:before_test] = Array(buildizer.buildizer_conf['before_test'])
    params[:test] = Array(buildizer.buildizer_conf['test'])
  end
end

#install_test_package_instructions(target) ⇒ Object 



209
210
211
 
# File 'lib/buildizer/builder/base.rb', line 209

def install_test_package_instructions(target)
  target.os.install_test_package_instructions(target)
end

#merge_params(into: nil, params:) {|into, params| ... } ⇒ Object

Yields:

  • (into, params) 


80
81
82
83
84
85
 
# File 'lib/buildizer/builder/base.rb', line 80

def merge_params(into: nil, params:, &blk)
  into ||= initial_target_params
  params ||= {}
  yield into, params if block_given?
  do_merge_params into, params
end

#new_target(target_name) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/buildizer/builder/base.rb', line 28

def new_target(target_name)
  os_name, os_version, target_tag = target_name.split('/', 3)

  os = docker.new_os(os_name, os_version)

  params = initial_target_params
  buildizer.buildizer_conf.each do |match_key, match_params|
    match_os_name, match_os_version, match_target_tag = match_key.to_s.split('/', 3)
    if os.name.match_glob?(match_os_name) and
      ( match_os_version.nil? or os.version.match_glob?(match_os_version) ) and
        ( match_target_tag.nil? or (not target_tag.nil? and
                                    target_tag.match_glob?(match_target_tag)) )
      params = merge_params(into: params, params: match_params)
    end
  end

  check_params! params

  target_klass.new(self, os, name: target_name, **params)
end

#prepare ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/buildizer/builder/base.rb', line 128

def prepare
  docker.with_cache do
    Array(buildizer.buildizer_conf['before_prepare'])
      .each {|cmd| buildizer.command! cmd, desc: "Before prepare command: #{cmd}"}

    targets.each {|target| prepare_target_build_image(target)}

    Array(buildizer.buildizer_conf['after_prepare'])
      .each {|cmd| buildizer.command! cmd, desc: "After prepare command: #{cmd}"}
  end # with_cache
end

#prepare_package_source_instructions(target) ⇒ Object 



150
151
152
153
154
155
156
157
158
 
# File 'lib/buildizer/builder/base.rb', line 150

def prepare_package_source_instructions(target)
  ["cp -r #{docker.container_package_mount_path} #{target.container_package_path}",
   "rm -rf #{target.container_package_path.join('.git')}",
   "cd #{target.container_package_path.dirname}",
   ["tar -zcvf #{target.container_package_archive_path} ",
    "#{target.container_package_path.basename}"].join,
   "ln -fs #{target.container_package_path} #{docker.container_package_path}",
   "ln -fs #{target.container_package_archive_path} #{docker.container_package_archive_path}"]
end

#prepare_target_build_image(target) ⇒ Object 



140
141
142
143
144
 
# File 'lib/buildizer/builder/base.rb', line 140

def prepare_target_build_image(target)
  target.prepare.each {|cmd| target.build_image.instruction(:RUN, "bash -lec \"#{cmd}\"")}
  target.os.build_dep(target.build_image, Array(build_dep(target)).to_set + target.build_dep)
  docker.make_build_image target
end

#prepare_test_container_instructions(target) ⇒ Object 



213
214
215
 
# File 'lib/buildizer/builder/base.rb', line 213

def prepare_test_container_instructions(target)
  target.os.prepare_test_container_instructions(target)
end

#target_klass ⇒ Object 



18
19
20
 
# File 'lib/buildizer/builder/base.rb', line 18

def target_klass
  raise
end

#target_names ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'lib/buildizer/builder/base.rb', line 49

def target_names
  @target_names ||= begin
    targets = Array(buildizer.buildizer_conf['target'])
    restrict_targets = ENV['BUILDIZER_TARGET']
    restrict_targets = restrict_targets.split(',').map(&:strip) if restrict_targets
    targets = targets & restrict_targets if restrict_targets
    targets
  end
end

#targets ⇒ Object 



59
60
61
 
# File 'lib/buildizer/builder/base.rb', line 59

def targets
  @targets ||= target_names.map {|name| new_target(name)}
end

#test ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/buildizer/builder/base.rb', line 174

def test
  failures = targets
    .map {|target| [target, Array(test_target(target))]}
    .reduce([]) {|res, (target, results)|
      res.push *results.map {|res|
        {target: target,
         result: res}
      }
    }
    .select {|test| test[:result].net_status_error?}

  if failures.any?
    puts
    puts "Buildizer test FAILED:"
    failures.each do |failure|
      puts "* #{failure[:target].name} env=#{failure[:result][:data][:env]}"
      puts failure[:result][:message]
      puts
    end

    raise Error, message: "test failed"
  end
end

#test_target(target) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/buildizer/builder/base.rb', line 198

def test_target(target)
  unless target.test.any? or buildizer.options[:shell]
    buildizer.warn "No tests found for target '#{target.name}' (use directive 'test')"
    return
  end

  target
    .test_env
    .map {|env| test_target_env(target, env)}
end

#test_target_env(target, env) ⇒ Object 



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
 
# File 'lib/buildizer/builder/base.rb', line 217

def test_target_env(target, env)
  container_name = SecureRandom.uuid
  docker_opts = (target.test_options['docker'] || {}).zymbolize_keys

  docker.with_container(
    name: container_name,
    image: target.test_image,
    env: env.merge(TERM: ENV['TERM']),
    docker_opts: docker_opts,
    desc: "Run test container '#{container_name}' " +
          "target='#{target.name}' env=#{env}"
  ) do |container|
    before_test_cmd = [*Array(prepare_package_source_instructions(target)),
                       *Array(prepare_test_container_instructions(target)),
                       *Array(install_test_package_instructions(target)),
                       "cd #{docker.container_package_path}",
                       *target.before_test]

    docker.run_in_container! container: container,
                             cmd: before_test_cmd,
                             docker_opts: {tty: true},
                             desc: "Run before_test stage in test container '#{container}'"

    ret = {data: {env: env}}

    if buildizer.options[:shell]
      docker.shell_in_container container: container
    else
      test_cmd = ["cd #{docker.container_package_path}", *target.test]

      res = docker.run_in_container container: container,
                                    cmd: test_cmd,
                                    cmd_opts: {live_log: true, log_failure: false},
                                    docker_opts: {tty: true},
                                    desc: "Run test stage in test container '#{container}'"

      unless res.status.success?
        ret[:error] = :error
        ret[:message] = res.stdout + res.stderr
      end
    end

    ret
  end # with_container
end

#verify ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/buildizer/builder/base.rb', line 120

def verify
  targets.tap do |res|
    unless res.any?
      raise Error, error: :input_error, message: "Buildizer target is not defined"
    end
  end
end