Commit graph

1158 commits

Author SHA1 Message Date
Debarshi Ray
ecc76f39ac Silence SC1091
Otherwise https://www.shellcheck.net/ would complain:
  Line 44:
  . /etc/os-release
    ^-- SC1091: Not following: /etc/os-release was not specified as
      input (see shellcheck -x).

See: https://github.com/koalaman/shellcheck/wiki/SC1091
2019-02-19 14:57:14 +01:00
Emiel Wiedijk
26a285a7e0 POSIX only supports single digit file descriptors
See: https://wiki.ubuntu.com/DashAsBinSh

Detected by the checkbashisms [1] tool.

[1] https://packages.debian.org/sid/devscripts

https://github.com/debarshiray/toolbox/issues/53
2019-02-19 14:30:11 +01:00
Debarshi Ray
9315f6cbbf Fix typos
... detected by https://www.shellcheck.net/.

The opening solid bracket (ie. [) is actually a command like any other.
It expects it's final argument to be the closing bracket (ie. ]). Thus,
the redirection needs to be after the trailing bracket.

Fallout from 80f25c6924
2019-02-19 14:08:52 +01:00
Debarshi Ray
5b3d234c9e Make it work inside the toolbox container itself
A truly seamless developer experience requires erasing the divide
between the host and the toolbox container as much as possible.
Currently, various tools don't work at all when used from inside the
toolbox because they expect to be run on the host. eg., flatpak,
podman, and the toolbox script itself. This puts a significant enough
cognitive burden on the developer. At the very least, the human
operator needs to keep track of the context in which those commands
are being issued.

To make things better, the toolbox script has been made aware of the
context in which it is running. If it detects that it's running inside
the toolbox container, denoted by a 'podman exec ...' parent process
and the presence of /run/.containerenv, then it tries to forward its
own invocation to the host over D-Bus using 'flatpak-spawn --host' [1].
This uses the HostCommand method on the org.freedesktop.Flatpak D-Bus
service underneath to do the forwarding.

The process offering the org.freedesktop.Flatpak service doesn't have
some variables, like COLORTERM and TERM, set in its environment, and
their absence hinders the use of interactive shells. This is addressed
by tunneling the same set of environment variables that are also passed
to podman.

[1] http://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak-spawn

https://github.com/debarshiray/toolbox/pull/54
2019-02-19 13:22:18 +01:00
Debarshi Ray
a09692aa8b Split out the code to set environment variables in the toolbox
A subsequent commit will leverage this to tunnel the same environment
variables over D-Bus when the toolbox script forwards its own
invocation over 'flatpak-spawn --host'. This is necessary because the
process offering the underlying org.freedesktop.Flatpak D-Bus service
used by 'flatpak-spawn --host' doesn't have some variables, like
COLORTERM and TERM, set in its environment, and their absence hinders
the use of interactive shells.

Instead of keeping two separate hard coded lists, one for
flatpak-spawn and another for podman, it's better to use the same set
for both to avoid silly and weird bugs.

https://github.com/debarshiray/toolbox/pull/54
2019-02-19 13:22:18 +01:00
Debarshi Ray
b3a6578cc9 Avoid a Bash-ism (ie. source) and stick to POSIX (ie. .)
https://github.com/debarshiray/toolbox/issues/53
2019-02-18 18:31:04 +01:00
Debarshi Ray
dcb0fdacb0 Simplify code
Fallout from 5e4e63a11b
2019-02-18 18:16:35 +01:00
Debarshi Ray
9e0182e0a1 Use sed(1) instead of tr(1) for consistency
Shell scripts are archaic enough by themselves. For the sake of
readability it's better to stick to a smaller subset of features
that's already being widely used, instead of introducing slightly
different ways of doing the same thing.

Unless there's a pressing user-visible reason to introduce tr(1), it's
better to keep using sed(1).
2019-02-18 18:14:44 +01:00
Debarshi Ray
4d9a4bc22f Make --release a command-specific option
It's irrelevant for the list command, and it's more intuitive if it
behaves like the somewhat similar --container and --image options.
2019-02-18 13:18:12 +01:00
Debarshi Ray
e45ac66afe Refactor common code into a function 2019-02-18 11:53:34 +01:00
Debarshi Ray
403c4af508 Make --container a command-specific option
It's irrelevant for the list command, and it's more intuitive if it
behaves like the somewhat similar --image option.
2019-02-18 11:32:41 +01:00
Debarshi Ray
9d686a82dd Refactor common code into a function 2019-02-18 11:29:25 +01:00
Debarshi Ray
67522f0ad7 Use the host's PID namespace for the toolbox container
It's common practice to track down a process while developing. This
could be a process that's repeatedly crashing, or something that's
misbehaving by using up too many resources. Being able to seamlessly
look at what's happening on the host makes for a better developer
experience.

The toolbox doesn't intend to provide a segregated security domains,
so this is fine.
2019-02-18 10:49:08 +01:00
Debarshi Ray
e1898c0cc6 Style fix 2019-02-15 18:59:51 +01:00
Debarshi Ray
6d2c1f7e95 Hide the error output from column(1) unless --verbose is used
Fallout from 5e4e63a11b
2019-02-15 18:59:06 +01:00
Debarshi Ray
4cf58d5b72 Factor out the template for temporary directories into a variable 2019-02-15 17:23:40 +01:00
Debarshi Ray
c6b5a4836f Drop the "fedora" prefix and rename the project as just "toolbox"
The "fedora" prefix was used because this project was specifically
incubated to make it easier to hack on Fedora Silverblue. That and the
mix of upstream technologies (ie., Buildah and Podman) made it uniquely
"Fedora".

However, over time it has gotten clear that other groups, currently
Fedora downstreams like RHEL, are interested in it too. It won't be
surprising if in future it transcends the Fedora universe altogether.
Moreover, this project was inspired by coreos/toolbox [1]. There are
good reasons and enough interest to have a unified toolbox project
that addresses the needs of both Fedora CoreOS and Silverblue.

Therefore, it is best to drop the "fedora" prefix and call the whole
thing just "toolbox".

No extra effort was made to retain compatibility with the older name
due to the project's young age. Its userbase is limited to the earliest
of early adopters, and the benefits of a clean break outweigh the
loss of compatibility.

The OCI images and the toolbox container still retain the "fedora"
prefix to disambiguate them from their counterparts from other
operating systems.

[1] https://github.com/coreos/toolbox

https://github.com/debarshiray/toolbox/issues/8
2019-02-15 16:36:30 +01:00
Debarshi Ray
05f3530421 Shorten the prefix for debug and error messages
Using "$0" leads to printing the entire path to the fedora-toolbox
script, which adds visual noise to the output. Command line tools like
GNU Coreutils and Git remove any leading directory components from
the path, which seems like a reasonable trade-off between aesthetics
and verbosity.

https://github.com/debarshiray/fedora-toolbox/pull/50
2019-02-14 12:21:54 +01:00
Ondřej Zoder
5e4e63a11b Add a list command
https://github.com/debarshiray/fedora-toolbox/pull/39
2019-02-12 19:13:43 +01:00
Debarshi Ray
2aded000ec Avoid using a Bash-ism (ie. [[...]) for prefix matching 2019-02-11 18:32:33 +00:00
Debarshi Ray
1c18fa6d4f Avoid a Bash-ism (ie. [[...]) and stick to POSIX (ie. [...])
Fallout from 66e982af72
2019-02-11 18:08:29 +00:00
Debarshi Ray
2b6faa26f9 Prepare 0.0.5 2019-02-11 14:17:47 +00:00
Daniel J Walsh
4a2a15f2eb Give access to mounts under $HOME, and make autofs work 2019-01-28 11:45:25 +01:00
Debarshi Ray
4ff281b5ed Show a spinner while creating the toolbox image using buildah 2019-01-28 11:45:25 +01:00
Debarshi Ray
00eeeae6c4 Show a spinner while configuring the working container using buildah 2019-01-28 11:45:25 +01:00
Debarshi Ray
f10d8e7495 Split out the code to configure the working directory
A subsequent commit will leverage this to show a spinner.
2019-01-28 11:45:25 +01:00
Debarshi Ray
f976ba0fc3 Style fixes 2019-01-28 11:45:25 +01:00
Debarshi Ray
e32a8d3d03 Show a spinner while creating the toolbox container using podman 2019-01-28 11:45:25 +01:00
Debarshi Ray
6f22c0bf98 Show a spinner while pulling an image from the registry using buildah 2019-01-28 11:45:25 +01:00
Debarshi Ray
c155acbc15 Add a spinner framework
It's disabled when --verbose is used to avoid racing with buildah and
podman's progress bars.
2019-01-28 11:45:25 +01:00
Colin Walters
c047659c1d README.md: Rework in various ways
- OSTree systems aren't fully immutable, you *can* install things
   we just discourage it
 - fedora-toolbox can (and should!) be used on non-OSTree based
   systems as well

https://github.com/debarshiray/fedora-toolbox/pull/43
2019-01-26 13:09:54 +01:00
Debarshi Ray
093002d8a4 README.md: Remove trailing newline 2019-01-21 17:07:43 +01:00
Debarshi Ray
8c3ce3b386 README.md: Tweak
Simplify the prompt. Most people are going to use the Fedora package.
Hence, the prompt doesn't need to reflect the fedora-toolbox Git tree
as the current directory.
2019-01-21 17:07:02 +01:00
Debarshi Ray
cd30c869c8 Prepare 0.0.4 2019-01-21 15:29:43 +01:00
Debarshi Ray
ed14389150 Avoid a Bash-ism (ie. ==) and stick to POSIX (ie. =)
Fallout from 66e982af72
2019-01-16 20:08:41 +01:00
Owen W. Taylor
66e982af72 Set up $HOME and /home to match the host
Silverblue, and rpm-ostree more generally are moving to
HOME=/var/home/$USER and make the /home symlink just a compatibility
feature. See:

 https://github.com/projectatomic/rpm-ostree/pull/1726

Matching what the host does will reduce weird side-effects. Propagate
$HOME into the container to avoid mismatches in /etc/default/useradd,
and if the host has /home as a symlink to /var/home, do the same for
the toolbox.

https://github.com/debarshiray/fedora-toolbox/pull/34
2019-01-16 19:14:59 +01:00
Debarshi Ray
47614b980c Avoid spooky root-like behaviour for non-root interactive shells
Currently, the non-root interactive shells were being spawned with a
full set of capabilities. This led to unexpected root-like behaviour
for non-root users. All capability sets, except the Permitted (or
CapBnd) set, should be cleared to match the usual state of a host
interactive shell for non-root users.

It doesn't look like podman offers a way to forward CapBnd from the
host without touching the other sets. If '--privileged' is used with
'podman create', then it forwards CapBnd but also initializes the
others to have a full set of capabilities. If it's not used, then it
doesn't touch anything other than CapBnd, but only forwards a subset
of the host's CapBnd, which means that using sudo to attain elevated
privileges inside the toolbox won't give the full set of capabilities
as on the host.

It might be so that having a smaller CapBnd actually doesn't matter.
However, until that's proven true, it's safer to insist on having
'--privileged' forward the full set, and then clear up the other sets
on our own.

https://github.com/debarshiray/fedora-toolbox/issues/16
2019-01-15 13:42:10 +01:00
Debarshi Ray
ca41e387d7 Give access to the FUSE kernel module
https://github.com/debarshiray/fedora-toolbox/issues/15
2019-01-11 16:02:01 +01:00
Debarshi Ray
4873850da2 Separate fedora-toolbox debug output from those originating elsewhere 2019-01-11 15:01:43 +01:00
Debarshi Ray
1f9007cc2c Replace tabs with spaces 2019-01-11 15:00:21 +01:00
Debarshi Ray
b71609580b Improve the readability of the debug output
... by annotating the different stages of activity. This makes it
easier to understand the rest of the spew coming from buildah and
podman.

https://github.com/debarshiray/fedora-toolbox/issues/31
2019-01-11 14:52:24 +01:00
Mildred Ki'Lya
e2315f183e Try to enter the same directory inside the toolbox
The intermediate /bin/sh process will reset the values of PS1 and PWD.
Therefore, it's necessary to pass those as arguments to the script.

https://github.com/debarshiray/fedora-toolbox/issues/20
2019-01-10 17:14:43 +00:00
Debarshi Ray
d7ec66c8ab Prepare 0.0.3 2019-01-04 12:41:43 +00:00
Debarshi Ray
0ed1be57e4 Update copyright notices 2019-01-04 12:37:52 +00:00
Debarshi Ray
62e20f9df3 Clean up the Buildah working containers on error
Working containers are removed with 'buildah rm', while 'buildah rmi'
is for images.
2019-01-03 13:00:43 +00:00
Milos Vyletel
c713908e8b Unbreak creating the toolbox if the toolbox image already exists
Fallout from cc0caef627

https://github.com/debarshiray/fedora-toolbox/issues/19
2019-01-02 17:36:02 +01:00
Debarshi Ray
dd4394c32c README.md: Tweak
There's a build system and various Fedora packages now. Therefore, most
people don't need to run the script from the Git tree.
2018-11-12 15:11:33 +00:00
Debarshi Ray
cfefaf368a Prepare 0.0.2 2018-11-12 14:49:04 +00:00
Debarshi Ray
606c2da224 Don't fallback to /bin/bash when exiting with a failure return code
If the last command that was run interactively inside the toolbox
container had returned with a non-zero return code, then exiting the
toolbox would trigger the fallback to /bin/bash, just like it would
happen if $SHELL was missing from the toolbox. This is because
'podman exec ...' relays the return code of the last command.

Therefore, don't rely on the return code of 'podman exec ...' and check
the availability of $SHELL upfront. This does leave it vulnerable to
races caused by the availability of $SHELL changing between the check
and the actual attempt to use it. However, file I/O is inherently racy,
and this is better than a spurious fallback.

Keep the name of the default interactive shell localized to 'enter' by
using a subshell because 'local' is not mandated by POSIX.
2018-11-12 15:33:04 +01:00
Debarshi Ray
be719eac89 Hide the error output from sed(1) unless --verbose is used
It's unlikely that sed(1) will generate any error output, but still
it's good to handle it for the sake of completeness.
2018-11-09 12:30:15 +00:00