https://github.com/khalidharun/dbtest
Database testing and mocking in R.
https://github.com/khalidharun/dbtest
Last synced: 4 months ago
JSON representation
Database testing and mocking in R.
- Host: GitHub
- URL: https://github.com/khalidharun/dbtest
- Owner: khalidharun
- Created: 2016-01-18T23:08:37.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-28T21:40:44.000Z (about 9 years ago)
- Last Synced: 2024-08-13T07:12:48.501Z (8 months ago)
- Language: R
- Homepage:
- Size: 149 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - khalidharun/dbtest - Database testing and mocking in R. (R)
README
DBTest [](https://travis-ci.org/avantcredit/dbtest) [](https://codecov.io/github/avantcredit/dbtest) [](http://avantcredit.github.io/dbtest/)
=============
DBTest is a package to provide database testing and mocking in R.
Imagine you want to make a call to a production database...
```R
DBI::dbConnect(drv = DBI::dbDriver("Postgres"), dbname = "production")
```
But in your tests, you'd prefer if your code called to a test database instead.
DBTest provides `with_test_db`, which you can use like this:
```R
dbtest::with_test_db(
DBI::dbConnect(drv = DBI::dbDriver("Postgres"), dbname = "production")
)
```
...that connection will be reset to a test connection instead! And all calls to the production database within your tests will be mocked as calls to the test database.
Also, in your tests `with_test_db` will create an R object called `test_con` which you can use to work with the connection.
```R
dbtest::with_test_db(DBI::dbListTables(test_con)) # test_con is a connection to the test database.
```
-
Lastly, to create separate, safe test blocks where database actions in previous tests do not affect future tests, wrap individual tests in `db_test_that` instead of `test_that`. If you do this, you do not need to use `with_test_db`.
## Further Testing
You can then test your database with a variety of helpers:
```R
library(testthat)
library(dbtest)
db_test_that("My database has a test table", {
expect_table("test")
})
db_test_that("My test table has a test column", {
expect_table_has(column("test"), table = "test")
})
db_test_that("My test table has a test column with at least three entries", {
expect_table_has(count("test") >= 3, table = "test")
})
db_test_that("'hello world' is in my test table", {
expect_sql_exists("SELECT test FROM test WHERE value = 'hello_world'")
})
db_test_that("The first value of my test column is 'hello world'", {
expect_sql_equals("SELECT test FROM test LIMIT 1", data.frame(test = "hello_world"))
})
```
## Installation
#### Installing the Package
```R
if (!require("devtools")) { install.packages("devtools") }
devtools::install_github("avantcredit/dbtest")
```
#### Creating the Test Database
```
psql postgres
CREATE DATABASE travis;
GRANT ALL PRIVILEGES ON DATABASE travis TO postgres;
ALTER ROLE postgres WITH LOGIN;
```
## License
This project is licensed under the MIT License:
Copyright (c) 2015-2016 Robert Krzyzanowski
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## Authors
This package was created by Peter Hurford, using code originally written in [cachemeifyoucan](https://github.com/robertzk/cachemeifyoucan).