Class: Simp::Rake::Build::Auto

Inherits:
Rake::TaskLib
  • Object
show all
Includes:
Constants
Defined in:
lib/simp/rake/build/auto.rb

Constant Summary collapse

BUILD_REQUIRED_COMMANDS =

Commands that are required by some part of the rake stack

Use an array for commands that may have multiple valid options

[
  'basename',
  'cat',
  'checkmodule',
  'chmod',
  'cp',
  'cpio',
  'createrepo',
  'date',
  'diff',
  'dirname',
  'file',
  'find',
  'gawk',
  'git',
  'gpg',
  'grep',
  'gzip',
  'implantisomd5',
  'install',
  'isoinfo',
  'm4',
  'make',
  'mkdir',
  'mktemp',
  ['python','python2','python3'],
  'readlink',
  'repoclosure',
  'rm',
  'rpm',
  'rpmbuild',
  'rpmdb',
  'rpmsign',
  'sed',
  'semodule_package',
  'setfacl',
  'sh',
  'sort',
  'tail',
  'tar',
  'uname',
  'uniq',
  'wc',
  'which',
  'xargs',
  ['dnf','yum'],
  'yumdownloader'
]

Instance Method Summary collapse

Methods included from Constants

#distro_build_dir, #init_member_vars

Constructor Details

#initialize(run_dir) ⇒ Auto

Returns a new instance of Auto.



74
75
76
77
78
 
# File 'lib/simp/rake/build/auto.rb', line 74

def initialize( run_dir )
  init_member_vars(run_dir)

  define
end

Instance Method Details

#define ⇒ Object

define rake tasks



81
82
83
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
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
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/simp/rake/build/auto.rb', line 81

def define
  namespace :build do

    desc "    Automatically detect and build a SIMP ISO for a target SIMP release.\n\n    This task runs all other build tasks\n\n    Arguments:\n      * :iso_paths    => Path to source ISO(s) and/or directories  [Default: '.']\n                         NOTE: colon-delimited list\n                         If not set, will build all enabled distributions\n      * :release      => SIMP release to build (e.g., '6.X')\n                         The Full list can be found in '\#{File.join(@build_dir, 'release_mappings.yaml')}'\n                         Default: \#{[@simp_version.split('.').first, 'X'].join('.')}\n      * :output_dir   => path to write SIMP ISO. [Default: './SIMP_ISO']\n      * :do_checksum  => Use sha256sum checksum to compare each ISO.  [Default: 'false']\n      * :key_name     => Key name to sign packages [Default: 'dev']\n\n    ENV vars:\n      - SIMP_BUILD_isos            => Path to the base OS ISO images\n      - SIMP_BUILD_distro          => Distribution to build\n                                      See '\#{File.join(@distro_build_dir, 'build_metadata.yaml')}'}\n      - SIMP_BUILD_prompt          => 'no' disables asking questions.\n                                      Will default to a full build and *will* erase existing artifacts.\n      - SIMP_BUILD_staging_dir     => Path to stage big build assets\n                                      [Default: './SIMP_ISO_STAGING']\n      - SIMP_BUILD_rm_staging_dir  => 'no' do not forcibly remove the staging dir before starting\n      - SIMP_BUILD_overlay         => 'no' uses an existing DVD overlay if found\n      - SIMP_BUILD_force_dirty     => 'yes' tries to checks out subrepos even if dirty\n      - SIMP_BUILD_docs            => 'yes' builds & includes documentation\n      - SIMP_BUILD_checkout        => 'no' will skip the git repo checkouts\n      - SIMP_BUILD_bundle          => 'no' skips running bundle in each subrepo\n      - SIMP_BUILD_unpack          => 'no' prevents unpacking the source ISO\n      - SIMP_BUILD_unpack_merge    => 'no' prevents auto-merging the unpacked ISO\n      - SIMP_BUILD_prune           => 'no' passes :prune=>false to iso:build\n      - SIMP_BUILD_iso_name        => Renames the output ISO filename [Default: false]\n      - SIMP_BUILD_iso_tag         => Appended to the output ISO's filename [Default: false]\n      - SIMP_BUILD_update_packages => Automatically update any necessary packages in the packages.yaml file [Default: false]\n      - SIMP_BUILD_verbose         => 'yes' enables verbose reporting. [Default: 'no']\n      - SIMP_BUILD_signing_key     => The name of the GPG key to use to sign packages. [Default: 'dev']\n      - SIMP_BUILD_reposync_only   => 'yes' skips unpacking the locally-build tarball so that you only get items from the reposync directory (if present)\n    EOM\n\n    task :auto, [:iso_paths,\n                 :release,\n                 :output_dir,\n                 :do_checksum,\n                 :key_name\n                ] do |t, args|\n\n      Simp::Rake::Helpers.check_required_commands(BUILD_REQUIRED_COMMANDS)\n\n      args.with_defaults(\n        :iso_paths    => ENV['SIMP_BUILD_isos'] || Dir.pwd,\n        :distribution => 'ALL',\n        :release      => [@simp_version.split('.').first, 'X'].join('.'),\n        :output_dir   => '',\n        :do_checksum  => 'false',\n        :key_name     => ENV['SIMP_BUILD_signing_key'] || 'dev'\n      )\n\n      reposync_only    = ENV.fetch('SIMP_BUILD_reposync_only', 'no') == 'yes'\n      iso_paths        = File.expand_path(args[:iso_paths])\n      target_release   = args[:release]\n      do_checksum      = (args.do_checksum = ~ /^$/ ? 'false' : args.do_checksum)\n      key_name         = args[:key_name]\n      verbose          = ENV.fetch('SIMP_BUILD_verbose', 'no') == 'yes'\n      prompt           = ENV.fetch('SIMP_BUILD_prompt', 'yes') != 'no'\n      method           = ENV.fetch('SIMP_BUILD_puppetfile','tracking')\n      do_rm_staging    = ENV.fetch('SIMP_BUILD_rm_staging_dir', 'yes') == 'yes'\n      build_overlay    = ENV.fetch('SIMP_BUILD_overlay', \"yes\") == 'yes'\n      do_docs          = ENV['SIMP_BUILD_docs'] == 'yes' ? 'true' : 'false'\n      do_merge         = ENV['SIMP_BUILD_unpack_merge'] != 'no'\n      do_prune         = ENV['SIMP_BUILD_prune'] != 'no' ? 'true' : 'false'\n      do_checkout      = ENV['SIMP_BUILD_checkout'] != 'no'\n      do_bundle        = ENV['SIMP_BUILD_bundle'] == 'yes' ? true : false\n      do_unpack        = ENV['SIMP_BUILD_unpack'] != 'no'\n      full_iso_name    = ENV.fetch('SIMP_BUILD_iso_name', false)\n      iso_name_tag     = ENV.fetch('SIMP_BUILD_iso_tag', false)\n\n      iso_status = {}\n\n      distro = @build_distro\n      version = @build_version\n      arch = @build_arch\n\n      tarball          = false\n      repo_root_dir    = File.expand_path( @base_dir )\n\n      fail(\"Cannot Build: No directory '\#{@distro_build_dir}' found\") unless File.directory?(@distro_build_dir)\n\n      begin\n        # For subtask mangling\n        $simp6_build_dir = @distro_build_dir\n        $simp6_build_metadata = {\n          :distro  => distro,\n          :version => version,\n          :arch    => arch\n        }\n\n        output_dir = args[:output_dir].sub(/^$/, File.expand_path( 'SIMP_ISO', @distro_build_dir ))\n\n        staging_dir = ENV.fetch('SIMP_BUILD_staging_dir', File.expand_path( 'SIMP_ISO_STAGING', @distro_build_dir ))\n\n        overlay_dir = File.join(@distro_build_dir, 'DVD_Overlay')\n\n        yaml_file = File.expand_path('release_mappings.yaml', @distro_build_dir)\n\n        tar_file = File.join(overlay_dir, \"SIMP-\#{@simp_version}-\#{distro}-\#{version}-\#{arch}.tar.gz\")\n\n        $simp6_clean_dirs << output_dir\n        $simp6_clean_dirs << staging_dir\n        $simp6_clean_dirs << overlay_dir\n\n        if File.exist?(tar_file)\n          if prompt\n            valid_entry = false\n            while !valid_entry do\n              puts(\"Existing tar file found at \#{tar_file}\")\n              print(\"Do you want to overwrite it? (y|N): \")\n\n              resp = $stdin.gets.chomp\n\n              if resp.empty? || (resp =~ /^(n|N)/)\n                tarball = tar_file\n                valid_entry = true\n              elsif resp =~ /^(y|Y)/\n                tarball = false\n                valid_entry = true\n\n                if verbose\n                  $stderr.puts(\"Notice: Overwriting existing tarball at \#{tar_file}\")\n                  $stderr.puts(\"Notice: PRESS CTRL-C WITHIN 5 SECONDS TO CANCEL\")\n                end\n\n                sleep(5)\n              else\n                puts(\"Invalid input: '\#{resp}', please try again\")\n              end\n            end\n          else\n            unless (build_overlay)\n              tarball = tar_file\n            end\n          end\n        end\n\n        if tarball\n          do_docs     = false\n          do_checkout = false\n          do_bundle   = false\n        end\n\n        @dirty_repos     = nil\n        @simp_output_iso = nil\n\n        # Build environment sanity checks\n        # --------------------\n        if do_rm_staging && !do_unpack\n          fail SIMPBuildException, \"ERROR: Mixing `SIMP_BUILD_rm_staging_dir=yes` and `SIMP_BUILD_unpack=no` is silly.\"\n        end\n\n        if File.exist?(output_dir) && !File.directory?(output_dir)\n          fail SIMPBuildException, \"ERROR: ISO output dir exists but is not a directory:\\n\\n\" +\n                                   \"    '\#{output_dir}'\\n\\n\"\n        end\n\n        unless File.directory?(output_dir)\n          FileUtils.mkdir_p(output_dir)\n        end\n\n        # Look up ISOs against known build assets\n        # --------------------\n        target_data = get_target_data(target_release, iso_paths, yaml_file, do_checksum, verbose )\n\n        # check out subrepos\n        # --------------------\n        if do_checkout && !tarball\n          puts\n          puts '='*80\n          puts \"## Checking out subrepositories\"\n          puts\n          puts \"     (skip with `SIMP_BUILD_checkout=no`)\"\n          puts '='*80\n\n          Dir.chdir repo_root_dir\n          Rake::Task['deps:status'].reenable\n          Rake::Task['deps:status'].invoke\n\n          if @dirty_repos && !ENV['SIMP_BUILD_force_dirty'] == 'yes'\n            raise SIMPBuildException, \"ERROR: Dirty repos detected!  I refuse to destroy uncommitted work.\"\n          else\n            puts\n            puts '-'*80\n            puts \"#### Checking out subrepositories using method '\#{method}'\"\n            puts '-'*80\n            Rake::Task['deps:checkout'].reenable\n            Rake::Task['deps:checkout'].invoke(method)\n          end\n\n          if do_bundle\n            puts\n            puts '-'*80\n            puts \"#### Running bundler in all repos\"\n            puts '     (Disable with `SIMP_BUILD_bundle=no`)'\n            puts '-'*80\n            Rake::Task['build:bundle'].reenable\n            Rake::Task['build:bundle'].invoke\n          else\n            puts\n            puts '-'*80\n            puts \"#### SKIPPED: bundler in all repos\"\n            puts '     (Force with `SIMP_BUILD_bundle=yes`)'\n            puts '-'*80\n          end\n        else\n          puts\n          puts '='*80\n          puts \"#### skipping sub repository checkout (because `SIMP_BUILD_checkout=no`)\"\n          puts\n        end\n\n        # build tarball\n        # --------------------\n        if tarball\n          puts\n          puts '-'*80\n          puts \"#### Using pre-existing tarball:\"\n          puts \"           '\#{tarball}'\"\n          puts\n          puts '-'*80\n\n        else\n          puts\n          puts '='*80\n          puts \"#### Running tar:build\"\n          puts '='*80\n\n          # Horrible state passing magic vars\n          $tarball_tgt = File.join(@distro_build_dir, 'DVD_Overlay', \"SIMP-\#{@simp_version}-\#{distro}-\#{version}-\#{arch}.tar.gz\")\n\n          Rake::Task['tar:build'].reenable\n          Rake::Task['tar:build'].invoke(key_name,do_docs)\n\n          tarball = $tarball_tgt\n        end\n\n        # yum sync\n        # --------------------\n        puts\n        puts '-'*80\n        puts \"#### rake build:yum:sync[\#{target_data['flavor']},\#{target_data['os_version']}]\"\n        puts '-'*80\n        Rake::Task['build:yum:sync'].reenable\n        Rake::Task['build:yum:sync'].invoke(target_data['flavor'],target_data['os_version'])\n\n        # If you have previously downloaded packages from yum, you may need to run\n        # $ rake build:yum:clean_cache\n\n        # Optionally, you may drop in custom packages you wish to have available during an install into build/yum_data/SIMP<simp_version>_<CentOS or RHEL><os_version>_<architecture>/packages\n        # TODO: ENV var for optional packages\n\n        prepare_staging_dir( staging_dir, do_rm_staging, repo_root_dir, verbose )\n        Dir.chdir staging_dir\n\n        #\n        # --------------------\n        if do_unpack\n          puts\n          puts '='*80\n          puts \"#### unpack ISOs into staging directory\"\n          puts \"     staging area: '\#{staging_dir}'\"\n          puts\n          puts \"     (skip with `SIMP_BUILD_unpack=no`)\"\n          puts '='*80\n          puts\n\n          Dir.glob( File.join(staging_dir, \"\#{target_data['flavor']}*/\") ).each do |f|\n            FileUtils.rm_f( f , :verbose => verbose )\n          end\n\n          target_data['isos'].each do |iso|\n            puts \"---- rake unpack[\#{iso},\#{do_merge},\#{Dir.pwd},isoinfo,\#{target_data['os_version']}\#{reposync_only}]\"\n            Rake::Task['unpack'].reenable\n            Rake::Task['unpack'].invoke(iso,do_merge,Dir.pwd,'isoinfo',target_data['os_version'],reposync_only)\n          end\n        else\n          puts\n          puts '='*80\n          puts \"#### skipping ISOs unpack (because `SIMP_BUILD_unpack=no`)\"\n          puts\n        end\n\n        Dir.chdir staging_dir\n\n        puts\n        puts '='*80\n        puts \"#### iso:build[\#{tarball}, \#{staging_dir}, \#{do_prune}]\"\n        puts '='*80\n        puts\n\n        ENV['SIMP_ISO_verbose'] = 'yes' if verbose\n        ENV['SIMP_PKG_verbose'] = 'yes' if verbose\n        Rake::Task['iso:build'].reenable\n        Rake::Task['iso:build'].invoke(tarball,staging_dir,do_prune)\n\n        _isos = Dir[ File.join(staging_dir, 'SIMP-*.iso') ]\n        if _isos.size == 0\n          fail \"ERROR: No SIMP ISOs found in '\#{staging_dir}'\"\n        elsif _isos.size > 1\n          warn \"WARNING: More than one SIMP ISO found in '\#{staging_dir}'\"\n          _isos.each{ |i| warn i }\n        end\n\n        # NOTE: It is possible at this point (given the right\n        # `SIMP_BUILD_xxx=no` flags) that iso:build will not have set\n        # `@simp_output_iso`.  In that case, look at the ISOs in the staging\n        # dir (there should only be one) and take our best guess.\n        if @simp_output_iso.nil?\n           @simp_output_iso = File.basename(_isos.first)\n        end\n\n        output_file = full_iso_name ? full_iso_name : @simp_output_iso\n        if iso_name_tag\n          output_file = output_file.sub(/\\.iso$/i, \"__\#{iso_name_tag}.iso\")\n        end\n\n        puts\n        puts '='*80\n        puts \"#### Moving '\#{@simp_output_iso}' into:\"\n        puts \"       '\#{output_dir}/\#{output_file}'\"\n        puts '='*80\n        puts\n\n        iso = File.join(output_dir,output_file)\n        FileUtils.mkdir_p File.dirname(iso), :verbose => verbose\n        FileUtils.mv(@simp_output_iso, iso, :verbose => verbose)\n\n        var_json = Simp::Packer::IsoVarsJson.new(iso, target_release, target_data, {})\n        var_json.write\n\n        puts\n        puts '='*80\n        puts \"#### FINIS!\"\n        puts '='*80\n        puts\n\n        iso_status[[distro, version, arch].join(' ')] = {\n          'success' => true\n        }\n\n      rescue => e\n        iso_status[[distro, version, arch].join(' ')] = {\n        'success'   => false,\n        'error'     => e.to_s,\n        'backtrace' => e.backtrace\n        }\n      end\n\n      successful_isos = []\n      failed_isos = []\n\n      iso_status.keys.each do |iso|\n        if iso_status[iso]['success']\n          successful_isos << iso\n        else\n          failed_isos << iso\n        end\n      end\n\n      unless successful_isos.empty?\n        puts '='*80\n        puts '='*80\n        puts(\"Successful ISOs:\")\n        puts(%(  * \#{successful_isos.join(\"\\n  * \")}))\n      end\n\n      unless failed_isos.empty?\n        puts '='*80\n        puts(\"Failed ISOs:\")\n        failed_isos.each do |iso|\n          puts(%(  * \#{iso}))\n          puts(%(    * Error: \#{iso_status[iso]['error']}))\n\n          if verbose\n            puts(%(    * Backtrace: \#{iso_status[iso]['backtrace'].join(\"\\n\")}))\n          else\n            puts(%(    * Context: \#{iso_status[iso]['backtrace'].first}))\n          end\n        end\n\n        exit(1)\n      end\n    end\n  end\n\n  def get_target_data(target_release, iso_paths, yaml_file, do_checksum, verbose )\n    puts '='*80\n    puts \"## validating ISOs for target:\"\n    puts \"      '\#{target_release}' in '\#{iso_paths}'\"\n    puts '='*80\n    puts\n\n    mapper          = Simp::Build::ReleaseMapper.new(target_release, yaml_file, do_checksum == 'true')\n    mapper.verbose  = true || verbose\n    target_data     = mapper.autoscan_unpack_list( iso_paths )\n\n    puts '-'*80\n    puts \"## target data:\"\n    puts ''\n    puts \"     target release: '\#{target_release}'\"\n    puts \"     target flavor:  '\#{target_data['flavor']}'\"\n    puts \"     source isos:\"\n    target_data['isos'].each do |iso|\n      puts \"        - \#{iso}\"\n    end\n    puts '-'*80\n    puts\n    sleep 3\n\n    target_data\n  end\n\n\n  def prepare_staging_dir( staging_dir, do_rm_staging, repo_root_dir, verbose )\n    if ['','/',Dir.home,repo_root_dir].include? staging_dir\n      fail SIMPBuildException,\n           \"ERROR: staging directoy path is too stupid to be believed:\\n\"+\n           \"         '\#{staging_dir}'\\n\\n\" +\n           \"       Use SIMP_BUILD_staging_dir='path/to/staging/dir'\\n\\n\"\n    end\n\n    if do_rm_staging\n      puts\n      puts '-'*80\n      puts '#### Ensuring previous staging directory is removed:'\n      puts \"       '\#{staging_dir}'\"\n      puts\n      puts '     (disable this with `SIMP_BUILD_rm_staging_dir=no`)'\n      puts '-'*80\n\n      FileUtils.rm_rf staging_dir, :verbose => verbose\n    elsif File.exist? staging_dir\n      warn ''\n      warn '!'*80\n      warn '#### WARNING: staging dir already exists at:'\n      warn \"              '\#{staging_dir}'\"\n      warn ''\n      warn '              - Previously staged assets in this directory may cause problems.'\n      warn '              - Use `SIMP_BUILD_rm_staging_dir=yes` to remove it automatically.'\n      warn ''\n      warn '!'*80\n      warn ''\n      sleep 10\n    end\n    FileUtils.mkdir_p staging_dir, :verbose => verbose\n  end\n\n\nend\n"

#get_target_data(target_release, iso_paths, yaml_file, do_checksum, verbose) ⇒ Object 



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/simp/rake/build/auto.rb', line 478

def get_target_data(target_release, iso_paths, yaml_file, do_checksum, verbose )
  puts '='*80
  puts "## validating ISOs for target:"
  puts "      '#{target_release}' in '#{iso_paths}'"
  puts '='*80
  puts

  mapper          = Simp::Build::ReleaseMapper.new(target_release, yaml_file, do_checksum == 'true')
  mapper.verbose  = true || verbose
  target_data     = mapper.autoscan_unpack_list( iso_paths )

  puts '-'*80
  puts "## target data:"
  puts ''
  puts "     target release: '#{target_release}'"
  puts "     target flavor:  '#{target_data['flavor']}'"
  puts "     source isos:"
  target_data['isos'].each do |iso|
    puts "        - #{iso}"
  end
  puts '-'*80
  puts
  sleep 3

  target_data
end

#prepare_staging_dir(staging_dir, do_rm_staging, repo_root_dir, verbose) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/simp/rake/build/auto.rb', line 506

def prepare_staging_dir( staging_dir, do_rm_staging, repo_root_dir, verbose )
  if ['','/',Dir.home,repo_root_dir].include? staging_dir
    fail SIMPBuildException,
         "ERROR: staging directoy path is too stupid to be believed:\n"+
         "         '#{staging_dir}'\n\n" +
         "       Use SIMP_BUILD_staging_dir='path/to/staging/dir'\n\n"
  end

  if do_rm_staging
    puts
    puts '-'*80
    puts '#### Ensuring previous staging directory is removed:'
    puts "       '#{staging_dir}'"
    puts
    puts '     (disable this with `SIMP_BUILD_rm_staging_dir=no`)'
    puts '-'*80

    FileUtils.rm_rf staging_dir, :verbose => verbose
  elsif File.exist? staging_dir
    warn ''
    warn '!'*80
    warn '#### WARNING: staging dir already exists at:'
    warn "              '#{staging_dir}'"
    warn ''
    warn '              - Previously staged assets in this directory may cause problems.'
    warn '              - Use `SIMP_BUILD_rm_staging_dir=yes` to remove it automatically.'
    warn ''
    warn '!'*80
    warn ''
    sleep 10
  end
  FileUtils.mkdir_p staging_dir, :verbose => verbose
end