Add additional testing for AWS Provider

Author: jonstacks

go.mod

@@ -2,4 +2,7 @@ module github.com/c2fo/cloud-finder
 
 go 1.12
 
-require github.com/stretchr/testify v1.3.0
+require (
+	github.com/jarcoal/httpmock v1.0.3
+	github.com/stretchr/testify v1.3.0
+)

go.sum

@@ -1,5 +1,7 @@
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/jarcoal/httpmock v1.0.3 h1:Qgv39cyHvgEguAofjb5GomnBCm10Dq71K+k1Aq0h7/o=
+github.com/jarcoal/httpmock v1.0.3/go.mod h1:ATjnClrvW/3tijVmpL/va5Z3aAyGvqU3gCT8nX0Txik=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

pkg/providers/aws/provider.go

@@ -9,7 +9,11 @@ import (
 	"github.com/c2fo/cloud-finder/pkg/logging"
 )
 
-const name = "aws"
+// Constants for the AWS provider
+const (
+	name    = "aws"
+	baseURL = "http://169.254.169.254"
+)
 
 // Provider is the AWS cloudfinder provider
 type Provider struct{}
@@ -28,7 +32,7 @@ func (p *Provider) Name() string {
 func (p *Provider) Check(opts *provider.Options) provider.Result {
 	httpClient := &http.Client{Timeout: opts.HTTPTimeout}
 	client := contrib.NewClient(httpClient)
-	client.SetBaseURL("http://169.254.169.254")
+	client.SetBaseURL(baseURL)
 
 	requests := map[string]string{
 		"AWS_AMI_ID":            "/latest/meta-data/ami-id",

pkg/providers/aws/provider_test.go

@@ -1,9 +1,14 @@
 package aws
 
 import (
+	"net"
+	"net/http"
+	"strings"
 	"testing"
+	"time"
 
 	"github.com/c2fo/cloud-finder/pkg/cloudfinder/provider"
+	"github.com/jarcoal/httpmock"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -22,3 +27,53 @@ func TestRegion(t *testing.T) {
 func TestAWSProviderImplementsProvider(t *testing.T) {
 	assert.Implements(t, (*provider.Provider)(nil), new(Provider))
 }
+
+func registerHTTPMockResponse(method, relativePath, response string) {
+	fullPath := strings.Join([]string{baseURL, relativePath}, "")
+	httpmock.RegisterResponder(method, fullPath, httpmock.NewStringResponder(http.StatusOK, response))
+}
+
+func withTestRoutes(t *testing.T, f func(t *testing.T)) {
+	httpmock.Activate()
+	defer httpmock.DeactivateAndReset()
+	registerHTTPMockResponse("GET", "/latest/meta-data/ami-id", `ami-abcd1234`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/ami-launch-index", `0`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/hostname", `ip-10-0-1-181`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/instance-id", `i-abcd1234`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/instance-type", `t2.medium`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/local-ipv4", `10.0.1.181`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/mac", `0a:2e:31:ec:fa:45`)
+	registerHTTPMockResponse("GET", "/latest/meta-data/placement/availability-zone", `us-west-2c`)
+
+	f(t)
+}
+
+func TestAWSProvider(t *testing.T) {
+	awsProvider := &Provider{}
+	providerOptions := &provider.Options{HTTPTimeout: 5 * time.Second}
+
+	withTestRoutes(t, func(t *testing.T) {
+		result := awsProvider.Check(providerOptions)
+		assert.NotNil(t, result, "Result should not be nil.")
+
+		awsResult, ok := result.(Result)
+		assert.True(t, ok, "Result should be an AWS Result.")
+
+		assert.Equal(t, `ami-abcd1234`, awsResult.AmiID())
+		launchIndex, err := awsResult.AmiLaunchIndex()
+		assert.NoError(t, err)
+
+		assert.Equal(t, int64(0), launchIndex)
+		assert.Equal(t, `ip-10-0-1-181`, awsResult.Hostname())
+		assert.Equal(t, `i-abcd1234`, awsResult.InstanceID())
+		assert.Equal(t, `t2.medium`, awsResult.InstanceType())
+		assert.Equal(t, net.IPv4(0x0a, 0x00, 0x01, 0xb5), awsResult.LocalIPv4())
+
+		mac, err := awsResult.MAC()
+		assert.NoError(t, err)
+		assert.Equal(t, `0a:2e:31:ec:fa:45`, mac.String())
+
+		assert.Equal(t, "us-west-2c", awsResult.AvailabilityZone())
+		assert.Equal(t, "us-west-2", awsResult.Region())
+	})
+}

pkg/providers/aws/result.go

@@ -2,7 +2,9 @@ package aws
 
 import (
 	"fmt"
+	"net"
 	"regexp"
+	"strconv"
 	"strings"
 )
 
@@ -37,3 +39,50 @@ func (r Result) String() string {
 	}
 	return strings.Join(items, "\n")
 }
+
+// AmiID returns the AMI ID returned from the metadata service.
+func (r Result) AmiID() string {
+	return r.responses["AWS_AMI_ID"]
+}
+
+// AmiLaunchIndex returns the launch index of the AMI.
+func (r Result) AmiLaunchIndex() (int64, error) {
+	strIndex, _ := r.responses["AWS_AMI_LAUNCH_INDEX"]
+	return strconv.ParseInt(strIndex, 10, 64)
+}
+
+// Hostname returns the instance's hostname.
+func (r Result) Hostname() string {
+	return r.responses["AWS_HOSTNAME"]
+}
+
+// InstanceID returns the instance ID.
+func (r Result) InstanceID() string {
+	return r.responses["AWS_INSTANCE_ID"]
+}
+
+// InstanceType returns the instance type.
+func (r Result) InstanceType() string {
+	return r.responses["AWS_INSTANCE_TYPE"]
+}
+
+// LocalIPv4 returns a net.IP representing the local IPv4 of the instance.
+func (r Result) LocalIPv4() net.IP {
+	return net.ParseIP(r.responses["AWS_LOCAL_IPV4"])
+}
+
+// MAC returns a net.HardwareAddr and error from parsing the MAC returned
+// from the metadata service.
+func (r Result) MAC() (net.HardwareAddr, error) {
+	return net.ParseMAC(r.responses["AWS_MAC"])
+}
+
+// AvailabilityZone returns the availability zone of the instance.
+func (r Result) AvailabilityZone() string {
+	return r.responses["AWS_AVAILABILITY_ZONE"]
+}
+
+// Region returns the region that the instance resides in.
+func (r Result) Region() string {
+	return r.responses["AWS_REGION"]
+}