tests/testthat/test-importOutput.R

In antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation

#Copyright © 2016 RTE Réseau de transport d’électricité

context("Functions .importOutput")

path_study_test <- grep(pattern = "test_case_study_v870", x = studyPathSV8, value = TRUE)

opts <- suppressWarnings({setSimulationPath(path_study_test,simulation="20240105-0934eco")})


test_that(".check_missing_output_files is ok", {
  
  links <- c("at - fr", "fr - it", "at - it")  
  args <- data.frame("link" = links,
                     "path" = file.path(opts$simPath, "economy", "mc-ind", "00001", "links", links, "values-annual.txt")
                     )
  output_missing_expected <- c(FALSE,FALSE,TRUE)  
  output_missing <- .check_missing_output_files(opts = opts, args = args)
  
  expect_equal(output_missing,output_missing_expected)
})


test_that("Test the general behaviour of .format_api_aggregate_result()", {
    
  expect_null(.format_api_aggregate_result(res = NULL, type_res = "details"))
  
  # mc-ind
  endpoint_res <- data.table("area" = rep("fr",12 * 2),
                             "cluster" = c(rep("Nuclear",12), rep("Gas",12)),
                             "mcYear" = rep(1, 12 * 2),
                             "timeId" = as.numeric(rep(seq(1,12),2)),
                             "production" = round(rnorm(n = 12 * 2, mean = 1000, sd = 50)),
                             "NP Cost" = round(rnorm(n = 12 * 2, mean = 10000, sd = 100)),
                             "NODU" = round(rnorm(n = 12 * 2, mean = 10, sd = 2)),
                             "Profit - Euro" = round(rnorm(n = 12 * 2, mean = 80, sd = 5))
                             )  
  final_res <- .format_api_aggregate_result(res = endpoint_res, type_res = "details")
  areas <- unique(final_res$area)
  clusters <- unique(final_res$cluster)
  
  expect_true(inherits(final_res$timeId, what = "integer"))
  expect_true(inherits(final_res$area, what = "factor"))
  expect_true(inherits(final_res$cluster, what = "factor"))
  expect_true(all(areas == tolower(areas)))
  expect_true(all(clusters == tolower(clusters)))
  #expect_true("profit" %in% colnames(final_res))
  
  # mc-all
  endpoint_res <- data.table("area" = rep("fr",12 * 2),
                             "timeId" = as.numeric(rep(seq(1,12),2)),
                             "OP. COST EXP" = round(rnorm(n = 12 * 2, mean = 102, sd = 7.5)),
                             "OP. COST MAX" = round(rnorm(n = 12 * 2, mean = 160, sd = 10)),
                             "OP. COST MIN" = round(rnorm(n = 12 * 2, mean = 80, sd = 5)),
                             "OP. COST STD" = round(rnorm(n = 12 * 2, mean = 40, sd = 2.5))  
                             )
                             
  final_res <- .format_api_aggregate_result(res = endpoint_res, type_res = "details")
  areas <- unique(final_res$area)
  
  expect_true(inherits(final_res$timeId, what = "integer"))
  expect_true(inherits(final_res$area, what = "factor"))
  expect_true(all(areas == tolower(areas)))
  expect_true(all(c("OP. COST", "OP. COST_max", "OP. COST_min", "OP. COST_std") %in% colnames(final_res)))
})


test_that(".compute_pattern_select_url() for column selection in API mode with aggregate endpoint", {
  
  expect_equal(.compute_pattern_select_url(select = "", query_file = "values"), "")
  expect_equal(.compute_pattern_select_url(select = "", query_file = "details"), "")
  expect_equal(.compute_pattern_select_url(select = "", query_file = "details-res"), "")
  expect_equal(.compute_pattern_select_url(select = "", query_file = "details-STstorage"), "")

  expect_equal(.compute_pattern_select_url(select = c("LOLD", "LOLP"), query_file = "values"),
               "&columns_names=LOLD,LOLP"
              )
  
  expect_equal(.compute_pattern_select_url(select = c("LOLD", "LOLP"), query_file = "details"),
               ""
              )
  expect_equal(.compute_pattern_select_url(select = c("fake_one", "production", "fake_two", "NP Cost"), query_file = "details"),
               "&columns_names=MWh,NP Cost - Euro"
              )
  expect_equal(.compute_pattern_select_url(select = c("fake_one", "production", "fake_two", "NP Cost - Euro"), query_file = "details"),
               "&columns_names=MWh"
  )
  
  expect_equal(.compute_pattern_select_url(select = c("fake_one", "levels", "P.withdrawal"), query_file = "details-STstorage"),
               "&columns_names=P-withdrawal - MW,Levels - MWh"
  )
})


test_that("Test the general behaviour of .rename_api_aggregate_result_colnames_to_legacy_names()", {
  
  cols_renamed <- .rename_api_aggregate_result_colnames_to_legacy_names(res_colnames = c("area", "timeId", "NP Cost - Euro"), type_res = "details")
  expect_equal(cols_renamed, c("area", "timeId", "NP Cost"))
  
  # Case sensitive
  cols_renamed <- .rename_api_aggregate_result_colnames_to_legacy_names(res_colnames = c("area", "timeId", "NP CoSt - EuRo"), type_res = "details")
  expect_equal(cols_renamed, c("area", "timeId", "NP CoSt - EuRo"))
  
  cols_renamed <- .rename_api_aggregate_result_colnames_to_legacy_names(res_colnames = c("area", "timeId", "another_column"), type_res = "details")
  expect_equal(cols_renamed, c("area", "timeId", "another_column"))
})


test_that("Test the general behaviour of .extract_selection_type_from_variables_selection_section()", {

  variables_selection <- list("select_var -" = "NODU by plant")
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var -")
  
  variables_selection <- list("select_var +" = "NODU by plant")
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var +")
  
  variables_selection <- list("select_var -" = "NODU by plant", "select_var -" = "DTG by plant")
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var -")
  
  variables_selection <- list("select_var +" = "NODU by plant", "select_var +" = "DTG by plant")
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var +")
  
  # additional name in list
  variables_selection <- list("select_var -" = "NODU by plant", "selected_vars_reset" = TRUE)
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var -")
  
  variables_selection <- list("select_var +" = "NODU by plant", "selected_vars_reset" = TRUE)
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var +")
  
  variables_selection <- list("select_var -" = "NODU by plant", "select_var -" = "DTG by plant", "selected_vars_reset" = TRUE)
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var -")
  
  variables_selection <- list("select_var +" = "NODU by plant", "select_var +" = "DTG by plant", "selected_vars_reset" = TRUE)
  sel_type <- .extract_selection_type_from_variables_selection_section(variables_selection = variables_selection)
  expect_equal(length(sel_type), 1)
  expect_equal(sel_type, "select_var +")

})


test_that("Test the general behaviour of .get_index_variables_to_adjust()", {

  ref_metrics <- c("DTG by plant", "MIN DTG BY PLANT", "NP Cost by plant", "NODU by plant", "Profit by plant")
  
  variables_selection <- list("select_var +" = "NODU by plant", "select_var +" = "DTG by plant", "selected_vars_reset" = TRUE)
  idx_vars <- .get_index_variables_to_adjust(variables_selection = variables_selection, reference_metrics = ref_metrics)
  expect_equal(length(idx_vars), 2)
  expect_equal(idx_vars, c(1, 4))
  
  variables_selection <- list("select_var -" = "NODU by plant", "select_var -" = "DTG by plant", "selected_vars_reset" = TRUE)
  idx_vars <- .get_index_variables_to_adjust(variables_selection = variables_selection, reference_metrics = ref_metrics)
  expect_equal(length(idx_vars), 2)
  expect_equal(idx_vars, c(-1, -4))
  
  variables_selection <- list("select_var +" = "NODU by plant", "select_var +" = "DTG by plant", "select_var +" = "MIN DTG BY PLANT", "selected_vars_reset" = TRUE)
  idx_vars <- .get_index_variables_to_adjust(variables_selection = variables_selection, reference_metrics = ref_metrics)
  expect_equal(length(idx_vars), 3)
  expect_equal(idx_vars, c(1, 2, 4))
  
  variables_selection <- list("select_var -" = "NODU by plant", "select_var -" = "DTG by plant", "select_var -" = "MIN DTG BY PLANT", "selected_vars_reset" = TRUE)
  idx_vars <- .get_index_variables_to_adjust(variables_selection = variables_selection, reference_metrics = ref_metrics)
  expect_equal(length(idx_vars), 3)
  expect_equal(idx_vars, c(-1, -2, -4))
  
  # Case insensitive
  variables_selection <- list("select_var -" = "nodu by PLANT", "select_var -" = "dtg BY plant", "select_var -" = "min DTG by PLANT", "selected_vars_reset" = TRUE)
  idx_vars <- .get_index_variables_to_adjust(variables_selection = variables_selection, reference_metrics = ref_metrics)
  expect_equal(length(idx_vars), 3)
  expect_equal(idx_vars, c(-1, -2, -4))
})


test_that("Test the general behaviour of .filter_referential_output_column_names_by_type()", {
  
  expected_cols <- c("ANTARES_DISPLAYED_NAME", "ORDINAL_POSITION_BY_TOPIC", "MIN_VERSION", "OUTPUT_DISPLAYED_NAME", "RPACKAGE_DISPLAYED_NAME") 
  cols_no_NA <- c("ANTARES_DISPLAYED_NAME", "ORDINAL_POSITION_BY_TOPIC", "OUTPUT_DISPLAYED_NAME", "RPACKAGE_DISPLAYED_NAME") 
  
  ref <- .filter_referential_output_column_names_by_type(type_res = "details")
  expect_true(inherits(x = ref, what = "data.frame"))
  expect_true(all(expected_cols %in% colnames(ref)))
  expect_false(any(is.na(ref[,cols_no_NA])))
  expect_equal(nrow(ref), 5)

  ref <- .filter_referential_output_column_names_by_type(type_res = "details-res")
  expect_true(inherits(x = ref, what = "data.frame"))
  expect_true(all(expected_cols %in% colnames(ref)))
  expect_false(any(is.na(ref[,cols_no_NA])))
  expect_equal(nrow(ref), 1)
  
  ref <- .filter_referential_output_column_names_by_type(type_res = "details-STstorage")
  expect_true(inherits(x = ref, what = "data.frame"))
  expect_true(all(expected_cols %in% colnames(ref)))
  expect_false(any(is.na(ref[,cols_no_NA])))
  expect_equal(nrow(ref), 4)
})