tebako 0.5.0

data/tests-2/tebako-test.rb

@@ -0,0 +1,312 @@
+#!/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 "English"
+require "tmpdir"
+require "fileutils"
+require "rbconfig"
+require "pathname"
+require "rubygems"
+require "open3"
+require "minitest/autorun"
+
+# Tebako test set
+# rubocop:disable Metrics/ClassLength
+class TebakoTest < MiniTest::Test
+  # Path to test fixtures.
+  FixturePath = File.expand_path(File.join(File.dirname(__FILE__), "fixtures"))
+  Prefix = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  Tebako = File.join(Prefix, "exe", "tebako")
+
+  def initialize(*args)
+    super(*args)
+    @testnum = 0
+  end
+
+  # Sets up temporary environment variables and yields to the
+  # block. When the block exits, the environment variables are set
+  # back to their original values.
+  def with_env(hash)
+    old = {}
+    hash.each do |k, v|
+      old[k] = ENV.fetch(k, nil)
+      ENV[k] = v
+    end
+    begin
+      yield
+    ensure
+      hash.each { |k, _v| ENV[k] = old[k] }
+    end
+  end
+
+  # Sets up an directory with a copy of a fixture and yields to the
+  # block, then cleans up everything. A fixture here is a hierachy of
+  # files located in test/fixtures.
+  def with_fixture(name, target_path = nil, &block)
+    path = File.join(FixturePath, name)
+    with_tmpdir([], target_path) do |tmpdirname|
+      FileUtils.cp_r path, tmpdirname
+      FileUtils.cd tmpdirname, &block
+    end
+  end
+
+  # Creates temporary dir, copies files to it, cleans everything when the business is finished
+  def with_tmpdir(files = [], path = nil)
+    tempdirname = path || File.join("/tmp", "tebako-test-#{$PROCESS_ID}-#{rand 2**32}").tr("\\", "/")
+    FileUtils.mkdir_p tempdirname
+    begin
+      FileUtils.cp files, tempdirname
+      yield(tempdirname)
+    ensure
+      FileUtils.rm_rf tempdirname
+    end
+  end
+
+  # Create a pristine environment to test built executables. Files are
+  # copied and the PATH environment is set to the minimal.
+  # yeilds the name for pristine temp dir (as opposed to temp dir used for packaging)
+  def pristine_env(*files)
+    with_tmpdir files do |tempdirname|
+      with_env "PATH" => "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:" do
+        yield(tempdirname)
+      end
+    end
+  end
+
+  def ruby_ver
+    ENV.fetch("RUBY_VER", "3.0.6")
+  end
+
+  # Run 'tebako press ...'
+  def press(tebako, name, package, prefix)
+    cmd = "#{tebako} press -R #{ruby_ver} -o #{package} -e #{name}.rb -r #{name} -p '#{prefix}'"
+    out, st = Open3.capture2e(cmd)
+    if st.exitstatus != 0
+      puts "\"cmd\" failed with status #{st.exitstatus}"
+      puts out
+    end
+    assert_equal 0, st.exitstatus
+    assert File.exist?(package)
+  end
+
+  # A kind of standart creates names - tmp dir with fixture - press sequence
+  def with_fixture_press_and_env(name)
+    package = "#{name}-package"
+    with_fixture name do
+      press(Tebako, name, package, Prefix)
+      pristine_env package do |tempdirname|
+        yield "#{tempdirname}/#{package}"
+      end
+    end
+  end
+
+  # Specified gems should be automatically included and usable in packaged app
+  def test_216_byebug
+    name = "gems-byebug"
+    with_fixture_press_and_env name do |package|
+      out, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert_equal out, "Hello! Byebug welcomes you to the magic world of ruby gems.\n"
+    end
+  end
+
+  # Specified gems should be automatically included and usable in packaged app
+  def test_215_expressir
+    name = "gems-expressir"
+    with_fixture_press_and_env name do |package|
+      out, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert_match(/Hello! Expressir gem welcomes you to the magic world of ruby gems./, out)
+    end
+  end
+
+  # Specified gems should be automatically included and usable in packaged app
+  def test_214_sassc
+    name = "gems-sassc"
+    with_fixture_press_and_env name do |package|
+      out, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert_match(/Hello! SassC gem welcomes you to the magic world of ruby gems./, out)
+    end
+  end
+
+  # Specified gems should be automatically included and usable in packaged app
+  def test_213_libmspack
+    name = "gems-libmspack"
+    with_fixture_press_and_env name do |package|
+      out, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert_match(/Hello! libmspack welcomes you to the magic world of ruby gems./, out)
+    end
+  end
+
+  # Specified gems should be automatically included and usable in packaged app
+  def test_212_seven_zip
+    name = "gems-seven-zip"
+    with_fixture_press_and_env name do |package|
+      out, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert_match(/Hello! SevenZipRuby welcomes you to the magic world of ruby gems/, out)
+    end
+  end
+
+  # Specified gems should be automatically included and usable in packaged app
+  def test_211_bundler
+    name = "gems-bundler"
+    with_fixture_press_and_env name do |package|
+      out, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert_equal out, "Hello! Bundler welcomes you to the magic world of ruby gems.\n"
+    end
+  end
+
+  # Test io.c and file.c patching
+  def test_122_io_and_file
+    name = "patches-io-and-file"
+    with_fixture_press_and_env name do |package|
+      _, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+    end
+  end
+
+  # Test dir.c patching
+  def test_122_dir
+    name = "patches-dir"
+    FileUtils.mkdir_p File.join(FixturePath, name, "level-1/level-2/level-3")
+    with_fixture_press_and_env name do |package|
+      _, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+    end
+  end
+
+  # Test main.c patching as relates to scrip argument handling
+  # Test that scripts can exit with a specific exit status code
+  def test_121_main
+    name = "patches-main"
+    with_fixture_press_and_env name do |package|
+      _, st = Open3.capture2("#{package} foo \"bar baz \\\"quote\\\"\"")
+      assert_equal 5, st.exitstatus
+    end
+  end
+
+  # Test:
+  #  -- that executable can write a file to the current working directory (io.c, file.c patching)
+  #  -- short options without whitespaces
+  def test_105_launcher_pwd
+    name = "launcher-pwd"
+    with_fixture_press_and_env name do |package|
+      _, st = Open3.capture2(package.to_s)
+      assert_equal 0, st.exitstatus
+      assert File.exist?("output.txt")
+      assert_equal "output", File.read("output.txt")
+    end
+  end
+
+  # Test that executable can use ruby standard libraries (i.e. cgi)
+  def test_104_launcher_coreincl
+    name = "launcher-coreincl"
+    with_fixture_press_and_env name do |package|
+      _, st = Open3.capture2(package)
+      assert_equal 0, st.exitstatus
+      assert File.exist?("output.txt")
+      assert_equal "3 &lt; 5", File.read("output.txt")
+    end
+  end
+
+  # Test that the standard output from a script can be redirected to a file.
+  def test_103_launcher_stdoutredir
+    name = "launcher-stdoutredir"
+    with_fixture_press_and_env name do |package|
+      system("#{package} > output.txt")
+      assert File.exist?("output.txt")
+      o = File.read("output.txt")
+      assert ["Hello, World!\n", "Hello, World!\r\n"].include?(o)
+    end
+  end
+
+  # Test that the standard input to a script can be redirected from a file.
+  def test_102_launcher_stdinredir
+    name = "launcher-stdinredir"
+    package = "#{name}-package"
+    with_fixture name do
+      press(Tebako, name, package, Prefix)
+      pristine_env package, "#{name}/input.txt" do |tempdirname|
+        _, st = Open3.capture2("#{tempdirname}/#{package} < #{tempdirname}/input.txt")
+        assert_equal 104, st.exitstatus
+      end
+    end
+  end
+
+  # Test :
+  # -- that we can build and run executables.
+  # -- short options with whitespaces
+  # -- that we are linking to known set of shared libraries (https://github.com/tamatebako/tebako/issues/42)
+
+  def expected_libs
+    if RbConfig::CONFIG["target_os"] =~ /darwin/
+      ["Security.framework", "Foundation.framework", "CoreFoundation.framework", "libSystem",
+       "libc++", "launcher-package-package:"]
+    # This is the test program itself: 'launcher-package-package:'
+    elsif RbConfig::CONFIG["target_os"] =~ /linux-musl/
+      ["libc.musl-x86_64.so", "ld-musl-x86_64.so"]
+    else # linux-gnu assumed
+      ["linux-vdso.so", "libpthread.so", "libdl.so", "libc.so", "ld-linux-", "libm.so",
+       "librt.so", "libgcc_s.so"]
+    end
+  end
+
+  def actual_libs(package)
+    out, st = if RbConfig::CONFIG["host_os"] =~ /darwin/
+                Open3.capture2("otool -L #{package}")
+              else # linux assumed
+                Open3.capture2("ldd #{package}")
+              end
+    assert_equal 0, st.exitstatus
+    out.lines.map(&:strip)
+  end
+
+  def check_libs(package)
+    l = actual_libs(package.to_s)
+    l.delete_if { |ln| expected_libs.any? { |lib| ln.include?(lib) } }
+    assert_equal 0, l.size, "Unexpected references to shared libraries #{l}"
+  end
+
+  def test_101_launcher
+    name = "launcher-package"
+    package = "#{name}-package"
+    with_fixture name do
+      press(Tebako, name, package, Prefix)
+      pristine_env package do |tempdirname|
+        _, st = Open3.capture2("#{tempdirname}/#{package}")
+        assert_equal 0, st.exitstatus
+        check_libs(package.to_s)
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: tebako
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: |
+  Tebako is an executable packager. It packages a set of files into a single
+  executable binary that allows a user to run a selected file from the
+  packaged software as if it is a mounted filesystem.
+email:
+- open.source@ribose.com
+executables:
+- tebako
+extensions: []
+extra_rdoc_files: []
+files:
+- CMakeLists.txt
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- cmake/copy_dir.cmake
+- cmake/def_tty_colours.cmake
+- common.env
+- exe/tebako
+- include/tebako/tebako-fs.h
+- include/tebako/tebako-main.h
+- lib/cli.rb
+- lib/tebako/cli.rb
+- lib/tebako/cli_helpers.rb
+- lib/tebako/error.rb
+- lib/tebako/packager.rb
+- lib/tebako/packager/pass1.rb
+- lib/tebako/packager/pass2.rb
+- lib/tebako/version.rb
+- resources/tebako-fs.cpp.in
+- resources/tebako-version.h.in
+- src/tebako-main.cpp
+- tebako.gemspec
+- tests-2/fixtures/gems-bundler/Gemfile
+- tests-2/fixtures/gems-bundler/gems-bundler.rb
+- tests-2/fixtures/gems-byebug/Gemfile
+- tests-2/fixtures/gems-byebug/gems-byebug.rb
+- tests-2/fixtures/gems-expressir/Gemfile
+- tests-2/fixtures/gems-expressir/gems-expressir.rb
+- tests-2/fixtures/gems-libmspack/Gemfile
+- tests-2/fixtures/gems-libmspack/gems-libmspack.rb
+- tests-2/fixtures/gems-sassc/Gemfile
+- tests-2/fixtures/gems-sassc/base_style/all.scss
+- tests-2/fixtures/gems-sassc/base_style/reset.scss
+- tests-2/fixtures/gems-sassc/gems-sassc.rb
+- tests-2/fixtures/gems-seven-zip/Gemfile
+- tests-2/fixtures/gems-seven-zip/gems-seven-zip.rb
+- tests-2/fixtures/launcher-coreincl/launcher-coreincl.rb
+- tests-2/fixtures/launcher-package/launcher-package.rb
+- tests-2/fixtures/launcher-pwd/launcher-pwd.rb
+- tests-2/fixtures/launcher-stdinredir/input.txt
+- tests-2/fixtures/launcher-stdinredir/launcher-stdinredir.rb
+- tests-2/fixtures/launcher-stdoutredir/launcher-stdoutredir.rb
+- tests-2/fixtures/patches-dir/level-1/level-2/file-1.txt
+- tests-2/fixtures/patches-dir/level-1/level-2/file-2.txt
+- tests-2/fixtures/patches-dir/level-1/level-2/file-3.txt
+- tests-2/fixtures/patches-dir/patches-dir.rb
+- tests-2/fixtures/patches-io-and-file/level-1/level-2/file-1.txt
+- tests-2/fixtures/patches-io-and-file/level-1/level-2/file-2.txt
+- tests-2/fixtures/patches-io-and-file/level-1/level-2/file-3.txt
+- tests-2/fixtures/patches-io-and-file/level-1/link-3
+- tests-2/fixtures/patches-io-and-file/patches-io-and-file.rb
+- tests-2/fixtures/patches-main/patches-main.rb
+- tests-2/tebako-test.rb
+- tests/scripts/cross-tests.sh
+- tests/scripts/functional-tests.sh
+- tests/test-00/test.rb
+- tests/test-01/tebako-test-run.rb
+- tests/test-09/tebako-test-0.0.1.gem
+- tests/test-11/bin/tebako-test-run.rb
+- tests/test-11/lib/tebako-test.rb
+- tests/test-11/tebako-test.gemspec
+- tests/test-12/tebako-test-a.gemspec
+- tests/test-12/tebako-test-b.gemspec
+- tests/test-13/bin/tebako-test-run.rb
+- tests/test-13/lib/tebako-test.rb
+- tests/test-13/tebako-test.gemspec
+- tests/test-15/Gemfile
+- tests/test-15/Rakefile
+- tests/test-15/bin/tebako-test-run.rb
+- tests/test-15/lib/tebako/bundle/test.rb
+- tests/test-15/lib/tebako/bundle/test/version.rb
+- tests/test-15/tebako-bundle-test.gemspec
+- tests/test-16/Gemfile
+- tests/test-16/Rakefile
+- tests/test-16/bin/tebako-test-run.rb
+- tests/test-16/lib/tebako/bundle/test.rb
+- tests/test-16/lib/tebako/bundle/test/version.rb
+- tests/test-16/tebako-bundle-test.gemspec
+- tests/test-18/Gemfile
+- tests/test-18/tebako-test-run.rb
+- tests/test-19/Gemfile
+- tests/test-19/tebako-test-run.rb
+homepage: https://github.com/tamatebako/tebako
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/tamatebako/tebako
+  source_code_uri: https://github.com/tamatebako/tebako
+post_install_message:
+rdoc_options: []
+require_paths:
+- cmake
+- exe
+- ext
+- include
+- lib
+- resources
+- src
+- tools/ci-scripts
+- tools/cmake-scripts
+- tools/includes
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Packager for Ruby executables
+test_files: []