refactor azure to prepare #4, close #45

maxheld83 · Sep 1, 2020 · 8d6f34a · 8d6f34a
1 parent 4f62d2a
commit 8d6f34a
Show file tree

Hide file tree

Showing 11 changed files with 341 additions and 133 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -28,7 +28,6 @@ Imports:
     checkmate (>= 2.0.0),
     withr (>= 2.2.0),
     fs (>= 1.4.0),
-    usethis (>= 1.6.1),
     htmltools (>= 0.5.0)
 Remotes:
   subugoe/[email protected]

diff --git a/NAMESPACE b/NAMESPACE
@@ -1,7 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
-export(az_webapp_config)
+export(az_webapp)
 export(az_webapp_shiny_opts)
+export(az_webapp_show)
 export(include_app2)
+export(include_app2_azure)
 export(is_github_actions)
 export(runOldFaithful)
diff --git a/R/azure.R b/R/azure.R
@@ -1,102 +1,104 @@
 #' Deploy a shiny app to [Microsoft Azure Web Apps for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/)
 #'
-#' Wraps the [Azure Command-Line Interface (CLI)](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) with defaults suitable for deploying a shiny app.
+#' Calls the [Azure Command-Line Interface (CLI)](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) with defaults suitable for deploying a shiny app.
+#' Wraps several steps.
 #'
-#' @param name
-#' Name of the web app.
-#'
-#' @param deployment_container_image_name
-#' The custom image name and optionally the tag name.
-#' Image must
-#' - include everything needed to run the shiny app, including shiny itself,
-#'   but *does not* need to include shiny server or other software to route, load balance and serve shiny,
-#' - include an `ENTRYPOINT` and/or [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd) instruction to start shiny automatically (recommended), *or* shiny must be started via the `startup_file` argument.
-#'
-#' @param startup_file
-#' `docker run` [`[COMMAND]`](https://docs.docker.com/engine/reference/run/) to use inside of your custom image `deployment_container_image_name`.
-#' Defaults to `NULL`, in which case the container is expected to start up shiny automatically (recommended).
-#' For details on the shiny startup command, see the examples.
+#' @param restart whether to restart the web app.
 #'
-#' **The `[EXPR]` (anything after `-e`) must not be quoted, and must not contain spaces ([#27](https://github.com/subugoe/shinycaas/issues/27))**.
-#' For example, the following `startup-file`s are valid (if nonsensical, because they don't start a shiny app)
-#' - `"Rscript -e 1+1"` (no spaces)
-#' - `"Rscript -e print('foo')"` (no spaces, no quoting *of* the `[EXPR]`)
+#' @param \dots passed on to other functions or placeholder.
 #'
-#' The following `startup-file`s are *invalid*:
-#' - `"Rscript -e 1 + 1"` (spaces inside `[EXPR]`)
-#' - `"Rscript -e '1+1'"` (quoting of `[EXPR]` would be treated as `"Rscript -e '\"1+1\"'"`).
+#' @example tests/testthat/setup-azure.R
 #'
-#' @param plan
-#' Name or resource id of the app service plan.
+#' @family azure functions
 #'
-#' @param resource_group
-#' The [Azure resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal) to which the shiny app should belong.
+#' @export
+az_webapp <- function(restart = FALSE,
+                      ...) {
+  checkmate::assert_flag(restart)
+  az_account_set(...)
+  az_configure(...)
+  az_webapp_create(...)
+  az_webapp_deployment_slot_create(...)
+  az_webapp_config_container_set(...)
+  az_webapp_update(...)
+  az_webapp_config_set(...)
+  az_webapp_config_appsettings_set(...)
+
+  if (restart) {
+    az_webapp_restart(...)
+  }
+}
+
+#' @describeIn az_webapp Setting subscription
 #'
 #' @param subscription
 #' Name or ID of the Azure subscription to which costs are billed.
 #' According to an upvoted answer on Stack Overflow, [Azure subscription IDs need not be considered a secret or personal identifiable information (PII)](https://stackoverflow.com/questions/45661109/are-azure-subscription-id-aad-tenant-id-and-aad-app-client-id-considered-secre).
 #' However, depending your applicable context and policies, you may want to provide this argument as a secret.
-#'
-#' @param docker_registry_server_url
-#' The container registry server url.
-#' Defaults to `NULL`, in which case the azure default, [docker hub](http://hub.docker.com) is used.
-#'
-#' @param docker_registry_server_user,docker_registry_server_password
-#' Credentials for private container registries.
-#' Defaults to `NULL` for public registries.
-#' Do not expose your credentials in public code; it's best to use secret environment variables.
-#'
-#' @param slot
-#' The name of the [deployment slot](https://docs.microsoft.com/en-us/azure/app-service/deploy-staging-slots).
-#' Defaults to the production slot if not specified.
-#' Only available for higher app service plan tiers.
-#'
-#' @param restart whether to restart the web app.
-#'
-#' @example tests/testthat/setup-azure.R
-#'
-#' @export
-az_webapp_config <- function(name,
-                             deployment_container_image_name,
-                             startup_file = NULL,
-                             plan,
-                             resource_group,
-                             subscription,
-                             docker_registry_server_url = NULL,
-                             docker_registry_server_user = NULL,
-                             docker_registry_server_password = NULL,
-                             slot = NULL,
-                             restart = FALSE) {
-  checkmate::assert_string(name)
-  checkmate::assert_string(deployment_container_image_name)
-  checkmate::assert_string(startup_file, null.ok = TRUE)
+az_account_set <- function(subscription, ...) {
   checkmate::assert_string(subscription)
-  checkmate::assert_string(resource_group)
-  checkmate::assert_string(slot, null.ok = TRUE)
-  checkmate::assert_string(docker_registry_server_url, null.ok = TRUE)
-  checkmate::assert_string(docker_registry_server_user, null.ok = TRUE)
-  checkmate::assert_string(docker_registry_server_password, null.ok = TRUE)
-
-  cli::cli_alert_info("Setting defaults ...")
+  cli::cli_alert_info("Setting subscription ...")
   # unclear where those are set
   az_cli_run(args = c("account", "set", "--subscription", subscription))
+}
+
+#' @describeIn az_webapp
+#' Set defaults for az CLI.
+#' Does not leave side effects (`.azure/`), but cleans up after itself.
+#' Must be called repeatedly.
+#' If a folder `.azure` is already in the working directory, those defaults are used and a warning is issued.
+#'
+#' @param name
+#' Name of the web app.
+#'
+#' @param resource_group
+#' The [Azure resource group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal) to which the shiny app should belong.
+az_configure <- function(name, resource_group, ...) {
   # precaution against ambiguous credentials and later cleanup deletion
   if (fs::dir_exists(".azure")) {
-    usethis::ui_stop(
-      "There is a folder {usethis::ui_path('.azure')} at the working directory.
-      It may already contain defaults.
-      Delete it to proceed."
+    cli::cli_alert_warning(
+      "Using the defaults found in {.file .azure} at the working directory ..."
     )
+    return(NULL)
   }
+  checkmate::assert_string(name)
+  checkmate::assert_string(resource_group)
+  cli::cli_alert_info("Setting defaults ...")
   az_cli_run(args = c(
     "configure",
     # only applies to current folder, useful if there are various projects
     "--scope", "local",
     "--defaults", paste0("group=", resource_group), paste0("web=", name)
   ))
-  # clean up not to let defaults linger
-  withr::defer(fs::dir_delete(".azure"))
+  # clean up not to let defaults linger, gottabe grandparent
+  withr::defer(fs::dir_delete(".azure"), envir = parent.frame(2))
+}
 
+#' @describeIn az_webapp
+#' Creates a web app
+#'
+#' @param plan
+#' Name or resource id of the app service plan.
+#'
+#' @param startup_file
+#' `docker run` [`[COMMAND]`](https://docs.docker.com/engine/reference/run/) to use inside of your custom image `deployment_container_image_name`.
+#' Defaults to `NULL`, in which case the container is expected to start up shiny automatically (recommended).
+#' For details on the shiny startup command, see the examples.
+#'
+#' **The `[EXPR]` (anything after `-e`) must not be quoted, and must not contain spaces ([#27](https://github.com/subugoe/shinycaas/issues/27))**.
+#' For example, the following `startup-file`s are valid (if nonsensical, because they don't start a shiny app)
+#' - `"Rscript -e 1+1"` (no spaces)
+#' - `"Rscript -e print('foo')"` (no spaces, no quoting *of* the `[EXPR]`)
+#'
+#' The following `startup-file`s are *invalid*:
+#' - `"Rscript -e 1 + 1"` (spaces inside `[EXPR]`)
+#' - `"Rscript -e '1+1'"` (quoting of `[EXPR]` would be treated as `"Rscript -e '\"1+1\"'"`).
+az_webapp_create <- function(plan,
+                             name,
+                             startup_file = NULL,
+                             deployment_container_image_name,
+                             ...) {
+  checkmate::assert_string(startup_file, null.ok = TRUE)
   cli::cli_alert_info("Creating or updating web app ...")
   az_cli_run(args = c(
     "webapp", "create",
@@ -110,16 +112,53 @@ az_webapp_config <- function(name,
     }
     # todo also pass on tags #25
   ))
+}
 
-  # create deployment slot
+#' @describeIn az_webapp Creates a deployment slot
+#'
+#' @param slot
+#' The name of the [deployment slot](https://docs.microsoft.com/en-us/azure/app-service/deploy-staging-slots).
+#' Defaults to the production slot if not specified.
+#' Only available for higher app service plan tiers.
+az_webapp_deployment_slot_create <- function(name, slot = NULL, ...) {
+  checkmate::assert_string(slot, null.ok = TRUE)
   if (!is.null(slot)) {
+    cli::cli_alert_info("Creating deployment slot ...")
     az_cli_run(args = c(
       "webapp", "deployment", "slot", "create",
       "--name", name,
       "--slot", slot
     ))
   }
+}
 
+#' @describeIn az_webapp Sets web app container settings
+#'
+#' @param deployment_container_image_name
+#' The custom image name and optionally the tag name.
+#' Image must
+#' - include everything needed to run the shiny app, including shiny itself,
+#'   but *does not* need to include shiny server or other software to route, load balance and serve shiny,
+#' - include an `ENTRYPOINT` and/or [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd) instruction to start shiny automatically (recommended), *or* shiny must be started via the `startup_file` argument.
+#'
+#' @param docker_registry_server_url
+#' The container registry server url.
+#' Defaults to `NULL`, in which case the azure default, [docker hub](http://hub.docker.com) is used.
+#'
+#' @param docker_registry_server_user,docker_registry_server_password
+#' Credentials for private container registries.
+#' Defaults to `NULL` for public registries.
+#' Do not expose your credentials in public code; it's best to use secret environment variables.
+az_webapp_config_container_set <- function(deployment_container_image_name,
+                                           docker_registry_server_url = NULL,
+                                           docker_registry_server_user = NULL,
+                                           docker_registry_server_password = NULL,
+                                           slot = NULL,
+                                           ...) {
+  checkmate::assert_string(deployment_container_image_name)
+  checkmate::assert_string(docker_registry_server_url, null.ok = TRUE)
+  checkmate::assert_string(docker_registry_server_user, null.ok = TRUE)
+  checkmate::assert_string(docker_registry_server_password, null.ok = TRUE)
   cli::cli_alert_info("Setting web app container settings")
   az_cli_run(args = c(
     "webapp", "config", "container", "set",
@@ -139,7 +178,10 @@ az_webapp_config <- function(name,
       c("--slot", slot)
     }
   ))
+}
 
+#' @describeIn az_webapp Sets web app tags
+az_webapp_update <- function(slot = NULL, ...) {
   cli::cli_alert_info("Setting web app tags ...")
   # for some reason, this is not part of the webapp config, though it is on portal.azure.com
   az_cli_run(args = c(
@@ -150,7 +192,10 @@ az_webapp_config <- function(name,
       c("--slot", slot)
     }
   ))
+}
 
+#' @describeIn az_webapp Sets web app configuration
+az_webapp_config_set <- function(slot = NULL, ...) {
   cli::cli_alert_info("Setting web app configuration ...")
   az_cli_run(args = c(
     "webapp", "config", "set",
@@ -163,7 +208,10 @@ az_webapp_config <- function(name,
       c("--slot", slot)
     }
   ))
+}
 
+#' @describeIn az_webapp Sets web app appsetings
+az_webapp_config_appsettings_set <- function(slot = NULL, ...) {
   # weirdly this cannot be set in the above
   az_cli_run(args = c(
     "webapp", "config", "appsettings", "set",
@@ -172,20 +220,20 @@ az_webapp_config <- function(name,
       c("--slot", slot)
     }
   ))
+}
 
+#' @describeIn az_webapp Restarts the web app
+az_webapp_restart <- function(slot = NULL, ...) {
   cli::cli_alert_info("Restaring web app ...")
-  if (restart) {
-    az_cli_run(args = c(
-      "webapp", "restart",
-      if (!is.null(slot)) {
-        c("--slot", slot)
-      }
-    ))
-  }
-
-  # TODO check whether app actually runs #22
+  az_cli_run(args = c(
+    "webapp", "restart",
+    if (!is.null(slot)) {
+      c("--slot", slot)
+    }
+  ))
 }
 
+
 #' Run Azure CLI
 #'
 #' @inheritDotParams processx::run
@@ -201,7 +249,8 @@ az_cli_run <- function(...) {
   )
 }
 
-#' @describeIn az_webapp_config
+#' Shiny options for Microsoft Azure Web App for Containers
+#'
 #' Set shiny options as [required for an Azure Webapp](https://docs.microsoft.com/en-us/azure/app-service/containers/configure-custom-container):
 #' - `options(shiny.port = as.integer(Sys.getenv('PORT'))`.
 #'    Your custom container is expected to listen on `PORT`, an environment variable set by Azure.
@@ -210,6 +259,8 @@ az_cli_run <- function(...) {
 #'
 #' You can also set these options manually as in the below example.
 #'
+#' @family azure functions
+#'
 #' @export
 az_webapp_shiny_opts <- function() {
   port <- Sys.getenv("PORT")
@@ -230,3 +281,27 @@ az_webapp_shiny_opts <- function() {
   # TODO might revert back to old_opts with
   # withr::defer(options(old_opts), envir = parent.frame(2))
 }
+
+#' Get details of a web app
+#'
+#' @family azure functions
+#'
+#' @export
+az_webapp_show <- function(name, resource_group, slot = NULL, subscription, ...) {
+  res <- az_cli_run(args = c(
+    "webapp", "show"
+  ))
+}
+
+#' Embed a shiny app with Microsoft Azure Web Apps for Containers
+#'
+#' @inheritDotParams include_app2
+#'
+#' @inheritParams az_webapp
+#'
+#' @family azure functions
+#'
+#' @export
+include_app2_azure <- function(slot = NULL, ...) {
+  NULL
+}
diff --git a/R/embed.R b/R/embed.R
@@ -9,6 +9,8 @@
 #'
 #' @return A tag list as from [htmltools::tagList()].
 #'
+#' @family helper functions
+#'
 #' @export
 include_app2 <- function(src, name = NULL, height = "100%", width = "100%") {
   htmltools::tags$div(