extracting GitHub related code to a separate class

surrounded by an interface.
It will help with mocking GitHub, and also providing support for Gitlab

Author: creativeprojects

.travis.yml

@@ -32,14 +32,12 @@ install:
   - go get -t -d -v ./...
 
 script:
-  - go build ./selfupdate/
-  - go build ./cmd/detect-latest-release/
-  - go build ./cmd/go-get-release/
+  - go build ./...
   - |
     if [[ "${GITHUB_TOKEN}" != "" ]]; then
-      go test -v -race -coverprofile=coverage.txt ./selfupdate
+      go test -v -race -coverprofile=coverage.txt . ./update
     else
-      go test -v -race -short ./selfupdate
+      go test -v -race -short . ./update
     fi
 
 after_success:

Makefile

@@ -11,7 +11,7 @@ GOTOOL=$(GOCMD) tool
 GOGET=$(GOCMD) get
 GOPATH?=`$(GOCMD) env GOPATH`
 
-TESTS=./...
+TESTS=. ./update
 COVERAGE_FILE=coverage.out
 
 BUILD_DATE=`date`
@@ -22,9 +22,7 @@ BUILD_COMMIT=`git rev-parse HEAD`
 all: test build
 
 build:
-		$(GOBUILD) -v ./selfupdate
-		$(GOBUILD) -v ./cmd/go-get-release
-		$(GOBUILD) -v ./cmd/detect-latest-release
+		$(GOBUILD) -v ./...
 
 test:
 		$(GOTEST) -race -v $(TESTS)
@@ -34,6 +32,7 @@ coverage:
 		$(GOTOOL) cover -html=$(COVERAGE_FILE)
 
 clean:
+		rm detect-latest-release go-get-release coverage.out
 		$(GOCLEAN)
 
 toc:

selfupdate/arch.go renamed to arch.go

@@ -8,7 +8,7 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/creativeprojects/go-selfupdate/selfupdate"
+	"github.com/creativeprojects/go-selfupdate"
 )
 
 func usage() {

selfupdate/arch_test.go renamed to arch_test.go

@@ -12,7 +12,7 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/creativeprojects/go-selfupdate/selfupdate"
+	"github.com/creativeprojects/go-selfupdate"
 )
 
 func usage() {

selfupdate/arm.go renamed to arm.go

@@ -1,25 +1,15 @@
 package selfupdate
 
-import "context"
-
 // Config represents the configuration of self-update.
 type Config struct {
-	// APIToken represents GitHub API token. If it's not empty, it will be used for authentication of GitHub API
-	APIToken string
-	// EnterpriseBaseURL is a base URL of GitHub API. If you want to use this library with GitHub Enterprise,
-	// please set "https://{your-organization-address}/api/v3/" to this field.
-	EnterpriseBaseURL string
-	// EnterpriseUploadURL is a URL to upload stuffs to GitHub Enterprise instance. This is often the same as an API base URL.
-	// So if this field is not set and EnterpriseBaseURL is set, EnterpriseBaseURL is also set to this field.
-	EnterpriseUploadURL string
+	// Source where to load the releases from (example: GitHubSource)
+	Source Source
 	// Validator represents types which enable additional validation of downloaded release.
 	Validator Validator
 	// Filters are regexp used to filter on specific assets for releases with multiple assets.
 	// An asset is selected if it matches any of those, in addition to the regular tag, os, arch, extensions.
 	// Please make sure that your filter(s) uniquely match an asset.
 	Filters []string
-	// Context used by the http client (default to context.Background)
-	Context context.Context
 	// OS is set to the value of runtime.GOOS by default, but you can force another value here
 	OS string
 	// Arch is set to the value of runtime.GOARCH by default, but you can force another value here

cmd/detect-latest-release/main.go

@@ -6,7 +6,6 @@ import (
 	"strings"
 
 	"github.com/Masterminds/semver/v3"
-	"github.com/google/go-github/v30/github"
 )
 
 var reVersion = regexp.MustCompile(`\d+\.\d+\.\d+`)
@@ -31,14 +30,8 @@ func (up *Updater) DetectVersion(slug string, version string) (release *Release,
 		return nil, false, fmt.Errorf("invalid slug format. It should be 'owner/name': %s", slug)
 	}
 
-	rels, res, err := up.api.Repositories.ListReleases(up.apiCtx, repo[0], repo[1], nil)
+	rels, err := up.source.ListReleases(repo[0], repo[1])
 	if err != nil {
-		log.Printf("API returned an error response: %s", err)
-		if res != nil && res.StatusCode == 404 {
-			// 404 means repository not found or release not found. It's not an error here.
-			err = nil
-			log.Print("API returned 404. Repository or release not found")
-		}
 		return nil, false, err
 	}
 
@@ -50,19 +43,19 @@ func (up *Updater) DetectVersion(slug string, version string) (release *Release,
 	url := asset.GetBrowserDownloadURL()
 	log.Printf("Successfully fetched the latest release. tag: %s, name: %s, URL: %s, Asset: %s", rel.GetTagName(), rel.GetName(), rel.GetURL(), url)
 
-	publishedAt := rel.GetPublishedAt().Time
+	publishedAt := rel.GetPublishedAt()
 	release = &Release{
 		version:           ver,
+		repoOwner:         repo[0],
+		repoName:          repo[1],
 		AssetURL:          url,
 		AssetByteSize:     asset.GetSize(),
 		AssetID:           asset.GetID(),
 		ValidationAssetID: -1,
-		URL:               rel.GetHTMLURL(),
-		ReleaseNotes:      rel.GetBody(),
+		URL:               rel.GetURL(),
+		ReleaseNotes:      rel.GetReleaseNotes(),
 		Name:              rel.GetName(),
 		PublishedAt:       &publishedAt,
-		RepoOwner:         repo[0],
-		RepoName:          repo[1],
 		OS:                up.os,
 		Arch:              up.arch,
 		Arm:               up.arm,
@@ -80,9 +73,11 @@ func (up *Updater) DetectVersion(slug string, version string) (release *Release,
 	return release, true, nil
 }
 
-func findAssetFromRelease(rel *github.RepositoryRelease,
-	suffixes []string, targetVersion string, filters []*regexp.Regexp) (*github.ReleaseAsset, *semver.Version, bool) {
-
+func findAssetFromRelease(rel SourceRelease, suffixes []string, targetVersion string, filters []*regexp.Regexp) (SourceAsset, *semver.Version, bool) {
+	if rel == nil {
+		log.Print("Empty release instance!")
+		return nil, nil, false
+	}
 	if targetVersion != "" && targetVersion != rel.GetTagName() {
 		log.Printf("Skip %s not matching to specified version %s", rel.GetTagName(), targetVersion)
 		return nil, nil, false
@@ -104,7 +99,7 @@ func findAssetFromRelease(rel *github.RepositoryRelease,
 		return nil, nil, false
 	}
 	if indices[0] > 0 {
-		log.Printf("Strip prefix '%s' from '%s'", verText[:indices[0]], verText)
+		// log.Printf("Strip prefix '%s' from '%s'", verText[:indices[0]], verText)
 		verText = verText[indices[0]:]
 	}
 
@@ -116,7 +111,7 @@ func findAssetFromRelease(rel *github.RepositoryRelease,
 		return nil, nil, false
 	}
 
-	for _, asset := range rel.Assets {
+	for _, asset := range rel.GetAssets() {
 		name := asset.GetName()
 		if len(filters) > 0 {
 			// if some filters are defined, match them: if any one matches, the asset is selected
@@ -146,20 +141,16 @@ func findAssetFromRelease(rel *github.RepositoryRelease,
 	return nil, nil, false
 }
 
-func findValidationAsset(rel *github.RepositoryRelease, validationName string) (*github.ReleaseAsset, bool) {
-	for _, asset := range rel.Assets {
+func findValidationAsset(rel SourceRelease, validationName string) (SourceAsset, bool) {
+	for _, asset := range rel.GetAssets() {
 		if asset.GetName() == validationName {
 			return asset, true
 		}
 	}
 	return nil, false
 }
 
-func (up *Updater) findReleaseAndAsset(rels []*github.RepositoryRelease, targetVersion string,
-) (*github.RepositoryRelease,
-	*github.ReleaseAsset,
-	*semver.Version,
-	bool) {
+func (up *Updater) findReleaseAndAsset(rels []SourceRelease, targetVersion string) (SourceRelease, SourceAsset, *semver.Version, bool) {
 	// we put the detected arch at the end of the list: that's fine for ARM so far,
 	// as the additional arch are more accurate than the generic one
 	for _, arch := range append(generateAdditionalArch(up.arch, up.arm), up.arch) {
@@ -175,10 +166,10 @@ func (up *Updater) findReleaseAndAsset(rels []*github.RepositoryRelease, targetV
 func findReleaseAndAssetForArch(
 	os string,
 	arch string,
-	rels []*github.RepositoryRelease,
+	rels []SourceRelease,
 	targetVersion string,
 	filters []*regexp.Regexp,
-) (*github.RepositoryRelease, *github.ReleaseAsset, *semver.Version, bool) {
+) (SourceRelease, SourceAsset, *semver.Version, bool) {
 	// Generate candidates
 	suffixes := make([]string, 0, 2*7*2)
 	for _, sep := range []rune{'_', '-'} {
@@ -193,8 +184,8 @@ func findReleaseAndAssetForArch(
 	}
 
 	var ver *semver.Version
-	var asset *github.ReleaseAsset
-	var release *github.RepositoryRelease
+	var asset SourceAsset
+	var release SourceRelease
 
 	// Find the latest version from the list of releases.
 	// Returned list from GitHub API is in the order of the date when created.