fix: s3.New test cases not asserting errors (#24)

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/prometheus/client_golang v1.17.0
 	github.com/prometheus/client_model v0.5.0
 	github.com/prometheus/common v0.45.0
+	github.com/stretchr/testify v1.8.4
 	google.golang.org/api v0.152.0
 	google.golang.org/genproto v0.0.0-20231127180814-3a041ad873d4
 )
@@ -34,6 +35,7 @@ require (
 	github.com/aws/smithy-go v1.18.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-logr/logr v1.3.0 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
@@ -42,7 +44,9 @@ require (
 	github.com/google/uuid v1.4.0 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
 	github.com/googleapis/gax-go/v2 v2.12.0 // indirect
+	github.com/kr/text v0.2.0 // indirect
 	github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/procfs v0.12.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/otel v1.21.0 // indirect
@@ -61,4 +65,5 @@ require (
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231127180814-3a041ad873d4 // indirect
 	google.golang.org/grpc v1.59.0 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -47,6 +47,7 @@ github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -96,6 +97,9 @@ github.com/googleapis/enterprise-certificate-proxy v0.3.2 h1:Vie5ybvEvT75RniqhfF
 github.com/googleapis/enterprise-certificate-proxy v0.3.2/go.mod h1:VLSiSSBs/ksPL8kq3OBOQ6WRI2QnaFynd1DCjZ62+V0=
 github.com/googleapis/gax-go/v2 v2.12.0 h1:A+gCJKdRfqXkr+BIRGtZLibNXf0m1f9E4HG56etFpas=
 github.com/googleapis/gax-go/v2 v2.12.0/go.mod h1:y+aIqrI5eb1YGMVJfuV3185Ts/D7qKpsEkdD5+I6QGU=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 h1:jWpvCLoY8Z/e3VKvlsiIGKtc+UG6U5vzxaoagmhXfyg=
 github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0/go.mod h1:QUyp042oQthUoa9bqDv0ER0wrtXnBruoNd7aNjkbP+k=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -109,13 +113,15 @@ github.com/prometheus/common v0.45.0 h1:2BGz0eBc2hdMDLnO/8n0jeB3oPrt2D08CekT0lne
 github.com/prometheus/common v0.45.0/go.mod h1:YJmSTw9BoKxJplESWWxlbyttQR4uaEcGyv9MZjVOJsY=
 github.com/prometheus/procfs v0.12.0 h1:jluTpSng7V9hY0O2R9DzzJHYb2xULk9VTR1V1R/k6Bo=
 github.com/prometheus/procfs v0.12.0/go.mod h1:pcuDEFsWDnvcgNzo4EEweacyhjeA9Zk3cnaOZAZEfOo=
+github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 go.opencensus.io v0.24.0 h1:y73uSU6J157QMP2kn2r30vwW1A2W2WFwSCGnAVxeaD0=
 go.opencensus.io v0.24.0/go.mod h1:vNK8G9p7aAivkbmorf4v+7Hgx+Zs0yY+0fOtgBfjQKo=
@@ -223,6 +229,7 @@ google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ
 google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
 google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/aws/aws.go

@@ -1,10 +1,13 @@
 package aws
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"time"
 
+	awsconfig "github.com/aws/aws-sdk-go-v2/config"
+	"github.com/aws/aws-sdk-go-v2/service/costexplorer"
 	"github.com/prometheus/client_golang/prometheus"
 
 	"github.com/grafana/cloudcost-exporter/pkg/aws/s3"
@@ -30,7 +33,26 @@ func New(config *Config) (*AWS, error) {
 	for _, service := range services {
 		switch service {
 		case "S3":
-			collector, err := s3.New(config.Region, config.Profile, config.ScrapeInterval)
+			// There are two scenarios:
+			// 1. Running locally, the user must pass in a region and profile to use
+			// 2. Running within an EC2 instance and the region and profile can be derived
+			// I'm going to use the AWS SDK to handle this for me. If the user has provided a region and profile, it will use that.
+			// If not, it will use the EC2 instance metadata service to determine the region and credentials.
+			// This is the same logic that the AWS CLI uses, so it should be fine.
+			options := []func(*awsconfig.LoadOptions) error{awsconfig.WithEC2IMDSRegion()}
+			if config.Region != "" {
+				options = append(options, awsconfig.WithRegion(config.Region))
+			}
+			if config.Profile != "" {
+				options = append(options, awsconfig.WithSharedConfigProfile(config.Profile))
+			}
+			ac, err := awsconfig.LoadDefaultConfig(context.Background(), options...)
+			if err != nil {
+				return nil, err
+			}
+
+			client := costexplorer.NewFromConfig(ac)
+			collector, err := s3.New(config.ScrapeInterval, client)
 			if err != nil {
 				return nil, fmt.Errorf("error creating s3 collector: %w", err)
 			}

pkg/aws/s3/s3.go

@@ -9,7 +9,6 @@ import (
 	"time"
 
 	"github.com/aws/aws-sdk-go-v2/aws"
-	"github.com/aws/aws-sdk-go-v2/config"
 	"github.com/aws/aws-sdk-go-v2/service/costexplorer"
 	"github.com/aws/aws-sdk-go-v2/service/costexplorer/types"
 	"github.com/prometheus/client_golang/prometheus"
@@ -108,27 +107,7 @@ type Collector struct {
 }
 
 // New creates a new Collector with a client and scrape interval defined.
-func New(region string, profile string, scrapeInterval time.Duration) (*Collector, error) {
-	// There are two scenarios:
-	// 1. Running locally, the user must pass in a region and profile to use
-	// 2. Running within an EC2 instance and the region and profile can be derived
-	// I'm going to use the AWS SDK to handle this for me. If the user has provided a region and profile, it will use that.
-	// If not, it will use the EC2 instance metadata service to determine the region and credentials.
-	// This is the same logic that the AWS CLI uses, so it should be fine.
-	options := []func(*config.LoadOptions) error{config.WithEC2IMDSRegion()}
-	if region != "" {
-		options = append(options, config.WithRegion(region))
-	}
-	if profile != "" {
-		options = append(options, config.WithSharedConfigProfile(profile))
-	}
-	cfg, err := config.LoadDefaultConfig(context.Background(), options...)
-	if err != nil {
-		return &Collector{}, err
-	}
-
-	client := costexplorer.NewFromConfig(cfg)
-
+func New(scrapeInterval time.Duration, client *costexplorer.Client) (*Collector, error) {
 	return &Collector{
 		client:   client,
 		interval: scrapeInterval,

pkg/aws/s3/s3_test.go

@@ -6,6 +6,10 @@ import (
 	"testing"
 	"time"
 
+	"github.com/aws/aws-sdk-go-v2/service/costexplorer"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
 	"github.com/aws/aws-sdk-go-v2/service/costexplorer/types"
 )
 
@@ -148,9 +152,8 @@ func TestS3BillingData_AddRegion(t *testing.T) {
 
 func TestNewCollector(t *testing.T) {
 	type args struct {
-		region   string
-		profile  string
 		interval time.Duration
+		client   *costexplorer.Client
 	}
 	tests := map[string]struct {
 		args  args
@@ -159,42 +162,22 @@ func TestNewCollector(t *testing.T) {
 	}{
 		"Create a new collector": {
 			args: args{
-				region:   "us-east-1",
-				profile:  "workloads-dev",
-				interval: time.Duration(1) * time.Hour,
-			},
-			want:  &Collector{},
-			error: true,
-		},
-		"Expect an error when creating a Collector with no profile outside of EC2": {
-			args: args{
-				region:   "us-east-1",
-				profile:  "",
 				interval: time.Duration(1) * time.Hour,
 			},
 			want:  &Collector{},
-			error: true,
-		},
-		"Expect an error when creating a Collector with no region outside of EC2": {
-			args: args{
-				region:   "",
-				profile:  "workloads-dev",
-				interval: time.Duration(1) * time.Hour,
-			},
-			want:  &Collector{},
-			error: true,
+			error: false,
 		},
 	}
 	for name, tt := range tests {
 		t.Run(name, func(t *testing.T) {
-			got, err := New(tt.args.region, tt.args.profile, tt.args.interval)
-			if err != nil && !tt.error {
-				t.Errorf("New() error = %v", err)
+			got, err := New(tt.args.interval, tt.args.client)
+			if tt.error {
+				require.Error(t, err)
 				return
 			}
-			if got == nil {
-				t.Errorf("New() = %v, want %v", got, tt.want)
-			}
+			require.NoError(t, err)
+			assert.NotNil(t, got)
+			assert.Equal(t, tt.args.interval, got.interval)
 		})
 	}
 }