New numbering system in API mode (ex : 7.0, 8.2, 9.2, ...) (#327)

* Compliant with new numbering system in API mode

* add unit tests

* API does not send "7" or "8" anymore but "7.0" or "8.0"

* Antares Web sends 7.0 instead of 7

* Convert Antares version to numeric

* Get antares version from info/general/version cause output mode version will be different from input mode version

* Update NEWS.md to have a more clear message (breaking change due to Antares Web)

---------

Co-authored-by: kemihak <kamel.kemiha@rte-france.com>

Author: KKamel67

NEWS.md

@@ -11,6 +11,10 @@ BUGFIXES :
 * `.getSimOptionsAPI()` reads and returns the new converted study version format (ex : 9.0 => 900) in output mode
 * `simulation_variables_names_by_supprt.csv` update to read the new thermal output variable `MIN GEN - MWh` available since 9.2 version
 
+BREAKING CHANGES :
+* `.getInputOptionsAPI()` Since Antares Web 2.33.0, new numbering system in API mode (ex : 7.0, 8.2, 9.2, ...) 
+
+
 # antaresRead 3.0.0
 
 BUGFIXES :

R/setSimulationPath.R

@@ -537,7 +537,7 @@ setSimulationPath <- function(path, simulation = NULL) {
 
   p <- params$general
 
-	first_month_in_year <- tolower(as.character(p[["first-month-in-year"]]))
+  first_month_in_year <- tolower(as.character(p[["first-month-in-year"]]))
   is_january_first_month_in_year <- first_month_in_year == "january"
 
   # Extract year from the "horizon" parameter.
@@ -713,24 +713,20 @@ setSimulationPath <- function(path, simulation = NULL) {
 #' @keywords internal
 .transform_antares_version <- function(antares_version) {
   antares_version <- format(antares_version, nsmall = 2)
-
+  
   # Split major and minor parts
   antares_version_splitted <- unlist(strsplit(antares_version, split = "\\."))
-
+  
   major <- antares_version_splitted[1]
   minor <- antares_version_splitted[2]
-
+  
   # max 1 digit for minor
   if (nchar(minor) > 2)
     stop("Invalid antares_version format, good format is like '9.99'",
          call. = FALSE)
-
+  
   # convert to numeric for package understanding
   num_version <- round(as.numeric(antares_version)*100)
 
   return(num_version)
 }
-
-
-
-

R/setSimulationPathAPI.R

@@ -62,12 +62,17 @@
 
   # Get basic information about the simulation
   params <- read_secure_json(file.path(simPath, "about-the-study", "parameters"), ...)
-
+  
   info <- read_secure_json(file.path(simPath, "info", "general"), ...)
 
   # Where are located the results ?
   simDataPath <- file.path(simPath, tolower(as.character(info$mode)))
-
+  antares_version <- info$version
+  
+  if (antares_version < 600 & antares_version >= 9) {
+    antares_version <- .transform_antares_version(antares_version = antares_version)
+  }
+  
   mc_ind_path <- file.path(simDataPath, "mc-ind&depth=1")
 
   synthesis <- .getSuccess(file.path(simDataPath, "mc-all&depth=1"), ...)
@@ -166,7 +171,7 @@
       yearByYear = yearByYear,
       scenarios = scenarios,
       mcYears = mcYears,
-      antaresVersion = paths$version,
+      antaresVersion = antares_version,
       areaList = areaList,
       districtList = gsub("^@ ?", "", districtList),
       linkList = linkList[linkList %in% linksDef$link],
@@ -206,10 +211,8 @@
     data.frame(link = paste(Y, "-", to), from = Y, to = to, stringsAsFactors = TRUE)
 
   }, allLinks, names(allLinks)))
-
-  # info <- read_secure_json(studyPath, ...)
-
-  antaresVersion <- paths$version
+  
+  antaresVersion <- .transform_antares_version(antares_version = paths$version)
   params <- read_secure_json(file.path(studyPath, "settings", "generaldata"), ...)
 
   # Areas with clusters
@@ -309,7 +312,7 @@ setSimulationPathAPI <- function(host, study_id, token, simulation = NULL,
   if (missing(token)) {
     stop("Please specify your access token")
   }
-
+  
   valid_host <- tryCatch({
     .getSuccess(file.path(host, "health"), token = "", timeout = timeout, config = httr_config)
   }, error = function(e) FALSE)
@@ -319,7 +322,7 @@ setSimulationPathAPI <- function(host, study_id, token, simulation = NULL,
   }
 
   stopifnot(timeout > 0)
-
+  
   check_study <- tryCatch({
     read_secure_json(file.path(host, "v1/studies", study_id), token = token,
                      timeout = timeout, config = httr_config

tests/testthat/test-setSimulationPath.R

@@ -289,3 +289,24 @@ test_that("Check version pb (9.2*100)<920 TRUE ?", {
     .transform_antares_version("9.2")<920
   )
 })
+
+
+test_that("Check that if version x < version y, then converted version x is < converted version y", {
+
+  ant_version <- c(7.0,
+                   7.1,
+                   7.2,
+                   8.0,
+                   8.1,
+                   8.2,
+                   8.3,
+                   8.4,
+                   8.5,
+                   8.6,
+                   8.7,
+                   8.8,
+                   9.2,
+                   9.3)
+  ant_version_converted <- sapply(ant_version, .transform_antares_version)
+  expect_true(all(diff(ant_version_converted) > 0))
+})

tests/testthat/test-setSimulationPathAPI.R

@@ -5,7 +5,7 @@ test_that("getSimOptionsAPI return antares version in right format", {
     # --- root
     "sim/info/general" = list(
       mode = "adequacy",
-      #version = 930,
+      version=9.3,
       name = "test",
       date = "today"
     ),
@@ -33,10 +33,41 @@ test_that("getSimOptionsAPI return antares version in right format", {
     .readLinksDef = function(x) data.frame(link="fr-de", from="fr", to="de"),
     .package = "antaresRead"
   )
-
+ 
   # when
-  res <- .getSimOptionsAPI(paths = list(version=930, simPath="sim"))
+  res <- .getSimOptionsAPI(paths = list(simPath="sim"))
 
   # then
   expect_equal(res$antaresVersion, 930)
 })
+
+
+test_that("getInputOptionsAPI return antares version in right format", {
+  # given
+  fixtures <- list(
+
+    # --- root
+    "study/general" = list(
+      name = "test",
+      date = "today"
+    ),
+
+    "input/areas/list" = c("fr", "de"),
+    "input/areas/sets" = list("@district1" = "district1"),
+    "input/links&depth=1" = list("de" = "de - fr", "fr" = "de - fr")
+  )
+
+  testthat::local_mocked_bindings(
+    read_secure_json = function(url, ...) fixtures[[url]],
+    .package = "antaresRead"
+  )
+
+  res <- .getInputOptionsAPI(paths = list(version=7.1, studyPath="study", inputPath="input"))
+  expect_equal(res$antaresVersion, 710)
+  
+  res <- .getInputOptionsAPI(paths = list(version=7.0, studyPath="study", inputPath="input"))
+  expect_equal(res$antaresVersion, 700)
+
+  res <- .getInputOptionsAPI(paths = list(version=9.3, studyPath="study", inputPath="input"))
+  expect_equal(res$antaresVersion, 930)
+})