Skip to content

RESTest 2.3.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 28 Oct 08:59
· 24 commits to master since this release
v2.3.0
99e0e02
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

RESTest 2.3.0 writes every run as a page to open in a browser, and says in report.json what happened to every operation and how the run went over the time it was given. It also installs with Homebrew, Java included; the command line, plans, dictionaries and exit codes are the same as in 2.2.0, and report.json only gains members.

What is new

  • A page for every run, report.html, written beside report.json: one file that opens with no network, from a build's artifacts, an e-mail or a laptop. It shows the errors and warnings in all and on every operation, the request behind each kind of fault with buttons that copy it as curl or as an issue, what could not be tested, and what the number the run ended with means. It shows nothing report.json does not hold; --set report.html=false writes report.json alone.
  • What happened to every operation, in report.json's operations: tested, and how its replies divided by class of status code; not reached; not testable, and why; or left alone by the plan. Beside it, documentIssues says which parts of the document could not be used, and keysNotGiven which keys the document asks for and nobody handed over.
  • What the run amounts to, in one word: verdict — errorsFound, noErrorsFound, nothingTested and the rest — worked out by the same rule as the exit code; and run, how the run was started.
  • How the run went over time: timeline says when the run began, the budget it had, and how the replies divided by class of status code in each sixtieth of it (report.timelineIntervals). An API that fell over after two seconds and one that failed from the first request no longer write the same file.
  • Homebrew, on macOS and Linux: brew install isa-group/tap/restest installs RESTest and the Java 21 it runs on, whatever Java the machine has, and brew upgrade restest moves to the next release.
  • Fixes: a path parameter that its path has no {…} for is left out of its operation, and said among the document's issues as leftOut, which ends the false F206 it caused; a reply off its schema no longer lists a detail line twice.

What a run sends and checks can be tuned or switched off: see settings and switches. What it does not do yet is in known limitations.

Install

With Homebrew, on macOS and Linux:

brew install isa-group/tap/restest

With Docker:

docker run --rm ghcr.io/isa-group/restest:2.3.0 version

With Java 21 or later, from one of the archives below:

tar -xzf restest-2.3.0.tgz
restest-2.3.0/bin/restest version

From the source:

git clone --branch v2.3.0 https://github.com/isa-group/RESTest.git
cd RESTest
./mvnw -q install -DskipTests
./restest version

README · Manual · Reference · All changes

Assets 5
Loading