Module: RakeCompilerDock

Defined in:

lib/rake_compiler_dock/predefined_user_group.rb,
lib/rake_compiler_dock.rb,
lib/rake_compiler_dock/colors.rb,
lib/rake_compiler_dock/starter.rb,
lib/rake_compiler_dock/version.rb,
lib/rake_compiler_dock/docker_check.rb

Overview

DO NOT EDIT - This file is generated per ‘rake update_lists’

Defined Under Namespace

Modules: Colors Classes: DockerCheck, DockerIsNotAvailable, Starter

Constant Summary

VERSION =

"1.5.1"

IMAGE_VERSION =

"1.5.1"

PredefinedUsers =

["_apt", "adm", "backup", "bin", "daemon", "dbus", "ftp", "games", "gnats", "halt", "irc", "list", "lp", "mail", "man", "news", "nobody", "operator", "proxy", "root", "rubyuser", "shutdown", "sync", "sys", "systemd-network", "uucp", "www-data"]

PredefinedGroups =

["adm", "audio", "backup", "bin", "cdrom", "cgred", "daemon", "dbus", "dialout", "dip", "disk", "fax", "floppy", "ftp", "games", "gnats", "input", "irc", "kmem", "list", "lock", "lp", "mail", "man", "mem", "news", "nobody", "nogroup", "operator", "plugdev", "proxy", "root", "rubyuser", "sasl", "shadow", "src", "ssh", "ssh_keys", "staff", "sudo", "sys", "systemd-journal", "systemd-network", "tape", "tty", "users", "utempter", "utmp", "uucp", "video", "voice", "wheel", "www-data"]

Class Method Summary

• .exec(*args, &block) ⇒ Object

  Run the command cmd within a fresh rake-compiler-dock container.

• .image_name ⇒ Object
• .sh(cmd, options = {}, &block) ⇒ Object

  Run the command cmd within a fresh rake-compiler-dock container and within a shell.

Class Method Details

.exec(*args, &block) ⇒ Object

Run the command cmd within a fresh rake-compiler-dock container. The command is run directly, without the shell.

If a block is given, upon command completion the block is called with an OK flag (true on a zero exit status) and a Process::Status object. Without a block a RuntimeError is raised when the command exits non-zero.

• Option :verbose can be set to enable printing of the command line. If not set, rake’s verbose flag is used.

• Option :check_docker can be set to false to disable the docker check.

• Option :sigfw can be set to false to not stop the container on Ctrl-C.

• Option :runas can be set to false to execute the command as user root.

• Option :options can be an Array of additional options to the ‘docker run’ command.

• Option :username can be used to overwrite the user name in the container

• Option :groupname can be used to overwrite the group name in the container

Examples:

RakeCompilerDock.exec 'bash', '-c', 'echo $RUBY_CC_VERSION'

# File 'lib/rake_compiler_dock.rb', line 72

def exec(*args, &block)
  Starter.exec(*args, &block)
end

.image_name ⇒ Object

# File 'lib/rake_compiler_dock.rb', line 50

def image_name
  Starter.image_name
end

.sh(cmd, options = {}, &block) ⇒ Object

Run the command cmd within a fresh rake-compiler-dock container and within a shell.

If a block is given, upon command completion the block is called with an OK flag (true on a zero exit status) and a Process::Status object. Without a block a RuntimeError is raised when the command exits non-zero.

Option :verbose can be set to enable printing of the command line. If not set, rake’s verbose flag is used.

Option :rubyvm can be set to :mri or :jruby . It selects the docker image with an appropriate toolchain.

Option :platform can be set to a list of space separated values. It selects the docker image(s) with an appropriate toolchain. Allowed values are aarch64-linux-gnu, arm-linux-gnu, arm64-darwin, x64-mingw-ucrt, x64-mingw32, x86-linux-gnu, x86-mingw32, x86_64-darwin, x86_64-linux-gnu. If the list contains multiple values, cmd is consecutively executed in each of the docker images, Option :platform is ignored when :rubyvm is set to :jruby. Default is “x86-mingw32 x64-mingw32” .

Examples:

RakeCompilerDock.sh 'bundle && rake cross native gem'

Check exit status after command runs:

sh %{bundle && rake cross native gem}, verbose: false do |ok, res|
  if ! ok
    puts "windows cross build failed (status = #{res.exitstatus})"
  end
end

# File 'lib/rake_compiler_dock.rb', line 46

def sh(cmd, options={}, &block)
  Starter.sh(cmd, options, &block)
end