Small var and comment name fixes (#111)

Author: haugenj

cmd/node-termination-handler.go

@@ -34,7 +34,7 @@ const (
 	spotITN              = "Spot ITN"
 )
 
-type monitorFunc func(chan<- drainevent.DrainEvent, chan<- drainevent.DrainEvent, *ec2metadata.EC2MetadataService) error
+type monitorFunc func(chan<- drainevent.DrainEvent, chan<- drainevent.DrainEvent, *ec2metadata.Service) error
 
 func main() {
 	signalChan := make(chan os.Signal, 1)
@@ -63,7 +63,7 @@ func main() {
 	if nthConfig.EnableScheduledEventDraining {
 		err = handleRebootUncordon(drainEventStore, *node)
 		if err != nil {
-			log.Printf("Unable to complete the uncordon after reboot workflow on startup: %v", err)
+			log.Printf("Unable to complete the uncordon after reboot workflow on startup: %v\n", err)
 		}
 	}
 

pkg/drainevent/scheduled-event.go

@@ -36,7 +36,7 @@ const (
 )
 
 // MonitorForScheduledEvents continuously monitors metadata for scheduled events and sends drain events to the passed in channel
-func MonitorForScheduledEvents(drainChan chan<- DrainEvent, cancelChan chan<- DrainEvent, imds *ec2metadata.EC2MetadataService) error {
+func MonitorForScheduledEvents(drainChan chan<- DrainEvent, cancelChan chan<- DrainEvent, imds *ec2metadata.Service) error {
 	drainEvents, err := checkForScheduledEvents(imds)
 	if err != nil {
 		return err
@@ -54,7 +54,7 @@ func MonitorForScheduledEvents(drainChan chan<- DrainEvent, cancelChan chan<- Dr
 }
 
 // checkForScheduledEvents Checks EC2 instance metadata for a scheduled event requiring a node drain
-func checkForScheduledEvents(imds *ec2metadata.EC2MetadataService) ([]DrainEvent, error) {
+func checkForScheduledEvents(imds *ec2metadata.Service) ([]DrainEvent, error) {
 	scheduledEvents, err := imds.GetScheduledMaintenanceEvents()
 	if err != nil {
 		return nil, fmt.Errorf("Unable to parse metadata response: %w", err)

pkg/drainevent/spot-itn-event.go

@@ -28,7 +28,7 @@ const (
 )
 
 // MonitorForSpotITNEvents continuously monitors metadata for spot ITNs and sends drain events to the passed in channel
-func MonitorForSpotITNEvents(drainChan chan<- DrainEvent, cancelChan chan<- DrainEvent, imds *ec2metadata.EC2MetadataService) error {
+func MonitorForSpotITNEvents(drainChan chan<- DrainEvent, cancelChan chan<- DrainEvent, imds *ec2metadata.Service) error {
 	drainEvent, err := checkForSpotInterruptionNotice(imds)
 	if err != nil {
 		return err
@@ -41,7 +41,7 @@ func MonitorForSpotITNEvents(drainChan chan<- DrainEvent, cancelChan chan<- Drai
 }
 
 // checkForSpotInterruptionNotice Checks EC2 instance metadata for a spot interruption termination notice
-func checkForSpotInterruptionNotice(imds *ec2metadata.EC2MetadataService) (*DrainEvent, error) {
+func checkForSpotInterruptionNotice(imds *ec2metadata.Service) (*DrainEvent, error) {
 	instanceAction, err := imds.GetSpotITNEvent()
 	if instanceAction == nil && err == nil {
 		// if there are no spot itns and no errors

pkg/draineventstore/drain-event-store.go

@@ -21,7 +21,7 @@ import (
 	"github.com/aws/aws-node-termination-handler/pkg/drainevent"
 )
 
-// Store is a the drain event store data structure
+// Store is the drain event store data structure
 type Store struct {
 	sync.RWMutex
 	NthConfig       config.Config

pkg/ec2metadata/ec2metadata.go

@@ -51,8 +51,8 @@ const (
 	secondsBeforeTTLRefresh = 15
 )
 
-// EC2MetadataService is used to query the EC2 instance metadata service v1 and v2
-type EC2MetadataService struct {
+// Service is used to query the EC2 instance metadata service v1 and v2
+type Service struct {
 	httpClient  http.Client
 	tries       int
 	metadataURL string
@@ -98,17 +98,17 @@ type NodeMetadata struct {
 	LocalIP        string
 }
 
-// New constructs an instance of the EC2MetadataService client
-func New(metadataURL string, tries int) *EC2MetadataService {
-	return &EC2MetadataService{
+// New constructs an instance of the Service client
+func New(metadataURL string, tries int) *Service {
+	return &Service{
 		metadataURL: metadataURL,
 		tries:       tries,
 		httpClient:  http.Client{},
 	}
 }
 
 // GetScheduledMaintenanceEvents retrieves EC2 scheduled maintenance events from imds
-func (e *EC2MetadataService) GetScheduledMaintenanceEvents() ([]ScheduledEventDetail, error) {
+func (e *Service) GetScheduledMaintenanceEvents() ([]ScheduledEventDetail, error) {
 	resp, err := e.Request(ScheduledEventPath)
 	if resp != nil && (resp.StatusCode < 200 || resp.StatusCode >= 300) {
 		return nil, fmt.Errorf("Metadata request received http status code: %d", resp.StatusCode)
@@ -125,8 +125,8 @@ func (e *EC2MetadataService) GetScheduledMaintenanceEvents() ([]ScheduledEventDe
 	return scheduledEvents, nil
 }
 
-// GetSpotITNEvent retrieves EC2 scheduled maintenance events from imds
-func (e *EC2MetadataService) GetSpotITNEvent() (instanceAction *InstanceAction, err error) {
+// GetSpotITNEvent retrieves EC2 spot interruption events from imds
+func (e *Service) GetSpotITNEvent() (instanceAction *InstanceAction, err error) {
 	resp, err := e.Request(SpotInstanceActionPath)
 	// 404s are normal when querying for the 'latest/meta-data/spot' path
 	if resp != nil && resp.StatusCode == 404 {
@@ -147,7 +147,7 @@ func (e *EC2MetadataService) GetSpotITNEvent() (instanceAction *InstanceAction,
 }
 
 // GetMetadataInfo generic function for retrieving ec2 metadata
-func (e *EC2MetadataService) GetMetadataInfo(path string) (info string, err error) {
+func (e *Service) GetMetadataInfo(path string) (info string, err error) {
 	resp, err := e.Request(path)
 	if resp != nil && (resp.StatusCode < 200 || resp.StatusCode >= 300) {
 		return "", fmt.Errorf("Metadata request received http status code: %d", resp.StatusCode)
@@ -166,7 +166,7 @@ func (e *EC2MetadataService) GetMetadataInfo(path string) (info string, err erro
 // Request sends an http request to IMDSv1 or v2 at the specified path
 // It is up to the caller to handle http status codes on the response
 // An error will only be returned if the request is unable to be made
-func (e *EC2MetadataService) Request(contextPath string) (*http.Response, error) {
+func (e *Service) Request(contextPath string) (*http.Response, error) {
 	req, err := http.NewRequest(http.MethodGet, e.metadataURL+contextPath, nil)
 	if err != nil {
 		return nil, fmt.Errorf("Unable to construct an http get request to IDMS for %s: %w", e.metadataURL+contextPath, err)
@@ -203,7 +203,7 @@ func (e *EC2MetadataService) Request(contextPath string) (*http.Response, error)
 	return resp, nil
 }
 
-func (e *EC2MetadataService) getV2Token() (string, int, error) {
+func (e *Service) getV2Token() (string, int, error) {
 	req, err := http.NewRequest(http.MethodPut, e.metadataURL+tokenRefreshPath, nil)
 	if err != nil {
 		return "", -1, fmt.Errorf("Unable to construct http put request to retrieve imdsv2 token: %w", err)
@@ -262,8 +262,8 @@ func retry(attempts int, sleep time.Duration, httpReq func() (*http.Response, er
 	return resp, err
 }
 
-// HydrateNodeMetadata attempts to gather additional ec2 instance information from the metadata service
-func (e *EC2MetadataService) GetNodeMetadata() NodeMetadata {
+// GetNodeMetadata attempts to gather additional ec2 instance information from the metadata service
+func (e *Service) GetNodeMetadata() NodeMetadata {
 	var metadata NodeMetadata
 	metadata.InstanceID, _ = e.GetMetadataInfo(InstanceIDPath)
 	metadata.InstanceType, _ = e.GetMetadataInfo(InstanceTypePath)

pkg/ec2metadata/ec2metadata_test.go

@@ -269,7 +269,7 @@ func TestGetScheduledMaintenanceEventsSuccess(t *testing.T) {
 	defer server.Close()
 
 	expectedStructs := []ec2metadata.ScheduledEventDetail{
-		ec2metadata.ScheduledEventDetail{
+		{
 			NotBefore:   notBefore,
 			Code:        code,
 			Description: description,
@@ -398,7 +398,7 @@ func TestGetMetadataServiceSuccess(t *testing.T) {
 	h.Equals(t, `x1.32xlarge`, resp)
 }
 
-func TestHydrateNodeMetadata(t *testing.T) {
+func TestGetNodeMetadata(t *testing.T) {
 	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 		rw.Header().Add("X-aws-ec2-metadata-token-ttl-seconds", "100")
 		if req.URL.String() == "/latest/api/token" {

pkg/node/node.go

@@ -63,6 +63,7 @@ func New(nthConfig config.Config) (*Node, error) {
 	}, nil
 }
 
+// NewWithValues will construct a node struct with a drain helper
 func NewWithValues(nthConfig config.Config, drainHelper *drain.Helper) (*Node, error) {
 	return &Node{
 		nthConfig:   nthConfig,

pkg/webhook/webhook_test.go

@@ -84,7 +84,7 @@ func TestPostSuccess(t *testing.T) {
 		}
 		h.Equals(t, req.Header.Get("Content-type"), headerMap["Content-type"])
 
-		// Test requst body
+		// Test request body
 		requestBody, err := ioutil.ReadAll(req.Body)
 		if err != nil {
 			t.Error("Unable to read request body.")