feat: support to specific the format of target file (#364)

Author: LinuxSuRen

Makefile

@@ -2,6 +2,8 @@ build: fmt test
 	export GOPROXY=https://goproxy.io
 	CGO_ENABLE=0 go build -ldflags "-w -s" -o bin/hd
 
+build-windows:
+	GOOS=windows CGO_ENABLE=0 go build -ldflags "-w -s" -o bin/windows/hd.exe
 build-linux: fmt lint build-linux-no-check
 build-linux-no-check:
 	export GOPROXY=https://goproxy.io

cmd/fetch.go

@@ -34,8 +34,6 @@ func newFetchCmd(context.Context) (cmd *cobra.Command) {
 		"If you want to reset the hd-config which means delete and clone it again")
 	flags.IntVarP(&opt.retry, "retry", "", 6, "Retry times due to timeout error")
 	flags.DurationVarP(&opt.timeout, "timeout", "", time.Second*10, "Timeout of fetching")
-
-	_ = cmd.RegisterFlagCompletionFunc("provider", ArrayCompletion(ProviderGitHub, ProviderGitee))
 	return
 }
 

cmd/get.go

@@ -61,11 +61,7 @@ func newGetCmd(ctx context.Context) (cmd *cobra.Command) {
 		`The default timeout in seconds with the HTTP request`)
 	flags.IntVarP(&opt.MaxAttempts, "max-attempts", "", 10,
 		`Max times to attempt to download, zero means there's no retry action'`)
-	flags.BoolVarP(&opt.NoProxy, "no-proxy", "", false, "Indicate no HTTP proxy taken")
-	flags.BoolVarP(&opt.ShowProgress, "show-progress", "", true, "If show the progress of download")
 	flags.Int64VarP(&opt.ContinueAt, "continue-at", "", -1, "ContinueAt")
-	flags.IntVarP(&opt.Thread, "thread", "t", viper.GetInt("thread"),
-		`Download file with multi-threads. It only works when its value is bigger than 1`)
 	flags.BoolVarP(&opt.KeepPart, "keep-part", "", false,
 		"If you want to keep the part files instead of deleting them")
 	flags.BoolVarP(&opt.PrintSchema, "print-schema", "", false,
@@ -77,10 +73,7 @@ func newGetCmd(ctx context.Context) (cmd *cobra.Command) {
 	flags.IntVarP(&opt.PrintVersionCount, "print-version-count", "", 20,
 		"The number of the version list")
 	flags.BoolVarP(&opt.Magnet, "magnet", "", false, "Fetch magnet list from a website")
-
-	_ = cmd.RegisterFlagCompletionFunc("proxy-github", ArrayCompletion("gh.api.99988866.xyz",
-		"ghproxy.com", "mirror.ghproxy.com"))
-	_ = cmd.RegisterFlagCompletionFunc("provider", ArrayCompletion(ProviderGitHub, ProviderGitee))
+	flags.StringVarP(&opt.Format, "format", "", "", "Specific the file format, for instance: tar, zip, msi")
 	return
 }
 
@@ -111,6 +104,7 @@ type downloadOption struct {
 	Force            bool
 	Mod              int
 	SkipTLS          bool
+	Format           string
 
 	ContinueAt int64
 
@@ -145,6 +139,10 @@ const (
 func (o *downloadOption) addDownloadFlags(flags *pflag.FlagSet) {
 	flags.IntVarP(&o.Mod, "mod", "", -1, "The file permission, -1 means using the system default")
 	flags.BoolVarP(&o.SkipTLS, "skip-tls", "k", false, "Skip the TLS")
+	flags.BoolVarP(&o.ShowProgress, "show-progress", "", true, "If show the progress of download")
+	flags.IntVarP(&o.Thread, "thread", "t", viper.GetInt("thread"),
+		`Download file with multi-threads. It only works when its value is bigger than 1`)
+	flags.BoolVarP(&o.NoProxy, "no-proxy", "", viper.GetBool("no-proxy"), "Indicate no HTTP proxy taken")
 }
 
 func (o *downloadOption) fetch() (err error) {
@@ -195,7 +193,11 @@ func (o *downloadOption) preRunE(cmd *cobra.Command, args []string) (err error)
 	}
 
 	targetURL := args[0]
-	o.Package = &installer.HDConfig{}
+	o.Package = &installer.HDConfig{
+		FormatOverrides: installer.PackagingFormat{
+			Format: o.Format,
+		},
+	}
 	if o.Magnet || strings.HasPrefix(targetURL, "magnet:?") {
 		// download via external tool
 		o.URL = targetURL
@@ -206,6 +208,7 @@ func (o *downloadOption) preRunE(cmd *cobra.Command, args []string) (err error)
 			OS:       o.OS,
 			Arch:     o.Arch,
 			Fetch:    o.Fetch,
+			Package:  o.Package,
 		}
 		if targetURL, err = ins.ProviderURLParse(targetURL, o.AcceptPreRelease); err != nil {
 			err = fmt.Errorf("only http:// or https:// supported, error: %v", err)
@@ -351,7 +354,6 @@ func (o *downloadOption) runE(cmd *cobra.Command, args []string) (err error) {
 		}
 		var yes bool
 		if confirmErr := survey.AskOne(confirm, &yes); confirmErr == nil && yes {
-			fmt.Println("rename")
 			err = sysos.Rename(o.Output, suggested)
 		}
 	}

cmd/install.go

@@ -42,7 +42,6 @@ Cannot find your desired package? Please run command: hd fetch --reset, then try
 	opt.addDownloadFlags(flags)
 	flags.StringVarP(&opt.Category, "category", "c", "",
 		"The category of the potentials packages")
-	flags.BoolVarP(&opt.ShowProgress, "show-progress", "", true, "If show the progress of download")
 	flags.BoolVarP(&opt.AcceptPreRelease, "accept-preRelease", "", false,
 		"If you accept preRelease as the binary asset from GitHub")
 	flags.BoolVarP(&opt.AcceptPreRelease, "pre", "", false,
@@ -61,13 +60,8 @@ Cannot find your desired package? Please run command: hd fetch --reset, then try
 		"Indicate if force to download the package even it is exist")
 	flags.BoolVarP(&opt.CleanPackage, "clean-package", "", true,
 		"Clean the package if the installation is success")
-	flags.IntVarP(&opt.Thread, "thread", "t", viper.GetInt("thread"),
-		`Download file with multi-threads. It only works when its value is bigger than 1`)
-	flags.BoolVarP(&opt.NoProxy, "no-proxy", "", viper.GetBool("no-proxy"), "Indicate no HTTP proxy taken")
 	flags.BoolVarP(&opt.KeepPart, "keep-part", "", false,
 		"If you want to keep the part files instead of deleting them")
-
-	_ = cmd.RegisterFlagCompletionFunc("provider", ArrayCompletion(ProviderGitHub, ProviderGitee))
 	return
 }
 

cmd/root.go

@@ -47,9 +47,26 @@ func NewRoot(cxt context.Context) (cmd *cobra.Command) {
 		newGetCmd(cxt), newInstallCmd(cxt), newFetchCmd(cxt), newSearchCmd(cxt), newSetupCommand(v, stdio),
 		extver.NewVersionCmd("linuxsuren", "http-downloader", "hd", nil),
 		extpkg.NewCompletionCmd(cmd))
+
+	for _, c := range cmd.Commands() {
+		registerFlagCompletionFunc(c, "provider", ArrayCompletion(ProviderGitHub, ProviderGitee))
+		registerFlagCompletionFunc(c, "proxy-github", ArrayCompletion("gh.api.99988866.xyz",
+			"ghproxy.com", "mirror.ghproxy.com"))
+		registerFlagCompletionFunc(c, "os", ArrayCompletion("window", "linux", "darwin"))
+		registerFlagCompletionFunc(c, "arch", ArrayCompletion("amd64", "arm64"))
+		registerFlagCompletionFunc(c, "format", ArrayCompletion("tar.gz", "zip", "msi"))
+	}
 	return
 }
 
+func registerFlagCompletionFunc(cmd *cobra.Command, flag string, completionFunc CompletionFunc) {
+	if p := cmd.Flag(flag); p != nil {
+		if err := cmd.RegisterFlagCompletionFunc(flag, completionFunc); err != nil {
+			cmd.Println(err)
+		}
+	}
+}
+
 func loadConfig() (err error) {
 	viper.SetConfigName("hd")
 	viper.SetConfigType("yaml")

cmd/search.go

@@ -6,6 +6,7 @@ import (
 	"io"
 
 	"github.com/linuxsuren/http-downloader/pkg/installer"
+	"github.com/linuxsuren/http-downloader/pkg/log"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
@@ -46,11 +47,13 @@ Thanks to https://github.com/hunshcn/gh-proxy`)
 }
 
 func (s *searchOption) runE(c *cobra.Command, args []string) (err error) {
-	err = search(args[0], s.Fetch, s.fetcher, c.OutOrStdout())
+	logger := log.GetLoggerFromContextOrDefault(c)
+
+	err = search(args[0], s.Fetch, s.fetcher, c.OutOrStdout(), logger)
 	return
 }
 
-func search(keyword string, fetch bool, fetcher installer.Fetcher, writer io.Writer) (err error) {
+func search(keyword string, fetch bool, fetcher installer.Fetcher, writer io.Writer, logger *log.LevelLog) (err error) {
 	if fetch {
 		if err = fetcher.FetchLatestRepo("", "", writer); err != nil {
 			return
@@ -62,6 +65,7 @@ func search(keyword string, fetch bool, fetcher installer.Fetcher, writer io.Wri
 		return
 	}
 
+	logger.Info("start to search in:", configDir)
 	result := installer.FindByKeyword(keyword, configDir)
 	for _, item := range result {
 		fmt.Fprintln(writer, item)

cmd/search_test.go

@@ -9,21 +9,24 @@ import (
 	"testing"
 
 	"github.com/linuxsuren/http-downloader/pkg/installer"
+	"github.com/linuxsuren/http-downloader/pkg/log"
 	"github.com/stretchr/testify/assert"
 )
 
 func Test_search(t *testing.T) {
+	logger := log.GetLogger()
+
 	buf := &bytes.Buffer{}
-	err := search("keyword", true, &installer.FakeFetcher{}, buf)
+	err := search("keyword", true, &installer.FakeFetcher{}, buf, logger)
 	assert.Nil(t, err)
 	assert.Empty(t, buf.String())
 
 	// expect an error with GetConfigDir
-	err = search("", true, &installer.FakeFetcher{GetConfigDirErr: errors.New("fake")}, buf)
+	err = search("", true, &installer.FakeFetcher{GetConfigDirErr: errors.New("fake")}, buf, logger)
 	assert.NotNil(t, err)
 
 	// expect an error with FetchLatestRepo
-	err = search("", true, &installer.FakeFetcher{FetchLatestRepoErr: errors.New("fake")}, buf)
+	err = search("", true, &installer.FakeFetcher{FetchLatestRepoErr: errors.New("fake")}, buf, logger)
 	assert.NotNil(t, err)
 
 	tempDir, err := os.MkdirTemp("", "config")
@@ -41,7 +44,7 @@ func Test_search(t *testing.T) {
 	err = os.WriteFile(path.Join(orgDir, "fake.yml"), []byte{}, os.ModeAppend)
 	assert.Nil(t, err)
 
-	err = search("repo", true, &installer.FakeFetcher{ConfigDir: tempDir}, buf)
+	err = search("repo", true, &installer.FakeFetcher{ConfigDir: tempDir}, buf, logger)
 	assert.Nil(t, err)
 }
 

cmd/setup.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/AlecAivazis/survey/v2/terminal"
+	"github.com/linuxsuren/http-downloader/pkg/installer"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -52,7 +53,11 @@ func (o *setupOption) runE(cmd *cobra.Command, args []string) (err error) {
 		return
 	}
 
-	configDir := os.ExpandEnv("$HOME/.config")
+	var configDir string
+	fetcher := &installer.DefaultFetcher{}
+	if configDir, err = fetcher.GetConfigDir(); err != nil {
+		return
+	}
 	if err = os.MkdirAll(configDir, 0750); err != nil {
 		err = fmt.Errorf("failed to create directory: %s, error: %v", configDir, err)
 		return

pkg/installer/check.go

@@ -168,8 +168,13 @@ func (o *Installer) GetVersion(path string) (version string, err error) {
 	return
 }
 
-func getOrgAndRepo(orgAndRepo string) (string, string) {
-	return strings.Split(orgAndRepo, "/")[0], strings.Split(orgAndRepo, "/")[1]
+func getOrgAndRepo(orgAndRepo string) (org string, repo string) {
+	items := strings.Split(orgAndRepo, "/")
+	if len(items) >= 2 {
+		org = items[0]
+		repo = items[1]
+	}
+	return
 }
 
 // ProviderURLParse parse the URL
@@ -217,6 +222,7 @@ func (o *Installer) ProviderURLParse(path string, acceptPreRelease bool) (packag
 				}
 				cfg.Org = o.Org
 				cfg.Repo = o.Repo
+				cfg.FormatOverrides.Format = o.Package.FormatOverrides.Format
 				o.Package = &cfg
 				o.AdditionBinaries = cfg.AdditionBinaries
 				o.Tar = cfg.Tar != "false"
@@ -481,14 +487,17 @@ func chooseOneFromArray(options []string) (result string, err error) {
 }
 
 func getPackagingFormat(installer *Installer) string {
+	if installer.Package != nil && installer.Package.FormatOverrides.Format != "" {
+		return installer.Package.FormatOverrides.Format
+	}
 	platformType := strings.ToLower(installer.OS)
 	if platformType == "windows" {
-		if installer.Package != nil {
+		if installer.Package != nil && installer.Package.FormatOverrides.Windows != "" {
 			return installer.Package.FormatOverrides.Windows
 		}
 		return "zip"
 	}
-	if installer.Package != nil {
+	if installer.Package != nil && installer.Package.FormatOverrides.Linux != "" {
 		return installer.Package.FormatOverrides.Linux
 	}
 	return "tar.gz"

pkg/installer/check_test.go

@@ -507,3 +507,65 @@ func Test_getVersionOrDefault(t *testing.T) {
 		})
 	}
 }
+
+func TestGetPackagingFormat(t *testing.T) {
+	tests := []struct {
+		name      string
+		installer *Installer
+		expect    string
+	}{{
+		name: "have specific format",
+		installer: &Installer{
+			OS: "Darwin",
+			Package: &HDConfig{
+				FormatOverrides: PackagingFormat{
+					Format: "msi",
+				},
+			},
+		},
+		expect: "msi",
+	}, {
+		name: "windows with config",
+		installer: &Installer{
+			OS: "Windows",
+			Package: &HDConfig{
+				FormatOverrides: PackagingFormat{
+					Windows: "msi",
+				},
+			},
+		},
+		expect: "msi",
+	}, {
+		name: "windows without config",
+		installer: &Installer{
+			OS: "Windows",
+		},
+		expect: "zip",
+	}, {
+		name:      "darwin without config",
+		installer: &Installer{},
+		expect:    "tar.gz",
+	}, {
+		name: "linux, and package is not nil, but the override is empty",
+		installer: &Installer{
+			Package: &HDConfig{},
+		},
+		expect: "tar.gz",
+	}, {
+		name: "linux with override",
+		installer: &Installer{
+			Package: &HDConfig{
+				FormatOverrides: PackagingFormat{
+					Linux: "tar.gz",
+				},
+			},
+		},
+		expect: "tar.gz",
+	}}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := getPackagingFormat(tt.installer)
+			assert.Equal(t, tt.expect, result)
+		})
+	}
+}