Add Dockerfile to enable running end-to-end tests with docker

.dockerignore

@@ -0,0 +1,24 @@
+.git
+Dockerfile
+
+# Rust stuff
+target
+
+# Vagrant stuff
+.vagrant
+*.log
+
+# Compiled artifacts
+# (see devtools/*-package-for-*.sh)
+/exa-linux-x86_64
+/exa-linux-x86_64-*.zip
+/exa-macos-x86_64
+/exa-macos-x86_64-*.zip
+/MD5SUMS
+/SHA1SUMS
+
+# Snap stuff
+parts
+prime
+stage
+*.snap

Dockerfile

@@ -0,0 +1,109 @@
+FROM rust:1.71.1 AS just
+# Install Just, the command runner.
+RUN curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to /usr/bin
+
+FROM rust:1.71.1 AS specsheet
+RUN cargo install -q --git https://github.com/ogham/specsheet
+
+FROM rust:1.71.1 AS cargo-hack
+RUN cargo install -q cargo-hack
+
+FROM rust:1.71.1 AS cargo-kcov
+RUN cargo install -q cargo-kcov
+
+FROM rust:1.71.1 AS exa
+WORKDIR /app
+# Copy the source code into the image
+COPY . .
+# Build exa
+RUN cargo build
+
+# We use Ubuntu instead of Debian because the image comes with two-way
+# shared folder support by default.
+# This image is based from Ubuntu
+FROM rust:1.71.1 AS base
+
+# Install the dependencies needed for exa to build
+RUN apt-get update -qq
+RUN apt-get install -qq -o=Dpkg::Use-Pty=0 \
+    git gcc curl attr libgit2-dev zip \
+    fish zsh bash bash-completion
+
+# Install kcov for test coverage
+# This doesn’t run coverage over the xtests so it’s less useful for now
+COPY --from=cargo-kcov /usr/local/cargo/bin/cargo-kcov /usr/bin/cargo-kcov
+
+RUN apt-get install -y \
+    cmake g++ pkg-config \
+    libcurl4-openssl-dev libdw-dev binutils-dev libiberty-dev
+
+RUN ln -s $(which python3) /usr/bin/python
+RUN cargo kcov --print-install-kcov-sh | sh
+
+# Create a variety of misc scripts.
+
+RUN ln -sf /vagrant/devtools/dev-run-debug.sh /usr/bin/exa
+RUN ln -sf /vagrant/devtools/dev-run-release.sh /usr/bin/rexa
+
+RUN echo -e "#!/bin/sh\ncargo build --manifest-path /vagrant/Cargo.toml \\$@" > /usr/bin/build-exa
+RUN ln -sf /usr/bin/build-exa /usr/bin/b
+
+RUN echo -e "#!/bin/sh\ncargo test --manifest-path /vagrant/Cargo.toml \\$@ -- --quiet" > /usr/bin/test-exa
+RUN ln -sf /usr/bin/test-exa /usr/bin/t
+
+RUN echo -e "#!/bin/sh\n/vagrant/xtests/run.sh" > /usr/bin/run-xtests
+RUN ln -sf /usr/bin/run-xtests /usr/bin/x
+
+RUN echo -e "#!/bin/sh\nbuild-exa && test-exa && run-xtests" > /usr/bin/compile-exa
+RUN ln -sf /usr/bin/compile-exa /usr/bin/c
+
+ADD --chmod=+x devtools/dev-package-for-linux.sh /vagrant/devtools/dev-package-for-linux.sh
+RUN echo -e "#!/bin/sh\nbash /vagrant/devtools/dev-package-for-linux.sh \\$@" > /usr/bin/package-exa
+RUN echo -e "#!/bin/sh\ncat /etc/motd" > /usr/bin/halp
+
+# Configure the welcoming text that gets shown:
+
+# Capture the help text so it gets displayed first
+RUN rm -f /etc/update-motd.d/*
+ADD --chmod=+x devtools/dev-help.sh /vagrant/devtools/dev-help.sh
+RUN bash /vagrant/devtools/dev-help.sh > /etc/motd
+
+# Tell bash to execute a bunch of stuff when a session starts
+RUN echo "source /vagrant/devtools/dev-bash.sh" > ${HOME}/.bash_profile
+
+# Link the completion files so they’re “installed”:
+
+# bash
+RUN ln -s /vagrant/completions/bash/exa /etc/bash_completion.d/exa
+RUN ln -s /vagrant/completions/bash/exa /usr/share/bash-completion/completions/exa
+
+# zsh
+RUN ln -s /vagrant/completions/zsh/_exa /usr/share/zsh/vendor-completions/_exa
+
+# fish
+RUN ln -s /vagrant/completions/fish/exa.fish /usr/share/fish/completions/exa.fish
+
+
+# Copy the source code into the image
+COPY --chmod=+x . /vagrant/
+
+# Make sudo dummy replacement
+# This is needed for some tests that use sudo
+RUN echo -e '#!/bin/sh\n"$@"' > /usr/bin/sudo
+RUN chmod +x /usr/bin/sudo
+
+RUN bash /vagrant/devtools/dev-set-up-environment.sh
+RUN bash /vagrant/devtools/dev-create-test-filesystem.sh
+
+WORKDIR /vagrant
+COPY --from=exa /app/target /vagrant/target
+
+# TODO: remove this once tests don't depend on it
+RUN ln -s /vagrant/* ${HOME}
+
+COPY --from=specsheet /usr/local/cargo/bin/specsheet /usr/bin/specsheet
+COPY --from=cargo-hack /usr/local/cargo/bin/cargo-hack /usr/bin/cargo-hack
+COPY --from=just /usr/bin/just /usr/bin/just
+
+FROM base AS test
+CMD ["/vagrant/xtests/run.sh"]

README.md

@@ -234,9 +234,26 @@ The full command is `cargo build --release --target=x86_64-unknown-linux-musl --
 
 For more information, see the [Building from Source page](https://the.exa.website/install/source).
 
+### End to end testing
 
-### Testing with Vagrant
+#### Testing with containers
 
+You can use [Docker](https://www.docker.com/) to run exa in a container, and test it against a known state.
+
+```fish
+# Build the container image
+docker build . -t exa-test --target test
+
+# Run the tests in the container
+docker run -it exa-test
+
+# In case you want to get into the container to test something
+docker run -it exa-test fish
+```
+
+> Note: You should be able to run this with any container runtime you'd like. You are welcome to add a PR documenting how to do this with other runtimes.
+
+#### Testing with Vagrant
 exa uses [Vagrant][] to configure virtual machines for testing.
 
 Programs such as exa that are basically interfaces to the system are [notoriously difficult to test][testing].
@@ -269,4 +286,4 @@ Once this is done, you can SSH in, and build and test:
 
 Of course, the drawback of having a standard development environment is that you stop noticing bugs that occur outside of it.
 For this reason, Vagrant isn’t a *necessary* development step — it’s there if you’d like to use it, but exa still gets used and tested on other platforms.
-It can still be built and compiled on any target triple that it supports, VM or no VM, with `cargo build` and `cargo test`.
+It can still be built and compiled on any target triple that it supports, VM or no VM, with `cargo build` and `cargo test`.