Drop the iso_checksum_type & iso_checksum_url fields (#8437)

* Drop the iso_checksum_type & iso_checksum_url fields In favor of simply using iso_checksum that will know what to do. * fix after master merge * Update builder_test.go * Update builder_test.go * Update builder_test.go * Update builder_test.go * Update builder_test.go * remove checksum lowercasing tests * Update builder_test.go * Update builder_test.go * better docs * Update builder_test.go * even better docs * Update config.go * Update builder_test.go * Update step_create_vmx_test.go * make generate * better docs * fix imports * up tests * Update _ISOConfig-required.html.md * Update builder_test.go * don't use sha1.Sum("none") as a caching path * Update builder_test.go * better docs * Update iso_config_test.go remove ISOChecksumType/ISOChecksumURL references * Update step_download_test.go * add iso_checksum_url and iso_checksum_type fixers + tests * add concrete examples of checksum values * add examples of checksumming from local file * update go-getter dep * up deps * use new go-getter version * up ESX5Driver.VerifyChecksum: use go-getter's checksumming * ISOConfig.Prepare: get checksum there in case we need it as a string in ESX5Driver.VerifyChecksum * Update iso_config.go * get go-getter from v2 branch * Update driver_esx5.go add more comments * Update driver_esx5.go * show better error message when the checksum is invalid * Update builder_test.go put in a valid checksum to fix tests, checksum is md5("packer") * Update builder_test.go test invalid and valid checksum * more test updating * fix default md5 string to be a valid md5 * TestChecksumFileNameMixedCaseBug: use 'file:' prefix for file checksumming * Update iso_config_test.go * Update iso_config_test.go * Update builder_test.go * Update builder_test.go * Update builder_test.go * Update CHANGELOG.md * Update CHANGELOG.md * Update go.mod * Update go.mod * Update CHANGELOG.md
hashicorp · May 28, 2020 · 0fa60c6 · 0fa60c6
1 parent 3dc4ba2
commit 0fa60c6
Show file tree

Hide file tree

Showing 350 changed files with 74,845 additions and 34,084 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,13 @@
     removed. Run `packer fix template.json` to migrate an existig template
     [GH-9149]
 
+* For all iso based builders, the `iso_checksum_type` and `iso_checksum_url`
+    fields have been removed in favor of simply setting the `iso_checksum`
+    field. Use the [packer fix](https://www.packer.io/docs/commands/fix/)
+    command to update a config file. See any [iso_checksum field
+    docs](https://www.packer.io/docs/builders/virtualbox/iso/#iso_checksum) to
+    read more about this[GH-8437]
+
 ### FEATURES:
 * **New post-processor** Yandex Export [GH-9124]
 

diff --git a/builder/hyperv/iso/builder.go b/builder/hyperv/iso/builder.go
@@ -197,13 +197,12 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 			Path:  b.config.OutputDir,
 		},
 		&common.StepDownload{
-			Checksum:     b.config.ISOChecksum,
-			ChecksumType: b.config.ISOChecksumType,
-			Description:  "ISO",
-			ResultKey:    "iso_path",
-			Url:          b.config.ISOUrls,
-			Extension:    b.config.TargetExtension,
-			TargetPath:   b.config.TargetPath,
+			Checksum:    b.config.ISOChecksum,
+			Description: "ISO",
+			ResultKey:   "iso_path",
+			Url:         b.config.ISOUrls,
+			Extension:   b.config.TargetExtension,
+			TargetPath:  b.config.TargetPath,
 		},
 		&common.StepCreateFloppy{
 			Files:       b.config.FloppyConfig.FloppyFiles,

diff --git a/builder/hyperv/iso/builder.hcl2spec.go b/builder/hyperv/iso/builder.hcl2spec.go
diff --git a/builder/hyperv/iso/builder_test.go b/builder/hyperv/iso/builder_test.go
@@ -16,8 +16,7 @@ import (
 
 func testConfig() map[string]interface{} {
 	return map[string]interface{}{
-		"iso_checksum":            "foo",
-		"iso_checksum_type":       "md5",
+		"iso_checksum":            "md5:0B0F137F17AC10944716020B018F8126",
 		"iso_url":                 "http://www.packer.io",
 		"shutdown_command":        "yes",
 		"ssh_username":            "foo",
@@ -275,8 +274,18 @@ func TestBuilderPrepare_ISOChecksum(t *testing.T) {
 		t.Fatal("should have error")
 	}
 
-	// Test good
+	// Test invalid checksum
 	config["iso_checksum"] = "FOo"
+	_, warns, err = b.Prepare(config)
+	if len(warns) > 0 {
+		t.Fatalf("bad: %#v", warns)
+	}
+	if err == nil {
+		t.Fatal("should have error")
+	}
+
+	// Test good
+	config["iso_checksum"] = "md5:0B0F137F17AC10944716020B018F8126"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) > 0 {
@@ -292,8 +301,7 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 	var b Builder
 	config := testConfig()
 
-	// Test bad
-	config["iso_checksum_type"] = ""
+	config["iso_checksum"] = "0B0F137F17AC10944716020B018F8126"
 	_, warns, err := b.Prepare(config)
 	if len(warns) > 0 {
 		t.Fatalf("bad: %#v", warns)
@@ -303,7 +311,7 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 	}
 
 	// Test good
-	config["iso_checksum_type"] = "mD5"
+	config["iso_checksum"] = "mD5:0B0F137F17AC10944716020B018F8126"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) > 0 {
@@ -313,12 +321,8 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 		t.Fatalf("should not have error: %s", err)
 	}
 
-	if b.config.ISOChecksumType != "md5" {
-		t.Fatalf("should've lowercased: %s", b.config.ISOChecksumType)
-	}
-
 	// Test unknown
-	config["iso_checksum_type"] = "fake"
+	config["iso_checksum"] = "fake:foo"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) > 0 {
@@ -329,7 +333,7 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 	}
 
 	// Test none
-	config["iso_checksum_type"] = "none"
+	config["iso_checksum"] = "none"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) == 0 {
@@ -338,10 +342,6 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 	if err != nil {
 		t.Fatalf("should not have error: %s", err)
 	}
-
-	if b.config.ISOChecksumType != "none" {
-		t.Fatalf("should've lowercased: %s", b.config.ISOChecksumType)
-	}
 }
 
 func TestBuilderPrepare_ISOUrl(t *testing.T) {

diff --git a/builder/hyperv/vmcx/builder.go b/builder/hyperv/vmcx/builder.go
@@ -237,13 +237,12 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 			Path:  b.config.OutputDir,
 		},
 		&common.StepDownload{
-			Checksum:     b.config.ISOChecksum,
-			ChecksumType: b.config.ISOChecksumType,
-			Description:  "ISO",
-			ResultKey:    "iso_path",
-			Url:          b.config.ISOUrls,
-			Extension:    b.config.TargetExtension,
-			TargetPath:   b.config.TargetPath,
+			Checksum:    b.config.ISOChecksum,
+			Description: "ISO",
+			ResultKey:   "iso_path",
+			Url:         b.config.ISOUrls,
+			Extension:   b.config.TargetExtension,
+			TargetPath:  b.config.TargetPath,
 		},
 		&common.StepCreateFloppy{
 			Files:       b.config.FloppyFiles,

diff --git a/builder/hyperv/vmcx/builder.hcl2spec.go b/builder/hyperv/vmcx/builder.hcl2spec.go
diff --git a/builder/hyperv/vmcx/builder_test.go b/builder/hyperv/vmcx/builder_test.go
@@ -16,8 +16,7 @@ import (
 
 func testConfig() map[string]interface{} {
 	return map[string]interface{}{
-		"iso_checksum":            "foo",
-		"iso_checksum_type":       "md5",
+		"iso_checksum":            "md5:0B0F137F17AC10944716020B018F8126",
 		"iso_url":                 "http://www.packer.io",
 		"shutdown_command":        "yes",
 		"ssh_username":            "foo",
@@ -193,7 +192,7 @@ func TestBuilderPrepare_ISOChecksum(t *testing.T) {
 	}
 
 	// Test good
-	config["iso_checksum"] = "FOo"
+	config["iso_checksum"] = "0B0F137F17AC10944716020B018F8126"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) > 0 {
@@ -217,8 +216,7 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 	defer os.RemoveAll(td)
 	config["clone_from_vmcx_path"] = td
 
-	// Test bad
-	config["iso_checksum_type"] = ""
+	config["iso_checksum"] = "0B0F137F17AC10944716020B018F8126"
 	_, warns, err := b.Prepare(config)
 	if len(warns) > 0 {
 		t.Fatalf("bad: %#v", warns)
@@ -228,7 +226,7 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 	}
 
 	// Test good
-	config["iso_checksum_type"] = "mD5"
+	config["iso_checksum"] = "mD5:0B0F137F17AC10944716020B018F8126"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) > 0 {
@@ -238,12 +236,8 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 		t.Fatalf("should not have error: %s", err)
 	}
 
-	if b.config.ISOChecksumType != "md5" {
-		t.Fatalf("should've lowercased: %s", b.config.ISOChecksumType)
-	}
-
 	// Test none
-	config["iso_checksum_type"] = "none"
+	config["iso_checksum"] = "none"
 	b = Builder{}
 	_, warns, err = b.Prepare(config)
 	if len(warns) == 0 {
@@ -253,9 +247,6 @@ func TestBuilderPrepare_ISOChecksumType(t *testing.T) {
 		t.Fatalf("should not have error: %s", err)
 	}
 
-	if b.config.ISOChecksumType != "none" {
-		t.Fatalf("should've lowercased: %s", b.config.ISOChecksumType)
-	}
 }
 
 func TestBuilderPrepare_ISOUrl(t *testing.T) {

diff --git a/builder/parallels/iso/builder.go b/builder/parallels/iso/builder.go
@@ -191,13 +191,12 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 			ParallelsToolsMode:   b.config.ParallelsToolsMode,
 		},
 		&common.StepDownload{
-			Checksum:     b.config.ISOChecksum,
-			ChecksumType: b.config.ISOChecksumType,
-			Description:  "ISO",
-			Extension:    b.config.TargetExtension,
-			ResultKey:    "iso_path",
-			TargetPath:   b.config.TargetPath,
-			Url:          b.config.ISOUrls,
+			Checksum:    b.config.ISOChecksum,
+			Description: "ISO",
+			Extension:   b.config.TargetExtension,
+			ResultKey:   "iso_path",
+			TargetPath:  b.config.TargetPath,
+			Url:         b.config.ISOUrls,
 		},
 		&parallelscommon.StepOutputDir{
 			Force: b.config.PackerForce,

diff --git a/builder/parallels/iso/builder.hcl2spec.go b/builder/parallels/iso/builder.hcl2spec.go
diff --git a/builder/parallels/iso/builder_test.go b/builder/parallels/iso/builder_test.go
@@ -10,8 +10,7 @@ import (
 
 func testConfig() map[string]interface{} {
 	return map[string]interface{}{
-		"iso_checksum":           "foo",
-		"iso_checksum_type":      "md5",
+		"iso_checksum":           "md5:0B0F137F17AC10944716020B018F8126",
 		"iso_url":                "http://www.google.com/",
 		"shutdown_command":       "yes",
 		"ssh_username":           "foo",

diff --git a/builder/proxmox/builder.go b/builder/proxmox/builder.go
@@ -65,13 +65,12 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 	// Build the steps
 	steps := []multistep.Step{
 		&common.StepDownload{
-			Checksum:     b.config.ISOChecksum,
-			ChecksumType: b.config.ISOChecksumType,
-			Description:  "ISO",
-			Extension:    b.config.TargetExtension,
-			ResultKey:    downloadPathKey,
-			TargetPath:   b.config.TargetPath,
-			Url:          b.config.ISOUrls,
+			Checksum:    b.config.ISOChecksum,
+			Description: "ISO",
+			Extension:   b.config.TargetExtension,
+			ResultKey:   downloadPathKey,
+			TargetPath:  b.config.TargetPath,
+			Url:         b.config.ISOUrls,
 		},
 		&stepUploadISO{},
 		&stepStartVM{},

diff --git a/builder/proxmox/config.hcl2spec.go b/builder/proxmox/config.hcl2spec.go
diff --git a/builder/qemu/builder.go b/builder/qemu/builder.go
@@ -465,7 +465,7 @@ func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error) {
 	}
 
 	if b.config.ISOSkipCache {
-		b.config.ISOChecksumType = "none"
+		b.config.ISOChecksum = "none"
 	}
 	isoWarnings, isoErrs := b.config.ISOConfig.Prepare(&b.config.ctx)
 	warnings = append(warnings, isoWarnings...)
@@ -588,13 +588,12 @@ func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (pack
 	steps := []multistep.Step{}
 	if !b.config.ISOSkipCache {
 		steps = append(steps, &common.StepDownload{
-			Checksum:     b.config.ISOChecksum,
-			ChecksumType: b.config.ISOChecksumType,
-			Description:  "ISO",
-			Extension:    b.config.TargetExtension,
-			ResultKey:    "iso_path",
-			TargetPath:   b.config.TargetPath,
-			Url:          b.config.ISOUrls,
+			Checksum:    b.config.ISOChecksum,
+			Description: "ISO",
+			Extension:   b.config.TargetExtension,
+			ResultKey:   "iso_path",
+			TargetPath:  b.config.TargetPath,
+			Url:         b.config.ISOUrls,
 		},
 		)
 	} else {

diff --git a/builder/qemu/builder.hcl2spec.go b/builder/qemu/builder.hcl2spec.go
diff --git a/builder/qemu/builder_test.go b/builder/qemu/builder_test.go
@@ -44,8 +44,7 @@ eHLc1nkCgYEApm/motCTPN32nINZ+Vvywbv64ZD+gtpeMNP3CLrbe1X9O+H52AXa
 
 func testConfig() map[string]interface{} {
 	return map[string]interface{}{
-		"iso_checksum":            "foo",
-		"iso_checksum_type":       "md5",
+		"iso_checksum":            "md5:0B0F137F17AC10944716020B018F8126",
 		"iso_url":                 "http://www.google.com/",
 		"ssh_username":            "foo",
 		packer.BuildNameConfigKey: "foo",