This package is primarily useful for developers of DBI backends. It provides a considerable set of test cases for DBI backends. These test cases correspond to the DBI specification. Please follow the steps below to add these test cases to your DBI backend.
Install from CRAN via
install.packages("DBItest")
or the development version using
::install_github("r-dbi/DBItest") devtools
In your driver package, add DBItest
to the
Suggests:
and enable the tests. Run the following code in
you package’s directory:
# install.packages("usethis")
::use_package("DBItest", "suggests")
usethis::use_test("DBItest") usethis
This enables testing using testthat
(if necessary) and
creates, among others, a file test-DBItest.R
in the
tests/testthat
directory. Replace its entire contents by
the following:
::make_context(Kazam(), NULL)
DBItest::test_all() DBItest
This assumes that Kazam()
returns an instance of your
DBIDriver
class. Additional arguments to
dbConnect()
are specified as named list instead of the
NULL
argument to make_context()
. The
default_skip
argument to make_context()
allows
skipping tests that are not (yet) satisfied by your backend.
Further reading:
Detailed instructions in
vignette("DBItest")
The feature list in the original proposal.
Please note that the ‘DBItest’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.