Add Is.Existing.Table Validation in OBDC.Storage.Service

FlippieCoetser · Oct 5, 2023 · 0e448e2 · 0e448e2
2 parents 8c1da5b + 3462839
commit 0e448e2
Show file tree

Hide file tree

Showing 15 changed files with 368 additions and 135 deletions.
diff --git a/R/Memory.Storage.Broker.R b/R/Memory.Storage.Broker.R
@@ -10,6 +10,7 @@ Memory.Storage.Broker <- \(configuration = NULL) {
     tables[[table]] <<- tables[[table]] |> rbind(data)
     return(NULL)
   }
+  # TODO: Return as data.frame with name column
   operations[['Get.Tables']]    <- \() {
     tables |> names()
   }

diff --git a/R/Memory.Storage.Validator.R b/R/Memory.Storage.Validator.R
@@ -48,6 +48,7 @@ Memory.Storage.Validator <- \(broker = NULL) {
     )
     return(entity)
   }
+  # TODO: align with ODBC.Storage.Validator
   validators[['Is.Existing.Table']]  <- \(table) {
     broker[['Get.Tables']]() |> 
       is.element(table)         |> 

diff --git a/R/ODBC.Storage.Broker.R b/R/ODBC.Storage.Broker.R
@@ -20,6 +20,10 @@ ODBC.Storage.Broker <- \(configuration, sql = Query::SQL()) {
 
     return(output)
   }
+  operations[['Get.Tables']]        <- \() {
+    query <- "SELECT TABLE_NAME as name FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE'"
+    query |> operations[['Execute.Query']]()
+  }
   operations[['Insert']]            <- \(entity, table) {
     table |>
     sql[['INSERT']](entity) |>

diff --git a/R/ODBC.Storage.Exceptions.R b/R/ODBC.Storage.Exceptions.R
@@ -56,6 +56,10 @@ ODBC.Storage.Exceptions <- \() {
 
     'Conversion failed when converting from a character string to uniqueidentifier' |> 
     grepl(error) |> exceptions[["Conversion.Failed"]]()
+
+    table <- sub(".*Invalid object name '[^\\.]+\\.([^']+)'.*", "\\1", error)
+    "Invalid object name 'dbo.Invalid'." |>
+    grepl(error) |> exceptions[["Table.Invalid"]](table)
 
     stop(error, call. = FALSE)
   }
@@ -79,5 +83,10 @@ ODBC.Storage.Exceptions <- \() {
       stop('Query is null. Provide a Query.', call. = FALSE)
     } 
   }
+  exceptions[['Table.Invalid']]      <- \(invoke, table) {
+    if(invoke) {
+      stop('ODBC.Storage: Table.Invalid: ', table, ' is not a valid table.', call. = FALSE)
+    }
+  }
   return(exceptions)
 }
diff --git a/R/ODBC.Storage.Service.R b/R/ODBC.Storage.Service.R
@@ -1,5 +1,5 @@
 ODBC.Storage.Service <- \(broker) {
-  validate <- ODBC.Storage.Validator()
+  validate <- ODBC.Storage.Validator(broker)
 
   services <- list()
   services[['Execute.Query']]    <- \(query) {
@@ -12,29 +12,41 @@ ODBC.Storage.Service <- \(broker) {
     entity |> validate[['Entity']]()
     table  |> validate[['Table']]()
 
+    table  |> validate[['Is.Existing.Table']]()
+    # TODO: entity |> validate[['Is.New.Entity']](table)
+
     entity |> broker[['Insert']](table)
   }
-  services[['Retrieve']]        <- \(table, fields) {
+  services[['Retrieve']]        <- \(table, fields = '*') {
     table |> validate[['Table']]()
 
+    table |> validate[['Is.Existing.Table']]()
+
     table |> broker[['Select']](fields)
   }
-  services[['RetrieveWhereId']] <- \(id, table, fields) {
+  services[['RetrieveWhereId']] <- \(id, table, fields = '*') {
     id    |> validate[['Id']]()
     table |> validate[['Table']]()
 
+    table |> validate[['Is.Existing.Table']]()
+
     id |> broker[['SelectWhereId']](table, fields)
   }
   services[['Modify']]          <- \(entity, table) {
     entity |> validate[['Entity']]()
     table  |> validate[['Table']]()
+
+    table  |> validate[['Is.Existing.Table']]()
+    # TODO: entity |> validate[['Is.Existing.Entity']](table)
 
     entity |> broker[['Update']](table)
   }
   services[['Remove']]          <- \(id, table) {
     id    |> validate[['Id']]()
     table |> validate[['Table']]()
 
+    table |> validate[['Is.Existing.Table']]()
+
     id |> broker[['Delete']](table)
   }
   return(services)

diff --git a/R/ODBC.Storage.Validator.R b/R/ODBC.Storage.Validator.R
@@ -1,4 +1,4 @@
-ODBC.Storage.Validator <- \() {
+ODBC.Storage.Validator <- \(broker = NULL) {
   exception <- ODBC.Storage.Exceptions()
 
   validators <- Validate::Validator()
@@ -24,5 +24,10 @@ ODBC.Storage.Validator <- \() {
       validators[['Is.Character']]()    |>
       validators[['Is.UUID']]('id')
   }
+  validators[['Is.Existing.Table']] <- \(table) {
+    tables <- broker[['Get.Tables']]() 
+    any(tables[['name']] == table) |> isFALSE() |> exception[['Table.Invalid']](table)
+    return(table)
+  }
   return(validators)
 }
diff --git a/tests/testthat/helper.sql.R b/tests/testthat/helper.sql.R
@@ -3,8 +3,6 @@ configurator  <-
   ODBC.Configuration.Service() |>
   ODBC.Configuration.Processor()
 
-configuration <- configurator[["Get.Config"]]()
-
 sql           <- Query::SQL()
 sql.utilities <- Query::SQL.Utilities()
 sql.functions <- Query::SQL.Functions()

diff --git a/tests/testthat/test-ODBC.Configuration.Broker.R b/tests/testthat/test-ODBC.Configuration.Broker.R
@@ -37,6 +37,7 @@ describe('When operations <- ODBC.Configuration.Broker()',{
 
 describe("When configuration <- operation[['Get.Preset.Config']]()",{
   it('then configuration is a list',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -47,6 +48,7 @@ describe("When configuration <- operation[['Get.Preset.Config']]()",{
     configuration |> expect.list()
   })
   it('then configuration contains drv parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -57,6 +59,7 @@ describe("When configuration <- operation[['Get.Preset.Config']]()",{
     configuration[['drv']] |> expect.exist()
   })
   it('then configuration contains dsn parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -67,6 +70,7 @@ describe("When configuration <- operation[['Get.Preset.Config']]()",{
     configuration[['dsn']] |> expect.exist()
   })
   it('then configuration contains uid parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -77,6 +81,7 @@ describe("When configuration <- operation[['Get.Preset.Config']]()",{
     configuration[['uid']] |> expect.exist()
   })
   it('then configuration contains pwd parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -87,57 +92,67 @@ describe("When configuration <- operation[['Get.Preset.Config']]()",{
     configuration[['pwd']] |> expect.exist()
   })
   it('then an exception is thrown is no DSN found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No DSN environment variable not found in .Renviron Configuration file."
 
+    cache <- 'DSN' |> environment[['Get.Env.Variable']]()
+
     # When
     'DSN' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Preset.Config']]() |> expect.error(expect.error)
 
     # Then
-    'DSN' |> environment[['Cache.Env.Variable']]('DSN')
+    'DSN' |> environment[['Cache.Env.Variable']](cache)
   })
   it('then an exception is thrown is no UID found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No UID environment variable not found in .Renviron Configuration file."
 
+    cache <- 'UID' |> environment[['Get.Env.Variable']]()
+
     # When
     'UID' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Preset.Config']]() |> expect.error(expect.error)
 
     # Then
-    'UID' |> environment[['Cache.Env.Variable']]('UID')
+    'UID' |> environment[['Cache.Env.Variable']](cache)
   })
   it('then an exception is thrown is no PWD found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No PWD environment variable not found in .Renviron Configuration file."
 
+    cache <- 'PWD' |> environment[['Get.Env.Variable']]()
+
     # When
     'PWD' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Preset.Config']]() |> expect.error(expect.error)
 
     # Then
-    'PWD' |> environment[['Cache.Env.Variable']]('PWD')
+    'PWD' |> environment[['Cache.Env.Variable']](cache)
   })
 })
 
 describe("When configuration <- operation[['Get.Manual.Config']]()",{
   it('then configuration is a list',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -148,6 +163,7 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration |> expect.list()
   })
   it('then configuration contains drv parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -158,6 +174,7 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration[['drv']] |> expect.exist()
   })
   it('then configuration contains driver parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -168,6 +185,7 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration[['driver']] |> expect.exist()
   })
   it('then configuration contains server parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -178,6 +196,7 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration[['server']] |> expect.exist()
   })
   it('then configuration contains database parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -188,6 +207,7 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration[['database']] |> expect.exist()
   })
   it('then configuration contains uid parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -198,6 +218,7 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration[['uid']] |> expect.exist()
   })
   it('then configuration contains pwd parameter',{
+    skip_if_not(environment == 'local')
     # Given
     operations <- ODBC.Configuration.Broker()
 
@@ -208,83 +229,98 @@ describe("When configuration <- operation[['Get.Manual.Config']]()",{
     configuration[['pwd']] |> expect.exist()
   })
   it('then an exception is thrown is no DRIVER found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No DRIVER environment variable not found in .Renviron Configuration file."
 
+    cache <- 'DRIVER' |> environment[['Get.Env.Variable']]()
+
     # When
     'DRIVER' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Manual.Config']]() |> expect.error(expect.error)
 
     # Then
-    'DRIVER' |> environment[['Cache.Env.Variable']]('DRIVER')
+    'DRIVER' |> environment[['Cache.Env.Variable']](cache)
   })
   it('then an exception is thrown is no SERVER found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No SERVER environment variable not found in .Renviron Configuration file."
 
+    cache <- 'SERVER' |> environment[['Get.Env.Variable']]()
+
     # When
     'SERVER' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Manual.Config']]() |> expect.error(expect.error)
 
     # Then
-    'SERVER' |> environment[['Cache.Env.Variable']]('SERVER')
+    'SERVER' |> environment[['Cache.Env.Variable']](cache)
   })
   it('then an exception is thrown is no DATABASE found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No DATABASE environment variable not found in .Renviron Configuration file."
 
+    cache <- 'DATABASE' |> environment[['Get.Env.Variable']]()
+
     # When
     'DATABASE' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Manual.Config']]() |> expect.error(expect.error)
 
     # Then
-    'DATABASE' |> environment[['Cache.Env.Variable']]('DATABASE')
+    'DATABASE' |> environment[['Cache.Env.Variable']](cache)
   })
   it('then an exception is thrown is no UID found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No UID environment variable not found in .Renviron Configuration file."
 
+    cache <- 'UID' |> environment[['Get.Env.Variable']]()
+
     # When
     'UID' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Manual.Config']]() |> expect.error(expect.error)
 
     # Then
-    'UID' |> environment[['Cache.Env.Variable']]('UID')
+    'UID' |> environment[['Cache.Env.Variable']](cache)
   })
   it('then an exception is thrown is no PWD found in .Renviron',{
+    skip_if_not(environment == 'local')
     # Given
     environment <- Environment::Environment()
     operation  <- ODBC.Configuration.Broker()
 
     expect.error <- "No PWD environment variable not found in .Renviron Configuration file."
 
+    cache <- 'PWD' |> environment[['Get.Env.Variable']]()
+
     # When
     'PWD' |> environment[['Clear.Env.Variable']]()
 
     # Then
     operation[['Get.Manual.Config']]() |> expect.error(expect.error)
 
     # Then
-    'PWD' |> environment[['Cache.Env.Variable']]('PWD')
+    'PWD' |> environment[['Cache.Env.Variable']](cache)
   })
 })