microsandbox-rb 0.5.7

data/Cargo.toml

@@ -0,0 +1,16 @@
+# Workspace root for the Ruby native extension. rb-sys (RbSys::ExtensionTask)
+# runs `cargo metadata` from here to locate the cdylib crate. The microsandbox
+# core crate is pulled in as an external path dependency by the member crate
+# (it lives in its own workspace in the adjacent checkout).
+[workspace]
+resolver = "2"
+members = ["ext/microsandbox"]
+
+[profile.release]
+# Loaded into the Ruby process: keep unwinding (NOT panic = "abort") so magnus
+# converts Rust panics into Ruby exceptions at the FFI boundary rather than
+# aborting the host. Default opt-level 3.
+opt-level = 3
+
+[profile.dev]
+opt-level = 0

data/DESIGN.md

@@ -0,0 +1,159 @@
+# microsandbox Ruby SDK — Architecture
+
+This gem is the Ruby member of the official microsandbox SDK family. Like the
+Python, Node, and Go SDKs, it does **not** talk to a daemon over a socket:
+it embeds the microsandbox runtime directly in the host process through a Rust
+native extension and spawns real microVMs as child processes.
+
+## Why a native extension (not pure Ruby)
+
+The official SDKs (`sdk/python`, `sdk/node-ts`, `sdk/go`) are all thin language
+bindings over the same Rust core crate (`crates/microsandbox`):
+
+| SDK     | Binding tech            | Artifact                |
+|---------|-------------------------|-------------------------|
+| Python  | pyo3                    | `_microsandbox` cdylib  |
+| Node    | napi-rs                 | `.node` addon           |
+| Go      | cgo + FFI header        | static lib              |
+| **Ruby**| **magnus + rb-sys**     | **`microsandbox_rb.bundle`** |
+
+There is no network protocol to reimplement in pure Ruby — the runtime is
+embedded. So the only way to be *aligned* with the official SDKs is to wrap the
+**same** `microsandbox` core crate. We use [magnus](https://github.com/matsadler/magnus)
+(0.8) + [rb-sys](https://github.com/oxidize-rb/rb-sys) (0.9), the modern,
+production-grade Ruby↔Rust toolchain (used by `wasmtime-rb`, `oxi-test`, etc.).
+
+## Two layers (mirrors the Python SDK)
+
+```
+lib/microsandbox/*.rb      ← ergonomic, idiomatic Ruby (this is what users call)
+        │ delegates to
+ext/microsandbox/src/*.rs  ← magnus bindings over the core crate (Microsandbox::Native::*)
+        │ calls
+crates/microsandbox        ← the shared Rust runtime engine
+```
+
+* **Native layer** (`Microsandbox::Native`): thin, synchronous wrappers that own
+  the core Rust objects (`Sandbox`, `ExecOutput`, `SandboxFsOps`, …) and expose
+  primitive-typed methods. Mirrors `sdk/python/src/*.rs`.
+* **Ruby layer** (`Microsandbox`): keyword-argument constructors, block-form
+  lifecycle (`Sandbox.create(...) { |sb| ... }` auto-stops, like Python's
+  `async with`), predicate/bang naming, the typed error hierarchy, and value
+  objects. Mirrors `sdk/python/microsandbox/*.py`.
+
+## Sync, not async
+
+Ruby has no `async`/`await` in its core object model, so — like the **Go** SDK —
+the Ruby API is **synchronous**. The core crate is async (tokio). Each native
+method runs its future to completion on a shared, lazily-initialized
+multi-threaded tokio runtime via `runtime.block_on(fut)`.
+
+### GVL release
+
+`block_on` is wrapped in `nogvl` (`rb_thread_call_without_gvl`) so the Ruby
+Global VM Lock is **released** while a sandbox operation is in flight. Without
+this, a long-running `exec` would freeze every other Ruby thread/fiber in the
+process (a real problem under Rails/Puma). The `nogvl` closure runs pure Rust
+only (never touches the Ruby C API) and uses `catch_unwind` so a Rust panic is
+captured and re-raised *after* the GVL is re-acquired rather than unwinding
+across the C frame (which would be UB).
+
+## Error mapping
+
+The core returns one big `MicrosandboxError` enum. `error.rs` maps each variant
+to a Ruby exception class under `Microsandbox` (e.g. `InvalidConfig` →
+`Microsandbox::InvalidConfigError`), all descending from `Microsandbox::Error`,
+each carrying a stable `#code`. This mirrors `sdk/python/microsandbox/errors.py`
+and the Rust→class mapping in `sdk/python/src/error.rs`.
+
+## Runtime binary (`msb` + `libkrunfw`)
+
+The core crate's `prebuilt` feature (on by default) downloads the `msb` microVM
+runtime and `libkrunfw` firmware into `~/.microsandbox/{bin,lib}` **at build
+time** (`build.rs`). The path resolver checks, in order: `$MSB_PATH` →
+SDK-set path (`Microsandbox.runtime_path=`) → config file → workspace build →
+`~/.microsandbox/bin/msb` → `which msb`. `Microsandbox.install` / `.installed?`
+expose the core `setup::install`/`is_installed` for explicit, idempotent
+provisioning (mirrors the Python `install()`/`is_installed()`).
+
+## Core-crate dependency (self-contained)
+
+`ext/microsandbox/Cargo.toml` depends on the core crate via a **pinned git tag**
+(`microsandbox` / `microsandbox-network` at `v0.5.7`), so the gem builds anywhere
+— CI, `rake-compiler-dock` release containers, and end-user source installs —
+without an adjacent checkout. For fast local development against a sibling
+microsandbox checkout, copy `.cargo/config.toml.example` to `.cargo/config.toml`
+(gitignored); its `paths` override builds against the local crates instead of
+git. The override must never be committed — it would break container builds.
+
+## Packaging & releases
+
+* **Source gem**: compiles the extension via `extconf.rb` (rb-sys
+  `create_rust_makefile`); requires a Rust toolchain (MSRV below).
+* **Precompiled platform gems**: built in CI on a `vX.Y.Z` tag
+  (`.github/workflows/release.yml`) with `oxidize-rb/cross-gem-action`
+  (`rake-compiler-dock`) per `Gem::Platform`, shipping multi-ABI
+  `lib/microsandbox/<ruby_abi>/` native artifacts — the same model Node uses with
+  per-platform packages. End users then install with no Rust toolchain. Published
+  to RubyGems via Trusted Publishing (OIDC). See [Releasing](README.md#releasing).
+  Whether the heavy core cross-builds for `arm64-darwin` under osxcross is
+  confirmed on first run; if not, that platform moves to a native macOS runner.
+
+## Build requirements
+
+* Ruby >= 3.1, RubyGems >= 3.3.11
+* Rust (stable) >= 1.91 — the core crate is edition 2024 and pulls `smoltcp`
+  which sets MSRV 1.91. `rust-toolchain.toml` pins `stable`.
+* Linux with KVM, or macOS on Apple Silicon (same as the other SDKs).
+
+## Implemented surface (v1) vs roadmap
+
+**Implemented:** sandbox lifecycle (`create`/`start`/`get`/`list`/`list_with`/
+`remove`/`stop`/`kill`, the async `request_stop`/`request_kill`/`request_drain`/
+`wait_until_stopped` (→ `SandboxStopResult`) / `detach` / `owns_lifecycle?`
+controls, block form), `exec`/`shell` with collected `ExecOutput`,
+**streaming** `exec_stream`/`shell_stream` (`ExecHandle` is `Enumerable` over
+`ExecEvent`s, with stdin sink + signal/kill/resize), the full guest filesystem
+API (`fs.read`/`write`/`list`/`mkdir`/`remove`/`stat`/…), `metrics`,
+`Microsandbox.all_sandbox_metrics`, **streaming `metrics_stream`/`log_stream`**
+(`Enumerable` over `Metrics`/`LogEntry`), `logs`,
+**OCI image-cache management** (`Image.get`/`list`/`inspect`/`remove`/`prune`),
+**named volumes** (`Volume.create`/`get`/`list`/`remove` + `volumes:` mounts),
+**snapshots** (`Snapshot.create`/`get`/`list`/`remove`/`verify`/`export`/`import`
++ `from_snapshot:` boot), `version`/`install`/`installed?`, and
+the typed error hierarchy.
+
+Create options now cover `image`, `cpus`, `memory`, `oci_upper_size`, `env`,
+`workdir`, `shell`, `user`, `hostname`, `labels`, `scripts`, `entrypoint`,
+`ports`/`ports_udp`, `volumes`, `network` policy presets
+(`public_only`/`none`/`allow_all`/`non_local`), `log_level`, `quiet_logs`,
+`security`, `max_duration`, `idle_timeout`, `rlimits`, `pull_policy`, `secrets`,
+`from_snapshot`, `detached`, and `replace`/`replace_with_timeout`. `exec`/`shell`
+add per-call `rlimits`.
+
+## Verification
+
+The binding is verified at four levels:
+
+1. **Unit** (130 examples) — the Ruby layer's option normalization and value
+   objects, with the native layer stubbed.
+2. **Real-microVM integration** (`spec/integration`, opt-in via
+   `MICROSANDBOX_INTEGRATION=1`) — boots actual sandboxes and round-trips
+   `exec`/`shell`/`fs`/`metrics`/`logs`/streaming/snapshots. Run locally on
+   macOS Apple Silicon and wired into CI on a KVM runner.
+3. **Cross-SDK behavioral parity** — an identical-operations harness run through
+   this gem and through the **official Go SDK** against the same embedded runtime
+   produces byte-identical observable results (exec exit/stdout/success, env
+   propagation, non-zero-exit handling, fs round-trip + size, metrics). Both wrap
+   the same core crate, so this confirms the binding shapes data identically to
+   the official SDKs.
+4. **Packaged-gem install** — `gem install microsandbox-rb-<v>.gem` compiles the
+   shipped Rust source via `extconf.rb` and the installed gem boots a real
+   microVM, confirming the gem manifest and source-install path are complete.
+
+**Roadmap:** custom per-rule network policies (CIDR/domain/group allow-deny
+rules — the presets and secret-host allowances are covered), file patches,
+registry auth, interactive `attach`/`attach_shell` (host-TTY coupled — raw mode,
+SIGWINCH), SSH (`SshClient`/`SftpClient`/`SshServer`), and the raw agent client.
+The native layer is structured so these slot in module-by-module, exactly as in
+the Python binding.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.