wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Tool for interactive command line environments on Linux
1173 commits 1 branch 0 tags 9.2 MiB
Shell 54.9%
Go 36.1%
Dockerfile 5.8%
Meson 1.9%
Python 0.7%
Other 0.6%
Find a file
Debarshi Ray 3dc106e10a test/system: Clarify misleading 'toolbox --help' test 
Commit 5e63e9ec9b added a 'help' command to show the toolbox(1)
manual or a manual page for a specific command, and made the --help flag
identical to it.  Therefore it's misleading to say that the --help flag
should show the usage screen.  The usage screen is a brief listing of
the commands and options, which isn't the same thing as the more
detailed manuals.

Later, after this test was written, commit 40fc1689a3 added a
fallback for host operating systems without man(1), like Fedora CoreOS,
that would show a very brief usage screen with only the most common
commands.

To make it more confusing, the test was checking for a string that's
common to both the toolbox(1) manual and the fallback brief usage screen
that might be shown by 'toolbox --help'.  This meant that it was neither
able to distinguish between the code paths nor ensure that they were
working as intended.

This was resolved by adapting the existing 'toolbox --help' test to
strictly ensure that it's showing the toolbox(1) manual when man(1) is
present, and by adding a new test to strictly ensure that it's showing
the fallback brief usage screen when man(1) is absent.

Until Bats 1.10.0, 'run --keep-empty-lines' had a bug where it counted
the trailing newline on the last line as a separate line [1].  However,
Bats 1.10.0 is only available in Fedora >= 39 and is absent from Fedoras
37 and 38.

Fallout from b27795a03e

[1] Bats commit 6648e2143bffb933
    https://github.com/bats-core/bats-core/commit/6648e2143bffb933
    https://github.com/bats-core/bats-core/issues/708

https://github.com/containers/toolbox/pull/1386
2023-10-12 13:18:34 +02:00
.github .github/workflows: Build the Ubuntu images for ppc64le 2023-09-28 08:29:36 +02:00
data build: Replace join_paths with the / operator 2022-10-21 17:24:03 +02:00
doc doc/toolbox: Add a usage section 2023-09-25 20:03:32 +02:00
images images: Ensure that the manuals from extra-packages are available 2023-10-09 13:12:55 +02:00
playbooks Revert "playbooks: Add workaround for Fedora Rawhide" 2023-08-24 16:34:44 +02:00
profile.d profile.d: Show welcome message on Fedora Sericea 2023-06-09 10:29:59 +02:00
src pkg/utils: Preserve environment variables for Bash's history facility 2023-09-30 14:22:31 +02:00
test test/system: Clarify misleading 'toolbox --help' test 2023-10-12 13:18:34 +02:00
.codespellexcludefile .codespellexcludefile: Silence false positives 2022-12-14 23:09:21 +01:00
.gitignore test/system: Track bats libs as submodules & install them better 2021-07-22 10:23:53 +02:00
.gitmodules test/system: Track bats libs as submodules & install them better 2021-07-22 10:23:53 +02:00
.mailmap .mailmap: Canonicalize my email 2022-08-01 18:37:43 +02:00
.zuul.yaml .zuul: Try to prevent the CI from timing out on Fedora 2023-10-12 13:18:02 +02:00
CODE-OF-CONDUCT.md CODE-OF-CONDUCT.md Update URL 2023-07-05 14:32:01 +02:00
CONTRIBUTING.md Fix spelling mistakes using codespell 2022-11-17 11:56:58 +01:00
COPYING Rename LICENSE as COPYING 2018-10-19 18:24:23 +02:00
gen-docs-list Update copyright notices 2022-11-28 21:01:18 +01:00
GOALS.md GOALS.md: Cosmetics 2021-01-25 21:13:07 +01:00
meson.build test/system: Test that networking works 2023-06-30 19:53:31 +02:00
meson_options.txt build: Enable changing the completion paths & drop install_completions 2022-10-21 16:42:29 +02:00
meson_post_install.py build: Skip a needless failure when running systemd-tmpfiles as non-root 2022-10-21 16:45:37 +02:00
NEWS Release 0.0.99.4 2023-02-20 17:02:55 +01:00
README.md README.md: Unbreak Arch Linux package URL 2023-06-09 11:19:45 +02:00
SECURITY.md SECURITY.md: Update URL 2023-06-27 17:20:43 +02:00
toolbox Silence SC2317 2023-01-12 14:41:53 +01:00

README.md

README

Zuul Daily Pipeline

Arch Linux package Fedora package

Toolbox is a tool for Linux, which allows the use of interactive command line environments for development and troubleshooting the host operating system, without having to install software on the host. It is built on top of Podman and other standard container technologies from OCI.

Toolbox environments have seamless access to the user's home directory, the Wayland and X11 sockets, networking (including Avahi), removable devices (like USB sticks), systemd journal, SSH agent, D-Bus, ulimits, /dev and the udev database, etc..

This is particularly useful on OSTree based operating systems like Fedora CoreOS and Silverblue. The intention of these systems is to discourage installation of software on the host, and instead install software as (or in) containers — they mostly don't even have package managers like DNF or YUM. This makes it difficult to set up a development environment or troubleshoot the operating system in the usual way.

Toolbox solves this problem by providing a fully mutable container within which one can install their favourite development and troubleshooting tools, editors and SDKs. For example, it's possible to do yum install ansible without affecting the base operating system.

However, this tool doesn't require using an OSTree based system. It works equally well on Fedora Workstation and Server, and that's a useful way to incrementally adopt containerization.

The toolbox environment is based on an OCI image. On Fedora this is the fedora-toolbox image. This image is used to create a toolbox container that offers the interactive command line environment.

Note that Toolbox makes no promise about security beyond what's already available in the usual command line environment on the host that everybody is familiar with.

Installation & Use

See our guides on installing & getting started with Toolbox and Linux distro support.