Skip to content
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.

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

Make client auth extension public and implement component.Component #814

Merged
merged 5 commits into from Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion extension/googleclientauthextension/config.go
Expand Up @@ -54,7 +54,7 @@ var defaultScopes = []string{
"https://www.googleapis.com/auth/trace.append",
}

func createDefaultConfig() component.Config {
func CreateDefaultConfig() component.Config {
return &Config{
Scopes: defaultScopes,
}
Expand Down
43 changes: 23 additions & 20 deletions extension/googleclientauthextension/factory.go
Expand Up @@ -21,7 +21,6 @@

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/extension"
"go.opentelemetry.io/collector/extension/auth"
"golang.org/x/oauth2/google"
"google.golang.org/grpc/credentials/oauth"

Expand All @@ -32,43 +31,47 @@
func NewFactory() extension.Factory {
return extension.NewFactory(
metadata.Type,
createDefaultConfig,
createExtension,
CreateDefaultConfig,
CreateExtension,
metadata.ExtensionStability,
)
}

func createExtension(ctx context.Context, set extension.CreateSettings, cfg component.Config) (extension.Extension, error) {
func CreateExtension(ctx context.Context, set extension.CreateSettings, cfg component.Config) (extension.Extension, error) {
config := cfg.(*Config)
ca := &clientAuthenticator{
config: config,
}
return ca, nil
}

// clientAuthenticator supplies credentials from an oauth.TokenSource.
type clientAuthenticator struct {
oauth.TokenSource
config *Config
}

func (ca *clientAuthenticator) Start(ctx context.Context, _ component.Host) error {
config := ca.config
creds, err := google.FindDefaultCredentials(ctx, config.Scopes...)
if err != nil {
return nil, err
return err
}
if config.Project == "" {
config.Project = creds.ProjectID
}
if config.Project == "" {
return nil, errors.New("no project set in config or found with application default credentials")
return errors.New("no project set in config or found with application default credentials")

Check warning on line 64 in extension/googleclientauthextension/factory.go

View check run for this annotation

Codecov / codecov/patch

extension/googleclientauthextension/factory.go#L64

Added line #L64 was not covered by tests
}
if config.QuotaProject == "" {
config.QuotaProject = quotaProjectFromCreds(creds)
}

ca := clientAuthenticator{
TokenSource: oauth.TokenSource{TokenSource: creds.TokenSource},
config: config,
}

return auth.NewClient(
auth.WithClientRoundTripper(ca.roundTripper),
auth.WithClientPerRPCCredentials(ca.perRPCCredentials),
), nil
ca.TokenSource = oauth.TokenSource{TokenSource: creds.TokenSource}
return nil
}

// clientAuthenticator supplies credentials from an oauth.TokenSource.
type clientAuthenticator struct {
oauth.TokenSource
config *Config
func (ca *clientAuthenticator) Shutdown(ctx context.Context) error {
return nil

Check warning on line 74 in extension/googleclientauthextension/factory.go

View check run for this annotation

Codecov / codecov/patch

extension/googleclientauthextension/factory.go#L73-L74

Added lines #L73 - L74 were not covered by tests
}

// quotaProjectFromCreds retrieves quota project from the credentials file.
Expand Down
20 changes: 19 additions & 1 deletion extension/googleclientauthextension/factory_test.go
Expand Up @@ -37,7 +37,25 @@ func TestNewFactory(t *testing.T) {

func TestCreateExtension(t *testing.T) {
dashpole marked this conversation as resolved.
Show resolved Hide resolved
t.Setenv("GOOGLE_APPLICATION_CREDENTIALS", "testdata/fake_creds.json")
ext, err := NewFactory().CreateExtension(context.Background(), extension.CreateSettings{}, createDefaultConfig())
ext, err := NewFactory().CreateExtension(context.Background(), extension.CreateSettings{}, CreateDefaultConfig())
assert.NotNil(t, ext)
assert.NoError(t, err)
}

func TestStart(t *testing.T) {
t.Setenv("GOOGLE_APPLICATION_CREDENTIALS", "testdata/fake_creds.json")
ext, err := NewFactory().CreateExtension(context.Background(), extension.CreateSettings{}, CreateDefaultConfig())
assert.NotNil(t, ext)
assert.NoError(t, err)
err = ext.Start(context.Background(), nil)
assert.NoError(t, err)
}

func TestStart_WithError(t *testing.T) {
t.Setenv("GOOGLE_APPLICATION_CREDENTIALS", "testdata/foo.json")
ext, err := NewFactory().CreateExtension(context.Background(), extension.CreateSettings{}, CreateDefaultConfig())
assert.NotNil(t, ext)
assert.NoError(t, err)
err = ext.Start(context.Background(), nil)
assert.Error(t, err)
}
1 change: 0 additions & 1 deletion extension/googleclientauthextension/go.mod
Expand Up @@ -7,7 +7,6 @@ require (
go.opentelemetry.io/collector/component v0.94.0
go.opentelemetry.io/collector/confmap v0.94.0
go.opentelemetry.io/collector/extension v0.94.0
go.opentelemetry.io/collector/extension/auth v0.94.0
golang.org/x/oauth2 v0.16.0
google.golang.org/grpc v1.61.0
)
Expand Down
2 changes: 0 additions & 2 deletions extension/googleclientauthextension/go.sum
Expand Up @@ -63,8 +63,6 @@ go.opentelemetry.io/collector/confmap v0.94.0 h1:yjzdGPHCeae7VooJkgeOWO2Y3XFKwOI
go.opentelemetry.io/collector/confmap v0.94.0/go.mod h1:pCT5UtcHaHVJ5BIILv1Z2VQyjZzmT9uTdBmC9+Z0AgA=
go.opentelemetry.io/collector/extension v0.94.0 h1:8XspN+A1aQhN3vQb2reE4kYF7qSkKULKF++TE4VEA9o=
go.opentelemetry.io/collector/extension v0.94.0/go.mod h1:G0+tNTYZf0D0d42tWKv8rILMi4YkalPw2qtXTn80SOU=
go.opentelemetry.io/collector/extension/auth v0.94.0 h1:TJxKM9dArGnaz6DYO3ASYYBU/DIHfzr622BPtCY/Z04=
go.opentelemetry.io/collector/extension/auth v0.94.0/go.mod h1:kL5FQQtUAUTs8ngP51ft1Guzn2czFZloG9lBANXekNM=
go.opentelemetry.io/collector/pdata v1.1.0 h1:cE6Al1rQieUjMHro6p6cKwcu3sjHXGG59BZ3kRVUvsM=
go.opentelemetry.io/collector/pdata v1.1.0/go.mod h1:IDkDj+B4Fp4wWOclBELN97zcb98HugJ8Q2gA4ZFsN8Q=
go.opentelemetry.io/otel v1.23.1 h1:Za4UzOqJYS+MUczKI320AtqZHZb7EqxO00jAHE0jmQY=
Expand Down
2 changes: 1 addition & 1 deletion extension/googleclientauthextension/grpc.go
Expand Up @@ -22,7 +22,7 @@

// perRPCCredentials returns gRPC credentials using the OAuth TokenSource, and adds
// google metadata.
func (ca clientAuthenticator) perRPCCredentials() (credentials.PerRPCCredentials, error) {
func (ca clientAuthenticator) PerRPCCredentials() (credentials.PerRPCCredentials, error) {

Check warning on line 25 in extension/googleclientauthextension/grpc.go

View check run for this annotation

Codecov / codecov/patch

extension/googleclientauthextension/grpc.go#L25

Added line #L25 was not covered by tests
return ca, nil
}

Expand Down
2 changes: 1 addition & 1 deletion extension/googleclientauthextension/http.go
Expand Up @@ -23,7 +23,7 @@ import (

// roundTripper provides an HTTP RoundTripper which adds gcp credentials and
// headers.
func (ca *clientAuthenticator) roundTripper(base http.RoundTripper) (http.RoundTripper, error) {
func (ca *clientAuthenticator) RoundTripper(base http.RoundTripper) (http.RoundTripper, error) {
return &oauth2.Transport{
Source: ca,
Base: &parameterTransport{
Expand Down
2 changes: 1 addition & 1 deletion extension/googleclientauthextension/http_test.go
Expand Up @@ -23,7 +23,7 @@ import (

func TestRoundTripper(t *testing.T) {
ca := clientAuthenticator{}
rt, err := ca.roundTripper(roundTripperFunc(func(r *http.Request) (*http.Response, error) {
rt, err := ca.RoundTripper(roundTripperFunc(func(r *http.Request) (*http.Response, error) {
return nil, nil
}))
assert.NotNil(t, rt)
Expand Down