inst/testdownhelp.md

In ThinkR-open/testdown: 'testhat' Results to Bookdown

How to read {testdown} reports {-}

Glossary {-}

Scopes of tests {-}

There are three scopes when it comes to tests:

• "Test files", which are the files included inside the test/testthat/ folder, and which contain a testing infrastructure. Each file contains one ore more test(s).

• "Tests", which start with test_that("",. Each test contains one or more expectation(s).

• "Expectations", which (usually) start with expect_ (note that skip_ functions are also considered as expectations). An expectation only contains one statement. If you put a roxygen tag @description just before your expectation, it will be displayed in the testing results (otherwise the 'Description' column will be blank).

To sum up, Test files contains one or more test(s), which contain one or more expectation(s).

Expectations status {-}

• ✅ Success: Passed (the expectation is met).

• ❌ Failure: Failed (the expectation is not met).

• ⚠️ Warning: The expectation returned a warning.

• ❌ Error (test stopped): the expectation has returned an error, and the current test was stopped (i.e further expectations in the current test will not be launched).

• 🔄 Skip: This expectation has validated a "skip" expectation for the current test.

• 🔄 Was Skipped: The expectation has been skipped and is reported as a 'skipped expectation', due to a skip_if or an error previously in the test. Note that when an expectation is skipped, the Description, and Test time are not retrieved.

First page {-}

The index offers a summary of:

• When the tests were run

• The package (Title, Version, and Description of the package)

• The project

• Name of the project
• Environment the tests were run into (aka the directory)

• Details about the test results

• Results overview

• The testing infrastructure

• R version
• Operating system
• Locale

• Package versions

• Glossary of terms

Global results {-}

This page offers a summary of the results, grouped by test.

Details of the table:

• File: Name of the file that contains the test. This column is clickable and will open the corresponding page.

• Test: Label given to the test.

• Expectations: Number of expectations contained in the test.

• Result: If the test contains one or more error(s), failed expectation(s), or warning(s) ❌, otherwise ✅.

• Time spent: Time spent on this particular test.

Test-files.R {-}

Each test file has its own chapter, detailing the results of the expectations.

The summary at the top gives an overview of the results for the given test file.

Then, details are included about the tested file:

• Test: Label of the test (i.e. the text in test_that("label of the test", ...))

• Description: The description of the test, as detailed in the #' @description roxygen tag used just before the expectation. If no description was set, it will be blank.

• Expectation: Raw name of the expectation, i.e the R code used.

• Result: Success / Failure / Warning / Errored / Skip / Was skipped (see "Expectations status" at the top of this page).

• Location: Name of the file containing the test, with the line number where the expectation is located (for example, test-hello-world.R#9 means the expectation started at line 9, in the test-hello-world.R file)

• Test_time: When was the test run.

Aggregated {-}

Aggregation of expectations that returned a failure/error, warning, or were skipped.

• Location: Name of the file containing the test, with the line number where the expectation is located (for example, test-hello-world.R#9 means the expectation started at line 9, in the test-hello-world.R file)

• Test: Label of the test (i.e. the text in test_that("label of the test", ...))

• Description: The description of the test, as detailed in the #' @description roxygen tag used just before the expectation. If no description was set, it will be blank.

• Expectation: Raw name of the expectation, i.e the R code used.

• Message: Message output by R when the expectation failed/warned/skip.

ThinkR-open/testdown documentation built on April 17, 2023, 3:21 a.m.