R/spec-connection-disconnect.R

In r-dbi/DBItest: Testing DBI Backends

#' spec_connection_disconnect
#' @family connection specifications
#' @usage NULL
#' @format NULL
#' @keywords NULL
spec_connection_disconnect <- list(
  disconnect_formals = function() {
    # <establish formals of described functions>
    expect_equal(names(formals(dbDisconnect)), c("conn", "..."))
  },

  can_disconnect = function(ctx) {
    #' @return
    con <- connect(ctx)
    #' `dbDisconnect()` returns `TRUE`, invisibly.
    expect_invisible_true(dbDisconnect(con))
  },

  #'
  #' @section Failure modes:
  #' A warning is issued on garbage collection when a connection has been
  #' released without calling `dbDisconnect()`,
  #' but this cannot be tested automatically.

  disconnect_closed_connection = function(ctx, closed_con) {
    #' At least one warning is issued immediately when calling `dbDisconnect()` on an
    #' already disconnected
    suppressWarnings(expect_warning(dbDisconnect(closed_con)))
  },

  disconnect_invalid_connection = function(ctx, invalid_con) {
    #' or invalid connection.
    suppressWarnings(expect_warning(dbDisconnect(invalid_con)))
  },
  #
  NULL
)