Class: Simp::Rake::Pkg

Inherits:
Rake::TaskLib
  • Object
show all
Includes:
Helpers::RPMSpec
Defined in:
lib/simp/rake/pkg.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers::RPMSpec

#rpm_template

Methods included from Build::Constants

#init_member_vars, #os_build_metadata

Constructor Details

#initialize(base_dir, unique_name = nil, unique_namespace = nil, simp_version = nil) {|_self| ... } ⇒ Pkg

Returns a new instance of Pkg.

Yields:

  • (_self)

Yield Parameters:



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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/simp/rake/pkg.rb', line 41

def initialize( base_dir, unique_name=nil, unique_namespace=nil, simp_version=nil )
  @base_dir            = base_dir
  @pkg_name            = File.basename(@base_dir)
  @pkg_dir             = File.join(@base_dir, 'dist')
  @pkg_tmp_dir         = File.join(@pkg_dir, 'tmp')
  @pkg_stash_dir       = File.join(@pkg_tmp_dir, '.stash')
  @exclude_list        = [ File.basename(@pkg_dir) ]
  @clean_list          = []
  @ignore_changes_list = [
    'Gemfile.lock',
    'spec/fixtures/modules'
  ]
  @chroot_name         = unique_name

  local_spec = Dir.glob(File.join(@base_dir, 'build', '*.spec'))
  unless local_spec.empty?
    @spec_file = local_spec.first
  else
    FileUtils.mkdir_p(@pkg_stash_dir) unless File.directory?(@pkg_stash_dir)

    @spec_tempfile = File.open(File.join(@pkg_tmp_dir, "#{@pkg_name}.spec"), 'w')
    @spec_tempfile.write(rpm_template(simp_version))

    @spec_file = @spec_tempfile.path

    @spec_tempfile.flush
    @spec_tempfile.close

    FileUtils.chmod(0640, @spec_file)
  end

  # The following are required to build successful RPMs using the new
  # LUA-based RPM template

  @puppet_module_info_files = [
    @spec_file,
    %(#{@base_dir}/build),
    %(#{@base_dir}/CHANGELOG),
    %(#{@base_dir}/metadata.json)
  ]

  ::CLEAN.include( @pkg_dir )

  yield self if block_given?

  ::CLEAN.include( @clean_list )

  if unique_namespace
    namespace unique_namespace.to_sym do
      define
    end
  else
    define
  end
end

Instance Attribute Details

#base_dir ⇒ Object

path to the project’s directory. Usually ‘File.dirname(__FILE__)`



19
20
21
 
# File 'lib/simp/rake/pkg.rb', line 19

def base_dir
  @base_dir
end

#clean_list ⇒ Object

array of items to additionally clean



34
35
36
 
# File 'lib/simp/rake/pkg.rb', line 34

def clean_list
  @clean_list
end

#exclude_list ⇒ Object

array of items to exclude from the tarball



31
32
33
 
# File 'lib/simp/rake/pkg.rb', line 31

def exclude_list
  @exclude_list
end

#ignore_changes_list ⇒ Object

array of items to ignore when checking if the tarball needs to be rebuilt



37
38
39
 
# File 'lib/simp/rake/pkg.rb', line 37

def ignore_changes_list
  @ignore_changes_list
end

#pkg_dir ⇒ Object

path to the directory to place generated assets (e.g., rpm, srpm, tar.gz)



28
29
30
 
# File 'lib/simp/rake/pkg.rb', line 28

def pkg_dir
  @pkg_dir
end

#pkg_name ⇒ Object

the name of the package. Usually ‘File.basename(@base_dir)`



22
23
24
 
# File 'lib/simp/rake/pkg.rb', line 22

def pkg_name
  @pkg_name
end

#spec_file ⇒ Object

path to the project’s RPM specfile



25
26
27
 
# File 'lib/simp/rake/pkg.rb', line 25

def spec_file
  @spec_file
end

#spec_info ⇒ Object (readonly)

Returns the value of attribute spec_info.



39
40
41
 
# File 'lib/simp/rake/pkg.rb', line 39

def spec_info
  @spec_info
end

Class Method Details

.get_mock_configs ⇒ Object

helper methods

Get a list of all of the mock configs available on the system.



440
441
442
 
# File 'lib/simp/rake/pkg.rb', line 440

def Pkg.get_mock_configs
  Dir.glob('/etc/mock/*.cfg').sort.map{ |x| x = File.basename(x,'.cfg')}
end

Instance Method Details

#define ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/simp/rake/pkg.rb', line 97

def define
  # For the most part, we don't want to hear Rake's noise, unless it's an error
  # TODO: Make this configurable
  verbose(false)

  define_clean
  define_clobber
  define_pkg_tar
  define_pkg_srpm
  define_pkg_rpm
  define_pkg_scrub
  task :default => 'pkg:tar'

  Rake::Task['pkg:tar'].enhance(['pkg:restore_stash'])
  Rake::Task['pkg:srpm'].enhance(['pkg:restore_stash'])
  Rake::Task['pkg:rpm'].enhance(['pkg:restore_stash'])

  self
end

#define_clean ⇒ Object 



189
190
191
192
193
194
195
196
 
# File 'lib/simp/rake/pkg.rb', line 189

def define_clean
  desc <<-EOM
  Clean build artifacts for #{@pkg_name} (except for mock)
  EOM
  task :clean do |t,args|
    # this is provided by 'rake/clean' and the ::CLEAN constant
  end
end

#define_clobber ⇒ Object 



198
199
200
201
202
203
204
 
# File 'lib/simp/rake/pkg.rb', line 198

def define_clobber
  desc <<-EOM
  Clobber build artifacts for #{@pkg_name} (except for mock)
  EOM
  task :clobber do |t,args|
  end
end

#define_pkg_rpm ⇒ Object 



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
 
# File 'lib/simp/rake/pkg.rb', line 347

def define_pkg_rpm
  namespace :pkg do
    desc <<-EOM
    Build the #{@pkg_name} RPM.
      Building RPMs requires a working Mock setup (http://fedoraproject.org/wiki/Projects/Mock)
        * :chroot - The Mock chroot configuration to use. See the '--root' option in mock(1)."
        * :unique - Whether or not to build the RPM in a unique Mock environment.
                    This can be very useful for parallel builds of all modules.
        * :snapshot_release - Add snapshot_release (date and time) to rpm version.
                    Rpm spec file must have macro for this to work.

        By default, the package will be built to support a SIMP-6.X file structure.
        To build the package for a different version of SIMP, export SIMP_BUILD_version=<5.X,4.X>
    EOM
    task :rpm,[:chroot,:unique,:snapshot_release] => [:srpm] do |t,args|
      args.with_defaults(:unique => 'false')
      args.with_defaults(:snapshot_release => 'false')

      l_date = ''
      if args[:snapshot_release] == 'true'
        l_date = '.' + "#{TIMESTAMP}"
        mocksnap = "-D 'snapshot_release #{l_date}'"
        @tar_dest = "#{@pkg_dir}/#{@full_pkg_name}#{l_date}.tar.gz"
      end

      rpms = Dir.glob(%(#{@pkg_dir}/#{@spec_info[:name]}-*#{@spec_info[:version]}-*#{l_date}*.rpm))

      srpms = rpms.select{|x| x =~ /src\.rpm$/}
      rpms = (rpms - srpms)

      # Get rid of any RPMs that are not of this distribution build if we
      # have found one
      if @spec_info[:dist_tag]
        rpms.delete_if do |rpm|
          if rpm.split(@spec_info[:dist_tag]).last != ".#{@spec_info[:arch]}.rpm"
            if File.exist?(rpm)
              stash(rpm)
            end

            true
          else
            false
          end
        end
      end

      srpms.each do |srpm|
        dirname = File.dirname(srpm)
        basename = File.basename(srpm,'.src.rpm')
        srpm_info = Simp::RPM.get_info(srpm)

        rpm = [File.join(dirname, basename), srpm_info[:arch], 'rpm'].join('.')
        if require_rebuild?(rpm, srpm)
          mock_cmd = mock_pre_check(args[:chroot], @chroot_name, args[:unique])

          cmd = %Q(#{mock_cmd} --root #{args[:chroot]} #{mocksnap} #{srpm})

          sh cmd

          # remote chroot unless told not to (saves LOTS of space during ISO builds)
          unless ENV['SIMP_RAKE_MOCK_cleanup'] == 'no'
            cmd = %Q(#{mock_cmd} --root #{args[:chroot]} --clean)
            sh cmd
          end
        end
      end
    end
  end
end

#define_pkg_scrub ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/simp/rake/pkg.rb', line 417

def define_pkg_scrub
  namespace :pkg do
    # :pkg:scrub
    # -----------------------------
    desc <<-EOM
    Scrub the #{@pkg_name} mock build directory.
    EOM
    task :scrub,[:chroot,:unique] do |t,args|
      args.with_defaults(:unique => 'false')

      mock_cmd = mock_pre_check( args[:chroot], @chroot_name, args[:unique], false )
      cmd = %Q(#{mock_cmd} --scrub=all)
      sh cmd
    end

  end

end

#define_pkg_srpm ⇒ Object 



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
 
# File 'lib/simp/rake/pkg.rb', line 280

def define_pkg_srpm
  namespace :pkg do
    desc <<-EOM
    Build the #{@pkg_name} SRPM.
      Building RPMs requires a working Mock setup (http://fedoraproject.org/wiki/Projects/Mock)
        * :chroot - The Mock chroot configuration to use. See the '--root' option in mock(1)."
        * :unique - Whether or not to build the SRPM in a unique Mock environment.
                    This can be very useful for parallel builds of all modules.
        * :snapshot_release - Add snapshot_release (date and time) to rpm version.
                    Rpm spec file must have macro for this to work.

        By default, the package will be built to support a SIMP-6.X file structure.
        To build the package for a different version of SIMP, export SIMP_BUILD_version=<5.X,4.X>
   EOM
    task :srpm,[:chroot,:unique,:snapshot_release] => [:tar] do |t,args|
      args.with_defaults(:unique => 'false')
      args.with_defaults(:snapshot_release => 'false')

      l_date = ''
      if args[:snapshot_release] == 'true'
        l_date = '.' + "#{TIMESTAMP}"
        mocksnap = "-D 'snapshot_release #{l_date}'"
        @tar_dest = "#{@pkg_dir}/#{@full_pkg_name}#{l_date}.tar.gz"
      end

      srpms = Dir.glob(%(#{@pkg_dir}/#{@spec_info[:name]}*-#{@spec_info[:version]}-*#{l_date}*.src.rpm))

      # Get rid of any SRPMs that are not of this distribution build if we
      # have found one
      if @spec_info[:dist_tag]
        srpms.delete_if do |srpm|
          if srpm.split(@spec_info[:dist_tag]).last != '.src.rpm'
            if File.exist?(srpm)
              stash(srpm)
            end

            true
          else
            false
          end
        end
      end

      if require_rebuild?(srpms, @tar_dest)

        mock_cmd = mock_pre_check( args[:chroot], @chroot_name, args[:unique] )

        @puppet_module_info_files.each do |file|
          next unless File.exist?(file)

          Find.find(file) do |path|
            next if File.directory?(path)

            tgt_file = File.join(@pkg_dir, File.basename(path))
            FileUtils.remove_entry_secure(tgt_file) if File.exist?(tgt_file)
            FileUtils.cp(path, @pkg_dir) if File.exist?(path)
          end
        end

        cmd = %Q(#{mock_cmd} --root #{args[:chroot]} #{mocksnap} --buildsrpm --spec #{@spec_file} --sources #{@pkg_dir})

        sh cmd
      end
    end
  end
end

#define_pkg_tar ⇒ Object 



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
 
# File 'lib/simp/rake/pkg.rb', line 206

def define_pkg_tar
  namespace :pkg do
    directory @pkg_dir

    task :restore_stash do |t,args|
      at_exit { restore_stash }
    end

    task :initialize_spec_info,[:chroot,:unique] => [@pkg_dir] do |t,args|
      args.with_defaults(:chroot => nil)
      args.with_defaults(:unique => false)

      initialize_spec_info(args[:chroot], args[:unique])
    end

    # :pkg:tar
    # -----------------------------
    desc <<-EOM
    Build the #{@pkg_name} tar package.
        * :snapshot_release - Add snapshot_release (date and time) to rpm
                              version, rpm spec file must have macro for
                              this to work.
    EOM
    task :tar,[:chroot,:unique,:snapshot_release] => [:initialize_spec_info] do |t,args|
      args.with_defaults(:snapshot_release => 'false')
      args.with_defaults(:chroot => nil)
      args.with_defaults(:unique => 'false')

      l_date = ''
      if args[:snapshot_release] == 'true'
        l_date = '.' + "#{TIMESTAMP}"
        @tar_dest = "#{@pkg_dir}/#{@full_pkg_name}#{l_date}.tar.gz"
      end

      # Remove any tar files that are not from this version
      tar_files = Dir.glob(%(#{@pkg_dir}/#{@spec_info[:name]}-#{@spec_info[:version]}*.tar.gz))
      tar_files.delete(@tar_dest)
      tar_files.each do |tf|
        stash(tf)
      end

      target_dir = File.basename(@base_dir)

      Dir.chdir(%(#{@base_dir}/..)) do
        require_rebuild = false
        if File.exist?(@tar_dest)
          Find.find(target_dir) do |path|
            filename = File.basename(path)

            Find.prune if filename =~ /^\./
            Find.prune if ((filename == File.basename(@pkg_dir)) && File.directory?(path))

            to_ignore = @ignore_changes_list.map{|x| x = Dir.glob(File.join(@base_dir, x))}.flatten
            Find.prune if to_ignore.include?(File.expand_path(path))

            next if File.directory?(path)

            unless uptodate?(@tar_dest,[path])
              require_rebuild = true
              break
            end
          end
        else
          require_rebuild = true
        end

        if require_rebuild
          sh %Q(tar --owner 0 --group 0 --exclude-vcs --exclude=#{@exclude_list.join(' --exclude=')} --transform='s/^#{@pkg_name}/#{@dir_name}/' -cpzf "#{@tar_dest}" #{@pkg_name})
        end
      end
    end
  end
end

#initialize_spec_info(chroot, unique = 'false') ⇒ Object

Initialize the mock space if passed and retrieve the spec info from that space directly.

Ensures that the correct file names are used across the board.



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
 
# File 'lib/simp/rake/pkg.rb', line 134

def initialize_spec_info(chroot, unique='false')
  unless @spec_info
    # This gets the resting spec file and allows us to pull out the name
    @spec_info   = Simp::RPM.get_info(@spec_file)
    @spec_info_dir = @base_dir

    if chroot
      @chroot_name = @chroot_name || "#{@spec_info[:name]}__#{ENV.fetch( 'USER', 'USER' )}"

      if ENV['SIMP_PKG_rand_name'] && (ENV['SIMP_PKG_rand_name'] != 'no')
        @chroot_name = @chroot_name + '__' + Time.now.strftime('%s%L')
      end

      if @spec_info[:has_dist_tag]
        mock_cmd = mock_pre_check( chroot, @chroot_name, unique ) + " --root #{chroot}"

        # Need to do this in case there is already a directory in /tmp
        rand_dirname = (0...10).map { ('a'..'z').to_a[rand(26)] }.join
        rand_tmpdir = %(/tmp/#{rand_dirname}_tmp)

        # Hack to work around the fact that we have conflicting '-D' entries
        # TODO: Refactor this
        mock_cmd = mock_cmd.split(/-D '.*?'/).join
        mock_cmd = "#{mock_cmd} -D 'pup_module_info_dir #{rand_tmpdir}'"

        sh %Q(#{mock_cmd} --chroot 'mkdir -p #{rand_tmpdir}')

        @puppet_module_info_files.each do |copy_in|
          if File.exist?(copy_in)
            sh %Q(#{mock_cmd} --copyin #{copy_in} #{rand_tmpdir})
          end
        end

        sh %Q(#{mock_cmd} --chroot 'chmod -R ugo+rwX #{rand_tmpdir}')

        info_hash = {
          :command    => %Q(#{mock_cmd} --chroot --cwd='#{rand_tmpdir}'),
          :rpm_extras => %(--specfile #{rand_tmpdir}/#{File.basename(@spec_file)} )
        }

        @spec_info = Simp::RPM.get_info(@spec_file, info_hash)
      end
    end

    @dir_name       = "#{@spec_info[:name]}-#{@spec_info[:version]}"
    _full_pkg_name = "#{@dir_name}-#{@spec_info[:release]}"
    @full_pkg_name  = _full_pkg_name.gsub("%{?snapshot_release}","")
    @tar_dest       = "#{@pkg_dir}/#{@full_pkg_name}.tar.gz"

    if @tar_dest =~ /UNKNOWN/
      fail("Error: Could not determine package information from 'metadata.json'. Got '#{File.basename(@tar_dest)}'")
    end
  end
end

#is_mock_initialized(mock_cmd, chroot) ⇒ Object 



526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/simp/rake/pkg.rb', line 526

def is_mock_initialized( mock_cmd, chroot )
  @@initialized_mocks ||= []
  return true if @@initialized_mocks.include?(chroot)

  %x{#{mock_cmd} --root #{chroot} --chroot "test -d /tmp" &> /dev/null }
  initialized = $?.success?
  @@initialized_mocks << chroot

  # A simple test to see if the chroot is initialized.
  initialized
end

#mock_pre_check(chroot, unique_ext, unique = 'false', init = true) ⇒ Object

Run some pre-checks to make sure that mock will work properly.

chroot = name of mock chroot to use unique_ext = TODO Pass init=false if you do not want the function to initialize.

Returns a String that contains the appropriate mock command.

Raises:

  • (StandardError) 


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
 
# File 'lib/simp/rake/pkg.rb', line 468

def mock_pre_check( chroot, unique_ext, unique='false', init=true )

  mock = ENV['mock'] || '/usr/bin/mock'

  raise(StandardError,"Could not find mock on your system, exiting") unless File.executable?(mock)

  mock_configs = Pkg.get_mock_configs
  unless chroot
    raise(StandardError,
      "Error: No mock chroot provided. Your choices are:\n  #{mock_configs.join("\n  ")}"
    )
  end

  # If you pass a config file, just take it
  unless chroot.split('.').last == 'cfg'
    unless mock_configs.include?(chroot)
      raise(StandardError,
        "Error: Invalid mock chroot provided. Your choices are:\n  #{mock_configs.join("\n  ")}"
      )
    end
  end

  raise %Q(unique_ext must be a String ("#{unique_ext}" = #{unique_ext.class})) unless unique_ext.is_a?(String)

  # if true, restrict yum to the chroot's local yum cache (defaults to false)
  mock_offline = ENV.fetch( 'SIMP_RAKE_MOCK_OFFLINE', 'N' ).chomp.index( %r{^(1|Y|true|yes)$} ) || false

  mock_cmd =  "#{mock} --quiet"
  mock_cmd += " --uniqueext=#{unique_ext}" if unique
  mock_cmd += ' --offline'                 if mock_offline

  initialized = is_mock_initialized(mock_cmd, chroot)

  unless initialized && init
    sh %Q(#{mock_cmd} --root #{chroot} --init #{unique_ext})
  else
    # Remove any old build cruft from the mock directory.
    # This is kludgy but WAY faster than rebuilding them all, even with a cache.
    sh %Q(#{mock_cmd} --root #{chroot} --chroot "/bin/rm -rf /builddir/build/BUILDROOT /builddir/build/*/*")
  end

  # Install useful stock packages
  if ENV.fetch( 'SIMP_RAKE_MOCK_EXTRAS', 'yes' ) == 'yes'
    pkgs = ['openssl', 'openssl-devel']

    env_pkgs = ENV.fetch('SIMP_RAKE_MOCK_PKGS','')
    unless env_pkgs.empty?
      pkgs = pkgs + env_pkgs.split(',')
    end

    pkgs.each do |pkg|
      sh %Q(#{mock_cmd} --root #{chroot} --install #{pkg})
    end
  end

  return mock_cmd + " --no-clean --no-cleanup-after --resultdir=#{@pkg_dir} --disable-plugin=package_state"
end

#require_rebuild?(new, old) ⇒ Boolean

Return True if any of the ‘old’ Array are newer than the ‘new’ Array

Returns:

  • (Boolean) 


445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/simp/rake/pkg.rb', line 445

def require_rebuild?(new, old)
  return true if ( Array(old).empty? || Array(new).empty?)

  Array(new).each do |new_file|
    unless File.exist?(new_file)
      return true
    end

    unless uptodate?(new_file, Array(old))
      return true
    end
  end

  return false
end

#restore_stash ⇒ Object

Restore everything from the stash dir



124
125
126
127
128
 
# File 'lib/simp/rake/pkg.rb', line 124

def restore_stash
  Dir.glob(File.join(@pkg_stash_dir, '*')).each do |file|
    FileUtils.mv(file, @pkg_dir)
  end
end

#stash(file) ⇒ Object

Add a file to the pkg stash These will be restored to the @pkg_dir at the end of the run



119
120
121
 
# File 'lib/simp/rake/pkg.rb', line 119

def stash(file)
  FileUtils.mv(file, @pkg_stash_dir)
end