move checksums to url_checksums in the config file (#50)

Author: WillAbides

bindown.go

@@ -86,7 +86,15 @@ func loadConfigFromJSON(data []byte) (*Config, error) {
 
 //Config is downloaders configuration
 type Config struct {
-	Downloaders map[string][]*Downloader `json:"downloaders,omitempty" yaml:"downloaders"`
+	Downloaders  map[string][]*Downloader `json:"downloaders,omitempty" yaml:"downloaders"`
+	URLChecksums map[string]string        `json:"url_checksums,omitempty" yaml:"url_checksums,omitempty"`
+}
+
+func (c *Config) urlChecksum(url string) string {
+	if c.URLChecksums == nil {
+		c.URLChecksums = map[string]string{}
+	}
+	return c.URLChecksums[url]
 }
 
 // Downloader returns a Downloader for the given binary, os and arch.
@@ -106,8 +114,11 @@ func (c *Config) Downloader(binary, os, arch string) *Downloader {
 	return nil
 }
 
-//UpdateChecksums updates checksums
-func (c *Config) UpdateChecksums(downloaderName, cellarDir string) error {
+//AddDownloaderChecksums adds checksums to c.URLChecksums
+func (c *Config) AddDownloaderChecksums(downloaderName, cellarDir string) error {
+	if c.URLChecksums == nil {
+		c.URLChecksums = make(map[string]string, 1)
+	}
 	names := c.allDownloaderNames()
 	if downloaderName != "" {
 		names = []string{downloaderName}
@@ -118,14 +129,25 @@ func (c *Config) UpdateChecksums(downloaderName, cellarDir string) error {
 		if !ok {
 			return fmt.Errorf("nothing configured for %q", binary)
 		}
-		for _, downloader := range downloaders {
-			err := downloader.UpdateChecksum(UpdateChecksumOpts{
+		for i := range downloaders {
+			url, err := downloaders[i].url()
+			if err != nil {
+				return err
+			}
+			if c.URLChecksums[url] != "" {
+				downloaders[i].Checksum = ""
+				continue
+			}
+			sum, err := downloaders[i].getUpdatedChecksum(UpdateChecksumOpts{
 				CellarDir: cellarDir,
 			})
 			if err != nil {
 				return err
 			}
+			downloaders[i].Checksum = ""
+			c.URLChecksums[url] = sum
 		}
+		c.Downloaders[binary] = downloaders
 	}
 	return nil
 }
@@ -153,7 +175,15 @@ func (c *Config) Validate(downloaderName string, cellarDir string) error {
 			return fmt.Errorf("nothing configured for %q", binary)
 		}
 		for _, downloader := range dls {
-			err := downloader.Validate(ValidateOpts{
+			dl := downloader.clone()
+			url, err := downloader.url()
+			if err != nil {
+				return err
+			}
+			if dl.Checksum == "" {
+				dl.Checksum = c.urlChecksum(url)
+			}
+			err = dl.Validate(ValidateOpts{
 				DownloaderName: binary,
 				CellarDir:      cellarDir,
 			})

bindown.yml

@@ -4,24 +4,20 @@ downloaders:
     arch: amd64
     url: https://github.com/myitcv/gobin/releases/download/v0.0.10/darwin-amd64
     archive_path: darwin-amd64
-    checksum: 84ed966949e06bebd7d006bc343caf9d736932fd8b37df5cb5b268a28d07bd30
   - os: linux
     arch: amd64
     url: https://github.com/myitcv/gobin/releases/download/v0.0.10/linux-amd64
     archive_path: linux-amd64
-    checksum: 415266d9af98578067051653f5057ea267c51ebf085408df48b118a8b978bac6
   - os: windows
     arch: amd64
     url: https://github.com/myitcv/gobin/releases/download/v0.0.13/windows-amd64
     archive_path: windows-amd64
-    checksum: 70d3688c652bba96f377eb5d3a8068a07274024876c6e3b8d3785f0a63348905
   golangci-lint:
   - os: darwin
     arch: amd64
     url: https://github.com/golangci/golangci-lint/releases/download/v{{.version}}/golangci-lint-{{.version}}-{{.os}}-{{.arch}}{{.urlsuffix}}
     archive_path: golangci-lint-{{.version}}-{{.os}}-{{.arch}}/golangci-lint{{.archivepathsuffix}}
     link: true
-    checksum: 7536c375997cca3d2e1f063958ad0344108ce23aed6bd372b69153bdbda82d13
     vars:
       archivepathsuffix: ""
       urlsuffix: .tar.gz
@@ -31,7 +27,6 @@ downloaders:
     url: https://github.com/golangci/golangci-lint/releases/download/v{{.version}}/golangci-lint-{{.version}}-{{.os}}-{{.arch}}{{.urlsuffix}}
     archive_path: golangci-lint-{{.version}}-{{.os}}-{{.arch}}/golangci-lint{{.archivepathsuffix}}
     link: true
-    checksum: 34df1794a2ea8e168b3c98eed3cc0f3e13ed4cba735e4e40ef141df5c41bc086
     vars:
       archivepathsuffix: ""
       urlsuffix: .tar.gz
@@ -41,7 +36,6 @@ downloaders:
     url: https://github.com/golangci/golangci-lint/releases/download/v{{.version}}/golangci-lint-{{.version}}-{{.os}}-{{.arch}}{{.urlsuffix}}
     archive_path: golangci-lint-{{.version}}-{{.os}}-{{.arch}}/golangci-lint{{.archivepathsuffix}}
     link: true
-    checksum: 8ccb76466e4cdaebfc1633c137043c0bec23173749a6bca42846c7350402dcfe
     vars:
       archivepathsuffix: .exe
       urlsuffix: .zip
@@ -50,27 +44,34 @@ downloaders:
   - os: darwin
     arch: amd64
     url: https://github.com/goreleaser/goreleaser/releases/download/v0.120.7/goreleaser_Darwin_x86_64.tar.gz
-    checksum: 2ec8bb354cca2936d0722e7da770c37e2ba6cc90de4a1cea186e20968c47b663
   - os: linux
     arch: amd64
     url: https://github.com/goreleaser/goreleaser/releases/download/v0.120.7/goreleaser_Linux_x86_64.tar.gz
-    checksum: 771f2ad8219078b16a3e82097e9805309f6516640f0c6ab6b87f9b085a8ad743
   - os: windows
     arch: amd64
     url: https://github.com/goreleaser/goreleaser/releases/download/v0.120.7/goreleaser_Windows_x86_64.zip
     archive_path: goreleaser.exe
-    checksum: 0e06f50e1b2213a84b493d32a805dd6d8e8ad960ec9526edd8ecd96e2ab91743
   semver-next:
   - os: darwin
     arch: amd64
     url: https://github.com/WillAbides/semver-next/releases/download/v0.4.0/semver-next_0.4.0_darwin_amd64.tar.gz
-    checksum: a519f2c3bbe8972deb094d56c196fec89496f663431321c22be343ced23839fb
   - os: linux
     arch: amd64
     url: https://github.com/WillAbides/semver-next/releases/download/v0.4.0/semver-next_0.4.0_linux_amd64.tar.gz
-    checksum: 6317c36bec63158038381e8878601151ae996310fef58306f70cb03f1b46ef7f
   - os: windows
     arch: amd64
     url: https://github.com/WillAbides/semver-next/releases/download/v0.4.0/semver-next_0.4.0_windows_amd64.tar.gz
     archive_path: semver-next.exe
-    checksum: 573ea65ef3b40442626fbb19d07880bb4929e7b12fd7161e41732a03f23b2c95
+url_checksums:
+  https://github.com/WillAbides/semver-next/releases/download/v0.4.0/semver-next_0.4.0_darwin_amd64.tar.gz: a519f2c3bbe8972deb094d56c196fec89496f663431321c22be343ced23839fb
+  https://github.com/WillAbides/semver-next/releases/download/v0.4.0/semver-next_0.4.0_linux_amd64.tar.gz: 6317c36bec63158038381e8878601151ae996310fef58306f70cb03f1b46ef7f
+  https://github.com/WillAbides/semver-next/releases/download/v0.4.0/semver-next_0.4.0_windows_amd64.tar.gz: 573ea65ef3b40442626fbb19d07880bb4929e7b12fd7161e41732a03f23b2c95
+  https://github.com/golangci/golangci-lint/releases/download/v1.23.7/golangci-lint-1.23.7-darwin-amd64.tar.gz: 7536c375997cca3d2e1f063958ad0344108ce23aed6bd372b69153bdbda82d13
+  https://github.com/golangci/golangci-lint/releases/download/v1.23.7/golangci-lint-1.23.7-linux-amd64.tar.gz: 34df1794a2ea8e168b3c98eed3cc0f3e13ed4cba735e4e40ef141df5c41bc086
+  https://github.com/golangci/golangci-lint/releases/download/v1.23.7/golangci-lint-1.23.7-windows-amd64.zip: 8ccb76466e4cdaebfc1633c137043c0bec23173749a6bca42846c7350402dcfe
+  https://github.com/goreleaser/goreleaser/releases/download/v0.120.7/goreleaser_Darwin_x86_64.tar.gz: 2ec8bb354cca2936d0722e7da770c37e2ba6cc90de4a1cea186e20968c47b663
+  https://github.com/goreleaser/goreleaser/releases/download/v0.120.7/goreleaser_Linux_x86_64.tar.gz: 771f2ad8219078b16a3e82097e9805309f6516640f0c6ab6b87f9b085a8ad743
+  https://github.com/goreleaser/goreleaser/releases/download/v0.120.7/goreleaser_Windows_x86_64.zip: 0e06f50e1b2213a84b493d32a805dd6d8e8ad960ec9526edd8ecd96e2ab91743
+  https://github.com/myitcv/gobin/releases/download/v0.0.10/darwin-amd64: 84ed966949e06bebd7d006bc343caf9d736932fd8b37df5cb5b268a28d07bd30
+  https://github.com/myitcv/gobin/releases/download/v0.0.10/linux-amd64: 415266d9af98578067051653f5057ea267c51ebf085408df48b118a8b978bac6
+  https://github.com/myitcv/gobin/releases/download/v0.0.13/windows-amd64: 70d3688c652bba96f377eb5d3a8068a07274024876c6e3b8d3785f0a63348905

bindown_test.go

@@ -155,7 +155,7 @@ func TestConfig_Downloader(t *testing.T) {
 	assert.Nil(t, got)
 }
 
-func TestConfig_UpdateChecksums(t *testing.T) {
+func TestConfig_AddDownloaderChecksums(t *testing.T) {
 	ts := testutil.ServeFile(t, testutil.DownloadablesPath("foo.tar.gz"), "/foo/foo.tar.gz", "foo=bar")
 	dlURL := ts.URL + "/foo/foo.tar.gz?foo=bar"
 	getConfig := func() Config {
@@ -201,32 +201,38 @@ func TestConfig_UpdateChecksums(t *testing.T) {
 	t.Run("updates all", func(t *testing.T) {
 		dir := testutil.TmpDir(t)
 		config := getConfig()
-		err := config.UpdateChecksums("", dir)
+		err := config.AddDownloaderChecksums("", dir)
 		require.NoError(t, err)
 		for _, downloaders := range config.Downloaders {
 			for _, downloader := range downloaders {
-				require.Equal(t, testutil.FooChecksum, downloader.Checksum)
+				require.Empty(t, downloader.Checksum)
+				dlURL, err := downloader.url()
+				require.NoError(t, err)
+				require.Equal(t, testutil.FooChecksum, config.URLChecksums[dlURL])
 			}
 		}
 	})
 
 	t.Run("updates one", func(t *testing.T) {
 		dir := testutil.TmpDir(t)
 		config := getConfig()
-		err := config.UpdateChecksums("bar", dir)
+		err := config.AddDownloaderChecksums("bar", dir)
 		require.NoError(t, err)
 		for _, downloader := range config.Downloaders["foo"] {
 			require.Equal(t, "deadbeef", downloader.Checksum)
 		}
 		for _, downloader := range config.Downloaders["bar"] {
-			require.Equal(t, testutil.FooChecksum, downloader.Checksum)
+			require.Empty(t, downloader.Checksum)
+			dlURL, err := downloader.url()
+			require.NoError(t, err)
+			require.Equal(t, testutil.FooChecksum, config.URLChecksums[dlURL])
 		}
 	})
 
 	t.Run("downloader doesn't exist", func(t *testing.T) {
 		dir := testutil.TmpDir(t)
 		config := getConfig()
-		err := config.UpdateChecksums("fake", dir)
+		err := config.AddDownloaderChecksums("fake", dir)
 		require.EqualError(t, err, `nothing configured for "fake"`)
 	})
 
@@ -246,7 +252,7 @@ func TestConfig_UpdateChecksums(t *testing.T) {
 				},
 			},
 		}
-		err := config.UpdateChecksums("foo", dir)
+		err := config.AddDownloaderChecksums("foo", dir)
 		require.Error(t, err)
 	})
 }

downloader.go

@@ -194,17 +194,25 @@ func (d *Downloader) setDefaultBinName(defaultName string) {
 	}
 }
 
-func (d *Downloader) validateChecksum(targetDir string) error {
+func (d *Downloader) validateChecksum(targetDir string, knownChecksums map[string]string) error {
 	d.requireApplyTemplates()
-	targetFile, err := d.downloadablePath(targetDir)
+	dl := d.clone()
+	u, err := dl.url()
+	if err != nil {
+		return err
+	}
+	if knownChecksums != nil && dl.Checksum == "" {
+		dl.Checksum = knownChecksums[u]
+	}
+	targetFile, err := dl.downloadablePath(targetDir)
 	if err != nil {
 		return err
 	}
 	result, err := fileChecksum(targetFile)
 	if err != nil {
 		return err
 	}
-	if d.Checksum != result {
+	if dl.Checksum != result {
 		defer func() {
 			delErr := os.RemoveAll(targetFile)
 			if delErr != nil {
@@ -213,7 +221,7 @@ func (d *Downloader) validateChecksum(targetDir string) error {
 		}()
 		return fmt.Errorf(`checksum mismatch in downloaded file %q 
 wanted: %s
-got: %s`, targetFile, d.Checksum, result)
+got: %s`, targetFile, dl.Checksum, result)
 	}
 	return nil
 }
@@ -234,10 +242,19 @@ func (d *Downloader) UpdateChecksum(opts UpdateChecksumOpts) error {
 	return nil
 }
 
+func (d *Downloader) url() (string, error) {
+	dl := d.clone()
+	err := dl.applyTemplates()
+	if err != nil {
+		return "", err
+	}
+	return dl.URL, nil
+}
+
 //getUpdatedChecksum downloads the archive and returns its actual checksum.
 func (d *Downloader) getUpdatedChecksum(opts UpdateChecksumOpts) (string, error) {
-	d = d.clone()
-	err := d.applyTemplates()
+	dl := d.clone()
+	err := dl.applyTemplates()
 	if err != nil {
 		return "", err
 	}
@@ -252,15 +269,15 @@ func (d *Downloader) getUpdatedChecksum(opts UpdateChecksumOpts) (string, error)
 		}()
 	}
 
-	downloadDir := filepath.Join(cellarDir, "downloads", d.downloadsSubName())
+	downloadDir := filepath.Join(cellarDir, "downloads", dl.downloadsSubName())
 
-	err = d.download(downloadDir)
+	err = dl.download(downloadDir)
 	if err != nil {
 		log.Printf("error downloading: %v", err)
 		return "", err
 	}
 
-	dlPath, err := d.downloadablePath(downloadDir)
+	dlPath, err := dl.downloadablePath(downloadDir)
 	if err != nil {
 		return "", err
 	}
@@ -278,6 +295,8 @@ type InstallOpts struct {
 	TargetDir string
 	// Force - whether to force the install even if it already exists
 	Force bool
+	// Map of known checksums to validate against
+	URLChecksums map[string]string
 }
 
 func (d *Downloader) downloadsSubName() string {
@@ -316,7 +335,7 @@ func (d *Downloader) Install(opts InstallOpts) error {
 		return err
 	}
 
-	err = d.validateChecksum(downloadDir)
+	err = d.validateChecksum(downloadDir, opts.URLChecksums)
 	if err != nil {
 		log.Printf("error validating: %v", err)
 		return err

downloader_test.go

@@ -51,7 +51,7 @@ func Test_Downloader_validateChecksum(t *testing.T) {
 			tmplApplied: true,
 		}
 		require.NoError(t, util.CopyFile(testutil.DownloadablesPath("foo.tar.gz"), filepath.Join(dir, "foo.tar.gz"), nil))
-		err := d.validateChecksum(dir)
+		err := d.validateChecksum(dir, nil)
 		assert.NoError(t, err)
 		assert.True(t, fileExists(filepath.Join(dir, "foo.tar.gz")))
 	})
@@ -64,7 +64,7 @@ func Test_Downloader_validateChecksum(t *testing.T) {
 			tmplApplied: true,
 		}
 
-		err := d.validateChecksum(dir)
+		err := d.validateChecksum(dir, nil)
 		assert.Error(t, err)
 	})
 
@@ -76,7 +76,7 @@ func Test_Downloader_validateChecksum(t *testing.T) {
 			tmplApplied: true,
 		}
 		require.NoError(t, util.CopyFile(testutil.DownloadablesPath("foo.tar.gz"), filepath.Join(dir, "foo.tar.gz"), nil))
-		err := d.validateChecksum(dir)
+		err := d.validateChecksum(dir, nil)
 		assert.Error(t, err)
 		assert.False(t, fileExists(filepath.Join(dir, "foo.tar.gz")))
 	})

internal/cli/config.go

@@ -37,7 +37,7 @@ type configUpdateChecksumsCmd struct {
 
 func (d *configUpdateChecksumsCmd) Run(kctx *kong.Context) error {
 	config := configFile(kctx)
-	err := config.UpdateChecksums(d.TargetFile, cli.Config.ConfigOpts.CellarDir)
+	err := config.AddDownloaderChecksums(d.TargetFile, cli.Config.ConfigOpts.CellarDir)
 	if err != nil {
 		return err
 	}

internal/cli/download.go

@@ -44,6 +44,7 @@ arch: %s`, binary, d.OS, d.Arch)
 		TargetDir:      binDir,
 		Force:          d.Force,
 		CellarDir:      d.ConfigOpts.CellarDir,
+		URLChecksums:   config.URLChecksums,
 	}
 
 	return downloader.Install(installOpts)