Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: lambdaisland/kaocha
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 29458d98d0ef514fd2dc60e467d42abe35d05a82
Choose a base ref
..
head repository: lambdaisland/kaocha
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 26f3b81ec8e37eb8f7b019a8bc33616d488b05f3
Choose a head ref
1 change: 1 addition & 0 deletions doc/clojure_test/assertions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# `clojure.test` assertion extensions

When running `clojure.test` based tests through Kaocha, some of the behavior
1 change: 1 addition & 0 deletions doc/command_line/capability_check.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Capability check for org.clojure/tools.cli If a project's dependency

pulls in an old version of tools.cli, then this may break command line flags
1 change: 1 addition & 0 deletions doc/command_line/fail_fast.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# CLI: `--fail-fast` option

Kaocha by default runs all tests it can find, providing a final summary on
1 change: 1 addition & 0 deletions doc/command_line/print_config.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# CLI: Print the Kaocha configuration

A Kaocha test run starts with building up a Kaocha configuration map, based on
1 change: 1 addition & 0 deletions doc/command_line/profile.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# CLI: `--profile` option

The `--profile KEYWORD` flags sets the profile that is used to read the
1 change: 1 addition & 0 deletions doc/command_line/reporter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# CLI: `--reporter` option

The progress and summary printed by Kaocha are done by one or more "reporter"
1 change: 1 addition & 0 deletions doc/command_line/suite_names.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# CLI: Selecting test suites

Each test suite has a unique id, given as a keyword in the test configuration.
1 change: 1 addition & 0 deletions doc/config/bindings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Configuration: Bindings

You can configure dynamic vars from `tests.edn`, these will be bound to the
1 change: 1 addition & 0 deletions doc/filtering/focus_meta.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Focusing based on metadata

You can limit the test run based on test's metadata. How to associate metadata
1 change: 1 addition & 0 deletions doc/filtering/focusing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Focusing on specific tests

You can limit the test run to only specific tests or test groups (e.g.
1 change: 1 addition & 0 deletions doc/filtering/skip_meta.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Skipping based on metadata

You can limit the test run based on test's metadata. How to associate metadata
1 change: 1 addition & 0 deletions doc/filtering/skipping.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Skipping test based on ids

You can tell Kaocha to completely ignore certain tests or test groups, either
1 change: 1 addition & 0 deletions doc/pending.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Marking tests as pending

Pending tests are tests that are not yet implemented, or that need fixing, and
1 change: 1 addition & 0 deletions doc/plugins/capture_output.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Plugin: Capture output

Kaocha has a plugin which will capture all output written to stdout or stderr
1 change: 1 addition & 0 deletions doc/plugins/hooks_plugin.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Plugin: Hooks

The hooks plugin allows hooking into Kaocha's process with arbitrary
1 change: 1 addition & 0 deletions doc/plugins/notifier_plugin.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Plugin: Notifier (desktop notifications)

Desktop notifications can be enabled with the `:kaocha.plugin/notifier`
1 change: 1 addition & 0 deletions doc/plugins/orchestra_plugin.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Orchestra (spec instrumentation)

You can enable spec instrumentation of your functions before running
41 changes: 21 additions & 20 deletions doc/plugins/version_filter.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Plugin: Clojure/Java Version filter

The `version-filter` plugin will look for test metadata specifying the minimum
or maximum version of Clojure or Java the test is designed to work with, and
skip the test unless it falls within the range specified.

The recognized metadata keys are `:min-clojure-version`,
`:max-clojure-version`, `:min-java-version`, and `:max-java-version`. The
associated value is a version string, such as `"1.10.0"`.

You can set both a minimum and a maximum to limit to a certain range. The
boundaries are always inclusive, so `^{:max-clojure-version "1.9"}` will run
on Clojure `1.9.*` or earlier.

Specificty matters, a test with a max version of `"1.10" will also run on
version `"1.10.2"`, whereas if the max version is `"1.10.0"` it will not.

Note that the Java version is based on the "java.runtime.version" system
property. Before Java 9 this was the so called "developer version", which
started with `1.`, e.g. `"1.8.0"`, so Java (JDK) versions effectivel jumped
from `1.8` to `9`.
[1](https://blogs.oracle.com/java-platform-group/a-new-jdk-9-version-string-scheme)
[2](https://en.wikipedia.org/wiki/Java_version_history#Versioning_change)
or maximum version of Clojure or Java the test is designed to work with, and
skip the test unless it falls within the range specified.

The recognized metadata keys are `:min-clojure-version`,
`:max-clojure-version`, `:min-java-version`, and `:max-java-version`. The
associated value is a version string, such as `"1.10.0"`.

You can set both a minimum and a maximum to limit to a certain range. The
boundaries are always inclusive, so `^{:max-clojure-version "1.9"}` will run
on Clojure `1.9.*` or earlier.

Specificty matters, a test with a max version of `"1.10" will also run on
version `"1.10.2"`, whereas if the max version is `"1.10.0"` it will not.

Note that the Java version is based on the "java.runtime.version" system
property. Before Java 9 this was the so called "developer version", which
started with `1.`, e.g. `"1.8.0"`, so Java (JDK) versions effectivel jumped
from `1.8` to `9`.
[1](https://blogs.oracle.com/java-platform-group/a-new-jdk-9-version-string-scheme)
[2](https://en.wikipedia.org/wiki/Java_version_history#Versioning_change)

## Enabling in `tests.edn`

1 change: 1 addition & 0 deletions doc/spec_test_check.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Automatic spec test check generation

Kaocha can discover all of your fdefs and generate `clojure.spec.test.check`
1 change: 1 addition & 0 deletions doc/syntax_error.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- This document is generated based on a corresponding .feature file, do not edit directly -->
# Syntax errors are preserved

Syntax errors should be passed along.