From 366a67e1121f81f72d81553c7678bfdc3bca93e9 Mon Sep 17 00:00:00 2001 From: Taeer Bar-Yam Date: Thu, 25 Jul 2024 07:49:22 -0400 Subject: [PATCH] update readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index d85e960..c8de4c4 100644 --- a/README.md +++ b/README.md @@ -54,8 +54,28 @@ NOTE: it sometimes takes a while for the services to start up, and in the meanti - mastodon-web.service - peertube.service - the `garage` CLI command gives information about garage storage, but cannot be used to actually inspect the contents. use `mc` (minio) for that + - run `mc alias set garage http://s3.garage.localhost:3900 --api s3v4 --path off $AWS_ACCESS_KEY_ID $AWS_SECRET_ACCESS_KEY` - in the chromium devtools, you can go to the networking tab and change things like response headers in a way that persists through reloads. this is much faster iteration time if that's what you need to epxeriment with. +## NixOS Tests + +Tests live in the aptly named `tests/` directory, and can be accessed at the flake URI `.#checks..` e.g. `nix build .#checks.x86_64-linux.mastodon-garage`. +They can also be run interactively with +``` +nix build .#checks...driverInteractive +./result/bin/nixos-test-driver 2>output +```` +you can `less -F output` from a different terminal to follow along. + +These tests are also equiped with the same port forwarding as the VMs, so when running interactively you should be able to access services through a browser running on your machine. + +While running interactively, `rebuildableTests` allows you to modify the test nodes and then redeploy without restarting the test and waiting for the VMs to start up again. To do this you must start the jumphost by running `redeploy_jumphost.start()` inside the driver. Then from the command line + +``` +nix build .#checks...driverInteractive +./result/bin/rebuild +``` + # questions - what is meant to be shared between instances?