feat: Dynamically obtain software versions, but fall but to static

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: audit.base
 Title: Base package for Posit Checks
-Version: 0.6.17
+Version: 0.6.18
 Authors@R:
     person("Jumping", "Rivers", , "[email protected]", role = c("aut", "cre"))
 Description: Base package for sharing classes between posit audit

NEWS.md

@@ -1,3 +1,6 @@
+# audit.base 0.6.18 _2024-06-25_
+- feat: Dynamically obtain software versions, but fall but to static
+
 # audit.base 0.6.17 _2024-06-24_
 - chore: Software bump
 - feat: Automatically extract connect/workbench versions

R/create_software_tibble.R → R/get_latest_versions_remote.R

@@ -1,5 +1,5 @@
 # https://gitlab.com/jumpingrivers/services/de/spd/infrastructure-template/-/blob/5c584fced32a6fc8fd7b25b3ea78f6fb7a8bd7ca/template/ansible/scripts/versions.sh
-create_software_tibble = function() {
+get_latest_versions_remote = function() {
   r = get_latest_versions_from_posit("r")
   py = get_latest_versions_from_posit("python")
   # Drop latest to get all releases

R/get_posit_cves.R → R/get_posit_remote_versions.R

@@ -1,11 +1,17 @@
 get_posit_remote_versions = function(type = c("connect", "workbench")) {
+  if (!requireNamespace("rvest")) {
+    cli::cli_alert_danger("Missing package - rvest")
+  }
   type = match.arg(type)
-  url = if (type == "connect") "https://docs.posit.co/connect/news/" 
-        else "https://docs.posit.co/ide/news/"
+  url = if (type == "connect") {
+    "https://docs.posit.co/connect/news/"
+  } else {
+    "https://docs.posit.co/ide/news/"
+  }
   page = rvest::read_html(url)
   sections = rvest::html_elements(page, "section")
   v_tibbles = purrr::map_df(sections, extract_posit_cves)
-  all_v = get_all_remote_versions(page) |>
+  all_v = get_all_remote_versions(page) %>%
     dplyr::filter(!.data$version %in% v_tibbles$version) %>%
     dplyr::bind_rows(v_tibbles) %>%
     dplyr::arrange(dplyr::desc(.data$version))

R/posit_versions.R

@@ -3,16 +3,27 @@
 #' Returns a tibble containing the Posit version, date of release,
 #' and any associated CVEs
 #' @param type Posit product of interest
+#' @param remote Try scrapping NEWS first, but fall back to local if that fails
 #' @export
 #' @examples
 #' get_posit_versions(type = "connect")
 #'
-get_posit_versions = function(type = c("connect", "workbench", "drivers")) {
+get_posit_versions = function(
+    type = c("connect", "workbench", "drivers"),
+    remote = TRUE) {
   type = match.arg(type)
-  fname = system.file("extdata", "versions", paste0(type, ".csv"),
-    mustWork = TRUE, package = "audit.base"
-  )
-  versions = readr::read_csv(fname, comment = "#", col_types = c("c", "c"))
+  versions = if (isTRUE(remote)) {
+    try(get_posit_remote_versions(type), silent = TRUE)
+  } else {
+    NULL
+  }
+  if ("try-error" %in% class(versions) || is.null(versions)) {
+    cli::cli_alert_warning("Unable to scrape NEWS page for {type}. Falling back to cache")
+    fname = system.file("extdata", "versions", paste0(type, ".csv"),
+      mustWork = TRUE, package = "audit.base"
+    )
+    versions = readr::read_csv(fname, comment = "#", col_types = c("c", "c"))
+  }
   versions = dplyr::arrange(versions, dplyr::desc(.data$version))
   return(versions)
 }

R/quarto-helpers.R

@@ -15,7 +15,7 @@ get_quarto_server_header = function(out) {
         ~ gt::html(paste(.x, as.character(.y)))
       )
     ) %>%
-    dplyr::mutate(value = ifelse(is.na(.data$value), "-", .data$value)) |>
+    dplyr::mutate(value = ifelse(is.na(.data$value), "-", .data$value)) %>%
     dplyr::distinct()
   dplyr::select(headers, -"documentation", -"header_docs", -"primary_header")
 }

R/software-versions.R

@@ -97,12 +97,20 @@ versions_to_display = function(installed) {
   dplyr::select(l, -"version_num", -"installed_version_num")
 }
 
-get_latest_versions = function() {
-  versions_fname = system.file("extdata", "versions", "software.csv",
-    package = "audit.base",
-    mustWork = TRUE
-  )
-  versions = readr::read_csv(versions_fname, comment = "#", col_types = "fc")
+get_latest_versions = function(remote = TRUE) {
+  versions = if (isTRUE(remote)) {
+    get_latest_versions_remote()
+  } else {
+    NULL
+  }
+  if ("try-error" %in% class(versions) || is.null(versions)) {
+    cli::cli_alert_warning("Using cached version for software versions")
+    versions_fname = system.file("extdata", "versions", "software.csv",
+      package = "audit.base",
+      mustWork = TRUE
+    )
+    versions = readr::read_csv(versions_fname, comment = "#", col_types = "fc")
+  }
   versions$major = get_major(versions$version)
   versions$patch = get_patch(versions$version)
   # Add a version number.

R/update_all_versions.R

@@ -14,7 +14,7 @@ update_all_versions = function() {
     file = "inst/extdata/versions/workbench.csv"
   )
 
-  software = create_software_tibble()
+  software = get_latest_versions_remote()
   readr::write_csv(software, file = "inst/extdata/versions/software.csv")
   return(invisible(NULL))
 }

tests/testthat/test-posit_versions.R

@@ -43,13 +43,14 @@ test_that("Testing check server", {
 test_that("Testing check Posit versions", {
   type = "connect"
   remote = get_posit_remote_versions(type)
-  local = get_posit_versions(type)
-  expect_true(all(remote$version %in% local$version), 
-    info = "Try running update_all_versions()")
+  local = get_posit_versions(type, remote = FALSE)
+  expect_true(all(remote$version %in% local$version),
+    info = "Try running update_all_versions()"
+  )
   type = "workbench"
   remote = get_posit_remote_versions(type)
-  local = get_posit_versions(type)
-  expect_true(all(remote$version %in% local$version), 
-    info = "Try running update_all_versions()")
-}
-)
+  local = get_posit_versions(type, remote = FALSE)
+  expect_true(all(remote$version %in% local$version),
+    info = "Try running update_all_versions()"
+  )
+})

tests/testthat/test-software-versions.R

@@ -45,9 +45,10 @@ test_that("Testing software versions quarto output", {
 
 test_that("Ensure that software versions are up to date", {
   testthat::skip_on_ci()
-  versions = get_latest_versions()
-  latest = create_software_tibble()
+  versions = get_latest_versions(remote = FALSE)
+  latest = get_latest_versions_remote()
   # If this test files, try running update_software_csv() first
-  expect_true(all(latest$version %in% versions$version), 
-    info = "Try running update_all_versions()")
+  expect_true(all(latest$version %in% versions$version),
+    info = "Try running update_all_versions()"
+  )
 })