Merge pull request #11 from Notts-HC/encrypt_option

added option to remove encryption in initiation of sql_server object

Author: Steve-Spreadborough

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: SQLRtools
 Type: Package
 Title: SQL R Tools
-Version: 0.0.1
+Version: 0.0.2
 Author: c(person("Stephen", "Spreadborough", 
           , "stephen.spreadborough@nottshc.nhs.uk ", 
           role = c("aut", "cre")))

NEWS.md

@@ -1,4 +1,9 @@
 
+# SQLRtools 0.0.2
+
+Minor update adding in option to remove encryption in the initiation of the
+`sql_server` class object.
+
 # SQLRtools 0.0.1
 
 Initial complete package containing:

R/sql_server.R

@@ -55,14 +55,17 @@ sql_server <- R6Class("sql_server", public = list(
   #' prem SQL server as will use windows credentials. Do NOT save credentials
   #' in code. Quoted string, default NULL.
   pwd = NULL,
+  
+  #' @field encrypt set whether to include "Encrypt=true;" in connection string. 
+  #' TRUE, default, will include & FALSE will exclude. Logical, default TRUE
+  encrypt = NULL,
 
   #' @field server_type type of connection, set when initialised.
   server_type = NULL,
 
   #' @field conn connection object, set when initialised.
   conn = NULL,
 
-
   #' @description
   #' Create new SQL server connection object.
   #'
@@ -72,14 +75,17 @@ sql_server <- R6Class("sql_server", public = list(
   #' @param port port of the database.
   #' @param uid user name for database login.
   #' @param pwd user password for database login.
+  #' @param encrypt set whether to include "Encrypt=true;" in connection string. 
+  #' TRUE, defautl, will include & FALSE will exclude. Logical, default TRUE
   #' @return A new 'SQL server connection' object.
 
   initialize = function(driver,
                         server,
                         database,
                         port = NULL,
                         uid = NULL,
-                        pwd = NULL) {
+                        pwd = NULL,
+                        encrypt = TRUE) {
 
     # set up params
     self$driver <- driver
@@ -88,6 +94,7 @@ sql_server <- R6Class("sql_server", public = list(
     self$port <- port
     self$uid <- uid
     self$pwd <- pwd
+    self$encrypt <- encrypt
     self$conn
     self$server_type <- case_when(tolower(self$driver) == "sql server" ~ "mssql",
                                   grepl("mysql", tolower(self$driver)) ~ "mysql",
@@ -130,11 +137,18 @@ sql_server <- R6Class("sql_server", public = list(
       # set connection by server type
       if (self$server_type == "mssql") {
 
+        if (isTRUE(self$encrypt)) {
+          encrypt <-  "Encrypt=true;"
+        } else {
+          encrypt <- ""
+        }
+        
+        
         # set connection string
         conn_string <- paste("driver={", self$driver, "};",
                              "server=", self$server, ";",
                              "database=", database, ";",
-                             "Encrypt=true;",
+                             encrypt,
                              "trusted_connection=true", sep = "")
 
         # set connection

man/sql_server.Rd

@@ -31,6 +31,11 @@ test_data <- data.frame(Int_field = 1:200,
 # 1. uploading data ------------------------------------------------------------
 
 testthat::test_that("mssql_server - upload method", {
+  
+  # check encrypt is TRUE
+  expect_true(mssql_serv$encrypt)
+  
+  # check encrypt in
 
   # upload table in one go
   upload_outcome <- mssql_serv$upload(data = test_data,
@@ -242,8 +247,58 @@ testthat::test_that("mssql_server - close connection", {
 })
 
 
+# 6. Connection setting encrypt to FALSE ---------------------------------------
 
+# create mysql server object
+mssql_serv2 <- sql_server$new(
+  driver = "SQL Server",
+  server = get_env_var("MSSQL_SERVER"),
+  database = get_env_var("MSSQL_DATABASE"),
+  encrypt = FALSE
+  )
+
+testthat::test_that("mssql_server - without encryption", {
+  
+  # check encrypt is TRUE
+  expect_false(mssql_serv2$encrypt)
+  
+  # upload table in one go
+  upload_outcome <- mssql_serv2$upload(
+    data = test_data,
+    table_name = test_table_name,
+    close_conn = FALSE
+    )
 
+  # table exists
+  table_exists <- mssql_serv2$table_exists(test_table_name,
+                                          close_conn = FALSE)
+  
+  # n rows
+  table_rows <- mssql_serv2$get(glue("SELECT count(*) as n
+                                    from {test_table_name}"),
+                               close_conn = FALSE) %>%
+    pull(n) %>%
+    as.integer()
+  
+  # field names
+  table_fields <- mssql_serv2$get(glue("SELECT TOP 0 *
+                                    from {test_table_name}"),
+                                 close_conn = FALSE)
+  
+  
+  # tests
+  testthat::expect_equal(upload_outcome, "success")
+  testthat::expect_equal(table_exists, "yes")
+  testthat::expect_equal(table_rows, 200L)
+  testthat::expect_equal(colnames(table_fields), colnames(test_data))
+  
+  # drop table
+  mssql_serv2$drop_table(test_table_name, close_conn = FALSE)
+  
+  # check if it exists
+  testthat::expect_equal("no", mssql_serv2$table_exists(test_table_name))
+  
+})