Refactor gitlab to generic remotes

This commit is contained in:
Ryan McGuire 2024-01-15 15:39:35 -05:00
parent da209c53e3
commit d6833a9ea0
21 changed files with 208 additions and 172 deletions

View File

@ -7,8 +7,8 @@ import (
"github.com/pterm/pterm" "github.com/pterm/pterm"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/viper" "github.com/spf13/viper"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/projects" cacheProjects "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/projects"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
var aliasAddCmd = &cobra.Command{ var aliasAddCmd = &cobra.Command{
@ -21,7 +21,7 @@ var aliasAddCmd = &cobra.Command{
} }
func runAddAliasCmd(cmd *cobra.Command, args []string) { func runAddAliasCmd(cmd *cobra.Command, args []string) {
var project *remotes.Project var project *projects.Project
// Check by flag // Check by flag
if projectID := viper.GetInt("alias.add.projectid"); projectID > 0 { if projectID := viper.GetInt("alias.add.projectid"); projectID > 0 {
@ -76,12 +76,12 @@ func addNewAliases(projectID int) {
} }
} }
func promptAliasesForProject(p *remotes.Project) []string { func promptAliasesForProject(p *projects.Project) []string {
aliases := cache.GetProjectAliases(p) aliases := cache.GetProjectAliases(p)
if len(aliases) > 0 { if len(aliases) > 0 {
plog.Info("Adding aliases to project", plog.Args( plog.Info("Adding aliases to project", plog.Args(
"project", p.String(), "project", p.String(),
"existingAliases", projects.ProjectAliasesString(aliases), "existingAliases", cacheProjects.ProjectAliasesString(aliases),
)) ))
} else { } else {
pterm.Info.Printfln("Adding aliases to %s", p.Name) pterm.Info.Printfln("Adding aliases to %s", p.Name)

View File

@ -6,7 +6,7 @@ import (
"github.com/pterm/pterm" "github.com/pterm/pterm"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/viper" "github.com/spf13/viper"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
var aliasDeleteCmd = &cobra.Command{ var aliasDeleteCmd = &cobra.Command{
@ -19,7 +19,7 @@ var aliasDeleteCmd = &cobra.Command{
} }
func runDeleteAliasCmd(cmd *cobra.Command, args []string) { func runDeleteAliasCmd(cmd *cobra.Command, args []string) {
var project *remotes.Project var project *projects.Project
var err error var err error
fzfOpts := &fzfProjectOpts{ fzfOpts := &fzfProjectOpts{

View File

@ -3,8 +3,8 @@ package cmd
import ( import (
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/viper" "github.com/spf13/viper"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/projects" cacheProjects "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/projects"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
var projectCmd = &cobra.Command{ var projectCmd = &cobra.Command{
@ -19,7 +19,7 @@ var projectCmd = &cobra.Command{
// Run: projectGoCmdRun, // Run: projectGoCmdRun,
} }
func getProject(args []string) *remotes.Project { func getProject(args []string) *projects.Project {
gitlabs := viper.GetStringSlice("project.gitlabs") gitlabs := viper.GetStringSlice("project.gitlabs")
fzfOpts := &fzfProjectOpts{ fzfOpts := &fzfProjectOpts{
Ctx: rootCmd.Context(), Ctx: rootCmd.Context(),
@ -33,7 +33,7 @@ func getProject(args []string) *remotes.Project {
} else { } else {
plog.Debug("Houston, we have a project", plog.Args( plog.Debug("Houston, we have a project", plog.Args(
"project", project.String(), "project", project.String(),
"aliases", projects.ProjectAliasesString( "aliases", cacheProjects.ProjectAliasesString(
cache.GetProjectAliases(project)), cache.GetProjectAliases(project)),
)) ))
} }

View File

@ -7,7 +7,7 @@ import (
"github.com/pterm/pterm" "github.com/pterm/pterm"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/viper" "github.com/spf13/viper"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
var projectShowCmd = &cobra.Command{ var projectShowCmd = &cobra.Command{
@ -20,7 +20,7 @@ var projectShowCmd = &cobra.Command{
} }
func projectShowCmdRun(cmd *cobra.Command, args []string) { func projectShowCmdRun(cmd *cobra.Command, args []string) {
var project *remotes.Project var project *projects.Project
var inCwd bool var inCwd bool
gitlabs := viper.GetStringSlice("project.gitlabs") gitlabs := viper.GetStringSlice("project.gitlabs")

View File

@ -4,8 +4,8 @@ import (
"context" "context"
fzf "github.com/ktr0731/go-fuzzyfinder" fzf "github.com/ktr0731/go-fuzzyfinder"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/projects" cacheProjects "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/projects"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
@ -18,8 +18,8 @@ type fzfProjectOpts struct {
// This will try to find a project by alias if a search term // This will try to find a project by alias if a search term
// is given, otherwise will fuzzy find by project // is given, otherwise will fuzzy find by project
func fzfFindProject(opts *fzfProjectOpts) *remotes.Project { func fzfFindProject(opts *fzfProjectOpts) *projects.Project {
var project *remotes.Project var project *projects.Project
if opts.Search != "" { if opts.Search != "" {
project = fzfSearchProjectAliases(opts) project = fzfSearchProjectAliases(opts)
@ -37,8 +37,8 @@ func fzfFindProject(opts *fzfProjectOpts) *remotes.Project {
// If . is given as a project, will open project from the // If . is given as a project, will open project from the
// current working directory. Otherwise, will attempt to fuzzy-find // current working directory. Otherwise, will attempt to fuzzy-find
// a project given a search term if provided // a project given a search term if provided
func fzfCwdOrSearchProjectAliases(opts *fzfProjectOpts) *remotes.Project { func fzfCwdOrSearchProjectAliases(opts *fzfProjectOpts) *projects.Project {
var project *remotes.Project var project *projects.Project
if opts.Search == "." { if opts.Search == "." {
project, _ = cache.GetProjectFromCwd() project, _ = cache.GetProjectFromCwd()
} else { } else {
@ -49,9 +49,9 @@ func fzfCwdOrSearchProjectAliases(opts *fzfProjectOpts) *remotes.Project {
// This will fuzzy search only aliases, preferring an exact // This will fuzzy search only aliases, preferring an exact
// match if one is given // match if one is given
func fzfSearchProjectAliases(opts *fzfProjectOpts) *remotes.Project { func fzfSearchProjectAliases(opts *fzfProjectOpts) *projects.Project {
var project *remotes.Project var project *projects.Project
var alias *projects.ProjectAlias var alias *cacheProjects.ProjectAlias
if alias = cache.GetAliasByName(opts.Search, opts.Gitlabs...); alias != nil { if alias = cache.GetAliasByName(opts.Search, opts.Gitlabs...); alias != nil {
project = cache.GetProjectByAlias(alias) project = cache.GetProjectByAlias(alias)
plog.Info("Perfect alias match... flawless") plog.Info("Perfect alias match... flawless")
@ -75,8 +75,8 @@ func fzfSearchProjectAliases(opts *fzfProjectOpts) *remotes.Project {
// a single one. Replaced by fzfProjectFromAliases in fzfSearchProjectAliases // a single one. Replaced by fzfProjectFromAliases in fzfSearchProjectAliases
// as merging is preferred, but can be used if it's ever desirable to // as merging is preferred, but can be used if it's ever desirable to
// return a single alias from all aliases // return a single alias from all aliases
func fzfAliasFromAliases(opts *fzfProjectOpts, aliases []*projects.ProjectAlias) *projects.ProjectAlias { func fzfAliasFromAliases(opts *fzfProjectOpts, aliases []*cacheProjects.ProjectAlias) *cacheProjects.ProjectAlias {
var alias *projects.ProjectAlias var alias *cacheProjects.ProjectAlias
i, err := fzf.Find( i, err := fzf.Find(
aliases, aliases,
func(i int) string { func(i int) string {
@ -95,8 +95,8 @@ func fzfAliasFromAliases(opts *fzfProjectOpts, aliases []*projects.ProjectAlias)
// Given a list of aliases, merge them together and use the resulting // Given a list of aliases, merge them together and use the resulting
// list of projects to return a project // list of projects to return a project
func fzfProjectFromAliases(opts *fzfProjectOpts, aliases []*projects.ProjectAlias) ( func fzfProjectFromAliases(opts *fzfProjectOpts, aliases []*cacheProjects.ProjectAlias) (
*remotes.Project, error) { *projects.Project, error) {
mergedProjects := projectsFromAliases(aliases) mergedProjects := projectsFromAliases(aliases)
if len(mergedProjects) == 1 { if len(mergedProjects) == 1 {
return mergedProjects[0], nil return mergedProjects[0], nil
@ -104,8 +104,8 @@ func fzfProjectFromAliases(opts *fzfProjectOpts, aliases []*projects.ProjectAlia
return fzfProjectFromProjects(opts, mergedProjects) return fzfProjectFromProjects(opts, mergedProjects)
} }
func projectsFromAliases(aliases []*projects.ProjectAlias) []*remotes.Project { func projectsFromAliases(aliases []*cacheProjects.ProjectAlias) []*projects.Project {
projects := make([]*remotes.Project, 0) projects := make([]*projects.Project, 0)
ALIASES: ALIASES:
for _, a := range aliases { for _, a := range aliases {
@ -123,8 +123,8 @@ ALIASES:
// If opts.MustHaveAlias, will only allow selection of projects // If opts.MustHaveAlias, will only allow selection of projects
// that have at least one alias defined // that have at least one alias defined
func fzfProject(opts *fzfProjectOpts) (*remotes.Project, error) { func fzfProject(opts *fzfProjectOpts) (*projects.Project, error) {
var searchableProjects []*remotes.Project var searchableProjects []*projects.Project
if opts.MustHaveAlias { if opts.MustHaveAlias {
searchableProjects = cache.GetProjectsWithAliases() searchableProjects = cache.GetProjectsWithAliases()
} else { } else {
@ -136,8 +136,8 @@ func fzfProject(opts *fzfProjectOpts) (*remotes.Project, error) {
} }
// Takes a list of projects and performs a fuzzyfind // Takes a list of projects and performs a fuzzyfind
func fzfProjectFromProjects(opts *fzfProjectOpts, projects []*remotes.Project) ( func fzfProjectFromProjects(opts *fzfProjectOpts, projects []*projects.Project) (
*remotes.Project, error) { *projects.Project, error) {
i, err := fzf.Find(projects, i, err := fzf.Find(projects,
func(i int) string { func(i int) string {
// Display the project along with its aliases // Display the project along with its aliases
@ -162,16 +162,16 @@ func fzfPreviewWindow(i, w, h int) string {
return cache.ProjectString(p) return cache.ProjectString(p)
} }
func filterProjectsWithGitlabs(projects []*remotes.Project, gitlabs ...string) []*remotes.Project { func filterProjectsWithGitlabs(gitProjects []*projects.Project, gitlabs ...string) []*projects.Project {
filteredProjects := make([]*remotes.Project, 0, len(projects)) filteredProjects := make([]*projects.Project, 0, len(gitProjects))
if len(gitlabs) > 0 { if len(gitlabs) > 0 {
for _, p := range projects { for _, p := range gitProjects {
if slices.Contains(gitlabs, p.Remote) { if slices.Contains(gitlabs, p.Remote) {
filteredProjects = append(filteredProjects, p) filteredProjects = append(filteredProjects, p)
} }
} }
} else { } else {
filteredProjects = projects filteredProjects = gitProjects
} }
return filteredProjects return filteredProjects
} }

View File

@ -9,11 +9,12 @@ import (
"github.com/pterm/pterm" "github.com/pterm/pterm"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/config" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/config"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
"gopkg.in/yaml.v3" "gopkg.in/yaml.v3"
) )
type Cache struct { type Cache struct {
Projects []*remotes.Project Projects []*projects.Project
Aliases []*ProjectAlias Aliases []*ProjectAlias
Updated time.Time Updated time.Time
config *config.Config config *config.Config
@ -124,7 +125,7 @@ func (c *Cache) Read() error {
// project aliase cache. Writes to disk. // project aliase cache. Writes to disk.
func (c *Cache) clear(clearAliases bool) { func (c *Cache) clear(clearAliases bool) {
c.log.Info("Clearing project cache") c.log.Info("Clearing project cache")
c.Projects = make([]*remotes.Project, 0) c.Projects = make([]*projects.Project, 0)
if clearAliases { if clearAliases {
c.log.Info("Clearing project alias cache") c.log.Info("Clearing project alias cache")
c.Aliases = make([]*ProjectAlias, 0) c.Aliases = make([]*ProjectAlias, 0)
@ -201,7 +202,7 @@ func NewProjectCache(opts *CacheOpts) (*Cache, error) {
} }
cache := &Cache{ cache := &Cache{
Projects: make([]*remotes.Project, 0), Projects: make([]*projects.Project, 0),
Aliases: make([]*ProjectAlias, 0), Aliases: make([]*ProjectAlias, 0),
config: opts.Config, config: opts.Config,
file: opts.Path, file: opts.Path,

View File

@ -3,7 +3,7 @@ package projects
import ( import (
"errors" "errors"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
@ -42,8 +42,8 @@ func (c *Cache) AddAlias(alias string, projectID int, remote string) error {
return c.addAlias(alias, projectID, remote) return c.addAlias(alias, projectID, remote)
} }
func (c *Cache) GetProjectsWithAliases() []*remotes.Project { func (c *Cache) GetProjectsWithAliases() []*projects.Project {
projectList := make([]*remotes.Project, 0) projectList := make([]*projects.Project, 0)
projectsFound := make([]int, 0) projectsFound := make([]int, 0)
for _, a := range c.Aliases { for _, a := range c.Aliases {
if !slices.Contains(projectsFound, a.ProjectID) { if !slices.Contains(projectsFound, a.ProjectID) {

View File

@ -4,15 +4,15 @@ import (
"strings" "strings"
"github.com/pterm/pterm" "github.com/pterm/pterm"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
func (c *Cache) AddProjects(projects ...*remotes.Project) { func (c *Cache) AddProjects(gitProjects ...*projects.Project) {
c.contentLock.Lock() c.contentLock.Lock()
defer c.contentLock.Unlock() defer c.contentLock.Unlock()
for _, p := range projects { for _, p := range gitProjects {
var existing *remotes.Project var existing *projects.Project
sameID := c.GetProjectsByID(p.ID) sameID := c.GetProjectsByID(p.ID)
// If there is only one by ID, we don't // If there is only one by ID, we don't

View File

@ -4,7 +4,7 @@ import (
"strings" "strings"
"github.com/lithammer/fuzzysearch/fuzzy" "github.com/lithammer/fuzzysearch/fuzzy"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
// Performs a fuzzy find on the input string, returning the closest // Performs a fuzzy find on the input string, returning the closest
@ -39,8 +39,8 @@ func (c *Cache) FuzzyFindAlias(name string) []*ProjectAlias {
// Returns all matching projects by fuzzy find term // Returns all matching projects by fuzzy find term
// Matches NameWithNamespace and Aliases // Matches NameWithNamespace and Aliases
func (c *Cache) FuzzyFindProjects(search string) []*remotes.Project { func (c *Cache) FuzzyFindProjects(search string) []*projects.Project {
projects := make([]*remotes.Project, 0, len(c.Projects)) projects := make([]*projects.Project, 0, len(c.Projects))
for _, p := range c.Projects { for _, p := range c.Projects {
if fuzzy.MatchFold(search, p.NameWithNamespace) { if fuzzy.MatchFold(search, p.NameWithNamespace) {
projects = append(projects, p) projects = append(projects, p)

View File

@ -4,11 +4,11 @@ import (
"strings" "strings"
"github.com/pterm/pterm" "github.com/pterm/pterm"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
func (c *Cache) ProjectString(p *remotes.Project) string { func (c *Cache) ProjectString(p *projects.Project) string {
info := strings.Builder{} info := strings.Builder{}
info.WriteString(pterm.LightGreen("\n--------------\n")) info.WriteString(pterm.LightGreen("\n--------------\n"))
@ -42,7 +42,7 @@ func (c *Cache) ProjectStrings(prefix string) []string {
return slices.Clip(projects) return slices.Clip(projects)
} }
func (c *Cache) GetProjectByPath(path string) *remotes.Project { func (c *Cache) GetProjectByPath(path string) *projects.Project {
for _, p := range c.Projects { for _, p := range c.Projects {
if p.PathWithNamespace == path { if p.PathWithNamespace == path {
return p return p
@ -51,7 +51,7 @@ func (c *Cache) GetProjectByPath(path string) *remotes.Project {
return nil return nil
} }
func (c *Cache) GetProjectByRemoteAndId(remote string, id int) *remotes.Project { func (c *Cache) GetProjectByRemoteAndId(remote string, id int) *projects.Project {
for _, p := range c.Projects { for _, p := range c.Projects {
if p.ID == id && p.Remote == remote { if p.ID == id && p.Remote == remote {
return p return p
@ -60,7 +60,7 @@ func (c *Cache) GetProjectByRemoteAndId(remote string, id int) *remotes.Project
return nil return nil
} }
func (c *Cache) GetProjectByID(id int) *remotes.Project { func (c *Cache) GetProjectByID(id int) *projects.Project {
for _, p := range c.Projects { for _, p := range c.Projects {
if p.ID == id { if p.ID == id {
return p return p
@ -72,8 +72,8 @@ func (c *Cache) GetProjectByID(id int) *remotes.Project {
// Plural form of GetProjectByID // Plural form of GetProjectByID
// Since multiple remotes may have the same project ID, // Since multiple remotes may have the same project ID,
// this will return all matching // this will return all matching
func (c *Cache) GetProjectsByID(id int) []*remotes.Project { func (c *Cache) GetProjectsByID(id int) []*projects.Project {
projects := make([]*remotes.Project, 0) projects := make([]*projects.Project, 0)
for _, p := range c.Projects { for _, p := range c.Projects {
if p.ID == id { if p.ID == id {
projects = append(projects, p) projects = append(projects, p)

View File

@ -7,7 +7,7 @@ import (
"text/tabwriter" "text/tabwriter"
"github.com/pterm/pterm" "github.com/pterm/pterm"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
"golang.org/x/exp/slices" "golang.org/x/exp/slices"
) )
@ -17,7 +17,7 @@ type ProjectAlias struct {
Remote string Remote string
} }
func (c *Cache) GetProjectAliasStrings(project *remotes.Project) []string { func (c *Cache) GetProjectAliasStrings(project *projects.Project) []string {
aliases := c.GetProjectAliases(project) aliases := c.GetProjectAliases(project)
strings := make([]string, len(aliases)) strings := make([]string, len(aliases))
for i, a := range c.GetProjectAliases(project) { for i, a := range c.GetProjectAliases(project) {
@ -26,7 +26,7 @@ func (c *Cache) GetProjectAliasStrings(project *remotes.Project) []string {
return strings return strings
} }
func (c *Cache) GetProjectStringWithAliases(project *remotes.Project) string { func (c *Cache) GetProjectStringWithAliases(project *projects.Project) string {
aliases := c.GetProjectAliasStrings(project) aliases := c.GetProjectAliasStrings(project)
return fmt.Sprintf("%s (%s) -> %s", return fmt.Sprintf("%s (%s) -> %s",
project.Name, project.Name,
@ -83,7 +83,7 @@ func (c *Cache) GetAliasByName(name string, gitlabs ...string) *ProjectAlias {
return nil return nil
} }
func (c *Cache) GetProjectByAlias(alias *ProjectAlias) *remotes.Project { func (c *Cache) GetProjectByAlias(alias *ProjectAlias) *projects.Project {
if alias == nil { if alias == nil {
return nil return nil
} }
@ -95,7 +95,7 @@ func (c *Cache) GetProjectByAlias(alias *ProjectAlias) *remotes.Project {
return nil return nil
} }
func (c *Cache) GetProjectAliases(project *remotes.Project) []*ProjectAlias { func (c *Cache) GetProjectAliases(project *projects.Project) []*ProjectAlias {
aliases := make([]*ProjectAlias, 0) aliases := make([]*ProjectAlias, 0)
for _, alias := range c.Aliases { for _, alias := range c.Aliases {
if alias.ProjectID == project.ID { if alias.ProjectID == project.ID {

View File

@ -6,10 +6,10 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
func (c *Cache) GoTo(project *remotes.Project) { func (c *Cache) GoTo(project *projects.Project) {
pPath := c.GetProjectPath(project) pPath := c.GetProjectPath(project)
c.log.Debug("Going to project", c.log.Args( c.log.Debug("Going to project", c.log.Args(
@ -25,8 +25,8 @@ func (c *Cache) GoTo(project *remotes.Project) {
os.Chdir(filepath.Dir(pPath)) os.Chdir(filepath.Dir(pPath))
} }
func (c *Cache) GetProjectFromCwd() (*remotes.Project, error) { func (c *Cache) GetProjectFromCwd() (*projects.Project, error) {
var project *remotes.Project var project *projects.Project
cwd, err := os.Getwd() cwd, err := os.Getwd()
if err != nil { if err != nil {
@ -46,7 +46,7 @@ func (c *Cache) GetProjectFromCwd() (*remotes.Project, error) {
return project, nil return project, nil
} }
func (c *Cache) IsProjectCloned(p *remotes.Project) bool { func (c *Cache) IsProjectCloned(p *projects.Project) bool {
_, err := os.Stat(c.GetProjectPath(p) + "/.git") _, err := os.Stat(c.GetProjectPath(p) + "/.git")
if err == nil { if err == nil {
return true return true
@ -63,6 +63,6 @@ func (c *Cache) PrepProjectPath(path string) {
} }
} }
func (c *Cache) GetProjectPath(p *remotes.Project) string { func (c *Cache) GetProjectPath(p *projects.Project) string {
return c.path + "/" + p.SanitizedPath() return c.path + "/" + p.SanitizedPath()
} }

View File

@ -5,7 +5,7 @@ import (
"time" "time"
git "github.com/go-git/go-git/v5" git "github.com/go-git/go-git/v5"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes" "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
const gitCloneTimeoutSecs = 30 const gitCloneTimeoutSecs = 30
@ -13,7 +13,7 @@ const gitCloneTimeoutSecs = 30
// Will either read in the current repo, preparing a report // Will either read in the current repo, preparing a report
// on its current state, or will clone the project if it has not // on its current state, or will clone the project if it has not
// already been cloned in its path // already been cloned in its path
func (c *Cache) OpenProject(ctx context.Context, project *remotes.Project) *git.Repository { func (c *Cache) OpenProject(ctx context.Context, project *projects.Project) *git.Repository {
path := c.GetProjectPath(project) path := c.GetProjectPath(project)
cloneCtx, cncl := context.WithDeadline(ctx, time.Now().Add(gitCloneTimeoutSecs*time.Second)) cloneCtx, cncl := context.WithDeadline(ctx, time.Now().Add(gitCloneTimeoutSecs*time.Second))
defer cncl() defer cncl()
@ -31,7 +31,7 @@ func (c *Cache) OpenProject(ctx context.Context, project *remotes.Project) *git.
// Check to make sure we can connect before we time out // Check to make sure we can connect before we time out
// shouldn't be necessary, but go-git does not properly // shouldn't be necessary, but go-git does not properly
// honor its context // honor its context
if err := project.CheckHost(remotes.GitlabProtoSSH); err != nil { if err := project.CheckHost(projects.GitlabProtoSSH); err != nil {
c.log.Fatal("Git remote unreachable, giving up", c.log.Args("error", err)) c.log.Fatal("Git remote unreachable, giving up", c.log.Args("error", err))
} }

View File

@ -0,0 +1,20 @@
package load
import (
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
)
type ProgressInfo struct {
ProgressChan chan Progress
ProjectsChan chan []*projects.Project
ErrorChan chan error
DoneChan chan interface{}
NumProjects int
}
type Progress struct {
Page int
Pages int
Projects int
TotalProjects int
}

View File

@ -0,0 +1,72 @@
package projects
import (
"fmt"
"strings"
"time"
"github.com/go-git/go-git/v5"
)
type Project struct {
ID int
Description string
SSHURLToRepo string
HTTPURLToRepo string
WebURL string
Name string
NameWithNamespace string
Path string
PathWithNamespace string
AvatarURL string
LastActivityAt time.Time
Readme string
Remote string
Owner string
Languages *ProjectLanguages
gitRepo *git.Repository
}
type ProjectLanguages []*ProjectLanguage
type ProjectLanguage struct {
Name string
Percentage float32
}
func (p *Project) String() string {
var projectString string
if p != nil {
projectString = fmt.Sprintf("%s (%s)", p.Path, p.PathWithNamespace)
}
return projectString
}
func (p *Project) GetLanguage() *ProjectLanguage {
if p.Languages == nil {
return nil
}
var lang *ProjectLanguage
var maxPcnt float32
for _, p := range *p.Languages {
if p.Percentage > maxPcnt {
lang = p
}
maxPcnt = p.Percentage
}
return lang
}
func (p *Project) SanitizedPath() string {
return strings.Trim(p.PathWithNamespace, " '\"%<>|`")
}
func (p *Project) SetRepo(r *git.Repository) {
p.gitRepo = r
}
func (p *Project) GetRepo() *git.Repository {
return p.gitRepo
}

View File

@ -1,4 +1,4 @@
package remotes package projects
import "github.com/pterm/pterm" import "github.com/pterm/pterm"

View File

@ -1,4 +1,4 @@
package remotes package projects
import ( import (
"errors" "errors"

View File

@ -0,0 +1,13 @@
package remote
import "gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/load"
// Any remote needs to be able to return
// the number of projects the user has access to and also
// stream all projects along with updates to channels
// provided by *load.ProgressInfo
type Remote interface {
Name() string
GetNumProjects(*RemoteQueryOpts) int
StreamProjects(*RemoteQueryOpts) *load.ProgressInfo
}

View File

@ -0,0 +1,8 @@
package remote
import "context"
type RemoteQueryOpts struct {
Ctx context.Context
OwnerOnly bool
}

View File

@ -1,13 +1,9 @@
package remotes package remotes
import ( import (
"fmt"
"strings"
"time"
"github.com/go-git/go-git/v5"
"github.com/pterm/pterm" "github.com/pterm/pterm"
"github.com/xanzy/go-gitlab" "github.com/xanzy/go-gitlab"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
// Will determine number of total projects, // Will determine number of total projects,
@ -19,32 +15,6 @@ const (
projectsPerGoroutine = 200 projectsPerGoroutine = 200
) )
type Project struct {
ID int
Description string
SSHURLToRepo string
HTTPURLToRepo string
WebURL string
Name string
NameWithNamespace string
Path string
PathWithNamespace string
AvatarURL string
LastActivityAt time.Time
Readme string
Remote string
Owner string
Languages *ProjectLanguages
gitRepo *git.Repository
}
type ProjectLanguages []*ProjectLanguage
type ProjectLanguage struct {
Name string
Percentage float32
}
type User struct { type User struct {
ID int ID int
Username string Username string
@ -57,43 +27,6 @@ func (c *Client) Api() *gitlab.Client {
return c.apiClient return c.apiClient
} }
func (p *Project) String() string {
var projectString string
if p != nil {
projectString = fmt.Sprintf("%s (%s)", p.Path, p.PathWithNamespace)
}
return projectString
}
func (p *Project) GetLanguage() *ProjectLanguage {
if p.Languages == nil {
return nil
}
var lang *ProjectLanguage
var maxPcnt float32
for _, p := range *p.Languages {
if p.Percentage > maxPcnt {
lang = p
}
maxPcnt = p.Percentage
}
return lang
}
func (p *Project) SanitizedPath() string {
return strings.Trim(p.PathWithNamespace, " '\"%<>|`")
}
func (p *Project) SetRepo(r *git.Repository) {
p.gitRepo = r
}
func (p *Project) GetRepo() *git.Repository {
return p.gitRepo
}
func (c *Client) GetTotalProjects(opts *gitlab.ListProjectsOptions) int { func (c *Client) GetTotalProjects(opts *gitlab.ListProjectsOptions) int {
reqOpts := *opts reqOpts := *opts
reqOpts.ListOptions = gitlab.ListOptions{ reqOpts.ListOptions = gitlab.ListOptions{
@ -112,8 +45,8 @@ func (c *Client) GetTotalProjects(opts *gitlab.ListProjectsOptions) int {
// Returns a list of projects along with the next page and an error // Returns a list of projects along with the next page and an error
// if there was an error // if there was an error
func (c *Client) ListProjects(opts *gitlab.ListProjectsOptions) ( func (c *Client) ListProjects(opts *gitlab.ListProjectsOptions) (
[]*Project, *gitlab.Response, error) { []*projects.Project, *gitlab.Response, error) {
pList := make([]*Project, 0) pList := make([]*projects.Project, 0)
projects, resp, err := c.apiClient.Projects.ListProjects( projects, resp, err := c.apiClient.Projects.ListProjects(
opts, opts,
gitlab.WithContext(c.Ctx), gitlab.WithContext(c.Ctx),
@ -126,19 +59,19 @@ func (c *Client) ListProjects(opts *gitlab.ListProjectsOptions) (
// A nil return indicates an API error or GitLab doesn't know what // A nil return indicates an API error or GitLab doesn't know what
// language the project uses. // language the project uses.
func (c *Client) GetProjectLanguages(project *gitlab.Project) *ProjectLanguages { func (c *Client) GetProjectLanguages(project *gitlab.Project) *projects.ProjectLanguages {
l, _, e := c.apiClient.Projects.GetProjectLanguages(project.ID, gitlab.WithContext(c.Ctx)) l, _, e := c.apiClient.Projects.GetProjectLanguages(project.ID, gitlab.WithContext(c.Ctx))
if e != nil { if e != nil {
pterm.Error.Printfln("Failed requesting project languages: %s", e.Error()) pterm.Error.Printfln("Failed requesting project languages: %s", e.Error())
return nil return nil
} }
var pLangs ProjectLanguages var pLangs projects.ProjectLanguages
pLangs = make([]*ProjectLanguage, len(*l)) pLangs = make([]*projects.ProjectLanguage, len(*l))
var i int var i int
for name, pcnt := range *l { for name, pcnt := range *l {
pLangs[i] = &ProjectLanguage{ pLangs[i] = &projects.ProjectLanguage{
Name: name, Name: name,
Percentage: pcnt, Percentage: pcnt,
} }

View File

@ -1,26 +1,14 @@
package remotes package remotes
import ( import (
"fmt"
"sync" "sync"
"github.com/xanzy/go-gitlab" "github.com/xanzy/go-gitlab"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/load"
"gitlab.sweetwater.com/it/devops/tools/gitlab-project-manager/internal/remotes/projects"
) )
type ProgressInfo struct {
ProgressChan chan Progress
ProjectsChan chan []*Project
ErrorChan chan error
DoneChan chan interface{}
NumProjects int
}
type Progress struct {
Page int
Pages int
Projects int
TotalProjects int
}
var DefaultListOpts = &gitlab.ListProjectsOptions{ var DefaultListOpts = &gitlab.ListProjectsOptions{
ListOptions: gitlab.ListOptions{ ListOptions: gitlab.ListOptions{
PerPage: projectsPerPage, PerPage: projectsPerPage,
@ -33,13 +21,14 @@ var DefaultListOpts = &gitlab.ListProjectsOptions{
// channels that stream progress info and then finally the full // channels that stream progress info and then finally the full
// list of projects on separate channels. If ownerOnly=true, only // list of projects on separate channels. If ownerOnly=true, only
// projects for which you are an owner will be loaded // projects for which you are an owner will be loaded
func (c *Client) StreamProjects(ownerOnly bool, projects int) *ProgressInfo { func (c *Client) StreamProjects(ownerOnly bool, numProjects int) *load.ProgressInfo {
pi := &ProgressInfo{ fmt.Println(numProjects)
ProgressChan: make(chan Progress), pi := &load.ProgressInfo{
ProjectsChan: make(chan []*Project), ProgressChan: make(chan load.Progress),
ProjectsChan: make(chan []*projects.Project),
ErrorChan: make(chan error), ErrorChan: make(chan error),
DoneChan: make(chan interface{}), DoneChan: make(chan interface{}),
NumProjects: projects, NumProjects: numProjects,
} }
go c.streamProjects(pi, ownerOnly) go c.streamProjects(pi, ownerOnly)
@ -47,7 +36,7 @@ func (c *Client) StreamProjects(ownerOnly bool, projects int) *ProgressInfo {
return pi return pi
} }
func (c *Client) streamProjects(pi *ProgressInfo, ownerOnly bool) { func (c *Client) streamProjects(pi *load.ProgressInfo, ownerOnly bool) {
defer close(pi.ProgressChan) defer close(pi.ProgressChan)
defer close(pi.ProjectsChan) defer close(pi.ProjectsChan)
@ -75,7 +64,7 @@ func (c *Client) streamProjects(pi *ProgressInfo, ownerOnly bool) {
} }
pi.ProjectsChan <- projects pi.ProjectsChan <- projects
pi.ProgressChan <- Progress{ pi.ProgressChan <- load.Progress{
Page: resp.CurrentPage, Page: resp.CurrentPage,
Pages: resp.TotalPages, Pages: resp.TotalPages,
Projects: len(projects), Projects: len(projects),
@ -99,16 +88,16 @@ func (c *Client) streamProjects(pi *ProgressInfo, ownerOnly bool) {
pi.DoneChan <- nil pi.DoneChan <- nil
} }
func (c *Client) handleProjects(projects []*gitlab.Project) []*Project { func (c *Client) handleProjects(gitProjects []*gitlab.Project) []*projects.Project {
// Opportunity to perform any filtering or additional lookups // Opportunity to perform any filtering or additional lookups
// on a per-project basis // on a per-project basis
pList := make([]*Project, 0, len(projects)) pList := make([]*projects.Project, 0, len(gitProjects))
for _, project := range projects { for _, project := range gitProjects {
var owner string var owner string
if project.Owner != nil { if project.Owner != nil {
owner = project.Owner.Email owner = project.Owner.Email
} }
p := &Project{ p := &projects.Project{
ID: project.ID, ID: project.ID,
Description: project.Description, Description: project.Description,
SSHURLToRepo: project.SSHURLToRepo, SSHURLToRepo: project.SSHURLToRepo,