R/check_inputs.r

In tomasgreif/mondrianr: Create Mondrian schema in R

#' Check inputs
#'
#' Checks inputs to function \code{\link{create_schema}}. Error is reported when wrong configuration is found,
#' otherwise this function returns nothing.
#' 
#' @param engine See function \code{\link{create_schema}} for details.
#' @param table See function \code{\link{create_schema}} for details.
#' @param primary_key See function \code{\link{create_schema}} for details.
#' @param con See function \code{\link{create_schema}} for details.
#' @param dimension See function \code{\link{create_schema}} for details.
#' @param aggregator See function \code{\link{create_schema}} for details.
#' @param schema_dest See function \code{\link{create_schema}} for details.
#' @param data_source_dest See function \code{\link{create_schema}} for details.
#' @param time_table See function \code{\link{create_schema}} for details.
#' @param security_type See function \code{\link{create_schema}} for details.
#' @param security_roles See function \code{\link{create_schema}} for details.
#' @param debug See function \code{\link{create_schema}} for details.
#' @export 

check_inputs <- function(engine=NA, table=NA, primary_key=NA, con=NA, dimension=NA, aggregator=NA,schema_dest=NA,data_source_dest=NA,
                         time_table=NA,security_type=NA, security_roles=NA, debug=FALSE) {
  
  is_vector(debug,1,'logical')
  
  if(debug) cat('Checking input arguments. \n')
  
  is_vector(engine)
  is_vector(table)
  is_vector(primary_key)
  is_vector(aggregator)
  is_vector(schema_dest)
  is_vector(data_source_dest)
  is_vector(time_table)
  is_vector(security_type)
  
  # Currently only R and PostgreSQL as data engine are supported
  if(!(engine %in% c('R','PostgreSQL'))) {
    stop('Engine has to be R or PostgreSQL')
  }
  
  # Table is always required
  if(is.na(table)) {
    stop('Table is required.')
  }
  
  # Primary key is required
  if(is.na(primary_key)) {
    stop('Primary key is required.')
  }
  
  # Schema destination is required
  if(is.na(schema_dest)) {
    stop('Schema destination is required.')
  }
  
  # If engine is PostgreSQL then connection is required
  if(engine=='PostgreSQL' & all(is.na(con))) {
    stop('For PostgreSQL you have to specify connection.')
  }
  
  # If engine is PostgreSQL then con has to have 5 elements exactly
  if (engine=='PostgreSQL') is_vector(con,5)
  
  # If engine is PostgreSQL than we should test that connection is valid
  if(engine=='PostgreSQL') {
    if (!check_database_connection('PostgreSQL',con)) {
      stop("Not valid PostgreSQL connection.") 
    }    
  }
  
  # We should check that table exists
  if(!check_table_exists(engine=engine, table=table, con=con, debug=debug)) {
    stop('Table specified as argument "table" does not exists.')
  }
  
  # If engine is PostgreSQL and time table is specified than it should exist
  if(engine=='PostgreSQL' & !is.na(time_table)) {
    if(!check_table_exists(engine=engine, table=time_table, con=con, debug=debug)) {  
      stop('Table specified as argument "time_table" does not exists.\n')
    }    
  }

  # If security type is defined then security roles should not be empty
  if(!is.na(security_type) & security_type!='one2one') {
    stop('Only one2one security type is supported.')
  }
  
  if(!is.na(security_type) & all(is.na(security_roles))) {
    stop('You have to specify at least one security role when one2one security is enabled.')
  }
  
  if(debug) cat('   Everything looks OK so far. \n')  

}