Class: Ace::Test::EndToEndRunner::Molecules::BwrapSandboxBackend

Inherits:
Object
  • Object
show all
Defined in:
lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb

Overview

Wraps subprocesses in a lightweight bubblewrap sandbox on Linux.

Constant Summary collapse

BUNDLER_ENV_PREFIXES = 
%w[BUNDLE BUNDLER].freeze
STRIPPED_ENV_KEYS = 
%w[RUBYOPT RUBYLIB].freeze
PROVIDER_HOME_MOUNTS = 
[
  [".claude", ".claude"],
  [".codex", ".codex"],
  [".gemini", ".gemini"],
  [".pi", ".pi"],
  [".local/share/opencode", ".local/share/opencode"]
].freeze
DEFAULT_SYSTEM_MOUNTS = 
%w[/usr /bin /sbin /lib /lib64 /etc /opt /var/lib/flatpak/exports].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sandbox_root:, source_root: nil, bwrap_path: "bwrap", outer_env: nil) ⇒ BwrapSandboxBackend

Returns a new instance of BwrapSandboxBackend.



36
37
38
39
40
41
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 36

def initialize(sandbox_root:, source_root: nil, bwrap_path: "bwrap", outer_env: nil)
  @sandbox_root = File.expand_path(sandbox_root)
  @source_root = source_root ? File.expand_path(source_root) : infer_source_root
  @bwrap_path = bwrap_path
  @outer_env = sanitized_outer_env(outer_env)
end

Instance Attribute Details

#sandbox_root ⇒ Object (readonly)

Returns the value of attribute sandbox_root.



24
25
26
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 24

def sandbox_root
  @sandbox_root
end

Class Method Details

.available?(bwrap_path: "bwrap") ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
34
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 30

def self.available?(bwrap_path: "bwrap")
  return false unless supported?

  system("which", bwrap_path, out: File::NULL, err: File::NULL)
end

.supported? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 26

def self.supported?
  Gem.win_platform? == false && RUBY_PLATFORM.include?("linux")
end

Instance Method Details

#capture3(cmd, chdir:, env: {}, stdin_data: nil) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 130

def capture3(cmd, chdir:, env: {}, stdin_data: nil)
  if self.class.supported?
    Open3.capture3(
      @outer_env,
      *wrap_command(cmd, chdir: chdir, env: env),
      chdir: "/",
      stdin_data: stdin_data
    )
  else
    full_env = prepared_env(env)
    Open3.capture3(
      @outer_env.merge(full_env),
      *Array(cmd),
      chdir: chdir,
      stdin_data: stdin_data
    )
  end
end

#command_prefix(chdir:, env: {}) ⇒ Object 



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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 73

def command_prefix(chdir:, env: {})
  return [] unless self.class.supported?

  ensure_available!
  merged_env = prepared_env(env)
  ensure_runtime_dirs(merged_env)

  args = [
    @bwrap_path,
    "--clearenv",
    "--die-with-parent",
    "--new-session",
    "--proc", "/proc",
    "--dev-bind", "/dev", "/dev",
    "--tmpfs", "/tmp",
    "--tmpfs", home_root,
    "--dir", merged_env.fetch("HOME"),
    "--bind", merged_env.fetch("HOME"), merged_env.fetch("HOME")
  ]

  host_mounts(merged_env.fetch("PATH")).each do |mount|
    append_bind(args, mount, mount, read_only: true)
  end
  append_bind(args, @source_root, @source_root, read_only: true) if @source_root
  append_bind(args, @sandbox_root, @sandbox_root, read_only: false)
  append_bind(args, support_root, support_root, read_only: false)
  ruby_root = merged_env["ACE_E2E_SANDBOX_RUBY_ROOT"].to_s
  append_bind(args, ruby_root, ruby_root, read_only: true) if !ruby_root.empty? && File.exist?(ruby_root)
  bind_provider_homes(args, merged_env.fetch("HOME"))

  setenvs = {
    "HOME" => merged_env.fetch("HOME"),
    "TMPDIR" => merged_env.fetch("TMPDIR"),
    "XDG_RUNTIME_DIR" => merged_env.fetch("XDG_RUNTIME_DIR"),
    "TMUX_TMPDIR" => merged_env.fetch("TMUX_TMPDIR"),
    "PATH" => merged_env.fetch("PATH"),
    "PROJECT_ROOT_PATH" => merged_env.fetch("PROJECT_ROOT_PATH")
  }
  setenvs["ACE_E2E_SOURCE_ROOT"] = merged_env["ACE_E2E_SOURCE_ROOT"] if merged_env["ACE_E2E_SOURCE_ROOT"]
  setenvs["ACE_E2E_SANDBOX_RUBY_ROOT"] = ruby_root unless ruby_root.empty?
  setenvs["ACE_TMUX_SESSION"] = merged_env["ACE_TMUX_SESSION"] if merged_env["ACE_TMUX_SESSION"]

  merged_env.each do |key, value|
    next if setenvs.key?(key)
    next if value.nil?

    setenvs[key] = value.to_s
  end

  setenvs.each do |key, value|
    args.concat(["--setenv", key, value])
  end

  args.concat(["--chdir", File.expand_path(chdir), "--"])
  args
end

#ensure_available! ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 43

def ensure_available!
  return unless self.class.supported?
  return if self.class.available?(bwrap_path: @bwrap_path)

  raise "bubblewrap is required for Linux E2E sandboxing but '#{@bwrap_path}' is not available"
end

#exec(cmd, chdir:, env: {}) ⇒ Object 



149
150
151
152
153
154
155
156
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 149

def exec(cmd, chdir:, env: {})
  if self.class.supported?
    Kernel.exec(@outer_env, *wrap_command(cmd, chdir: chdir, env: env))
  else
    full_env = prepared_env(env)
    Kernel.exec(@outer_env.merge(full_env), *Array(cmd), chdir: chdir)
  end
end

#prepared_env(base_env = {}) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 50

def prepared_env(base_env = {})
  env = stringify_keys(base_env)
  STRIPPED_ENV_KEYS.each { |key| env.delete(key) }
  env["PROJECT_ROOT_PATH"] = @sandbox_root
  env["ACE_E2E_SOURCE_ROOT"] ||= @source_root if @source_root
  env["HOME"] = sandbox_home
  env["TMPDIR"] = sandbox_tmp
  env["XDG_RUNTIME_DIR"] = sandbox_runtime_dir
  env["TMUX_TMPDIR"] ||= sandbox_runtime_dir
  env["BUNDLE_GEMFILE"] ||= File.join(@sandbox_root, ".ace-local", "e2e-runtime", "Gemfile")
  env["ACE_CONFIG_PATH"] ||= File.join(@sandbox_root, ".ace")
  env["BUNDLE_APP_CONFIG"] ||= bundler_app_config
  env["BUNDLE_USER_HOME"] ||= bundler_home
  env["BUNDLE_USER_CACHE"] ||= bundler_cache
  env["BUNDLE_USER_CONFIG"] ||= bundler_user_config
  env["PATH"] ||= ENV["PATH"].to_s
  env
end

#wrap_command(cmd, chdir:, env: {}) ⇒ Object 



69
70
71
 
# File 'lib/ace/test/end_to_end_runner/molecules/bwrap_sandbox_backend.rb', line 69

def wrap_command(cmd, chdir:, env: {})
  command_prefix(chdir: chdir, env: env) + Array(cmd)
end