Skip to content

Commit

Permalink
Merge pull request #209 from airclovis/fix-issue-205
Browse files Browse the repository at this point in the history
Fix: Properly pass logger in ServiceQuota Fetcher
  • Loading branch information
airclovis authored Aug 20, 2024
2 parents 41da49f + 284e06c commit bb3c0ac
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 11 deletions.
2 changes: 1 addition & 1 deletion internal/app/exporter/exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ func (c *rdsCollector) getQuotasMetrics(client servicequotas.ServiceQuotasClient

c.logger.Debug("fetch quotas")

fetcher := servicequotas.NewFetcher(ctx, client)
fetcher := servicequotas.NewFetcher(ctx, client, c.logger)

metrics, err := fetcher.GetRDSQuotas()
if err != nil {
Expand Down
26 changes: 26 additions & 0 deletions internal/app/servicequotas/mock/servicequotas.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,29 @@ func (m ServiceQuotasClient) GetServiceQuota(context context.Context, input *aws

return &aws_servicequotas.GetServiceQuotaOutput{Quota: quota}, nil
}

type ServiceQuotasClientQuotaError struct {
ExpectedErrorQotaCode string
ExpectedErrorQuotaOutput *aws_servicequotas.GetServiceQuotaOutput
}

func (m ServiceQuotasClientQuotaError) GetServiceQuota(context context.Context, input *aws_servicequotas.GetServiceQuotaInput, optFns ...func(*aws_servicequotas.Options)) (*aws_servicequotas.GetServiceQuotaOutput, error) {
value := UnknownServiceQuota

if *input.ServiceCode == servicequotas.RDSServiceCode {
switch *input.QuotaCode {
case m.ExpectedErrorQotaCode:
return m.ExpectedErrorQuotaOutput, nil
case servicequotas.DBinstancesQuotacode:
value = DBinstancesQuota
case servicequotas.TotalStorageQuotaCode:
value = TotalStorage
case servicequotas.ManualDBInstanceSnapshotsQuotaCode:
value = ManualDBInstanceSnapshots
}
}

quota := &aws_servicequotas_types.ServiceQuota{Value: &value}

return &aws_servicequotas.GetServiceQuotaOutput{Quota: quota}, nil
}
8 changes: 5 additions & 3 deletions internal/app/servicequotas/servicequotas.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ import (
"context"
"errors"
"fmt"
"log/slog"

"github.com/aws/aws-sdk-go-v2/aws"
aws_servicequotas "github.com/aws/aws-sdk-go-v2/service/servicequotas"
"github.com/qonto/prometheus-rds-exporter/internal/app/trace"
converter "github.com/qonto/prometheus-rds-exporter/internal/app/unit"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/codes"
"golang.org/x/exp/slog"
)

var (
Expand Down Expand Up @@ -44,10 +45,11 @@ type ServiceQuotasClient interface {
GetServiceQuota(ctx context.Context, input *aws_servicequotas.GetServiceQuotaInput, optFns ...func(*aws_servicequotas.Options)) (*aws_servicequotas.GetServiceQuotaOutput, error)
}

func NewFetcher(ctx context.Context, client ServiceQuotasClient) *serviceQuotaFetcher {
func NewFetcher(ctx context.Context, client ServiceQuotasClient, logger slog.Logger) *serviceQuotaFetcher {
return &serviceQuotaFetcher{
ctx: ctx,
client: client,
logger: &logger,
}
}

Expand Down Expand Up @@ -86,7 +88,7 @@ func (s *serviceQuotaFetcher) getQuota(serviceCode string, quotaCode string) (fl

// AWS response payload could contains errors (eg. missing permission)
if result.Quota.ErrorReason != nil {
s.logger.Error("AWS quota error: ", "errorCode", result.Quota.ErrorReason.ErrorCode, "message", *result.Quota.ErrorReason.ErrorMessage)
s.logger.Error("AWS quota error: ", "errorCode", result.Quota.ErrorReason.ErrorCode, "message", aws.ToString(result.Quota.ErrorReason.ErrorMessage))
span.SetStatus(codes.Error, "failed to fetch quota")
span.RecordError(errQuotaError)

Expand Down
37 changes: 30 additions & 7 deletions internal/app/servicequotas/servicequotas_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@ package servicequotas_test

import (
"context"
"log/slog"
"testing"

aws_servicequotas "github.com/aws/aws-sdk-go-v2/service/servicequotas"
"github.com/aws/aws-sdk-go-v2/service/servicequotas/types"
"github.com/qonto/prometheus-rds-exporter/internal/app/servicequotas"
mock "github.com/qonto/prometheus-rds-exporter/internal/app/servicequotas/mock"
converter "github.com/qonto/prometheus-rds-exporter/internal/app/unit"
Expand All @@ -13,12 +16,32 @@ import (
)

func TestGetRDSQuotas(t *testing.T) {
context := context.TODO()
client := mock.ServiceQuotasClient{}
logger := slog.Default()
t.Run("GetRDSQuotasHappyPath", func(t *testing.T) {

Check failure on line 20 in internal/app/servicequotas/servicequotas_test.go

View workflow job for this annotation

GitHub Actions / golangci

only cuddled expressions if assigning variable or using from line above (wsl)
context := context.TODO()
client := mock.ServiceQuotasClient{}

result, err := servicequotas.NewFetcher(context, client).GetRDSQuotas()
require.NoError(t, err, "GetRDSQuotas must succeed")
assert.Equal(t, mock.DBinstancesQuota, result.DBinstances, "DbInstance quota is incorrect")
assert.Equal(t, converter.GigaBytesToBytes(mock.TotalStorage), result.TotalStorage, "Total storage quota is incorrect")
assert.Equal(t, mock.ManualDBInstanceSnapshots, result.ManualDBInstanceSnapshots, "Manual db instance snapshot quota is incorrect")
result, err := servicequotas.NewFetcher(context, client, *logger).GetRDSQuotas()
require.NoError(t, err, "GetRDSQuotas must succeed")
assert.Equal(t, mock.DBinstancesQuota, result.DBinstances, "DbInstance quota is incorrect")
assert.Equal(t, converter.GigaBytesToBytes(mock.TotalStorage), result.TotalStorage, "Total storage quota is incorrect")
assert.Equal(t, mock.ManualDBInstanceSnapshots, result.ManualDBInstanceSnapshots, "Manual db instance snapshot quota is incorrect")
})

t.Run("GetRDSQuotasErrorFetchingQuotaNilErrorMessage", func(t *testing.T) {
context := context.TODO()
client := mock.ServiceQuotasClientQuotaError{
ExpectedErrorQotaCode: servicequotas.DBinstancesQuotacode,
ExpectedErrorQuotaOutput: &aws_servicequotas.GetServiceQuotaOutput{
Quota: &types.ServiceQuota{
ErrorReason: &types.ErrorReason{
ErrorCode: types.ErrorCodeServiceQuotaNotAvailableError,
},
},
},
}

_, err := servicequotas.NewFetcher(context, client, *logger).GetRDSQuotas()
require.EqualError(t, err, "can't fetch DBinstance quota: AWS return error for this quota")
})
}

0 comments on commit bb3c0ac

Please sign in to comment.