1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package ec2
import (
"context"
"errors"
"net/http"
"testing"
"time"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/ec2metadata"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/sdk/resource"
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
)
func TestAWS_Detect(t *testing.T) {
type fields struct {
Client Client
}
type want struct {
Error string
Partial bool
Resource *resource.Resource
}
usWestInst := func() (ec2metadata.EC2InstanceIdentityDocument, error) {
// Example from https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-identity-documents.html
doc := ec2metadata.EC2InstanceIdentityDocument{
MarketplaceProductCodes: []string{"1abc2defghijklm3nopqrs4tu"},
AvailabilityZone: "us-west-2b",
PrivateIP: "10.158.112.84",
Version: "2017-09-30",
Region: "us-west-2",
InstanceID: "i-1234567890abcdef0",
InstanceType: "t2.micro",
AccountID: "123456789012",
PendingTime: time.Date(2016, time.November, 19, 16, 32, 11, 0, time.UTC),
ImageID: "ami-5fb8c835",
Architecture: "x86_64",
}
return doc, nil
}
usWestIDLabels := []attribute.KeyValue{
semconv.CloudProviderAWS,
semconv.CloudPlatformAWSEC2,
semconv.CloudRegion("us-west-2"),
semconv.CloudAvailabilityZone("us-west-2b"),
semconv.CloudAccountID("123456789012"),
semconv.HostID("i-1234567890abcdef0"),
semconv.HostImageID("ami-5fb8c835"),
semconv.HostType("t2.micro"),
}
testTable := map[string]struct {
Fields fields
Want want
}{
"Unavailable": {
Fields: fields{Client: &clientMock{}},
},
"Instance ID Error": {
Fields: fields{
Client: &clientMock{available: true, idDoc: func() (ec2metadata.EC2InstanceIdentityDocument, error) {
return ec2metadata.EC2InstanceIdentityDocument{}, errors.New("id not available")
}},
},
Want: want{Error: "id not available"},
},
"Hostname Not Found": {
Fields: fields{
Client: &clientMock{available: true, idDoc: usWestInst, metadata: map[string]meta{}},
},
Want: want{Resource: resource.NewWithAttributes(semconv.SchemaURL, usWestIDLabels...)},
},
"Hostname Response Error": {
Fields: fields{
Client: &clientMock{
available: true,
idDoc: usWestInst,
metadata: map[string]meta{
"hostname": {err: awserr.NewRequestFailure(awserr.New("EC2MetadataError", "failed to make EC2Metadata request", errors.New("response error")), http.StatusInternalServerError, "test-request")},
},
},
},
Want: want{
Error: `partial resource: ["hostname": 500 EC2MetadataError]`,
Partial: true,
Resource: resource.NewWithAttributes(semconv.SchemaURL, usWestIDLabels...),
},
},
"Hostname General Error": {
Fields: fields{
Client: &clientMock{
available: true,
idDoc: usWestInst,
metadata: map[string]meta{
"hostname": {err: errors.New("unknown error")},
},
},
},
Want: want{
Error: `partial resource: ["hostname": unknown error]`,
Partial: true,
Resource: resource.NewWithAttributes(semconv.SchemaURL, usWestIDLabels...),
},
},
"All Available": {
Fields: fields{
Client: &clientMock{
available: true,
idDoc: usWestInst,
metadata: map[string]meta{
"hostname": {value: "ip-12-34-56-78.us-west-2.compute.internal"},
},
},
},
Want: want{Resource: resource.NewWithAttributes(
semconv.SchemaURL,
semconv.CloudProviderAWS,
semconv.CloudPlatformAWSEC2,
semconv.CloudRegion("us-west-2"),
semconv.CloudAvailabilityZone("us-west-2b"),
semconv.CloudAccountID("123456789012"),
semconv.HostID("i-1234567890abcdef0"),
semconv.HostImageID("ami-5fb8c835"),
semconv.HostName("ip-12-34-56-78.us-west-2.compute.internal"),
semconv.HostType("t2.micro"),
)},
},
}
for name, tt := range testTable {
tt := tt
t.Run(name, func(t *testing.T) {
t.Parallel()
ec2ResourceDetector := NewResourceDetector(WithClient(tt.Fields.Client))
r, err := ec2ResourceDetector.Detect(context.Background())
assert.Equal(t, tt.Want.Resource, r, "Resource")
if tt.Want.Error != "" {
require.EqualError(t, err, tt.Want.Error, "Error")
assert.Equal(t, tt.Want.Partial, errors.Is(err, resource.ErrPartialResource), "Partial Resource")
return
}
require.NoError(t, err, "Error")
})
}
}
type clientMock struct {
available bool
idDoc func() (ec2metadata.EC2InstanceIdentityDocument, error)
metadata map[string]meta
}
type meta struct {
err error
value string
}
func (c *clientMock) Available() bool {
return c.available
}
func (c *clientMock) GetInstanceIdentityDocument() (ec2metadata.EC2InstanceIdentityDocument, error) {
return c.idDoc()
}
func (c *clientMock) GetMetadata(p string) (string, error) {
v, ok := c.metadata[p]
if !ok {
return "", awserr.NewRequestFailure(awserr.New("EC2MetadataError", "failed to make EC2Metadata request", errors.New("response error")), http.StatusNotFound, "test-request")
}
return v.value, v.err
}
|