Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New function use_test that adds a named test file #769

Merged
merged 3 commits into from
Apr 22, 2015
Merged

New function use_test that adds a named test file #769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b22389
New function use_test that adds a named test file
Apr 14, 2015
574ce93
NEWS
Apr 22, 2015
9d2824b
rename variable, show success message
Apr 22, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions NAMESPACE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ export(use_rcpp)
export(use_readme_rmd)
export(use_revdep)
export(use_rstudio)
export(use_test)
export(use_testthat)
export(use_travis)
export(use_vignette)
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
* `use_code_of_conduct()` adds a contributor code of conduct from
http://contributor-covenant.org. (#729)

* `use_test()` adds a new test file (#769, @krlmlr).

* `system_check()` combines arguments with ` `, not `, `. (#753)

* `lint()` gains a `cache` argument (@jimhester, #708).
Expand Down
27 changes: 27 additions & 0 deletions R/infrastructure.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,33 @@ use_testthat <- function(pkg = ".") {
#' @export
add_test_infrastructure <- use_testthat

#' @section \code{use_test}:
#' Add a test file, also add testing infrastructure if necessary.
#' This will create \file{tests/testthat/test-<name>.R} with a user-specified
#' name for the test. Will fail if the file exists.
#' @rdname infrastructure
#' @aliases add_test_infrastructure
#' @export
use_test <- function(name, pkg = ".") {
pkg <- as.package(pkg)

check_testthat()
if (!uses_testthat(pkg)) {
use_testthat(pkg)
}

path <- sprintf("test-%s.R", name)
if (file.exists(path)) {
stop("File ", path, " exists", call. = FALSE)
}

writeLines(
render_template("test-example.R", list(test_name = name)),
file.path(pkg$path, "tests", "testthat", path))

message("Test file created in ", path)
}

#' @section \code{use_rstudio}:
#' Does not modify \code{.Rbuildignore} as RStudio will do that when
#' opened for the first time.
Expand Down
8 changes: 8 additions & 0 deletions inst/templates/test-example.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
context("{{{ test_name }}}")

## TODO: Rename context
## TODO: Add more tests

test_that("multiplication works", {
expect_equal(2 * 2, 4)
})
10 changes: 10 additions & 0 deletions man/infrastructure.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,16 @@
\alias{use_rcpp}
\alias{use_revdep}
\alias{use_rstudio}
\alias{use_test}
\alias{use_testthat}
\alias{use_travis}
\alias{use_vignette}
\title{Add useful infrastructure to a package.}
\usage{
use_testthat(pkg = ".")

use_test(name, pkg = ".")

use_rstudio(pkg = ".")

use_vignette(name, pkg = ".")
Expand Down Expand Up @@ -55,6 +58,13 @@ add \pkg{testthat} to the suggested packages. This is called
automatically from \code{\link{test}} if needed.
}

\section{\code{use_test}}{

Add a test file, also add testing infrastructure if necessary.
This will create \file{tests/testthat/test-<name>.R} with a user-specified
name for the test. Will fail if the file exists.
}

\section{\code{use_rstudio}}{

Does not modify \code{.Rbuildignore} as RStudio will do that when
Expand Down
10 changes: 6 additions & 4 deletions man/use_build_ignore.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ path. Repeated entries will be silently removed.
}
\seealso{
Other infrastructure: \code{\link{add_rstudio_project}},
\code{\link{add_test_infrastructure}},
\code{\link{add_test_infrastructure}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{add_travis}}, \code{\link{add_travis}},
Expand All @@ -35,10 +36,11 @@ Other infrastructure: \code{\link{add_rstudio_project}},
\code{\link{use_cran_comments}},
\code{\link{use_package_doc}}, \code{\link{use_rcpp}},
\code{\link{use_revdep}}, \code{\link{use_rstudio}},
\code{\link{use_testthat}}, \code{\link{use_travis}},
\code{\link{use_vignette}}; \code{\link{use_data_raw}};
\code{\link{use_data}}; \code{\link{use_git_hook}};
\code{\link{use_package}}; \code{\link{use_readme_rmd}}
\code{\link{use_test}}, \code{\link{use_testthat}},
\code{\link{use_travis}}, \code{\link{use_vignette}};
\code{\link{use_data_raw}}; \code{\link{use_data}};
\code{\link{use_git_hook}}; \code{\link{use_package}};
\code{\link{use_readme_rmd}}
}
\keyword{internal}

9 changes: 5 additions & 4 deletions man/use_data.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,17 @@ Other infrastructure: \code{\link{add_build_ignore}},
\code{\link{use_build_ignore}};
\code{\link{add_rstudio_project}},
\code{\link{add_test_infrastructure}},
\code{\link{add_test_infrastructure}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{infrastructure}}, \code{\link{use_appveyor}},
\code{\link{use_code_of_conduct}},
\code{\link{use_cran_comments}},
\code{\link{use_package_doc}}, \code{\link{use_rcpp}},
\code{\link{use_revdep}}, \code{\link{use_rstudio}},
\code{\link{use_testthat}}, \code{\link{use_travis}},
\code{\link{use_vignette}}; \code{\link{use_data_raw}};
\code{\link{use_git_hook}}; \code{\link{use_package}};
\code{\link{use_readme_rmd}}
\code{\link{use_test}}, \code{\link{use_testthat}},
\code{\link{use_travis}}, \code{\link{use_vignette}};
\code{\link{use_data_raw}}; \code{\link{use_git_hook}};
\code{\link{use_package}}; \code{\link{use_readme_rmd}}
}

9 changes: 5 additions & 4 deletions man/use_data_raw.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,17 @@ Other infrastructure: \code{\link{add_build_ignore}},
\code{\link{use_build_ignore}};
\code{\link{add_rstudio_project}},
\code{\link{add_test_infrastructure}},
\code{\link{add_test_infrastructure}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{infrastructure}}, \code{\link{use_appveyor}},
\code{\link{use_code_of_conduct}},
\code{\link{use_cran_comments}},
\code{\link{use_package_doc}}, \code{\link{use_rcpp}},
\code{\link{use_revdep}}, \code{\link{use_rstudio}},
\code{\link{use_testthat}}, \code{\link{use_travis}},
\code{\link{use_vignette}}; \code{\link{use_data}};
\code{\link{use_git_hook}}; \code{\link{use_package}};
\code{\link{use_readme_rmd}}
\code{\link{use_test}}, \code{\link{use_testthat}},
\code{\link{use_travis}}, \code{\link{use_vignette}};
\code{\link{use_data}}; \code{\link{use_git_hook}};
\code{\link{use_package}}; \code{\link{use_readme_rmd}}
}

9 changes: 5 additions & 4 deletions man/use_git_hook.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,18 @@ Other infrastructure: \code{\link{add_build_ignore}},
\code{\link{use_build_ignore}};
\code{\link{add_rstudio_project}},
\code{\link{add_test_infrastructure}},
\code{\link{add_test_infrastructure}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{infrastructure}}, \code{\link{use_appveyor}},
\code{\link{use_code_of_conduct}},
\code{\link{use_cran_comments}},
\code{\link{use_package_doc}}, \code{\link{use_rcpp}},
\code{\link{use_revdep}}, \code{\link{use_rstudio}},
\code{\link{use_testthat}}, \code{\link{use_travis}},
\code{\link{use_vignette}}; \code{\link{use_data_raw}};
\code{\link{use_data}}; \code{\link{use_package}};
\code{\link{use_readme_rmd}}
\code{\link{use_test}}, \code{\link{use_testthat}},
\code{\link{use_travis}}, \code{\link{use_vignette}};
\code{\link{use_data_raw}}; \code{\link{use_data}};
\code{\link{use_package}}; \code{\link{use_readme_rmd}}
}
\keyword{internal}

9 changes: 5 additions & 4 deletions man/use_package.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,17 @@ Other infrastructure: \code{\link{add_build_ignore}},
\code{\link{use_build_ignore}};
\code{\link{add_rstudio_project}},
\code{\link{add_test_infrastructure}},
\code{\link{add_test_infrastructure}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{infrastructure}}, \code{\link{use_appveyor}},
\code{\link{use_code_of_conduct}},
\code{\link{use_cran_comments}},
\code{\link{use_package_doc}}, \code{\link{use_rcpp}},
\code{\link{use_revdep}}, \code{\link{use_rstudio}},
\code{\link{use_testthat}}, \code{\link{use_travis}},
\code{\link{use_vignette}}; \code{\link{use_data_raw}};
\code{\link{use_data}}; \code{\link{use_git_hook}};
\code{\link{use_readme_rmd}}
\code{\link{use_test}}, \code{\link{use_testthat}},
\code{\link{use_travis}}, \code{\link{use_vignette}};
\code{\link{use_data_raw}}; \code{\link{use_data}};
\code{\link{use_git_hook}}; \code{\link{use_readme_rmd}}
}

9 changes: 5 additions & 4 deletions man/use_readme_rmd.Rd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,18 @@ Other infrastructure: \code{\link{add_build_ignore}},
\code{\link{use_build_ignore}};
\code{\link{add_rstudio_project}},
\code{\link{add_test_infrastructure}},
\code{\link{add_test_infrastructure}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{add_travis}}, \code{\link{add_travis}},
\code{\link{infrastructure}}, \code{\link{use_appveyor}},
\code{\link{use_code_of_conduct}},
\code{\link{use_cran_comments}},
\code{\link{use_package_doc}}, \code{\link{use_rcpp}},
\code{\link{use_revdep}}, \code{\link{use_rstudio}},
\code{\link{use_testthat}}, \code{\link{use_travis}},
\code{\link{use_vignette}}; \code{\link{use_data_raw}};
\code{\link{use_data}}; \code{\link{use_git_hook}};
\code{\link{use_package}}
\code{\link{use_test}}, \code{\link{use_testthat}},
\code{\link{use_travis}}, \code{\link{use_vignette}};
\code{\link{use_data_raw}}; \code{\link{use_data}};
\code{\link{use_git_hook}}; \code{\link{use_package}}
}
\keyword{internal}