Module: Tebako::CliHelpers

Defined in:
lib/tebako/cli_helpers.rb

Overview

Cli helpers

Constant Summary collapse

WARN = 
<<~WARN

  ******************************************************************************************************************
  *                                                                                                                *
  *  WARNING: You are packaging in-place, i.e.: tebako package will be placed inside application root.             *
  *  It is not an error but we do not recommend it because it is a way to keep packaging old versions recrsively.  *
  *                                                                                                                *
  *  For example, ensure that `--root=` differs from `--output=` as described in README.adoc:                      *
  *  tebako press --root='~/projects/myproject' --entry=start.rb --output=/temp/myproject.tebako                   *
  *                                                                                                                *
  ******************************************************************************************************************

WARN
WARN2 = 
<<~WARN

  ******************************************************************************************************************
  *                                                                                                                *
  *  WARNING: You are creating packaging environment inside application root.                                      *
  *  It is not an error but it means that all build-time artifacts will ne included in tebako package.             *
  *  You do not need it unless under very special circumstances like tebako packaging tebako itself.               *
  *                                                                                                                *
  *  Please consider removing your exisitng `--prefix` folder abd use another one that points outside of `--root`  *
  *  like tebako press --r ~/projects/myproject -e start.rb -o /temp/myproject.tebako -p ~/.tebako                 *
  *                                                                                                                *
  ******************************************************************************************************************

WARN

Instance Method Summary collapse

Instance Method Details

#check_bootstrap_version!(options_manager) ⇒ Object

The fat payload slot is installed by the bootstrap at first run — a capability added in tebako-bootstrap 0.2.0



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/tebako/cli_helpers.rb', line 174

def check_bootstrap_version!(options_manager)
  return unless options_manager.fat?

  version = Tebako::BootstrapManager.default_version
  minimum = Tebako::BootstrapManager::PAYLOAD_MIN_VERSION
  return if payload_capable?(version, minimum)

  Tebako.packaging_error(134, "fat mode requires tebako-bootstrap >= #{minimum} (selected: #{version}; " \
                              "set TEBAKO_BOOTSTRAP_VERSION to a payload-capable release)")
end

#check_warnings(options_manager) ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/tebako/cli_helpers.rb', line 78

def check_warnings(options_manager)
  return unless options_manager.mode != "runtime"

  puts WARN if options_manager.package_within_root?
  puts WARN2 if options_manager.prefix_within_root?
  sleep 5
end

#dispatch_press(options_manager, scenario_manager) ⇒ Object 



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

def dispatch_press(options_manager, scenario_manager)
  if options_manager.three_part?
    do_press_three_part(options_manager, scenario_manager)
  elsif options_manager.prebuilt_runtime?
    do_press_prebuilt(options_manager, scenario_manager)
  else
    do_press_source(options_manager, scenario_manager)
  end
end

#do_press(options_manager) ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/tebako/cli_helpers.rb', line 86

def do_press(options_manager)
  scenario_manager = Tebako::ScenarioManager.new(options_manager.root, options_manager.fs_entrance)
  scenario_manager.configure_scenario
  options_manager.process_gemfile(scenario_manager.gemfile_path) if scenario_manager.with_gemfile
  check_warnings(options_manager)
  puts options_manager.press_announce(scenario_manager.msys?)
  dispatch_press(options_manager, scenario_manager)
end

#do_press_application(options_manager, scenario_manager) ⇒ Object 



191
192
193
194
195
196
 
# File 'lib/tebako/cli_helpers.rb', line 191

def do_press_application(options_manager, scenario_manager)
  return unless %w[both application].include?(options_manager.mode)

  packager = Tebako::PackagerLite.new(options_manager, scenario_manager)
  packager.create_package
end

#do_press_prebuilt(options_manager, scenario_manager) ⇒ Object

Press onto a prebuilt runtime package: resolve (download/verify/cache) the runtime, deploy the application image, stitch, re-sign on macOS.



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

def do_press_prebuilt(options_manager, scenario_manager)
  Tebako::Packager.check_prebuilt_env!(options_manager.stash_dir, options_manager.deps_bin_dir)
  runtime_path = Tebako::RuntimeManager.resolve(options_manager.ruby_ver, options_manager.host_platform)
  app_image = Tebako::Packager.build_app_image(options_manager, scenario_manager,
                                               Tebako::RuntimeManager.layout(runtime_path))

  images = [{ path: app_image, mount_point: scenario_manager.fs_mount_point,
              format_id: Tebako::Stitcher::FORMAT_DWARFS }] + options_manager.images
  package = "#{options_manager.package}#{scenario_manager.exe_suffix}"
  Tebako::Stitcher.stitch(runtime_path, images: images, output: package)
  puts "Created tebako #{options_manager.output_type_first} at \"#{package}\""
end

#do_press_runtime(options_manager, scenario_manager) ⇒ Object 



198
199
200
201
202
203
204
205
206
 
# File 'lib/tebako/cli_helpers.rb', line 198

def do_press_runtime(options_manager, scenario_manager)
  return unless %w[both runtime bundle classic].include?(options_manager.mode)

  generate_files(options_manager, scenario_manager)
  merged_env = ENV.to_h.merge(scenario_manager.b_env)
  Tebako.packaging_error(103) unless system(merged_env, press_cfg_cmd(options_manager))
  Tebako.packaging_error(104) unless system(merged_env, press_build_cmd(options_manager))
  finalize(options_manager, scenario_manager)
end

#do_press_source(options_manager, scenario_manager) ⇒ Object 



105
106
107
108
 
# File 'lib/tebako/cli_helpers.rb', line 105

def do_press_source(options_manager, scenario_manager)
  do_press_runtime(options_manager, scenario_manager)
  do_press_application(options_manager, scenario_manager)
end

#do_press_three_part(options_manager, scenario_manager) ⇒ Object

Press a three-part package (Stage 3B): tebako-bootstrap + application image slot(s) + tpkg trailer with the runtime reference (launcher ABI v1). 'lean' (the default) resolves the runtime into the shared cache at first run; 'fat' additionally embeds the runtime package as a payload slot, so the first run installs it without any network access.



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/tebako/cli_helpers.rb', line 130

def do_press_three_part(options_manager, scenario_manager)
  bootstrap_path, runtime_path = resolve_three_part_parts(options_manager)
  app_image = Tebako::Packager.build_app_image(options_manager, scenario_manager,
                                               Tebako::RuntimeManager.layout(runtime_path))
  payload_path = options_manager.fat? ? runtime_path : nil
  images = three_part_images(options_manager, scenario_manager, app_image, payload_path)
  package = "#{options_manager.package}#{scenario_manager.exe_suffix}"
  stitch_three_part(options_manager, bootstrap_path, images, package, payload_path)
  puts "Created tebako #{options_manager.output_type_first} at \"#{package}\""
end

#do_setup(options_manager) ⇒ Object 



208
209
210
211
212
213
214
 
# File 'lib/tebako/cli_helpers.rb', line 208

def do_setup(options_manager)
  puts "Setting up tebako packaging environment"

  merged_env = ENV.to_h.merge(Tebako::ScenarioManagerBase.new.b_env)
  Tebako.packaging_error(101) unless system(merged_env, setup_cfg_cmd(options_manager))
  Tebako.packaging_error(102) unless system(merged_env, setup_build_cmd(options_manager))
end

#finalize(options_manager, scenario_manager) ⇒ Object 



229
230
231
232
233
234
 
# File 'lib/tebako/cli_helpers.rb', line 229

def finalize(options_manager, scenario_manager)
  use_patchelf = options_manager.patchelf? && scenario_manager.linux_gnu?
  patchelf = use_patchelf ? "#{options_manager.deps_bin_dir}/patchelf" : nil
  Tebako::Packager.finalize(options_manager.ruby_src_dir, options_manager.package,
                            options_manager.rv, patchelf, options_manager.output_type_first)
end

#generate_files(options_manager, scenario_manager) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/tebako/cli_helpers.rb', line 216

def generate_files(options_manager, scenario_manager)
  puts "-- Generating files"

  v_parts = Tebako::VERSION.split(".")
  Tebako::Codegen.generate_tebako_version_h(options_manager, v_parts)
  Tebako::Codegen.generate_tebako_fs_cpp(options_manager, scenario_manager)
  Tebako::Codegen.generate_deploy_rb(options_manager, scenario_manager)

  return unless %w[both runtime].include?(options_manager.mode)

  Tebako::Codegen.generate_stub_rb(options_manager)
end

#options_from_tebafile(tebafile) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/tebako/cli_helpers.rb', line 236

def options_from_tebafile(tebafile)
  ::YAML.load_file(tebafile)["options"] || {}
rescue Psych::SyntaxError => e
  puts "Warning: The tebafile '#{tebafile}' contains invalid YAML syntax."
  puts e.message
  {}
rescue StandardError => e
  puts "An unexpected error occurred while loading the tebafile '#{tebafile}'."
  puts e.message
  {}
end

#payload_capable?(version, minimum) ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
188
189
 
# File 'lib/tebako/cli_helpers.rb', line 185

def payload_capable?(version, minimum)
  Gem::Version.new(version) >= Gem::Version.new(minimum)
rescue ArgumentError
  false
end

#payload_sha256(payload_path) ⇒ Object 



148
149
150
 
# File 'lib/tebako/cli_helpers.rb', line 148

def payload_sha256(payload_path)
  payload_path && Digest::SHA256.file(payload_path).hexdigest
end

#press_build_cmd(options_manager) ⇒ Object 



248
249
250
 
# File 'lib/tebako/cli_helpers.rb', line 248

def press_build_cmd(options_manager)
  "cmake --build #{options_manager.output_folder} --target tebako --parallel #{Etc.nprocessors}"
end

#press_cfg_cmd(options_manager) ⇒ Object 



252
253
254
 
# File 'lib/tebako/cli_helpers.rb', line 252

def press_cfg_cmd(options_manager)
  "cmake -DSETUP_MODE:BOOLEAN=OFF #{options_manager.cfg_options} #{options_manager.press_options}"
end

#resolve_three_part_parts(options_manager) ⇒ Object

Validate the options and the packaging environment, then resolve the bootstrap and the runtime into the shared cache. The runtime is needed in both three-part modes: 'fat' embeds it as a payload slot, 'lean' uses its extracted layout to align the application image's arch conventions (and references it in the trailer for first-run resolution)



157
158
159
160
161
162
163
 
# File 'lib/tebako/cli_helpers.rb', line 157

def resolve_three_part_parts(options_manager)
  options_manager.runtime_source # validates the mode/provenance combination
  check_bootstrap_version!(options_manager)
  Tebako::Packager.check_prebuilt_env!(options_manager.stash_dir, options_manager.deps_bin_dir)
  runtime_path = Tebako::RuntimeManager.resolve(options_manager.ruby_ver, options_manager.host_platform)
  [Tebako::BootstrapManager.resolve(options_manager.host_platform), runtime_path]
end

#setup_build_cmd(options_manager) ⇒ Object 



256
257
258
 
# File 'lib/tebako/cli_helpers.rb', line 256

def setup_build_cmd(options_manager)
  "cmake --build \"#{options_manager.output_folder}\" --target setup --parallel #{Etc.nprocessors}"
end

#setup_cfg_cmd(options_manager) ⇒ Object 



260
261
262
 
# File 'lib/tebako/cli_helpers.rb', line 260

def setup_cfg_cmd(options_manager)
  "cmake -DSETUP_MODE:BOOLEAN=ON #{options_manager.cfg_options}"
end

#stitch_three_part(options_manager, bootstrap_path, images, package, payload_path) ⇒ Object 



141
142
143
144
145
146
 
# File 'lib/tebako/cli_helpers.rb', line 141

def stitch_three_part(options_manager, bootstrap_path, images, package, payload_path)
  Tebako::Stitcher.stitch(bootstrap_path, images: images, output: package, lean: true,
                                          ruby_version: options_manager.ruby_ver,
                                          launcher_abi: Tebako::LauncherAbi::VERSION,
                                          runtime_sha256: payload_sha256(payload_path))
end

#three_part_images(options_manager, scenario_manager, app_image, runtime_path) ⇒ Object 



165
166
167
168
169
170
 
# File 'lib/tebako/cli_helpers.rb', line 165

def three_part_images(options_manager, scenario_manager, app_image, runtime_path)
  images = [{ path: app_image, mount_point: scenario_manager.fs_mount_point,
              format_id: Tebako::Stitcher::FORMAT_DWARFS }] + options_manager.images
  images << { path: runtime_path, mount_point: "", format_id: Tebako::Stitcher::FORMAT_RUNTIME } if runtime_path
  images
end