Skip to content

Add Databricks support for service principals when running in Posit Connect with connectcreds #931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add Databricks support for service principals when running in Posit Connect with connectcreds #931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Imports:
Rcpp (>= 0.12.11),
rlang (>= 1.1.0)
Suggests:
connectcreds,
connectcreds (>= 0.1.0.9000),
covr,
DBItest,
httr2,
Expand Down Expand Up @@ -90,3 +90,5 @@ Collate:
'utils.R'
'zzz.R'
VignetteBuilder: knitr
Remotes:
posit-dev/connectcreds
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

* Databricks: Fix repeated calls to `dbConnect` (#901).

* `databricks()` now detects service principal credentials when running on Posit Connect (@tnederlof, #930)

# odbc 1.6.1

* odbc will now automatically find statically built installations of
Expand Down
29 changes: 21 additions & 8 deletions R/driver-databricks.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ NULL
#' model, with support for personal access tokens, OAuth machine-to-machine
#' credentials, and OAuth user-to-machine credentials supplied via Posit
#' Workbench or the Databricks CLI on desktop. It can also detect viewer-based
#' credentials on Posit Connect if the \pkg{connectcreds} package is
#' installed. All of these credentials are detected automatically if present
#' using [standard environment variables](https://docs.databricks.com/en/dev-tools/auth.html#environment-variables-and-fields-for-client-unified-authentication).
#' and service principal credentials on Posit Connect if the \pkg{connectcreds}
#' package is installed. All of these credentials are detected automatically if
#' present using [standard environment variables](https://docs.databricks.com/en/dev-tools/auth.html#environment-variables-and-fields-for-client-unified-authentication).
#'
#' In addition, on macOS platforms, the `dbConnect()` method will check
#' for irregularities with how the driver is configured,
Expand Down Expand Up @@ -49,12 +49,13 @@ NULL
#' httpPath = "sql/protocolv1/o/4425955464597947/1026-023828-vn51jugj"
#' )
#'
#' # Use credentials from the viewer (when possible) in a Shiny app
#' # deployed to Posit Connect.
#' # Use credentials from the viewer or a service principal (when possible) in
#' # a Shiny app deployed to Posit Connect.
#' library(connectcreds)
#' server <- function(input, output, session) {
#' conn <- DBI::dbConnect(
#' odbc::databricks(),
#' workspace = "https://example.cloud.databricks.com",
#' httpPath = "sql/protocolv1/o/4425955464597947/1026-023828-vn51jugj"
#' )
#' }
Expand Down Expand Up @@ -134,9 +135,12 @@ databricks_args <- function(httpPath,
if (running_on_connect()) {
msg <- c(
msg,
"i" = "Or consider enabling Posit Connect's Databricks integration \
for viewer-based credentials. See {.url \
https://docs.posit.co/connect/user/oauth-integrations/#adding-oauth-integrations-to-deployed-content}
"i" = "Or consider enabling Posit Connect's Databricks integration. \
For viewer-based credentials. See {.url \
https://docs.posit.co/connect/user/oauth-integrations/#viewer-oauth-integrations}
for details. \
For service principal credentials, see {.url \
https://docs.posit.co/connect/user/oauth-integrations/#service-account-oauth-integrations}
for details."
)
}
Expand Down Expand Up @@ -227,6 +231,15 @@ databricks_auth_args <- function(host, uid = NULL, pwd = NULL) {
))
}

if (is_installed("connectcreds") && connectcreds::has_service_account_token(workspace)) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also just add a conditional on the connectcreds package version here, I think? And then merge without a Remotes on the dev version.

token <- connectcreds::connect_service_account_token(workspace)
return(list(
authMech = 11,
auth_flow = 0,
auth_accesstoken = token$access_token
))
}

if (!is.null(uid) && !is.null(pwd)) {
return(list(uid = uid, pwd = pwd, authMech = 3))
} else if (xor(is.null(uid), is.null(pwd))) {
Expand Down
11 changes: 6 additions & 5 deletions man/databricks.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/testthat/test-driver-databricks.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ test_that("Workbench-managed credentials are ignored for other hosts", {
expect_equal(databricks_auth_args(host = "some-host"), NULL)
})

test_that("we hint viewer-based credentials on Connect", {
test_that("we hint viewer-based and service principal credentials on Connect", {
local_mocked_bindings(
running_on_connect = function() TRUE
)
Expand Down
Loading