tebako 0.5.0

data/lib/tebako/cli.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2021-2023 [Ribose Inc](https://www.ribose.com).
+# All rights reserved.
+# This file is a part of tebako
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require "fileutils"
+require "thor"
+require "yaml"
+
+require_relative "cli_helpers"
+require_relative "error"
+require_relative "version"
+
+# Tebako - an executable packager
+# Implementation of tebako command-line interface
+module Tebako
+  OPTIONS_FILE = ".tebako.yml"
+  # Tebako packager front-end
+  class TebakoCli < Thor
+    package_name "Tebako"
+    class_option :prefix, type: :string, aliases: "-p", required: false,
+                          desc: "A path to tebako packaging environment, '~/.tebako' ('$HOME/.tebako') by default"
+
+    desc "clean", "Clean tebako packaging environment"
+    def clean
+      puts "Cleaning tebako packaging environment"
+      FileUtils.rm_rf([deps, output], secure: true)
+    end
+
+    desc "press", "Press tebako image"
+    method_option :"entry-point", type: :string, aliases: ["-e", "--entry"], required: true,
+                                  desc: "Ruby application entry point"
+    method_option :"log-level", type: :string, aliases: "-l", required: false, enum: %w[error warn debug trace],
+                                desc: "Tebako memfs logging level, 'error' by default"
+    method_option :output, type: :string, aliases: "-o", required: false,
+                           desc: "Tebako package file name, entry point base file name in the current folder by default"
+    method_option :root, type: :string, aliases: "-r", required: true, desc: "Root folder of the Ruby application"
+    method_option :Ruby, type: :string, aliases: "-R", required: false,
+                         enum: Tebako::CliHelpers::RUBY_VERSIONS.keys,
+                         desc: "Tebako package Ruby version, #{Tebako::CliHelpers::DEFAULT_RUBY_VERSION} by default"
+    def press
+      puts press_announce
+      do_press
+    rescue TebakoError => e
+      puts "Tebako script failed: #{e.message} [#{e.error_code}]"
+      exit e.error_code
+    end
+
+    desc "setup", "Set up tebako packaging environment"
+    method_option :Ruby, type: :string, aliases: "-R", required: false,
+                         enum: Tebako::CliHelpers::RUBY_VERSIONS.keys,
+                         desc: "Tebako package Ruby version, #{Tebako::CliHelpers::DEFAULT_RUBY_VERSION} by default"
+    def setup
+      puts "Setting up tebako packaging environment"
+      do_setup
+    rescue TebakoError => e
+      puts "Tebako script failed: #{e.message} [#{e.error_code}]"
+      exit e.error_code
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    no_commands do
+      def options
+        original_options = super
+
+        return original_options unless File.exist?(OPTIONS_FILE)
+
+        defaults = ::YAML.load_file(OPTIONS_FILE) || {}
+        puts defaults.merge(original_options)
+        Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
+      end
+
+      def generate
+        FileUtils.mkdir_p(prefix)
+        File.write(File.join(prefix, "version.txt"), "#{Tebako::VERSION}\n")
+        puts("all: ")
+      end
+    end
+
+    private
+
+    no_commands do
+      def do_press
+        packaging_error(103) unless system(b_env, "cmake -DSETUP_MODE:BOOLEAN=OFF #{cfg_options} #{press_options}")
+        packaging_error(104) unless system(b_env,
+                                           "cmake --build #{output} --target tebako --parallel #{Etc.nprocessors}")
+      end
+
+      def do_setup
+        FileUtils.mkdir_p(prefix)
+        File.write(File.join(prefix, "version.txt"), "#{Tebako::VERSION}\n")
+        packaging_error(101) unless system(b_env, "cmake -DSETUP_MODE:BOOLEAN=ON #{cfg_options}")
+        packaging_error(102) unless system(b_env,
+                                           "cmake --build #{output} --target setup --parallel #{Etc.nprocessors}")
+      end
+
+      def press_announce
+        @press_announce ||= <<~ANN
+          Running tebako press at #{prefix}
+             Ruby version:            '#{extend_ruby_version[0]}'
+             Project root:            '#{options["root"]}'
+             Application entry point: '#{options["entry-point"]}'
+             Package file name:       '#{package}'
+             Loging level:            '#{l_level}'
+        ANN
+      end
+    end
+
+    include Tebako::CliHelpers
+  end
+end

data/lib/tebako/cli_helpers.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2023 [Ribose Inc](https://www.ribose.com).
+# All rights reserved.
+# This file is a part of tebako
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require "etc"
+require "fileutils"
+require "pathname"
+require "rbconfig"
+
+require_relative "error"
+require_relative "version"
+
+# Tebako - an executable packager
+# Command-line interface methods
+module Tebako
+  # TebakoCli methods
+  module CliHelpers
+    def b_env
+      u_flags = if RbConfig::CONFIG["host_os"] =~ /darwin/
+                  "-DTARGET_OS_SIMULATOR=0 -DTARGET_OS_IPHONE=0  #{ENV.fetch("CXXFLAGS", nil)}"
+                else
+                  ENV.fetch("CXXFLAGS", nil)
+                end
+      #      cc = ENV.fetch("CC", "gcc")
+      #      cxx = ENV.fetch("CXX", "g++")
+      @b_env ||= { "CXXFLAGS" => u_flags }
+    end
+
+    def cfg_options
+      ruby_ver, ruby_hash = extend_ruby_version
+      @cfg_options ||=
+        "-DCMAKE_BUILD_TYPE=Release -DRUBY_VER:STRING='#{ruby_ver}' -DRUBY_HASH:STRING='#{ruby_hash}' " \
+        "-DDEPS:STRING='#{deps}' -G '#{m_files}' -B '#{output}' -S '#{source}'"
+    end
+
+    def deps
+      @deps ||= File.join(prefix, "deps")
+    end
+
+    RUBY_VERSIONS = {
+      "2.7.7" => "e10127db691d7ff36402cfe88f418c8d025a3f1eea92044b162dd72f0b8c7b90",
+      "3.0.6" => "6e6cbd490030d7910c0ff20edefab4294dfcd1046f0f8f47f78b597987ac683e",
+      "3.1.4" => "a3d55879a0dfab1d7141fdf10d22a07dbf8e5cdc4415da1bde06127d5cc3c7b6"
+      #      "3.2.2" => "96c57558871a6748de5bc9f274e93f4b5aad06cd8f37befa0e8d94e7b8a423bc"
+    }.freeze
+
+    DEFAULT_RUBY_VERSION = "3.0.6"
+
+    def extend_ruby_version
+      version = options["Ruby"].nil? ? DEFAULT_RUBY_VERSION : options["Ruby"]
+      unless RUBY_VERSIONS.key?(version)
+        raise TebakoError.new "Ruby version #{version} is not supported yet, exiting",
+                              253
+      end
+
+      @extend_ruby_version ||= [version, RUBY_VERSIONS[version]]
+    end
+
+    def l_level
+      @l_level ||= if options["log-level"].nil?
+                     "error"
+                   else
+                     options["log-level"]
+                   end
+    end
+
+    def m_files
+      @m_files ||= case RbConfig::CONFIG["host_os"]
+                   when /linux/, /darwin/
+                     "Unix Makefiles"
+                   when /msys/
+                     "Ninja"
+                   else
+                     raise TebakoError.new "#{RbConfig::CONFIG["host_os"]} is not supported yet, exiting", 254
+                   end
+    end
+
+    def output
+      @output ||= File.join(prefix, "output")
+    end
+
+    def package
+      @package ||= if options["output"].nil?
+                     File.join(Dir.pwd, File.basename(options["entry-point"], ".*"))
+                   else
+                     options["output"]
+                   end
+    end
+
+    PACKAGING_ERRORS = {
+      101 => "'tebako setup' configure step failed",
+      102 => "'tebako setup' build step failed",
+      103 => "'tebako press' configure step failed",
+      104 => "'tebako press' build step failed"
+    }.freeze
+
+    def packaging_error(code)
+      msg = PACKAGING_ERRORS[code]
+      msg = "Unknown packaging error" if msg.nil?
+      raise TebakoError.new msg, code
+    end
+
+    def prefix
+      @prefix ||= if options["prefix"].nil?
+                    File.expand_path("~/.tebako")
+                  elsif options["prefix"] == "PWD"
+                    Dir.pwd
+                  else
+                    File.expand_path(options["prefix"])
+                  end
+    end
+
+    def press_options
+      @press_options ||=
+        "-DROOT:STRING='#{options["root"]}' -DENTRANCE:STRING='#{options["entry-point"]}' " \
+        "-DPCKG:STRING='#{package}' -DLOG_LEVEL:STRING='#{options["log-level"]}'"
+    end
+
+    def source
+      c_path = Pathname.new(__FILE__).realpath
+      @source ||= File.expand_path("../../..", c_path)
+    end
+  end
+end

data/lib/tebako/error.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2023 [Ribose Inc](https://www.ribose.com).
+# All rights reserved.
+# This file is a part of tebako
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+# Tebako - an executable packager
+# Tebako error class
+module Tebako
+  # Tebako error class
+  class TebakoError < StandardError
+    def initialize(msg = "Unspecified error", code = 255)
+      @error_code = code
+      super(msg)
+    end
+    attr_accessor :error_code
+  end
+end

data/lib/tebako/packager/pass1.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2021-2023 [Ribose Inc](https://www.ribose.com).
+# All rights reserved.
+# This file is a part of tebako
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+# Tebako - an executable packager
+module Tebako
+  # Ruby patching definitions (pass1)
+  module Pass1
+    TOOL_RBINSTALL_RB_PATCH = {
+      "    next if files.empty?" => "# tebako patched    next if files.empty?"
+    }.freeze
+
+    RUBYGEM_OPENSSL_RB_PATCH = {
+      'autoload :OpenSSL, "openssl"' => "require \"openssl\"\nautoload :OpenSSL, \"openssl\""
+    }.freeze
+
+    EXT_SETUP_PATCH = {
+      "#option nodynamic" => "option nodynamic"
+    }.freeze
+
+    EXT_BIGDECIMAL_BIGDECIMAL_H_PATCH = {
+      "#include \"ruby/ruby.h\"" => <<~SUBST
+        #include "ruby/ruby.h"
+
+        /* -- Start of tebako patch -- */
+        #ifndef HAVE_RB_SYM2STR
+        #define HAVE_RB_SYM2STR  1
+        #endif
+
+        #ifndef HAVE_RB_ARRAY_CONST_PTR
+        #define HAVE_RB_ARRAY_CONST_PTR 1
+        #endif
+
+        #ifndef HAVE_RB_RATIONAL_NUM
+        #define HAVE_RB_RATIONAL_NUM 1
+        #endif
+
+        #ifndef HAVE_RB_RATIONAL_DEN
+        #define HAVE_RB_RATIONAL_DEN 1
+        #endif
+
+        #ifndef HAVE_RB_COMPLEX_REAL
+        #define HAVE_RB_COMPLEX_REAL
+        #endif
+
+        #ifndef HAVE_RB_COMPLEX_IMAG
+        #define HAVE_RB_COMPLEX_IMAG
+        #endif
+        /* -- End of tebako patch -- */
+
+      SUBST
+    }.freeze
+
+    CONFIGURE_PATCH = {
+      "EXTDLDFLAGS=\"-bundle_loader '\\$(BUILTRUBY)'\"" => ""
+    }.freeze
+
+    class << self
+      def get_patch_map(ostype, mount_point, ruby_ver)
+        patch_map = {
+          # ....................................................
+          # It won't install gems with no files defined in spec
+          # However if
+          #   -- we are installing a default gem from extension
+          #   -- extension is build statically
+          #  there may be no files install in addition to spec
+          # Example: io/wait extension (and others)
+          "tool/rbinstall.rb" => TOOL_RBINSTALL_RB_PATCH,
+
+          # ....................................................
+          # This is something that I cannnot explain
+          # (this patch does not seem related to static compilation)
+          "ext/bigdecimal/bigdecimal.h" => EXT_BIGDECIMAL_BIGDECIMAL_H_PATCH,
+
+          # ....................................................
+          # Allow only packaged gems (from within memfs)
+          "lib/rubygems/path_support.rb" => rubygems_path_support_patch(mount_point),
+
+          # ....................................................
+          # Disable dynamic extensions
+          "ext/Setup" => EXT_SETUP_PATCH
+        }
+        # ....................................................
+        # Fixing (bypassing) configure script bug where a variable is used before initialization
+        patch_map.store("configure", CONFIGURE_PATCH) if ostype =~ /darwin/
+
+        # ....................................................
+        # autoload :OpenSSL, "openssl"
+        # fails to deal with a default gem from statically linked extension
+        patch_map.store("lib/rubygems/openssl.rb", RUBYGEM_OPENSSL_RB_PATCH) if ruby_ver[0] == "3"
+
+        patch_map
+      end
+
+      private
+
+      def rubygems_path_support_patch_one(mount_point)
+        <<~SUBST
+            @home = env["GEM_HOME"] || Gem.default_dir
+          # -- Start of tebako patch --
+              unless env["TEBAKO_PASS_THROUGH"]
+                @home = Gem.default_dir unless @home.index("#{mount_point}") == 0
+              end
+          # -- End of tebako patch --
+
+        SUBST
+      end
+
+      def rubygems_path_support_patch_two(mount_point)
+        <<~SUBST
+
+            @path = split_gem_path env["GEM_PATH"], @home
+          # -- Start of tebako patch --
+              unless env["TEBAKO_PASS_THROUGH"]
+                @path.keep_if do |xpath|
+                  xpath.index("#{mount_point}") == 0
+                end
+              end
+          # -- End of tebako patch --
+
+        SUBST
+      end
+
+      def rubygems_path_support_patch(mount_point)
+        {
+          '  @home = env["GEM_HOME"] || Gem.default_dir' => rubygems_path_support_patch_one(mount_point),
+          '  @path = split_gem_path env["GEM_PATH"], @home' => rubygems_path_support_patch_two(mount_point)
+        }
+      end
+    end
+  end
+end