Fix. Use temporary_key_pair_name when specified. (#3739)

Fix: Use temporary_key_pair_name when specified.

This is to fix an issue where the temporary_key_pair_name configuration option
for amazon-ebs and amazon-instance builders would be ignored and replaced with
an automatically generated value using UUID, even when the option was explicitly
specified.

Remove space from the auto-generated SSH key-pair name.

Resolves #3736

builder/amazon/common/run_config.go

@@ -44,10 +44,14 @@ type RunConfig struct {
 }
 
 func (c *RunConfig) Prepare(ctx *interpolate.Context) []error {
-	// if we are not given an explicit keypairname, create a temporary one
+	// If we are not given an explicit ssh_keypair_name,
+	// then create a temporary one, but only if the
+	// temporary_key_pair_name has not been provided.
 	if c.SSHKeyPairName == "" {
-		c.TemporaryKeyPairName = fmt.Sprintf(
-			"packer %s", uuid.TimeOrderedUUID())
+		if c.TemporaryKeyPairName == "" {
+			c.TemporaryKeyPairName = fmt.Sprintf(
+				"packer_%s", uuid.TimeOrderedUUID())
+		}
 	}
 
 	if c.WindowsPasswordTimeout == 0 {

builder/amazon/common/run_config_test.go

@@ -3,6 +3,7 @@ package common
 import (
 	"io/ioutil"
 	"os"
+	"regexp"
 	"testing"
 
 	"github.com/mitchellh/packer/helper/communicator"
@@ -140,6 +141,21 @@ func TestRunConfigPrepare_TemporaryKeyPairName(t *testing.T) {
 	}
 
 	if c.TemporaryKeyPairName == "" {
-		t.Fatal("keypair empty")
+		t.Fatal("keypair name is empty")
+	}
+
+	// Match prefix and UUID, e.g. "packer_5790d491-a0b8-c84c-c9d2-2aea55086550".
+	r := regexp.MustCompile(`\Apacker_(?:(?i)[a-f\d]{8}(?:-[a-f\d]{4}){3}-[a-f\d]{12}?)\z`)
+	if !r.MatchString(c.TemporaryKeyPairName) {
+		t.Fatal("keypair name is not valid")
+	}
+
+	c.TemporaryKeyPairName = "ssh-key-123"
+	if err := c.Prepare(nil); len(err) != 0 {
+		t.Fatalf("err: %s", err)
+	}
+
+	if c.TemporaryKeyPairName != "ssh-key-123" {
+		t.Fatal("keypair name does not match")
 	}
 }

builder/amazon/common/step_run_source_instance.go

@@ -156,16 +156,16 @@ func (s *StepRunSourceInstance) Run(state multistep.StateBag) multistep.StepActi
 
 	if spotPrice == "" || spotPrice == "0" {
 		runOpts := &ec2.RunInstancesInput{
-			KeyName:                           &keyName,
-			ImageId:                           &s.SourceAMI,
-			InstanceType:                      &s.InstanceType,
-			UserData:                          &userData,
-			MaxCount:                          aws.Int64(1),
-			MinCount:                          aws.Int64(1),
-			IamInstanceProfile:                &ec2.IamInstanceProfileSpecification{Name: &s.IamInstanceProfile},
-			BlockDeviceMappings:               s.BlockDevices.BuildLaunchDevices(),
-			Placement:                         &ec2.Placement{AvailabilityZone: &s.AvailabilityZone},
-			EbsOptimized:                      &s.EbsOptimized,
+			KeyName:             &keyName,
+			ImageId:             &s.SourceAMI,
+			InstanceType:        &s.InstanceType,
+			UserData:            &userData,
+			MaxCount:            aws.Int64(1),
+			MinCount:            aws.Int64(1),
+			IamInstanceProfile:  &ec2.IamInstanceProfileSpecification{Name: &s.IamInstanceProfile},
+			BlockDeviceMappings: s.BlockDevices.BuildLaunchDevices(),
+			Placement:           &ec2.Placement{AvailabilityZone: &s.AvailabilityZone},
+			EbsOptimized:        &s.EbsOptimized,
 		}
 
 		if s.SubnetId != "" && s.AssociatePublicIpAddress {

builder/amazon/ebs/builder.go

@@ -117,21 +117,21 @@ func (b *Builder) Run(ui packer.Ui, hook packer.Hook, cache packer.Cache) (packe
 			BlockDevices: b.config.BlockDevices,
 		},
 		&awscommon.StepRunSourceInstance{
-			Debug:                             b.config.PackerDebug,
-			ExpectedRootDevice:                "ebs",
-			SpotPrice:                         b.config.SpotPrice,
-			SpotPriceProduct:                  b.config.SpotPriceAutoProduct,
-			InstanceType:                      b.config.InstanceType,
-			UserData:                          b.config.UserData,
-			UserDataFile:                      b.config.UserDataFile,
-			SourceAMI:                         b.config.SourceAmi,
-			IamInstanceProfile:                b.config.IamInstanceProfile,
-			SubnetId:                          b.config.SubnetId,
-			AssociatePublicIpAddress:          b.config.AssociatePublicIpAddress,
-			EbsOptimized:                      b.config.EbsOptimized,
-			AvailabilityZone:                  b.config.AvailabilityZone,
-			BlockDevices:                      b.config.BlockDevices,
-			Tags:                              b.config.RunTags,
+			Debug:                    b.config.PackerDebug,
+			ExpectedRootDevice:       "ebs",
+			SpotPrice:                b.config.SpotPrice,
+			SpotPriceProduct:         b.config.SpotPriceAutoProduct,
+			InstanceType:             b.config.InstanceType,
+			UserData:                 b.config.UserData,
+			UserDataFile:             b.config.UserDataFile,
+			SourceAMI:                b.config.SourceAmi,
+			IamInstanceProfile:       b.config.IamInstanceProfile,
+			SubnetId:                 b.config.SubnetId,
+			AssociatePublicIpAddress: b.config.AssociatePublicIpAddress,
+			EbsOptimized:             b.config.EbsOptimized,
+			AvailabilityZone:         b.config.AvailabilityZone,
+			BlockDevices:             b.config.BlockDevices,
+			Tags:                     b.config.RunTags,
 			InstanceInitiatedShutdownBehavior: b.config.InstanceInitiatedShutdownBehavior,
 		},
 		&stepTagEBSVolumes{