Improve code coverage (#29)

* Remove the package down component for now... It fails?

* - Disable testing on functions that require interactivity.
- Rename open_browser() to open_web_browser()

* Add site creation and retrieval failure conditions

* Split validating search_site tests

* Add a unit test for utilities that modifies system environment variables.

* Test the .onLoad() component by verifying options are set.

* Remove context

* We test a bit more now...

Author: coatless

.github/workflows/pkgdown.yaml

@@ -27,18 +27,14 @@
 ## Fixes
 
 - Addressed internal vignette index name being used as the title.
-- Block new CI/CD routines from being included with the package.
 
 ## Deployment
 
 - Switched from using [TravisCI](http://travis-ci.com/) to using
   [GitHub Actions for R](https://github.com/r-lib/actions). 
   ([#25](https://github.com/r-assist/searcher/issues/25),
    [#27](https://github.com/r-assist/searcher/pull/27))
-- Added [pkgdown](https://pkgdown.r-lib.org/) website for `searcher` available 
-  at: <https://r-assist.github.io/searcher>. 
-  ([#26](https://github.com/r-assist/searcher/issues/26),
-   [#27](https://github.com/r-assist/searcher/pull/27))
+- Improved code coverage of unit tests ([#29](https://github.com/r-assist/searcher/pull/29))
 
 # searcher 0.0.4
 

NEWS.md

@@ -31,32 +31,32 @@ browse_url = function(base,
 
   url = encode_url(base, unencoded_query, encoded_query)
   if (open_browser) {
-    if (is_rstudio() && getOption("searcher.use_rstudio_viewer")) {
+    if (is_rstudio() && getOption("searcher.use_rstudio_viewer")) { # nocov start
       open_rstudio_viewer(url)
     } else {
-      open_browser(url)
-    }
+      open_web_browser(url)
+    } # nocov end
   } else {
     message("Please type into your browser:\n", invisible(url))
   }
 
   invisible(url)
 }
 
-open_rstudio_viewer = function(url) {
+open_rstudio_viewer = function(url) { # nocov start
   message("Searching query in RStudio's Viewer panel ... ")
   Sys.sleep(getOption("searcher.launch_delay"))
 
   # If in RStudio, this should be set.
   viewer <- getOption("viewer")
   viewer(url)
-}
+} # nocov end
 
-open_browser = function(url) {
+open_web_browser = function(url) { # nocov start
   message("Searching query in a web browser ... ")
   Sys.sleep(getOption("searcher.launch_delay"))
   utils::browseURL(url)
-}
+} # nocov end
 
 #' Form Encoded URL
 #'

R/utilities.R

@@ -10,6 +10,19 @@ test_that("Keyword generation", {
   )
 })
 
+test_that("Site creation", {
+  expect_equal(
+    site_entry("fake", "http://example.com"),
+    list(
+      "site_long_name" = "fake",
+      "site_short_name" = "fake",
+      "site_url" = "http://example.com",
+      "keywords" = list(base = "r programming", tidyverse = "tidyverse"),
+      "suffix" = NULL
+    )
+  )
+})
+
 test_that("Site retrieval", {
 
   expect_equal(
@@ -25,3 +38,7 @@ test_that("Site retrieval", {
   )
 
 })
+
+test_that("Site retrieval failure", {
+  expect_error(site_details("fake"))
+})

tests/testthat/test-index-sites.R

@@ -1,5 +1,3 @@
-context("searcher")
-
 test_that("Check link generation", {
 
   ##### Google
@@ -100,12 +98,7 @@ test_that("Check link generation", {
 
 })
 
-test_that("Validate selection", {
-
-  expect_identical(
-    search_site("toad", "bb", rlang = FALSE),
-    "https://bitbucket.com/search?q=toad"
-  )
+test_that("Validate selection long name - search_site", {
 
   expect_error(
     search_site("toad", "", rlang = FALSE)
@@ -121,21 +114,46 @@ test_that("Validate selection", {
     "https://bing.com/search?q=toad"
   )
 
+  expect_identical(
+    search_site("", rlang = FALSE),
+    "",
+    "Verify empty query fall through"
+  )
+
+})
+
+test_that("Validate selection short name - search_site", {
+
   expect_identical(
     search_site("toad", "ddg", rlang = FALSE),
     "https://duckduckgo.com/?q=toad"
   )
 
   expect_identical(
-    search_site("", rlang = FALSE),
-    "",
-    "Verify empty query fall through"
+    search_site("toad", "sp", rlang = FALSE),
+    "https://startpage.com/do/dsearch?query=toad"
   )
 
-})
+  expect_identical(
+    search_site("toad", "rscom", rlang = FALSE),
+    "https://community.rstudio.com/search?q=toad"
+  )
 
+  expect_identical(
+    search_site("toad", "gh", rlang = FALSE),
+    "https://github.com/search?q=toad&type=Issues"
+  )
 
+  expect_identical(
+    search_site("toad", "so", rlang = FALSE),
+    "https://stackoverflow.com/search?q=toad"
+  )
 
+  expect_identical(
+    search_site("toad", "bb", rlang = FALSE),
+    "https://bitbucket.com/search?q=toad"
+  )
+})
 
 test_that("Verify search handler generation", {
   expect_message(searcher("bing")(""))
@@ -145,7 +163,6 @@ test_that("Verify search handler generation", {
   )
 })
 
-
 test_that("Malformed search query validation", {
 
   expect_identical(
@@ -205,3 +222,7 @@ test_that("Malformed search query validation", {
     "NULL value handling"
   )
 })
+
+test_that("Ensure deprecation", {
+  expect_error(search_ixquick())
+})

tests/testthat/test-search-functions.R

@@ -0,0 +1,32 @@
+test_that("Verify package load settings", {
+
+  pkg_default_options = searcher_default_options
+  pkg_default_names = names(pkg_default_options)
+
+  # Clean environment
+  for(default_name in pkg_default_names) {
+    options(default_name = NULL)
+  }
+
+  is_option_present = function(x) {
+    !is.null(getOption(x, NULL))
+  }
+
+  # Verify names have been unset
+  expect_true(all(sapply(pkg_default_names, is_option_present)))
+
+  # And call the onload..
+  .onLoad()
+
+  # Check if names are registered
+  expect_true(all(pkg_default_names %in% names(options())))
+
+  # Verify if contents were set.
+  set_option_values = sapply(pkg_default_names, getOption,
+                             simplify = FALSE, USE.NAMES = TRUE)
+  expect_equal(
+    set_option_values,
+    pkg_default_options
+  )
+
+})

tests/testthat/test-searcher-package.R

@@ -0,0 +1,14 @@
+test_that("Detect RStudio", {
+  # Obtain value
+  before = Sys.getenv("RSTUDIO")
+
+  # Modify check environment variable
+  Sys.setenv("RSTUDIO" = 1)
+  expect_true(is_rstudio(),  info = "Within RStudio")
+
+  Sys.setenv("RSTUDIO" = 0)
+  expect_false(is_rstudio(), info = "Not in RStudio")
+
+  # Restore
+  Sys.setenv("RSTUDIO" = before)
+})