[Internal] Move package credentials in config (#1115)

renaudhartert-db · web-flow · commit 23d9c1ea2bf1 · 2025-01-07T14:57:39.000Z
## What changes are proposed in this pull request?

This PR moves the `credentials` package in `config`, thus centralizing
the credentials logic in a single place.

The goal of this change is to prepare the current SDK-Beta to facilitate
migration to the new SDK that is currently being developed.

This PR introduces a breaking change by changing the import paths to
`CredentialsProvider`. However, we believe that the impact is fairly
contained as (i) `CredentialsProvider` is mostly internally, and (ii)
the breaking change can be addressed by updating the import path.

## How is this tested?

Through normal unit test and integration tests.
diff --git a/config/api_client.go b/config/api_client.go
@@ -9,7 +9,7 @@ import (
 	"time"
 
 	"github.com/databricks/databricks-sdk-go/apierr"
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/httpclient"
 	"github.com/databricks/databricks-sdk-go/useragent"
 )
diff --git a/config/auth_azure_cli.go b/config/auth_azure_cli.go
@@ -11,7 +11,7 @@ import (
 
 	"golang.org/x/oauth2"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/logger"
 )
 
diff --git a/config/auth_azure_client_secret.go b/config/auth_azure_client_secret.go
@@ -8,7 +8,7 @@ import (
 	"golang.org/x/oauth2"
 	"golang.org/x/oauth2/clientcredentials"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/logger"
 )
 
diff --git a/config/auth_azure_github_oidc.go b/config/auth_azure_github_oidc.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/httpclient"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2"
diff --git a/config/auth_azure_msi.go b/config/auth_azure_msi.go
@@ -8,7 +8,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/httpclient"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2"
diff --git a/config/auth_basic.go b/config/auth_basic.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"net/http"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 )
 
 type BasicCredentials struct {
diff --git a/config/auth_databricks_cli.go b/config/auth_databricks_cli.go
@@ -10,7 +10,7 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2"
 )
diff --git a/config/auth_default.go b/config/auth_default.go
@@ -5,7 +5,7 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/logger"
 )
 
diff --git a/config/auth_gcp_google_credentials.go b/config/auth_gcp_google_credentials.go
@@ -6,7 +6,7 @@ import (
 	"io/ioutil"
 	"os"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2/google"
 	"google.golang.org/api/idtoken"
diff --git a/config/auth_gcp_google_id.go b/config/auth_gcp_google_id.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2"
 	"google.golang.org/api/impersonate"
diff --git a/config/auth_m2m.go b/config/auth_m2m.go
@@ -8,7 +8,7 @@ import (
 	"golang.org/x/oauth2"
 	"golang.org/x/oauth2/clientcredentials"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/httpclient"
 	"github.com/databricks/databricks-sdk-go/logger"
 )
diff --git a/config/auth_metadata_service.go b/config/auth_metadata_service.go
@@ -8,7 +8,7 @@ import (
 	"net/url"
 	"time"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/httpclient"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2"
diff --git a/config/auth_pat.go b/config/auth_pat.go
@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"net/http"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 )
 
 type PatCredentials struct {
diff --git a/config/config.go b/config/config.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/databricks/databricks-sdk-go/common"
 	"github.com/databricks/databricks-sdk-go/common/environment"
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/httpclient"
 	"github.com/databricks/databricks-sdk-go/logger"
 	"golang.org/x/oauth2"
diff --git a/config/credentials/credentials.go b/config/credentials/credentials.go
@@ -0,0 +1,68 @@
+package credentials
+
+import (
+	"net/http"
+
+	"golang.org/x/oauth2"
+)
+
+// CredentialsProvider is an interface for providing credentials to the client.
+// Implementations of this interface should set the necessary headers on the request.
+type CredentialsProvider interface {
+	// SetHeaders sets the necessary headers on the request.
+	SetHeaders(r *http.Request) error
+}
+
+type credentialsProvider struct {
+	setHeaders func(r *http.Request) error
+}
+
+func (c *credentialsProvider) SetHeaders(r *http.Request) error {
+	return c.setHeaders(r)
+}
+
+func NewCredentialsProvider(visitor func(r *http.Request) error) CredentialsProvider {
+	return &credentialsProvider{
+		setHeaders: visitor,
+	}
+}
+
+// OAuthCredentialsProvider is a specialized CredentialsProvider uses and provides an OAuth token.
+type OAuthCredentialsProvider interface {
+	CredentialsProvider
+	// Token returns the OAuth token generated by the provider.
+	Token() (*oauth2.Token, error)
+}
+
+type oauthCredentialsProvider struct {
+	setHeaders func(r *http.Request) error
+	token      func() (*oauth2.Token, error)
+}
+
+func (c *oauthCredentialsProvider) SetHeaders(r *http.Request) error {
+	return c.setHeaders(r)
+}
+
+func (c *oauthCredentialsProvider) Token() (*oauth2.Token, error) {
+	return c.token()
+}
+
+func NewOAuthCredentialsProvider(visitor func(r *http.Request) error, tokenProvider func() (*oauth2.Token, error)) OAuthCredentialsProvider {
+	return &oauthCredentialsProvider{
+		setHeaders: visitor,
+		token:      tokenProvider,
+	}
+}
+
+// OAuthToken represents an OAuth token as defined by the OAuth 2.0 Authorization Framework.
+// https://datatracker.ietf.org/doc/html/rfc6749
+type OAuthToken struct {
+	// The access token issued by the authorization server. This is the token that will be used to authenticate requests.
+	AccessToken string `json:"access_token"  auth:",sensitive"`
+	// Time in seconds until the token expires.
+	ExpiresIn int `json:"expires_in"`
+	// The scope of the token. This is a space-separated list of strings that represent the permissions granted by the token.
+	Scope string `json:"scope"`
+	// The type of token that was issued.
+	TokenType string `json:"token_type"`
+}
diff --git a/credentials/credentials_provider.go b/credentials/credentials_provider.go
diff --git a/credentials/oauth_credentials_provider.go b/credentials/oauth_credentials_provider.go
diff --git a/credentials/oauth_token.go b/credentials/oauth_token.go
diff --git a/examples/custom-auth/main.go b/examples/custom-auth/main.go
@@ -10,7 +10,7 @@ import (
 
 	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/config"
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"github.com/databricks/databricks-sdk-go/service/compute"
 )
 
diff --git a/httpclient/oauth_token.go b/httpclient/oauth_token.go
@@ -5,7 +5,7 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/databricks/databricks-sdk-go/credentials"
+	"github.com/databricks/databricks-sdk-go/config/credentials"
 	"golang.org/x/oauth2"
 )
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"time"`
`10`	`10`
`11`	`11`	`"github.com/databricks/databricks-sdk-go/apierr"`
`12`		`- "github.com/databricks/databricks-sdk-go/credentials"`
	`12`	`+ "github.com/databricks/databricks-sdk-go/config/credentials"`
`13`	`13`	`"github.com/databricks/databricks-sdk-go/httpclient"`
`14`	`14`	`"github.com/databricks/databricks-sdk-go/useragent"`
`15`	`15`	`)`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`
`12`	`12`	`"golang.org/x/oauth2"`
`13`	`13`
`14`		`- "github.com/databricks/databricks-sdk-go/credentials"`
	`14`	`+ "github.com/databricks/databricks-sdk-go/config/credentials"`
`15`	`15`	`"github.com/databricks/databricks-sdk-go/logger"`
`16`	`16`	`)`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"golang.org/x/oauth2"`
`9`	`9`	`"golang.org/x/oauth2/clientcredentials"`
`10`	`10`
`11`		`- "github.com/databricks/databricks-sdk-go/credentials"`
	`11`	`+ "github.com/databricks/databricks-sdk-go/config/credentials"`
`12`	`12`	`"github.com/databricks/databricks-sdk-go/logger"`
`13`	`13`	`)`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"fmt"`
`7`	`7`	`"net/http"`
`8`	`8`
`9`		`- "github.com/databricks/databricks-sdk-go/credentials"`
	`9`	`+ "github.com/databricks/databricks-sdk-go/config/credentials"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`type BasicCredentials struct {`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`"path/filepath"`
`11`	`11`	`"strings"`
`12`	`12`
`13`		`- "github.com/databricks/databricks-sdk-go/credentials"`
	`13`	`+ "github.com/databricks/databricks-sdk-go/config/credentials"`
`14`	`14`	`"github.com/databricks/databricks-sdk-go/logger"`
`15`	`15`	`"golang.org/x/oauth2"`
`16`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`"errors"`
`6`	`6`	`"fmt"`
`7`	`7`
`8`		`- "github.com/databricks/databricks-sdk-go/credentials"`
	`8`	`+ "github.com/databricks/databricks-sdk-go/config/credentials"`
`9`	`9`	`"github.com/databricks/databricks-sdk-go/logger"`
`10`	`10`	`)`
`11`	`11`