Add self-update (#13)

Add `hipapu` binary to tracked binaries

Pass writer to all functions writing to output

Minor style fixes

Author: outcatcher

.golangci.yaml

@@ -17,18 +17,13 @@ linters:
     - gochecknoglobals
     - exhaustruct
     - depguard
-    - forbidigo
     - godox # TODOs are perfectly fine
   exclusions:
     rules:
       - path: _test\.go
         linters:
           - gosec
           - funlen
-  # exclusions:
-  # presets:
-  #   - common-false-positives
-  #   - legacy
   settings:
     revive:
       rules:
@@ -62,6 +57,11 @@ linters:
       case:
         rules:
           json: snake
+    varnamelen:
+      ignore-map-index-ok: true
+      ignore-type-assert-ok: true
+      ignore-names:
+        - i
 formatters:
   enable:
     - gci

app/app_test.go

@@ -6,6 +6,8 @@
 package app_test
 
 import (
+	"bytes"
+	"io"
 	"testing"
 	"time"
 
@@ -40,7 +42,8 @@ func TestAppWorkflow(t *testing.T) {
 	apk := new(app.Application)
 
 	const (
-		expectecdURL = "https://github.com/outcatcher/asdfasdf"
+		expectecdURL    = "https://github.com/outcatcher/asdfasdf"
+		expectedSkipURL = expectecdURL + ".skip.me"
 
 		expectedConfigPath    = "./config.cfg"
 		expectedLocalFilename = "localFilePath"
@@ -60,6 +63,11 @@ func TestAppWorkflow(t *testing.T) {
 			RepoURL:   expectecdURL,
 			LocalPath: expectedLocalPath,
 		},
+		{
+			RepoURL:   expectedSkipURL,
+			LocalPath: expectedLocalPath,
+			SkipSync:  true,
+		},
 	})
 
 	apk.WithConfig(mockCfg)
@@ -77,6 +85,19 @@ func TestAppWorkflow(t *testing.T) {
 				Filename:    expectedLocalFilename,
 				DownloadURL: expectecdDownloadURL,
 			}},
+			RepoURL: expectecdURL,
+		}, nil)
+	mockRemote.
+		On("GetLatestRelease", ctx, expectedSkipURL).
+		Return(&remote.Release{
+			Name:        "123",
+			Description: "234",
+			PublishedAt: time.Now(),
+			Assets: []remote.Asset{{
+				Filename:    expectedLocalFilename,
+				DownloadURL: expectecdDownloadURL,
+			}},
+			RepoURL: expectedSkipURL,
 		}, nil)
 	mockRemote.
 		On("DownloadFile", ctx, expectecdDownloadURL, mock.Anything).
@@ -94,5 +115,18 @@ func TestAppWorkflow(t *testing.T) {
 
 	require.NoError(t, apk.Add(expectecdURL, expectedLocalPath))
 
-	require.NoError(t, apk.Synchronize(ctx))
+	outBuffer := new(bytes.Buffer)
+
+	require.NoError(t, apk.Synchronize(ctx, outBuffer))
+
+	line1, err := outBuffer.ReadString('\n')
+	require.NoError(t, err)
+
+	require.Contains(t, line1, expectecdURL)
+
+	line2, err := io.ReadAll(outBuffer)
+	require.NoError(t, err)
+
+	require.Contains(t, string(line2), "Skipping")
+	require.Contains(t, string(line2), expectedSkipURL)
 }

app/list.go

@@ -15,17 +15,18 @@ type Installation struct {
 	Release *remote.Release
 	// Local file info
 	LocalFile *local.FileInfo
+
+	// Skipping sync for installation
+	SkipSync bool
 }
 
 // List lists all existing installations.
-//
-// It would be better to add a type for return, but it's such a waste of code.
 func (a *Application) List(ctx context.Context) ([]Installation, error) {
 	installations := a.config.GetInstallations()
 
 	result := make([]Installation, len(installations))
 
-	for idx, installation := range installations {
+	for i, installation := range installations {
 		release, err := a.remote.GetLatestRelease(ctx, installation.RepoURL)
 		if err != nil {
 			return nil, fmt.Errorf("failed to get release info: %w", err)
@@ -36,9 +37,10 @@ func (a *Application) List(ctx context.Context) ([]Installation, error) {
 			return nil, fmt.Errorf("failed to get installation file info: %w", err)
 		}
 
-		result[idx] = Installation{
+		result[i] = Installation{
 			Release:   release,
 			LocalFile: file,
+			SkipSync:  installation.SkipSync,
 		}
 	}
 

app/sync.go

@@ -20,7 +20,7 @@ var (
 )
 
 // Synchronize runs synchronization of all new releases replacing local files reporting the progress.
-func (a *Application) Synchronize(ctx context.Context) error {
+func (a *Application) Synchronize(ctx context.Context, writer io.Writer) error {
 	installations, err := a.List(ctx)
 	if err != nil {
 		return fmt.Errorf("sync error: %w", err)
@@ -35,11 +35,29 @@ func (a *Application) Synchronize(ctx context.Context) error {
 	var errs error
 
 	for i, installation := range installations {
+		if installation.SkipSync {
+			_, _ = fmt.Fprintf(
+				writer,
+				"Skipping sync for installation #%d of %d (%s)\n",
+				i+1,
+				len(installations),
+				installation.Release.RepoURL,
+			)
+
+			continue
+		}
+
 		// todo: output is a CLI interaction, needs to be moved out to cmd somehow
-		fmt.Printf("Synchronizing installation #%d of %d\n", i+1, len(installations))
+		_, _ = fmt.Fprintf(
+			writer,
+			"Synchronizing installation #%d of %d (%s)\n",
+			i+1,
+			len(installations),
+			installation.Release.RepoURL,
+		)
 
 		// todo: parrallelize
-		if err := a.syncInstallation(ctx, installation); err != nil {
+		if err := a.syncInstallation(ctx, installation, writer); err != nil {
 			errs = errors.Join(errs, err)
 
 			continue
@@ -51,7 +69,7 @@ func (a *Application) Synchronize(ctx context.Context) error {
 
 //nolint:cyclop,funlen  // rewriting makes it less readable
 func (a *Application) syncInstallation(
-	ctx context.Context, installation Installation,
+	ctx context.Context, installation Installation, extWriter io.Writer,
 ) error {
 	a.log().InfoContext(ctx,
 		"Starting sync of installation",
@@ -99,8 +117,7 @@ func (a *Application) syncInstallation(
 	a.log().Info("Download started", "download URL", downloadURL, "total size, MiB", totalSize/1024/1024) //nolint:mnd
 
 	// todo: progress bar is a CLI interaction, needs to be moved out to cmd somehow
-	bar := progressbar.DefaultBytes(-1, "Downloading to"+tmpFilePath)
-	bar.ChangeMax(totalSize)
+	bar := newProgressBar(extWriter, totalSize, "Downloading to "+tmpFilePath)
 
 	// cleanup on cancel
 	go func() {
@@ -138,3 +155,23 @@ func (a *Application) syncInstallation(
 
 	return nil
 }
+
+func newProgressBar(writer io.Writer, maxBytes int, description string) *progressbar.ProgressBar {
+	//nolint:mnd  // temporary location for progress bar initialization
+	return progressbar.NewOptions(
+		maxBytes,
+		progressbar.OptionSetDescription(description),
+		progressbar.OptionSetWriter(writer),
+		progressbar.OptionShowBytes(true),
+		progressbar.OptionShowTotalBytes(true),
+		progressbar.OptionSetWidth(10),
+		progressbar.OptionThrottle(65*time.Millisecond),
+		progressbar.OptionShowCount(),
+		progressbar.OptionOnCompletion(func() {
+			_, _ = fmt.Fprint(writer, "\n")
+		}),
+		progressbar.OptionSpinnerType(14),
+		progressbar.OptionFullWidth(),
+		progressbar.OptionSetRenderBlankState(true),
+	)
+}

cmd/handlers/actions.go

@@ -4,6 +4,7 @@ package handlers
 import (
 	"context"
 	"fmt"
+	"io"
 
 	"github.com/outcatcher/hipapu/app"
 	"github.com/urfave/cli/v3"
@@ -13,9 +14,12 @@ import (
 const DefaultCommandName = commandNameList
 
 type application interface {
+	// List lists all existing installations.
 	List(ctx context.Context) ([]app.Installation, error)
+	// Add adds installation to the list. Rewrites configuration file.
 	Add(remoteURL, localPath string) error
-	Synchronize(ctx context.Context) error
+	// Synchronize runs synchronization of all new releases replacing local files reporting the progress.
+	Synchronize(ctx context.Context, writer io.Writer) error
 }
 
 // ActionHandlers handle CLI actions.

cmd/handlers/mocks/mock_application.go

@@ -24,7 +24,7 @@ func (h *ActionHandlers) CommandSync() *cli.Command {
 }
 
 func (h *ActionHandlers) sync(ctx context.Context, cmd *cli.Command) error {
-	if err := h.app.Synchronize(ctx); err != nil {
+	if err := h.app.Synchronize(ctx, cmd.Writer); err != nil {
 		if errors.Is(err, app.ErrEmptyInstallationList) {
 			_, _ = fmt.Fprintln(cmd.Writer, "Empty installation list. Nothing to synchronize.")
 

cmd/handlers/sync.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/outcatcher/hipapu/app"
 	"github.com/outcatcher/hipapu/cmd/handlers/mocks"
+	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 )
 
@@ -20,7 +21,7 @@ func TestSync(t *testing.T) {
 	ctx := t.Context()
 
 	appMock := mocks.NewMockapplication(t)
-	appMock.On("Synchronize", ctx).Once().Return(nil)
+	appMock.On("Synchronize", ctx, mock.Anything).Once().Return(nil)
 
 	hdl := &ActionHandlers{app: appMock}
 
@@ -36,7 +37,7 @@ func TestSync_emptyList(t *testing.T) {
 	ctx := t.Context()
 
 	appMock := mocks.NewMockapplication(t)
-	appMock.On("Synchronize", ctx).Once().Return(app.ErrEmptyInstallationList)
+	appMock.On("Synchronize", ctx, mock.Anything).Once().Return(app.ErrEmptyInstallationList)
 
 	hdl := &ActionHandlers{app: appMock}
 

cmd/handlers/sync_test.go

@@ -3,6 +3,7 @@ package main
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"os/signal"
 	"syscall"
@@ -61,7 +62,7 @@ func main() {
 	}()
 
 	if err := cmd.Run(ctx, os.Args); err != nil {
-		println(err.Error())
+		fmt.Println(err) //nolint:forbidigo  // exactly where needed
 
 		os.Exit(1)
 	}

cmd/main.go

@@ -26,12 +26,14 @@ func TestAdd(t *testing.T) {
 	cfg, err := config.LoadConfig(path)
 	require.NoError(t, err)
 
+	require.Len(t, cfg.Installations, 1, "no self installation")
+
 	require.NoError(t, cfg.Add(testInstall))
 
 	newCfg, err := config.LoadConfig(path)
 	require.NoError(t, err)
 	require.NotNil(t, newCfg)
 
-	require.Len(t, newCfg.Installations, 1)
-	require.Equal(t, testInstall, newCfg.Installations[0])
+	require.Len(t, newCfg.Installations, 2)
+	require.Contains(t, newCfg.Installations, testInstall)
 }