feat: new sync command (#9)

Author: yeqown

cmd/gitlab-flow/commands.go

@@ -93,3 +93,13 @@ func getDashCommand() *cli.Command {
 		Subcommands: getDashSubCommands(),
 	}
 }
+
+// getSyncCommand
+func getSyncCommand() *cli.Command {
+	return &cli.Command{
+		Name:        "sync",
+		Usage:       "synchronize resource from remote gitlab server",
+		Category:    "sync",
+		Subcommands: getSyncSubCommands(),
+	}
+}

cmd/gitlab-flow/commands_feature.go

@@ -17,7 +17,7 @@ func getFeatureSubCommands() cli.Commands {
 		getFeatureTestSubCommand(),
 		getFeatureReleaseSubCommand(),
 		getFeatureResolveConflictCommand(),
-		getSyncMilestoneSubCommand(),
+		// getSyncMilestoneSubCommand(), moved into `sync` commands
 	}
 }
 
@@ -164,32 +164,3 @@ func getFeatureResolveConflictCommand() *cli.Command {
 		},
 	}
 }
-
-// getSyncMilestoneSubCommand
-func getSyncMilestoneSubCommand() *cli.Command {
-	return &cli.Command{
-		Name:      "sync",
-		Usage:     "rebuild local data from remote gitlab repository",
-		ArgsUsage: "",
-		Category:  "feature",
-		Flags: []cli.Flag{
-			&cli.IntFlag{
-				Name:     "milestone_id",
-				Aliases:  []string{"m"},
-				Usage:    "choose milestone manually",
-				Required: false,
-			},
-			&cli.BoolFlag{
-				Name:    "interact",
-				Aliases: []string{"i"},
-				Usage:   "choose milestone in the list load from remote repository",
-				Value:   false,
-			},
-		},
-		Action: func(c *cli.Context) error {
-			milestoneID := c.Int("milestoneID")
-			interact := c.Bool("interact")
-			return getFlow(c).SyncMilestone(milestoneID, interact)
-		},
-	}
-}

cmd/gitlab-flow/commands_sync.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"github.com/urfave/cli/v2"
+)
+
+func getSyncSubCommands() cli.Commands {
+	return cli.Commands{
+		getSyncProjectCommand(),
+		getSyncMilestoneSubCommand(),
+	}
+}
+
+// getSyncProjectCommand synchronize project from remote gitlab server into local database.
+func getSyncProjectCommand() *cli.Command {
+	return &cli.Command{
+		Name:      "project",
+		Usage:     "synchronize project information from remote gitlab server into local database",
+		ArgsUsage: "",
+		Category:  "sync",
+		Flags: []cli.Flag{
+			&cli.BoolFlag{
+				Name:   "sync-project",
+				Value:  true,
+				Hidden: true,
+			},
+		},
+		Action: func(c *cli.Context) error {
+			return getFlow(c).SyncProject()
+		},
+	}
+}
+
+// getSyncMilestoneSubCommand
+func getSyncMilestoneSubCommand() *cli.Command {
+	return &cli.Command{
+		Name:      "milestone",
+		Usage:     "rebuild local features, branches, issues and merges from remote gitlab repository",
+		ArgsUsage: "",
+		Category:  "sync",
+		Flags: []cli.Flag{
+			&cli.IntFlag{
+				Name:     "milestone_id",
+				Aliases:  []string{"m"},
+				Usage:    "choose milestone manually",
+				Required: false,
+			},
+			&cli.BoolFlag{
+				Name:    "interact",
+				Aliases: []string{"i"},
+				Usage:   "choose milestone in the list load from remote repository",
+				Value:   false,
+			},
+		},
+		Action: func(c *cli.Context) error {
+			milestoneID := c.Int("milestoneID")
+			interact := c.Bool("interact")
+			return getFlow(c).SyncMilestone(milestoneID, interact)
+		},
+	}
+}

cmd/gitlab-flow/main.go

@@ -35,5 +35,6 @@ func mountCommands(app *cli.App) {
 		getFeatureCommand(),
 		getHotfixCommand(),
 		getDashCommand(),
+		getSyncCommand(),
 	}
 }

cmd/gitlab-flow/support.go

@@ -77,7 +77,7 @@ func parseGlobalFlags(c *cli.Context) globalFlags {
 		DebugMode:   c.Bool("debug"),
 		ProjectName: c.String("project"),
 		OpenBrowser: c.Bool("web"),
-		ForceRemote: c.Bool("force-remote"),
+		ForceRemote: c.Bool("force-remote") || c.Bool("sync-project"),
 		CWD:         c.String("cwd"),
 	}
 }

internal/flow.go

@@ -45,8 +45,9 @@ type IFlow interface {
 	// HotfixFinish open the WebURL of merge request which is from hotfix branch to types.MasterBranch.
 	HotfixFinish(hotfixBranchName string) error
 
-	// SyncMilestone synchronize remote repository milestone and
-	// related issues / merge requests to local.
+	// SyncProject synchronize project information from remote gitlab server.
+	SyncProject() error
+	// SyncMilestone synchronize remote repository milestone and related issues / merge requests to local.
 	SyncMilestone(milestoneID int, interact bool) error
 }
 

internal/flow_impl.go

@@ -52,7 +52,7 @@ func NewFlow(ctx *types.FlowContext) IFlow {
 		repo:           impl.NewBasedSqlite3(impl.ConnectDB(ctx.ConfPath(), ctx.Conf.DebugMode)),
 	}
 
-	// flowContext with null project information, so we need to fill it.
+	// if flowContext has NONE project information, so we need to fill it.
 	if err := flow.fillContextWithProject(); err != nil {
 		log.
 			Fatalf("could not locate project(%s): %v", ctx.ProjectName(), err)
@@ -609,6 +609,18 @@ func (f flowImpl) SyncMilestone(milestoneID int, interact bool) error {
 	return nil
 }
 
+// SyncProject want to rebuild project manually while project is not exists in local database.
+func (f flowImpl) SyncProject() error {
+	// NewFlow get project information earlier than SyncProject method, so synchronize project only need to
+	// set FlowContext.forceRemote as true which will read project information from remote rather than
+	// load from local database.
+
+	// forceRemote was set by `parseGlobalFlags` function.
+	// lookup parseGlobalFlags for more detail.
+
+	return nil
+}
+
 // syncFormatResultIntoDO rebuild local data from remote gitlab repository.
 // @return issues, mrs, branches, featureBranchName
 func (f flowImpl) syncFormatResultIntoDO(