summary: guard against external scores

render_scorecard_summary() and summarize_package_results() have not
been reworked to support external scores.  We use these functions for
MPN.  For non-R packages, we don't yet have a need for these
functions.

Document that these functions don't accept external scores, and add a
custom guard so that a more informative error is given if any results
directory with external scores is passed.

R/render-scorecard-summary.R

@@ -1,7 +1,8 @@
 
 #' Render PDF summary of scorecards
 #'
-#' @param result_dirs A vector of output directories
+#' @param result_dirs A vector of output directories, each one produced by
+#'   [score_pkg()]. [external_scores] are not supported.
 #' @param snapshot A report subtitle indicating the grouping of these packages, such as an MPN snapshot. See details.
 #' @param out_dir Output directory for saving scorecard summary. If `NULL`, assumes all `result_dirs` point to the same output directory
 #' @inheritParams render_scorecard
@@ -23,6 +24,8 @@ render_scorecard_summary <- function(result_dirs,
     snapshot <- paste('MPN Snapshot', snapshot)
   }
 
+  assert_no_external(result_dirs)
+
   # Format overall scores and risk
   overall_risk_summary <- build_risk_summary(result_dirs, risk_breaks, out_dir)
 
@@ -142,7 +145,7 @@ build_risk_summary <- function(result_dirs,
 #' @returns a dataframe
 #' @export
 summarize_package_results <- function(result_dirs){
-
+  assert_no_external(result_dirs)
   json_paths <- get_result_path(result_dirs, "scorecard.json")
 
   risk_summary_df <- tibble::tibble(
@@ -170,3 +173,9 @@ summarize_package_results <- function(result_dirs){
 
   return(risk_summary_df)
 }
+
+assert_no_external <- function(result_dirs, call = rlang::caller_env()) {
+  if (any(fs::file_exists(get_result_path(result_dirs, "pkg.json")))) {
+    abort("External scores are not supported.", call = call)
+  }
+}

tests/testthat/test-summarize-package-results.R

@@ -72,4 +72,8 @@ describe("summarize_package_results", {
     )
   })
 
+  it("aborts on external scores", {
+    rdir <- local_create_external_results()
+    expect_error(render_scorecard_summary(rdir), "not supported")
+  })
 })