testthat 1.0.0

Breaking changes

The expectation() function now expects an expectation type (one of "success", "failure", "error", "skip", "warning") as first argument. If you're creating your own expectations, you'll need to use expect() instead (#437).

New expectations

The expectation system got a thorough overhaul (#217). This primarily makes it easier to add new expectations in the future, but also included a thorough review of the documentation, ensuring that related expectations are documented together, and have evocative names.

One useful change is that most expectations invisibly return the input object. This makes it possible to chain together expectations with magrittr:

factor("a") %>% 
  expect_type("integer") %>% 
  expect_s3_class("factor") %>% 
  expect_length(1)

(And to make this style even easier, testthat now re-exports the pipe, #412).

The exception to this rule are the expectations that evaluate (i.e.
for messages, warnings, errors, output etc), which invisibly return NULL. These functions are now more consistent: using NA will cause a failure if there is a errors/warnings/mesages/output (i.e. they're not missing), and will NULL fail if there aren't any errors/warnings/mesages/output. This previously didn't work for expect_output() (#323), and the error messages were confusing with expect_error(..., NA) (#342, @nealrichardson + @krlmlr, #317).

Another change is that expect_output() now requires you to explicitly print the output if you want to test a print method: expect_output("a", "a") will fail, expect_output(print("a"), "a") will succeed.

There are six new expectations:

• expect_type() checks the type of the object (#316),
  expect_s3_class() tests that an object is S3 with given class,
  expect_s4_class() tests that an object is S4 with given class (#373).
  I recommend using these more specific expectations instead of the
  more general expect_is().
• expect_length() checks that an object has expected length.
• expect_success() and expect_failure() are new expectations designed
  specifically for testing other expectations (#368).

A number of older features have been deprecated:

• expect_more_than() and expect_less_than() have been deprecated. Please
  use expect_gt() and expect_lt() instead.
• takes_less_than() has been deprecated.
• not() has been deprecated. Please use the explicit individual forms
  expect_error(..., NA) , expect_warning(.., NA) and so on.

Expectations are conditions

Now all expectations are also conditions, and R's condition system is used to signal failures and successes (#360, @krlmlr). All known conditions (currently, "error", "warning", "message", "failure", and "success") are converted to expectations using the new as.expectation(). This allows third-party test packages (such as assertthat, testit, ensurer, checkmate, assertive) to seamlessly establish testthat compatibility by issuing custom error conditions (e.g., structure(list(message = "Error message"), class = c("customError", "error", "condition"))) and then implementing as.expectation.customError(). The assertthat package contains an example.

Reporters

The reporters system class has been considerably refactored to make existing reporters simpler and to make it easier to write new reporters. There are two main changes:

• Reporters classes are now R6 classes instead of Reference Classes.
• Each callbacks receive the full context:
  • add_results() is passed context and test as well as the expectation.
  • test_start() and test_end() both get the context and test.
  • context_start() and context_end() get the context.
• Warnings are now captured and reported in most reporters.
• The reporter output goes to the original standard output and is not affected by sink() and expect_output() (#420, @krlmlr).
• The default summary reporter lists all warnings (#310), and all skipped
  tests (@krlmlr, #343). New option testthat.summary.max_reports limits
  the number of reports printed by the summary reporter. The default is 15
  (@krlmlr, #354).
• MinimalReporter correct labels errors with E and failures with F (#311).
• New FailReporter to stop in case of failures or errors after all tests
  (#308, @krlmlr).

Other

• New functions capture_output(), capture_message(), and
  capture_warnings() selectively capture function output. These are
  used in expect_output(), expect_message() and expect_warning()
  to allow other types out output to percolate up (#410).
• try_again() allows you to retry code multiple times until it succeeds
  (#240).
• test_file(), test_check(), and test_package() now attach testthat so
  all testing functions are available.
• source_test_helpers() gets a useful default path: the testthat tests
  directory. It defaults to the test_env() to be consistent with the
  other source functions (#415).
• test_file() now loads helpers in the test directory before running
  the tests (#350).
• test_path() makes it possible to create paths to files in tests/testthat
  that work interactively and when called from tests (#345).
• Add skip_if_not() helper.
• Add skip_on_bioc() helper (@thomasp85).
• make_expectation() uses expect_equal().
• setup_test_dir() has been removed. If you used it previously, instead use
  source_test_helpers() and find_test_scripts().
• source_file() exports the function testthat uses to load files from disk.
• test_that() returns a logical that indicates if all tests were successful
  (#360, @krlmlr).
• find_reporter() (and also all high-level testing functions) support a vector
  of reporters. For more than one reporter, a MultiReporter is created
  (#307, @krlmlr).
• with_reporter() is used internally and gains new argument
  start_end_reporter = TRUE (@krlmlr, 355).
• set_reporter() returns old reporter invisibly (#358, @krlmlr).
• Comparing integers to non-numbers doesn't raise errors anymore, and falls
  back to string comparison if objects have different lengths. Complex numbers
  are compared using the same routine (#309, @krlmlr).
• compare.numeric() and compare.chacter() recieved another overhaul. This
  should improve behaviour of edge cases, and provides a strong foundation for
  further work. Added compare.POSIXt() for better reporting of datetime
  differences.
• expect_identical() and is_identical_to() now use compare() for more
  detailed output of differences (#319, @krlmlr).
• Added Catch v1.2.1 for unit testing of C++ code.
  See ?use_catch() for more details. (@kevinushey)

testthat 0.11.0

• Handle skipped tests in the TAP reporter (#262).
• New expect_silent() ensures that code produces no output, messages,
  or warnings (#261).
• New expect_lt(), expect_lte(), expect_gt() and expect_gte() for
  comparison with or without equality (#305, @krlmlr).
• expect_output(), expect_message(), expect_warning(), and
  expect_error() now accept NA as the second argument to indicate that
  output, messages, warnings, and errors should be absent (#219).
• Praise gets more diverse thanks to the praise package, and you'll now
  get random encouragment if your tests don't pass.
• testthat no longer muffles warning messages. If you don't want to see them
  in your output, you need to explicitly quiet them, or use an expectation that
  captures them (e.g. expect_warning()). (#254)
• Use of tests in inst/tests is formally deprecated. Please move them into
  tests/testthat instead (#231).
• expect_match() now encodes the match, as well as the output, in the
  expectation message (#232).
• expect_is() gives better failure message when testing multiple inheritance,
  e.g. expect_is(1:10, c("glm", "lm")) (#293).
• Corrected argument order in compare.numeric() (#294).
• comparison() constructure now checks its arguments are the correct type and
  length. This bugs a bug where tests failed with an error like "values must be
  length 1, but FUN(X[[1]]) result is length 2" (#279).
• Added skip_on_os(), to skip tests on specified operating systems
  (@kevinushey).
• Skip test that depends on devtools if it is not installed (#247, @krlmlr)
• Added skip_on_appveyor() to skip tests on Appveyor (@lmullen).
• compare() shows detailed output of differences for character vectors of
  different length (#274, @krlmlr).
• Detailed output from expect_equal() doesn't confuse expected and actual
  values anymore (#274, @krlmlr).

testthat 0.10.0

• Failure locations are now formated as R error locations.
• Deprecated library_if_available() has been removed.
• test (test_dir(), test_file(), test_package(), test_check()) functions
  now return a testthat_results object that contains all results, and can be
  printed or converted to data frame.
• test_dir(), test_package(), and test_check() have an added ...
  argument that allows filtering of test files using, e.g., Perl-style regular
  expressions,or fixed character filtering. Arguments in ... are passed to
  grepl() (@leeper).
• test_check() uses a new reporter specifically designed for R CMD check.
  It displays a summary at the end of the tests, designed to be <13 lines long
  so test failures in R CMD check display something more useful. This will
  hopefully stop BDR from calling testthat a "test obfuscation suite" (#201).
• compare() is now documented and exported. Added a numeric method so when
  long numeric vectors don't match you'll see some examples of where the
  problem is (#177). The line spacing in compare.character() was
  tweaked.
• skip_if_not_installed() skips tests if a package isn't installed (#192).
• expect_that(a, equals(b)) style of testing has been soft-deprecated.
  It will keep working, but it's no longer demonstrated any where, and new
  expectations will only be available in expect_equal(a, b) style. (#172)
• Once again, testthat suppresses messages and warnings in tests (#189)
• New test_examples() lets you run package examples as tests. Each example
  counts as one expectation and it succeeds if the code runs without errors
  (#204).
• New succeed() expectation always succeeds.
• skip_on_travis() allows you to skip tests when run on Travis CI.
  (Thanks to @mllg)
• colourise() was removed. (Colour is still supported, via the crayon
  package.)
• Mocks can now access values local to the call of with_mock (#193, @krlmlr).
• All equality expectations are now documented together (#173); all
  matching expectations are also documented together.

testthat 0.9.1

testthat 0.9.1

• Bump R version dependency

testthat 0.9

testthat 0.9

New features

• BDD: testhat now comes with an initial behaviour driven development (BDD)
  interface. The language is similiar to RSpec for Ruby or Mocha for JavaScript.
  BDD tests read like sentences, so they should make it easier to understand
  the specification of a function. See ?describe() for further information
  and examples.
• It's now possible to skip() a test with an informative message - this is
  useful when tests are only available under certain conditions, as when
  not on CRAN, or when an internet connection is available (#141).
• skip_on_cran() allows you to skip tests when run on CRAN. To take advantage
  of this code, you'll need either to use devtools, or run
  Sys.setenv(NOT_CRAN = "true"))
• Simple mocking: with_mock() makes it easy to temporarily replace
  functions defined in packages. This is useful for testing code that relies
  on functions that are slow, have unintended side effects or access resources
  that may not be available when testing (#159, @krlmlr).
• A new expectation, expect_equal_to_reference() has been added. It
  tests for equality to a reference value stored in a file (#148, @jonclayden).

Minor improvements and bug fixes

• auto_test_package() works once more, and now uses devtools::load_all()
  for higher fidelity loading (#138, #151).
• Bug in compare.character() fixed, as reported by Georgi Boshnakov.
• colourise() now uses option testthat.use_colours (default: TRUE). If it
  is FALSE, output is not colourised (#153, @mbojan).
• is_identical_to() only calls all.equal() to generate an informative
  error message if the two objects are not identical (#165).
• safe_digest() uses a better strategy, and returns NA for directories
  (#138, #146).
• Random praise is renabled by default (again!) (#164).
• Teamcity reporter now correctly escapes output messages (#150, @windelinckx).
  It also uses nested suites to include test names.

Deprecated functions

• library_if_available() has been deprecated.

testthat 0.8.1

• Better default environment for test_check() and test_package() which
  allows S4 class creation in tests
• compare.character() no longer fails when one value is missing.

Testthat 0.8

testthat 0.8 comes with a new recommended structure for storing your tests. To
better meet CRAN recommended practices, testthat now recommend that you to put
your tests in tests/testthat, instead of inst/tests (this makes it
possible for users to choose whether or not to install tests). With this
new structure, you'll need to use test_check() instead of test_packages()
in the test file (usually tests/testthat.R) that runs all testthat unit
tests.

The other big improvement to usability comes from @kforner, who contributed
code to allow the default results (i.e. those produced by SummaryReporter)
to include source references so you can see exactly where failures occured.

New reporters

• MultiReporter, which combines several reporters into one.
  (Thanks to @kforner)
• ListReporter, which captures all test results with their file,
  context, test and elapsed time. test_dir, test_file, test_package and
  test_check now use the ListReporter to invisibly return a summary of
  the tests as a data frame. (Thanks to @kforner)
• TeamCityReporter to produce output compatible with the TeamCity
  continuous integration environment. (Thanks to @windelinckx)
• SilentReporter so that testthat can test calls to test_that.
  (Thanks to @craigcitro, #83)

New expectations

• expect_null() and is_null to check if an object is NULL (#78)
• expect_named() and has_names() to check the names of a vector (#79)
• expect_more_than(), is_more_than(), expect_less_than(),
  is_less_than() to check values above or below a threshold.
  (#77, thanks to @jknowles)

Minor improvements and bug fixes

• expect_that() (and thus all expect_* functions) now invisibly return
  the expectation result, and stops if info or label arguments have
  length > 1 (thanks to @kforner)
• fixed two bugs with source_dir(): it did not look for the source scripts
  at the right place, and it did not use its chdir argument.
• When using expect_equal() to compare strings, the default output for
  failure provides a lot more information, which should hopefully help make
  finding string mismatches easier.
• SummaryReporter has a max_reports option to limit the number of detailed
  failure reports to show. (Thanks to @crowding)
• Tracebacks will now also contain information about where the functions came
  from (where that information is available).
• matches and expect_match now pass additional arguments on to grepl so
  that you can use fixed = TRUE, perl = TRUE or ignore.case = TRUE to
  control details of the match. expect_match now correctly fails to match
  NULL. (#100)
• expect_output, expect_message, expect_warning and expect_error
  also pass ... on to grepl, so that you can use fixed = TRUE,
  perl = TRUE or ignore.case = TRUE
• Removed stringr and evaluate dependencies.
• The not() function makes it possible to negate tests. For example,
  expect_that(f(), not(throws_error())) asserts that f() does not
  throw an error.
• Make dir_state less race-y. (Thanks to @craigcitro, #80)
• auto_test now pays attention to its 'reporter' argument (Thanks to @crowding, #81)
• get_reporter(), set_reporter() and with_reporter() are now
  exported (#102)