Skip to content

Commit

Permalink
site: Remove metest references and add run subcommand
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbobbio committed Jan 14, 2024
1 parent c5274f2 commit e85ea82
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 10 deletions.
9 changes: 5 additions & 4 deletions site/src/cargo_maelstrom.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ cargo-maelstrom is a replacement for `cargo test` which will run tests as jobs o
distributed clustered job runner. Each test runs in a lightweight container
where it is isolated from computer it is running on and other tests.

Running your tests using it can be as simple as running `cargo metest` instead
of `cargo test`, (see [Running Tests](./cargo_maelstrom/running_tests.md) for
details) but due to the tests running in a very isolated environment by default,
there can be some configuration required to make all your tests pass (see
Running your tests using it can be as simple as running `cargo maelstrom run`
instead of `cargo test`, (see [Running
Tests](./cargo_maelstrom/running_tests.md) for details) but due to the tests
running in a very isolated environment by default, there can be some
configuration required to make all your tests pass (see
[Configuration](./cargo_maelstrom/configuration.md).)
4 changes: 2 additions & 2 deletions site/src/cargo_maelstrom/include_and_exclude_flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ packages. This can be a useful tip to remember when trying to run a single test.

If we were to run something like
```bash
cargo metest -i "name.equals(foobar)"
cargo maelstrom run -i "name.equals(foobar)"
```

`cargo-maelstrom` would run any test which has the name "foobar". A test with this
Expand All @@ -30,7 +30,7 @@ build all of them. But if I happened to know that only one package has this
test, the `baz` package, I would be better off running the following instead.

```bash
cargo metest -i "package.equals(baz) && name.equals(foobar)"
cargo maelstrom run -i "package.equals(baz) && name.equals(foobar)"
```

Now since I specified that I only care about the "baz" package, `cargo-maelstrom`
Expand Down
3 changes: 2 additions & 1 deletion site/src/cargo_maelstrom/running_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Replace `<broker-address>` with the hostname or IP of the machine the broker is
running on. Replace `<broker-port>` with the port you provided to the broker via
the `--port` CLI option. (In the book we chose port 9001 for this)

Now we should be able to build and run tests just by running `cargo metest`
Now we should be able to build and run tests just by running `cargo maelstrom
run`

With no arguments it attempt to run all the tests in your project.

Expand Down
4 changes: 2 additions & 2 deletions site/src/cargo_maelstrom/test_pattern_dsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ These other expressions are useful occasionally
- **`true`, `all`, `any`**: selects all tests
- **`false`, `none`**: selects no tests

When you provide no filter to `cargo-maelstrom` it acts as if typed `cargo metest
-i all`
When you provide no filter to `cargo-maelstrom` it acts as if you typed `cargo
maelstrom run -i all`

## Abbreviations

Expand Down
2 changes: 1 addition & 1 deletion site/src/install/cargo_maelstrom.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ export GITHUB_URL="https://github.com/maelstrom-software/maelstrom.git"
cargo install --git $GITHUB_URL cargo-maelstrom
```

You should now be able to invoke it by running `cargo metest`
You should now be able to invoke it by running `cargo maelstrom run`

0 comments on commit e85ea82

Please sign in to comment.