From e61d4af9c1e41a3bde67edae00284a5b7a6c30a9 Mon Sep 17 00:00:00 2001 From: Christoph Witzko Date: Fri, 13 Jan 2023 12:23:59 +0100 Subject: [PATCH] refactor: rename PluginInfo struct to Info --- pkg/plugin/client.go | 2 +- pkg/plugin/discovery/discovery.go | 4 ++-- pkg/plugin/discovery/download.go | 2 +- pkg/plugin/discovery/local.go | 6 +++--- pkg/plugin/discovery/resolver/github/github.go | 2 +- .../discovery/resolver/registry/registry.go | 2 +- pkg/plugin/discovery/resolver/resolver.go | 2 +- pkg/plugin/plugin.go | 6 +++--- pkg/plugin/plugin_test.go | 18 +++++++++--------- pkg/semrel/semrel.go | 3 ++- 10 files changed, 24 insertions(+), 23 deletions(-) diff --git a/pkg/plugin/client.go b/pkg/plugin/client.go index 4e6f1475..535873c1 100644 --- a/pkg/plugin/client.go +++ b/pkg/plugin/client.go @@ -27,7 +27,7 @@ func KillAllPlugins() { } } -func StartPlugin(pluginInfo *PluginInfo) (interface{}, error) { +func StartPlugin(pluginInfo *Info) (interface{}, error) { runningClientsMx.Lock() defer runningClientsMx.Unlock() logR, logW := io.Pipe() diff --git a/pkg/plugin/discovery/discovery.go b/pkg/plugin/discovery/discovery.go index e84e6b44..e6cd48e0 100644 --- a/pkg/plugin/discovery/discovery.go +++ b/pkg/plugin/discovery/discovery.go @@ -50,7 +50,7 @@ func New(config *config.Config) (*Discovery, error) { }, nil } -func (d *Discovery) fetchPlugin(pluginInfo *plugin.PluginInfo) (string, error) { +func (d *Discovery) fetchPlugin(pluginInfo *plugin.Info) (string, error) { pluginResolver, ok := d.resolvers[pluginInfo.Resolver] if !ok { return "", fmt.Errorf("resolver %s not found", pluginInfo.Resolver) @@ -64,7 +64,7 @@ func (d *Discovery) fetchPlugin(pluginInfo *plugin.PluginInfo) (string, error) { return downloadPlugin(pluginInfo, downloadInfo, d.config.ShowProgress) } -func (d *Discovery) FindPlugin(t, name string) (*plugin.PluginInfo, error) { +func (d *Discovery) FindPlugin(t, name string) (*plugin.Info, error) { pInfo, err := plugin.GetPluginInfo(t, name) if err != nil { return nil, err diff --git a/pkg/plugin/discovery/download.go b/pkg/plugin/discovery/download.go index c34da1fc..9ed85ba5 100644 --- a/pkg/plugin/discovery/download.go +++ b/pkg/plugin/discovery/download.go @@ -90,7 +90,7 @@ func extractFileFromTarGz(name, inputFile, outputFile string) error { var tgzRegexp = regexp.MustCompile(`^(.*)\.(tgz|tar\.gz)$`) -func downloadPlugin(pluginInfo *plugin.PluginInfo, downloadInfo *resolver.PluginDownloadInfo, showProgress bool) (string, error) { +func downloadPlugin(pluginInfo *plugin.Info, downloadInfo *resolver.PluginDownloadInfo, showProgress bool) (string, error) { versionDir := path.Join(pluginInfo.PluginPath, downloadInfo.Version) targetFile := path.Join(versionDir, downloadInfo.FileName) req, err := grab.NewRequest(targetFile, downloadInfo.URL) diff --git a/pkg/plugin/discovery/local.go b/pkg/plugin/discovery/local.go index cfeb036b..226a5194 100644 --- a/pkg/plugin/discovery/local.go +++ b/pkg/plugin/discovery/local.go @@ -16,7 +16,7 @@ const PluginDir = ".semrel" var osArchDir = runtime.GOOS + "_" + runtime.GOARCH -func setAndEnsurePluginPath(pluginInfo *plugin.PluginInfo) error { +func setAndEnsurePluginPath(pluginInfo *plugin.Info) error { pluginPath := path.Join(PluginDir, osArchDir, pluginInfo.NormalizedName) if _, err := os.Stat(pluginPath); os.IsNotExist(err) { err = os.MkdirAll(pluginPath, 0o755) @@ -32,7 +32,7 @@ func setAndEnsurePluginPath(pluginInfo *plugin.PluginInfo) error { var ErrPluginNotFound = errors.New("no plugin was found") -func getMatchingVersionDir(pluginInfo *plugin.PluginInfo) (string, error) { +func getMatchingVersionDir(pluginInfo *plugin.Info) (string, error) { vDirs, err := os.ReadDir(pluginInfo.PluginPath) if err != nil { return "", err @@ -65,7 +65,7 @@ func getMatchingVersionDir(pluginInfo *plugin.PluginInfo) (string, error) { return "", nil } -func findPluginLocally(pluginInfo *plugin.PluginInfo) (string, error) { +func findPluginLocally(pluginInfo *plugin.Info) (string, error) { vPth, err := getMatchingVersionDir(pluginInfo) if err != nil { return "", err diff --git a/pkg/plugin/discovery/resolver/github/github.go b/pkg/plugin/discovery/resolver/github/github.go index 29196052..8e1b5d14 100644 --- a/pkg/plugin/discovery/resolver/github/github.go +++ b/pkg/plugin/discovery/resolver/github/github.go @@ -119,7 +119,7 @@ func (g *Resolver) getAllValidGitHubReleases(repoOwner, repoName string) (ghRele return ret, nil } -func (g *Resolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver.PluginDownloadInfo, error) { +func (g *Resolver) ResolvePlugin(pluginInfo *plugin.Info) (*resolver.PluginDownloadInfo, error) { if pluginInfo.RepoSlug == "" { pluginInfo.RepoSlug = knownPlugins[pluginInfo.ShortNormalizedName] } diff --git a/pkg/plugin/discovery/resolver/registry/registry.go b/pkg/plugin/discovery/resolver/registry/registry.go index 68eb4e20..85faccf1 100644 --- a/pkg/plugin/discovery/resolver/registry/registry.go +++ b/pkg/plugin/discovery/resolver/registry/registry.go @@ -17,7 +17,7 @@ func NewResolver() *Resolver { return &Resolver{} } -func (r *Resolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver.PluginDownloadInfo, error) { +func (r *Resolver) ResolvePlugin(pluginInfo *plugin.Info) (*resolver.PluginDownloadInfo, error) { pluginAPIRes, err := getPluginInfo(pluginInfo.NormalizedName) if err != nil { return nil, err diff --git a/pkg/plugin/discovery/resolver/resolver.go b/pkg/plugin/discovery/resolver/resolver.go index 891b9fab..947f8f1e 100644 --- a/pkg/plugin/discovery/resolver/resolver.go +++ b/pkg/plugin/discovery/resolver/resolver.go @@ -10,6 +10,6 @@ type PluginDownloadInfo struct { } type Resolver interface { - ResolvePlugin(*plugin.PluginInfo) (*PluginDownloadInfo, error) + ResolvePlugin(*plugin.Info) (*PluginDownloadInfo, error) Names() []string } diff --git a/pkg/plugin/plugin.go b/pkg/plugin/plugin.go index 750051df..5f67bd01 100644 --- a/pkg/plugin/plugin.go +++ b/pkg/plugin/plugin.go @@ -13,7 +13,7 @@ import ( "github.com/go-semantic-release/semantic-release/v2/pkg/updater" ) -type PluginInfo struct { +type Info struct { Type string Name string NormalizedName string @@ -45,7 +45,7 @@ func normalizedPluginType(t string) string { var nameNormalizer = strings.NewReplacer(":", "-", "/", "-") -func GetPluginInfo(pluginType, pluginName string) (*PluginInfo, error) { +func GetPluginInfo(pluginType, pluginName string) (*Info, error) { nPluginType := normalizedPluginType(pluginType) if nPluginType == "" { return nil, fmt.Errorf("invalid plugin type: %s", pluginType) @@ -96,7 +96,7 @@ func GetPluginInfo(pluginType, pluginName string) (*PluginInfo, error) { normalizedName = strings.Join(normalizedParts[:len(normalizedParts)-1], "@") } - return &PluginInfo{ + return &Info{ Type: pluginType, Name: name, NormalizedName: normalizedName, diff --git a/pkg/plugin/plugin_test.go b/pkg/plugin/plugin_test.go index f591f883..97a98e22 100644 --- a/pkg/plugin/plugin_test.go +++ b/pkg/plugin/plugin_test.go @@ -17,16 +17,16 @@ func TestGetPluginInfo(t *testing.T) { testCases := []struct { t string input string - results *PluginInfo + results *Info }{ - {"provider", "git", &PluginInfo{ + {"provider", "git", &Info{ Type: "provider", Name: "git", NormalizedName: "provider-git", ShortNormalizedName: "provider-git", Resolver: "default", }}, - {"provider", "github:myorg/myplugin", &PluginInfo{ + {"provider", "github:myorg/myplugin", &Info{ Type: "provider", Name: "myplugin", NormalizedName: "provider-github-myorg-myplugin", @@ -34,7 +34,7 @@ func TestGetPluginInfo(t *testing.T) { Resolver: "github", RepoSlug: "myorg/myplugin", }}, - {"ci_condition", "github:myorg/myplugin", &PluginInfo{ + {"ci_condition", "github:myorg/myplugin", &Info{ Type: "ci_condition", Name: "myplugin", NormalizedName: "condition-github-myorg-myplugin", @@ -42,7 +42,7 @@ func TestGetPluginInfo(t *testing.T) { Resolver: "github", RepoSlug: "myorg/myplugin", }}, - {"provider", "github:myorg/myplugin@^1.0.0", &PluginInfo{ + {"provider", "github:myorg/myplugin@^1.0.0", &Info{ Type: "provider", Name: "myplugin", NormalizedName: "provider-github-myorg-myplugin", @@ -51,7 +51,7 @@ func TestGetPluginInfo(t *testing.T) { RepoSlug: "myorg/myplugin", Constraint: parseConstraint("^1.0.0"), }}, - {"provider", "git@2.0.0", &PluginInfo{ + {"provider", "git@2.0.0", &Info{ Type: "provider", Name: "git", NormalizedName: "provider-git", @@ -59,14 +59,14 @@ func TestGetPluginInfo(t *testing.T) { Resolver: "default", Constraint: parseConstraint("2.0.0"), }}, - {"hooks", "registry:logger", &PluginInfo{ + {"hooks", "registry:logger", &Info{ Type: "hooks", Name: "logger", NormalizedName: "hooks-registry-logger", ShortNormalizedName: "hooks-logger", Resolver: "registry", }}, - {"hooks", "myresolver:@myorg/myplugin", &PluginInfo{ + {"hooks", "myresolver:@myorg/myplugin", &Info{ Type: "hooks", Name: "myplugin", NormalizedName: "hooks-myresolver-@myorg-myplugin", @@ -74,7 +74,7 @@ func TestGetPluginInfo(t *testing.T) { Resolver: "myresolver", RepoSlug: "@myorg/myplugin", }}, - {"hooks", "myresolver:@myorg/myplugin@1.2.3", &PluginInfo{ + {"hooks", "myresolver:@myorg/myplugin@1.2.3", &Info{ Type: "hooks", Name: "myplugin", NormalizedName: "hooks-myresolver-@myorg-myplugin", diff --git a/pkg/semrel/semrel.go b/pkg/semrel/semrel.go index 99663718..e89d99cf 100644 --- a/pkg/semrel/semrel.go +++ b/pkg/semrel/semrel.go @@ -22,7 +22,8 @@ func calculateChange(commits []*Commit, latestRelease *Release) *Change { return change } -func applyChange(rawVersion string, rawChange *Change, allowInitialDevelopmentVersions bool, forceBumpPatchVersion bool) string { +//gocyclo:ignore +func applyChange(rawVersion string, rawChange *Change, allowInitialDevelopmentVersions, forceBumpPatchVersion bool) string { version := semver.MustParse(rawVersion) change := &Change{ Major: rawChange.Major,