fix: Improve download log in installer ⚓ (#123)

gabyx · Jul 2, 2023 · 57501a6 · 57501a6
1 parent bcd8032
commit 57501a6
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 15 deletions.
diff --git a/githooks/cmd/installer/download-binaries.go b/githooks/cmd/installer/download-binaries.go
@@ -111,7 +111,7 @@ func downloadBinaries(
 	log.PanicIfF(deploySettings == nil,
 		"Could not determine deploy settings.")
 
-	err := deploySettings.Download(versionTag, tempDir)
+	err := deploySettings.Download(log, versionTag, tempDir)
 	log.AssertNoErrorPanicF(err, "Could not download binaries.")
 
 	ext := ""

diff --git a/githooks/updates/download/checksums.go b/githooks/updates/download/checksums.go
@@ -9,9 +9,9 @@ import (
 	cm "github.com/gabyx/githooks/githooks/common"
 )
 
-// verifyChecksums verifies checksums with the signature and the public key, and returns
+// verifyChecksumSignature verifies checksums with the signature and the public key, and returns
 // the checksums content.
-func verifyChecksums(checksums Checksums, publicPGP string) ([]byte, error) {
+func verifyChecksumSignature(checksums Checksums, publicPGP string) ([]byte, error) {
 
 	checksumFile, err := GetFile(checksums.File.URL)
 	if err != nil {

diff --git a/githooks/updates/download/deploy-settings.go b/githooks/updates/download/deploy-settings.go
@@ -21,7 +21,7 @@ const deploySettingsVersion = 1
 
 // IDeploySettings is the common interface for all deploy settings.
 type IDeploySettings interface {
-	Download(versionTag string, dir string) error
+	Download(log cm.ILogContext, versionTag string, dir string) error
 }
 
 // LoadDeploySettings load the deploy settings from `file`.

diff --git a/githooks/updates/download/gitea.go b/githooks/updates/download/gitea.go
@@ -21,14 +21,21 @@ type GiteaDeploySettings struct {
 }
 
 // Download downloads the version with `versionTag` into `dir` from a Gitea instance.
-func (s *GiteaDeploySettings) Download(versionTag string, dir string) error {
-	return downloadGitea(s.APIUrl, s.Owner, s.Repository, versionTag, dir, s.PublicPGP)
+func (s *GiteaDeploySettings) Download(log cm.ILogContext, versionTag string, dir string) error {
+	return downloadGitea(log, s.APIUrl, s.Owner, s.Repository, versionTag, dir, s.PublicPGP)
 }
 
 // Downloads the Githooks release with tag `versionTag` and
 // extracts the matched asset into `dir`.
 // The assert matches the OS and architecture of the current runtime.
-func downloadGitea(url string, owner string, repo string, versionTag string, dir string, publicPGP string) error {
+func downloadGitea(
+	log cm.ILogContext,
+	url string,
+	owner string,
+	repo string,
+	versionTag string,
+	dir string,
+	publicPGP string) error {
 
 	client, err := gitea.NewClient(url)
 	if err != nil {
@@ -55,13 +62,15 @@ func downloadGitea(url string, owner string, repo string, versionTag string, dir
 			cm.ErrorF("Could not select asset in repo '%s/%s' at tag '%s'.", owner, repo, versionTag))
 	}
 
-	checksumData, err := verifyChecksums(checksums, publicPGP)
+	log.InfoF("Verify checksum file '%s'.", checksums.File.URL)
+	checksumData, err := verifyChecksumSignature(checksums, publicPGP)
 	if err != nil {
 		return cm.CombineErrors(err,
 			cm.ErrorF("Signature verification of update failed."+
 				"Something is fishy!"))
 	}
 
+	log.InfoF("Downloading file '%s'.", target.URL)
 	response, err := GetFile(target.URL)
 	if err != nil {
 		return cm.CombineErrors(err, cm.ErrorF("Could not download url '%s'.", target.URL))
@@ -84,7 +93,7 @@ func downloadGitea(url string, owner string, repo string, versionTag string, dir
 	}
 	temp.Close()
 
-	// Validate checksum.
+	log.InfoF("Validate checksums.")
 	err = checkChecksum(temp.Name(), checksumData)
 	if err != nil {
 		return cm.CombineErrors(err, cm.ErrorF("Checksum validation failed."))

diff --git a/githooks/updates/download/github.go b/githooks/updates/download/github.go
@@ -27,14 +27,20 @@ type GithubDeploySettings struct {
 }
 
 // Download downloads the version with `versionTag` to `dir` from a Github instance.
-func (s *GithubDeploySettings) Download(versionTag string, dir string) error {
-	return downloadGithub(s.Owner, s.Repository, versionTag, dir, s.PublicPGP)
+func (s *GithubDeploySettings) Download(log cm.ILogContext, versionTag string, dir string) error {
+	return downloadGithub(log, s.Owner, s.Repository, versionTag, dir, s.PublicPGP)
 }
 
 // Downloads the Githooks release with tag `versionTag` and
 // extracts the matched asset into `dir`.
 // The assert matches the OS and architecture of the current runtime.
-func downloadGithub(owner string, repo string, versionTag string, dir string, publicPGP string) error {
+func downloadGithub(
+	log cm.ILogContext,
+	owner string,
+	repo string,
+	versionTag string,
+	dir string,
+	publicPGP string) error {
 
 	client := github.NewClient(nil)
 	rel, _, err := client.Repositories.GetReleaseByTag(context.Background(),
@@ -58,13 +64,15 @@ func downloadGithub(owner string, repo string, versionTag string, dir string, pu
 			cm.ErrorF("Could not select asset in repo '%s/%s' at tag '%s'.", owner, repo, versionTag))
 	}
 
-	checksumData, err := verifyChecksums(checksums, publicPGP)
+	log.InfoF("Verify checksum file '%s'.", checksums.File.URL)
+	checksumData, err := verifyChecksumSignature(checksums, publicPGP)
 	if err != nil {
 		return cm.CombineErrors(err,
 			cm.ErrorF("Signature verification of update failed."+
 				"Something is fishy!"))
 	}
 
+	log.InfoF("Downloading file '%s'.", target.URL)
 	response, err := GetFile(target.URL)
 	if err != nil {
 		return cm.CombineErrors(err, cm.ErrorF("Could not download url '%s'.", target.URL))
@@ -88,6 +96,7 @@ func downloadGithub(owner string, repo string, versionTag string, dir string, pu
 	temp.Close()
 
 	// Validate checksum.
+	log.InfoF("Validate checksums.")
 	err = checkChecksum(temp.Name(), checksumData)
 	if err != nil {
 		return cm.CombineErrors(err, cm.ErrorF("Checksum validation failed."))

diff --git a/githooks/updates/download/http.go b/githooks/updates/download/http.go
@@ -26,7 +26,7 @@ type HTTPDeploySettings struct {
 
 // Download downloads the Githooks from a template URL and
 // extracts it into `dir`.
-func (s *HTTPDeploySettings) Download(versionTag string, dir string) error {
+func (s *HTTPDeploySettings) Download(log cm.ILogContext, versionTag string, dir string) error {
 	cm.Panic("Not implemented.")
 
 	return nil

diff --git a/githooks/updates/download/local.go b/githooks/updates/download/local.go
@@ -33,7 +33,7 @@ type LocalDeploySettings struct {
 
 // Download downloads the Githooks from a template URL and
 // extracts it into `dir`.
-func (s *LocalDeploySettings) Download(versionTag string, dir string) error {
+func (s *LocalDeploySettings) Download(log cm.ILogContext, versionTag string, dir string) error {
 	// Copy everything to director `dir`
 	pathTmpl := template.Must(template.New("").Parse(s.PathTemplate))