Class: Machinery::BuildTask

Inherits:
Object show all
Defined in:
lib/build_task.rb

Overview

Copyright © 2013-2016 SUSE LLC

This program is free software; you can redistribute it and/or modify it under the terms of version 3 of the GNU General Public License as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, contact SUSE LLC.

To contact SUSE about this file by physical or electronic mail, you may find current contact information at www.suse.com

Instance Method Summary collapse

Instance Method Details

#build(system_description, output_path, options = {}) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/build_task.rb', line 19

def build(system_description, output_path, options = {})
  Machinery::LocalSystem.validate_architecture("x86_64")
  Machinery::LocalSystem.validate_existence_of_packages(
    ["python3-kiwi", "kiwi-image-vmx-requires"]
  )

  tmp_config_dir = Dir.mktmpdir("machinery-config", "/tmp")
  tmp_image_dir = Dir.mktmpdir("machinery-image", "/tmp")
  img_extension = "qcow2"

  config = Machinery::KiwiConfig.new(system_description, options)
  config.write(tmp_config_dir)

  begin
    FileUtils.mkdir_p(output_path)
  rescue Errno::EACCES
    raise Machinery::Errors::BuildDirectoryCreateError.new(
      output_path,
      Machinery::CurrentUser.new.username
    )
  end

  if tmp_image_dir.start_with?("/tmp/") && tmp_config_dir.start_with?("/tmp/")
    tmp_script = write_kiwi_wrapper(tmp_config_dir, tmp_image_dir,
      output_path, img_extension)

    begin
      with_c_locale do
        Machinery::LoggedCheetah.run(
          "sudo",
          tmp_script.path,
          stdout: $stdout,
          stderr: $stderr
        )
      end
    rescue SignalException => e
      # Handle SIGHUP(1), SIGINT(2) and SIGTERM(15) gracefully
      if [1, 2, 15].include?(e.signo)
        Machinery::Ui.warn "Warning: Interrupted by user. Waiting for build process to abort..."

        # When we got a SIGHUP or a SIGTERM we send a SIGINT to all processes
        # in our progress group (forked by Cheetah).
        # For SIGINT that's not needed because it is propagated automatically.
        #
        # The reason for killing the child processes with SIGINT (vs SIGTERM)
        # is that with SIGTERM the bash wrapper script around kiwi returns
        # while the unmounting of /proc is still in progress. That would break
        # the cleanup of the temporary kiwi directories below.
        if [1, 15].include?(e.signo)
          trap("INT") {}
          `sudo kill -INT -#{Process.getpgrp}`
        end
        Process.waitall

        Machinery::Ui.warn "Cleaning up temporary files..."
        [tmp_config_dir, tmp_image_dir].each do |path|
          Machinery::LoggedCheetah.run("sudo", "rm", "-r", path) if Dir.exist?(path)
        end
      end
      raise
    rescue Cheetah::ExecutionFailed
      raise(
        Machinery::Errors::BuildFailed,
        "The execution of the build script failed."
      )
    ensure
      tmp_script.delete
    end
  else
    raise RuntimeError.new(
      "The Kiwi temporary build directories are not in /tmp. This should " \
      "never happen, so nothing is deleted."
    )
  end

  image_file = Dir.glob(File.join(output_path, "*.#{img_extension}")).first

  unless image_file
    raise(Machinery::Errors::BuildFailed, "The image build process failed. Check " \
      "build log '#{tmp_image_dir}/kiwi-terminal-output.log' for more " \
      "details."
    )
  end

  meta_data = {
    description: system_description.name,
    image_file: File.basename(image_file)
  }
  File.write(File.join(output_path, Machinery::IMAGE_META_DATA_FILE),
    meta_data.to_yaml
  )
end

#kiwi_wrapper(tmp_config_dir, tmp_image_dir, output_path, image_extension) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/build_task.rb', line 112

def kiwi_wrapper(tmp_config_dir, tmp_image_dir, output_path, image_extension)
  script = "#!/bin/bash\n"
  script << "/usr/bin/kiwi-ng --logfile='#{tmp_image_dir}/kiwi-terminal-output.log' system"
  script << " build --description='#{tmp_config_dir}' --target-dir='#{tmp_image_dir}'\n"
  script << "if [ $? -eq 0 ]; then\n"
  script << "  mv '#{tmp_image_dir}/'*.#{image_extension} '#{output_path}'\n"
  script << "  rm -rf '#{tmp_image_dir}'\n"
  script << "else\n"
  script << "  echo -e 'Building the Image with Kiwi failed.\nThe Kiwi build directory #{tmp_image_dir} was not removed.'\n"
  script << "fi\n"
  script << "rm -rf '#{tmp_config_dir}'\n"
end

#write_kiwi_wrapper(tmp_config_dir, tmp_image_dir, output_path, image_extension) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/build_task.rb', line 125

def write_kiwi_wrapper(tmp_config_dir, tmp_image_dir, output_path, image_extension)
  begin
    script = Tempfile.new('machinery-kiwi-wrapper-script')
    script << kiwi_wrapper(tmp_config_dir, tmp_image_dir, output_path, image_extension)
  ensure
    script.close unless script == nil
  end
  File.chmod(0755, script.path)
  script
end