Merge pull request #6 from mouuff/feature/provider/gitlab

Feature/provider/gitlab

Author: mouuff

README.md

@@ -16,7 +16,7 @@ It provides the flexibility to implement different updating user experiences lik
 *The gopher in this image was created by [Takuya Ueda][tu], licensed under [Creative Commons 3.0 Attributions license][cc3-by].*
 
 ## Features
-* Flexible way to provide updates (ex: using Github!)
+* Flexible way to provide updates (ex: using Github or Gitlab!)
 * Cross platform support (Mac, Linux, Arm, and Windows)
 * RSA signature verification
 * Tooling to generate and verify signatures
@@ -54,10 +54,11 @@ The updater uses a `Provider` as an input source for updates. It provides files
 
 Here is few examples of providers:
 * `provider.Github`: It will check for the latest release on Github with a specific zip name
+* `provider.Gitlab`: It will check for the latest release on Gitlab with a specific zip name
 * `provider.Local`: It will use a local folder, version will be defined in the VERSION file (can be used for testing, or in a company with a shared folder for example)
 * `provider.Zip`: Same as provider.Local but with a `Zip` file
 
-*In the future there will be providers for FTP servers and Gitlab.*
+*In the future there will be providers for FTP servers and Google cloud storage.*
 
 The updater will list the files and retrieve them the same way for all the providers:
 
@@ -74,7 +75,7 @@ We recommend using [goxc](https://github.com/laher/goxc) for compiling your Go a
 ### Planned features
 This project is currently under construction, here is some of the things to come:
 * More documentation and examples
-* Gitlab and FTP providers
+* Google cloud storage and FTP providers
 * Mutliple providers (enables the use of another provider if the first one is down)
 * Update channels for Github provider (alpha, beta, ...)
 * Rollback feature

examples/gitlab-simple/main.go

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"log"
+	"runtime"
+
+	"github.com/mouuff/go-rocket-update/pkg/provider"
+	"github.com/mouuff/go-rocket-update/pkg/updater"
+)
+
+func main() {
+	// Example project here: https://gitlab.com/arnaudalies.py/go-rocket-update-example
+	u := &updater.Updater{
+		Provider: &provider.Gitlab{
+			ProjectID: 24021648,
+			ZipName:   "binaries_" + runtime.GOOS + ".zip",
+		},
+		BinaryName: "go-rocket-update-example",
+		Version:    "v0.3.0",
+	}
+
+	log.Println(u.Version)
+	if err := u.Update(); err != nil {
+		log.Println(err)
+	}
+}

pkg/provider/provider_github.go

@@ -29,21 +29,21 @@ type githubTag struct {
 	Name string `json:"name"`
 }
 
-// repositoryInfo is used to get the name of the project and the owner name
+// githubRepositoryInfo is used to get the name of the project and the owner name
 // from this fields we are able to get other links (such as the release and tags link)
-type repositoryInfo struct {
+type githubRepositoryInfo struct {
 	RepositoryOwner string
 	RepositoryName  string
 }
 
 // getRepositoryInfo parses the github repository URL
-func (c *Github) repositoryInfo() (*repositoryInfo, error) {
+func (c *Github) repositoryInfo() (*githubRepositoryInfo, error) {
 	re := regexp.MustCompile(`github\.com/(.*?)/(.*?)$`)
 	submatches := re.FindAllStringSubmatch(c.RepositoryURL, 1)
 	if len(submatches) < 1 {
 		return nil, errors.New("Invalid github URL:" + c.RepositoryURL)
 	}
-	return &repositoryInfo{
+	return &githubRepositoryInfo{
 		RepositoryOwner: submatches[0][1],
 		RepositoryName:  submatches[0][2],
 	}, nil

pkg/provider/provider_gitlab.go

@@ -0,0 +1,157 @@
+package provider
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/mouuff/go-rocket-update/internal/fileio"
+)
+
+// Gitlab provider finds a zip 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
+
+	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)
+}
+
+// gitlabRelease struct used to unmarshal response from gitlab
+// https://gitlab.com/api/v4/projects/24021648/releases
+type gitlabRelease struct {
+	TagName string               `json:"tag_name"`
+	Assets  *gitlabReleaseAssets `json:"assets"`
+}
+
+type gitlabReleaseAssets struct {
+	Links []gitlabReleaseLink `json:"links"`
+}
+
+type gitlabReleaseLink struct {
+	Name      string `json:"name"`
+	DirectURL string `json:"direct_asset_url"`
+}
+
+// getReleasesURL get the releases URL for the gitlab repository
+func (c *Gitlab) getReleasesURL() (string, error) {
+	return fmt.Sprintf("https://gitlab.com/api/v4/projects/%d/releases",
+		c.ProjectID,
+	), nil
+}
+
+// getZipURL get the zip URL for the gitlab repository
+// the latest version is selected
+func (c *Gitlab) getZipURL() (string, error) {
+	release, err := c.getLatestRelease()
+	if err != nil {
+		return "", err
+	}
+	for _, link := range release.Assets.Links {
+		if strings.HasSuffix(link.Name, c.ZipName) {
+			return link.DirectURL, nil
+		}
+	}
+	return "", errors.New("Link not found for name: " + c.ZipName)
+}
+
+// getReleases gets tags of the repository
+func (c *Gitlab) getReleases() (releases []gitlabRelease, err error) {
+	releasesURL, err := c.getReleasesURL()
+	if err != nil {
+		return
+	}
+	resp, err := http.Get(releasesURL)
+	if err != nil {
+		return
+	}
+	defer resp.Body.Close()
+	err = json.NewDecoder(resp.Body).Decode(&releases)
+	if err != nil {
+		return
+	}
+	return
+}
+
+// getReleases gets tags of the repository
+func (c *Gitlab) getLatestRelease() (*gitlabRelease, error) {
+	releases, err := c.getReleases()
+	if err != nil {
+		return nil, err
+	}
+	if len(releases) < 1 {
+		return nil, errors.New("This gitlab project has no releases")
+	}
+	return &releases[0], nil
+}
+
+// Open opens the provider
+func (c *Gitlab) Open() (err error) {
+	zipURL, err := c.getZipURL() // get zip url for latest version
+	if err != nil {
+		return
+	}
+	resp, err := http.Get(zipURL)
+	if err != nil {
+		return
+	}
+	defer resp.Body.Close()
+
+	c.tmpDir, err = fileio.TempDir()
+	if err != nil {
+		return
+	}
+
+	c.zipPath = filepath.Join(c.tmpDir, c.ZipName)
+	zipFile, err := os.Create(c.zipPath)
+	if err != nil {
+		return
+	}
+	_, err = io.Copy(zipFile, resp.Body)
+	zipFile.Close()
+	if err != nil {
+		return
+	}
+	c.zipProvider = &Zip{Path: c.zipPath}
+	return c.zipProvider.Open()
+}
+
+// Close closes the provider
+func (c *Gitlab) Close() error {
+	if c.zipProvider != nil {
+		c.zipProvider.Close()
+		c.zipProvider = nil
+	}
+
+	if len(c.tmpDir) > 0 {
+		os.RemoveAll(c.tmpDir)
+		c.tmpDir = ""
+		c.zipPath = ""
+	}
+	return nil
+}
+
+// GetLatestVersion gets the latest version
+func (c *Gitlab) GetLatestVersion() (string, error) {
+	release, err := c.getLatestRelease()
+	if err != nil {
+		return "", err
+	}
+	return release.TagName, nil
+}
+
+// Walk walks all the files provided
+func (c *Gitlab) Walk(walkFn WalkFunc) error {
+	return c.zipProvider.Walk(walkFn)
+}
+
+// Retrieve file relative to "provider" to destination
+func (c *Gitlab) Retrieve(src string, dest string) error {
+	return c.zipProvider.Retrieve(src, dest)
+}

pkg/provider/provider_gitlab_test.go

@@ -0,0 +1,25 @@
+package provider_test
+
+import (
+	"runtime"
+	"testing"
+
+	provider "github.com/mouuff/go-rocket-update/pkg/provider"
+)
+
+func TestProviderGitlab(t *testing.T) {
+	p := &provider.Gitlab{
+		ProjectID: 24021648,
+		ZipName:   "binaries_" + runtime.GOOS + ".zip",
+	}
+
+	if err := p.Open(); err != nil {
+		t.Fatal(err)
+	}
+	defer p.Close()
+
+	err := ProviderTestWalkAndRetrieve(p)
+	if err != nil {
+		t.Fatal(err)
+	}
+}