mirror of
https://github.com/nushell/nushell.git
synced 2024-12-11 17:51:50 +01:00
9ef1203ef9
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description Test runner now uses annotations instead of magic function names to pick up code to run. Additionally skipping tests is now done on annotation level so skipping and unskipping a test no longer requires changes to the test code In order for a function to be picked up by the test runner it needs to meet following criteria: * Needs to be private (all exported functions are ignored) * Needs to contain one of valid annotations (and only the annotation) directly above the definition, all other comments are ignored Following are considered valid annotations: * \# test * \# test-skip * \# before-all * \# before-each * \# after-each * \# after-all # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
35 lines
682 B
Plaintext
35 lines
682 B
Plaintext
use std log
|
|
use std assert
|
|
|
|
#[before-each]
|
|
def before-each [] {
|
|
log debug "Setup is running"
|
|
{msg: "This is the context"}
|
|
}
|
|
|
|
#[after-each]
|
|
def after-each [] {
|
|
log debug $"Teardown is running. Context: ($in)"
|
|
}
|
|
|
|
#[test]
|
|
def assert_pass [] {
|
|
log debug $"Assert is running. Context: ($in)"
|
|
}
|
|
|
|
#[ignore]
|
|
def assert_skip [] {
|
|
log debug $"Assert is running. Context: ($in)"
|
|
}
|
|
|
|
#[ignore]
|
|
def assert_fail_skipped_by_default [] {
|
|
# Change test-skip to test if you want to see what happens if a test fails
|
|
log debug $"Assert is running. Context: ($in)"
|
|
assert false
|
|
}
|
|
|
|
def unrelated [] {
|
|
log error "This should not run"
|
|
}
|