Use provider.Decompress for provider.Gitlab

Author: mouuff

README.md

@@ -86,7 +86,7 @@ This project is currently under construction, here is some of the things to come
 - **Feb 7, 2021**: Minor: The `BinaryName` variable used in `Updater` have been renamed to `ExecutableName`.
 - **Feb 12, 2021**: Minor: The method `Updater.Update()` now returns `(UpdateStatus, error)` instead of just `(error)`.
 - **Feb 14, 2021**: Major: The `ExecutableName` variable used in `Updater` is no longer suffixed with `"_" + runtime.GOOS + "_" + runtime.GOARCH`.
-- **Feb 21, 2021**: Minor: The `ZipName` variable used in `provider.Github` and  `provider.Gitlab` have been renamed to `ArchiveName ` with the arrival of `tar.gz` support.
+- **Feb 21, 2021**: Minor: The `ZipName` variable used in `provider.Github` and `provider.Gitlab` have been renamed to `ArchiveName ` with the arrival of `tar.gz` support.
 
 
 [tu]: https://twitter.com/tenntenn

examples/gitlab-simple/main.go

@@ -14,8 +14,8 @@ func main() {
 	// Example project here: https://gitlab.com/arnaudalies.py/go-rocket-update-example
 	u := &updater.Updater{
 		Provider: &provider.Gitlab{
-			ProjectID: 24021648,
-			ZipName:   fmt.Sprintf("binaries_%s.zip", runtime.GOOS),
+			ProjectID:   24021648,
+			ArchiveName: fmt.Sprintf("binaries_%s.zip", runtime.GOOS),
 		},
 		ExecutableName: fmt.Sprintf("go-rocket-update-example_%s_%s", runtime.GOOS, runtime.GOARCH),
 		Version:        "v0.0.0",

pkg/provider/provider_github.go

@@ -19,7 +19,7 @@ type Github struct {
 	ArchiveName   string // Archive name (the zip/tar.gz you upload for a release on github), example: binaries.zip
 
 	tmpDir             string   // temporary directory this is used internally
-	DecompressProvider Provider // provider used to decompress the downloaded archive
+	decompressProvider Provider // provider used to decompress the downloaded archive
 	archivePath        string   // path to the downloaded archive (should be in tmpDir)
 }
 
@@ -130,18 +130,18 @@ func (c *Github) Open() (err error) {
 	if err != nil {
 		return
 	}
-	c.DecompressProvider, err = Decompress(c.archivePath)
+	c.decompressProvider, err = Decompress(c.archivePath)
 	if err != nil {
 		return nil
 	}
-	return c.DecompressProvider.Open()
+	return c.decompressProvider.Open()
 }
 
 // Close closes the provider
 func (c *Github) Close() error {
-	if c.DecompressProvider != nil {
-		c.DecompressProvider.Close()
-		c.DecompressProvider = nil
+	if c.decompressProvider != nil {
+		c.decompressProvider.Close()
+		c.decompressProvider = nil
 	}
 
 	if len(c.tmpDir) > 0 {
@@ -166,10 +166,10 @@ func (c *Github) GetLatestVersion() (string, error) {
 
 // Walk walks all the files provided
 func (c *Github) Walk(walkFn WalkFunc) error {
-	return c.DecompressProvider.Walk(walkFn)
+	return c.decompressProvider.Walk(walkFn)
 }
 
 // Retrieve file relative to "provider" to destination
 func (c *Github) Retrieve(src string, dest string) error {
-	return c.DecompressProvider.Retrieve(src, dest)
+	return c.decompressProvider.Retrieve(src, dest)
 }

pkg/provider/provider_gitlab.go

@@ -13,14 +13,14 @@ import (
 	"github.com/mouuff/go-rocket-update/internal/fileio"
 )
 
-// Gitlab provider finds a zip file in the repository's releases to provide files
+// Gitlab provider finds a archive file in the repository's releases to provide files
 type Gitlab struct {
-	ProjectID int
-	ZipName   string // Zip name (the zip you upload for a release on gitlab), example: binaries.zip
+	ProjectID   int
+	ArchiveName string // ArchiveName (the archive you upload for a release on gitlab), example: binaries.zip
 
-	tmpDir      string // temporary directory this is used internally
-	zipProvider *Zip   // provider used to unzip the downloaded zip
-	zipPath     string // path to the downloaded zip (should be in tmpDir)
+	tmpDir             string   // temporary directory this is used internally
+	decompressProvider Provider // provider used to decompress the downloaded archive
+	decompressPath     string   // path to the downloaded archive (should be in tmpDir)
 }
 
 // gitlabRelease struct used to unmarshal response from gitlab
@@ -46,19 +46,19 @@ func (c *Gitlab) getReleasesURL() (string, error) {
 	), nil
 }
 
-// getZipURL get the zip URL for the gitlab repository
+// getArchiveURL get the archive URL for the gitlab repository
 // the latest version is selected
-func (c *Gitlab) getZipURL() (string, error) {
+func (c *Gitlab) getArchiveURL() (string, error) {
 	release, err := c.getLatestRelease()
 	if err != nil {
 		return "", err
 	}
 	for _, link := range release.Assets.Links {
-		if strings.HasSuffix(link.Name, c.ZipName) {
+		if strings.HasSuffix(link.Name, c.ArchiveName) {
 			return link.DirectURL, nil
 		}
 	}
-	return "", errors.New("Link not found for name: " + c.ZipName)
+	return "", errors.New("Link not found for name: " + c.ArchiveName)
 }
 
 // getReleases gets tags of the repository
@@ -93,11 +93,11 @@ func (c *Gitlab) getLatestRelease() (*gitlabRelease, error) {
 
 // Open opens the provider
 func (c *Gitlab) Open() (err error) {
-	zipURL, err := c.getZipURL() // get zip url for latest version
+	archiveURL, err := c.getArchiveURL() // get archive url for latest version
 	if err != nil {
 		return
 	}
-	resp, err := http.Get(zipURL)
+	resp, err := http.Get(archiveURL)
 	if err != nil {
 		return
 	}
@@ -108,31 +108,31 @@ func (c *Gitlab) Open() (err error) {
 		return
 	}
 
-	c.zipPath = filepath.Join(c.tmpDir, c.ZipName)
-	zipFile, err := os.Create(c.zipPath)
+	c.decompressPath = filepath.Join(c.tmpDir, c.ArchiveName)
+	archiveFile, err := os.Create(c.decompressPath)
 	if err != nil {
 		return
 	}
-	_, err = io.Copy(zipFile, resp.Body)
-	zipFile.Close()
+	_, err = io.Copy(archiveFile, resp.Body)
+	archiveFile.Close()
 	if err != nil {
 		return
 	}
-	c.zipProvider = &Zip{Path: c.zipPath}
-	return c.zipProvider.Open()
+	c.decompressProvider, err = Decompress(c.decompressPath)
+	return c.decompressProvider.Open()
 }
 
 // Close closes the provider
 func (c *Gitlab) Close() error {
-	if c.zipProvider != nil {
-		c.zipProvider.Close()
-		c.zipProvider = nil
+	if c.decompressProvider != nil {
+		c.decompressProvider.Close()
+		c.decompressProvider = nil
 	}
 
 	if len(c.tmpDir) > 0 {
 		os.RemoveAll(c.tmpDir)
 		c.tmpDir = ""
-		c.zipPath = ""
+		c.decompressPath = ""
 	}
 	return nil
 }
@@ -148,10 +148,10 @@ func (c *Gitlab) GetLatestVersion() (string, error) {
 
 // Walk walks all the files provided
 func (c *Gitlab) Walk(walkFn WalkFunc) error {
-	return c.zipProvider.Walk(walkFn)
+	return c.decompressProvider.Walk(walkFn)
 }
 
 // Retrieve file relative to "provider" to destination
 func (c *Gitlab) Retrieve(src string, dest string) error {
-	return c.zipProvider.Retrieve(src, dest)
+	return c.decompressProvider.Retrieve(src, dest)
 }

pkg/provider/provider_gitlab_test.go

@@ -10,8 +10,8 @@ import (
 
 func TestProviderGitlab(t *testing.T) {
 	p := &provider.Gitlab{
-		ProjectID: 24021648,
-		ZipName:   fmt.Sprintf("binaries_%s.zip", runtime.GOOS),
+		ProjectID:   24021648,
+		ArchiveName: fmt.Sprintf("binaries_%s.zip", runtime.GOOS),
 	}
 
 	if err := p.Open(); err != nil {