Merge branch 'master' of github.com:AliceO2Group/Control into feature/OCONF-184-coconut-conf-history-command

Author: graduta

coconut/cmd/template_list.go

@@ -25,8 +25,8 @@
 package cmd
 
 import (
-	"github.com/spf13/cobra"
 	"github.com/AliceO2Group/Control/coconut/control"
+	"github.com/spf13/cobra"
 )
 
 // templateListCmd represents the template list command
@@ -35,10 +35,30 @@ var templateListCmd = &cobra.Command{
 	Aliases: []string{"list", "ls", "l"},
 	Short: "list available workflow templates",
 	Long: `The template list command shows a list of available workflow templates.
-These workflow templates can then be loaded to create an environment.`,
+These workflow templates can then be loaded to create an environment.
+
+` + "`coconut templ list` " + `can be called with 
+1) a combination of the ` + "`--repo` " + `, ` + "`--revision` " + `, ` + "`--all-branches` " + `, ` + "`--all-tags`" + `flags, or with
+2) an argument in the form of [repo-pattern]@[revision-pattern], where the patterns are globbing.`,
+	Example:
+` * ` + "`coconut templ list`" + ` lists templates from the HEAD of master for all git repositories
+ * ` + "`coconut templ list *AliceO2Group*`" + ` lists all templates coming from the HEAD of master of git repositories that match the pattern *AliceO2Group*
+ * ` + "`coconut templ list *@v*`" + ` lists templates coming from revisions matching the ` + "`v*`"  + `pattern for all git repositories
+ * ` + "`coconut templ list --repo=*AliceO2Group*`"  + ` lists all templates coming from the HEAD of master of git repositories that match the pattern *AliceO2Group*
+ * ` + "`coconut templ list --revision=dev*`" + ` lists templates coming from revisions matching the ` + "`dev*`"  + `pattern for all git repositories
+ * ` + "`coconut templ list --repo=*gitlab.cern.ch* --revision=master`" + ` lists templates for revisions ` + "`master`" + `for git repositories matching ` + "`*gitlab.cern.ch*`" + `
+ * ` + "`coconut templ list --all-branches`" + ` lists templates from all branches for all git repositories
+ * ` + "`coconut templ list --repo=*github.com* --all-tags`" + ` lists templates from all tags for git repositories which match the *github.com* pattern
+ * ` + "`coconut templ list --revision=5c7f1c1fded1b87243998579ed876c8035a08377 `" + ` lists templates from the commit corresponding to the hash for all git repositories`,
+
 	Run:   control.WrapCall(control.ListWorkflowTemplates),
 }
 
 func init() {
 	templateCmd.AddCommand(templateListCmd)
-}
+
+	templateListCmd.Flags().StringP("repository", "r", "*", "repositories to list templates from")
+	templateListCmd.Flags().StringP("revision", "i", "master", "revisions (branches/tags) to list templates from")
+	templateListCmd.Flags().BoolP("all-branches", "b", false, "list templates from all branches")
+	templateListCmd.Flags().BoolP("all-tags", "t", false, "list templates from all tags")
+}

coconut/control/control.go

@@ -33,6 +33,7 @@ import (
 	"github.com/xlab/treeprint"
 	"io"
 	"os"
+	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -490,13 +491,90 @@ func QueryRoles(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command,
 
 // ListWorkflowTemplates lists the available workflow templates and the git repo on which they reside.
 func ListWorkflowTemplates(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.Command, args []string, o io.Writer) (err error) {
-	if len(args) != 0 {
-		err = errors.New(fmt.Sprintf("accepts no arg(s), received %d", len(args)))
-		return err
+	repoPattern := "*"
+	revisionPattern := "master"
+	allBranches := false
+	allTags := false
+
+	if len(args) == 0 {
+		repoPattern, err = cmd.Flags().GetString("repository")
+		if err != nil {
+			return
+		}
+		if len(repoPattern) == 0 {
+			err = errors.New("cannot query for an empty repo")
+			return
+		}
+
+		revisionPattern, err = cmd.Flags().GetString("revision")
+		if err != nil {
+			return
+		}
+
+		if len(revisionPattern) == 0 {
+			err = errors.New("cannot query for an empty revision")
+			return
+		}
+
+		allBranches, err = cmd.Flags().GetBool("all-branches")
+		if err != nil {
+			return
+		}
+
+		allTags, err = cmd.Flags().GetBool("all-tags")
+		if err != nil {
+			return
+		}
+
+		if allBranches || allTags {
+			if revisionPattern != "master" {
+				fmt.Fprintln(o, "Ignoring `--all-{branches,tags}` flags, as a valid revision has been specified")
+				allBranches = false
+				allTags = false
+			}
+		}
+
+	} else 	if len(args) == 1 { // If we have an argument, give priority over the flags
+		simpleRepoRegex := regexp.MustCompile("\\A[^@]+\\z")
+		repoRevisionRegex := regexp.MustCompile("\\A[^@]+@[^@]+\\z")
+
+		if simpleRepoRegex.MatchString(args[0]) {
+			repoPattern = args[0]
+		} else if repoRevisionRegex.MatchString(args[0]) {
+			slicedArgument := strings.Split(args[0], "@")
+			repoPattern = slicedArgument[0]
+			revisionPattern = slicedArgument[1]
+		} else {
+			err = errors.New("arguments should be in the form of [repo-pattern](@[revision-pattern])")
+			return
+		}
+
+		if checkForFlag, _ := cmd.Flags().GetString("repository"); checkForFlag != "*" { // "*" comes from the flag's default value
+			fmt.Fprintln(o, "Ignoring `--repo` flag, as a valid argument has been passed ")
+		}
+
+		if checkForFlag, _ := cmd.Flags().GetString("revision"); checkForFlag != "master" {
+			fmt.Fprintln(o, "Ignoring `--revision` flag, as a valid argument has been passed")
+		}
+
+		if checkForFlag, _ := cmd.Flags().GetBool("all-branches"); checkForFlag != false {
+			fmt.Fprintln(o, "Ignoring `--all-branches` flag, as a valid argument has been passed")
+		}
+
+		if checkForFlag, _ := cmd.Flags().GetBool("all-tags"); checkForFlag != false {
+			fmt.Fprintln(o, "Ignoring `--all-tags` flag, as a valid argument has been passed")
+		}
+
+	} else {
+		err = errors.New(fmt.Sprintf("expecting one argument or a combination of the --repo and --revision flags, %d args received", len(args)))
+
+		return
 	}
 
+
 	var response *pb.GetWorkflowTemplatesReply
-	response, err = rpc.GetWorkflowTemplates(cxt, &pb.GetWorkflowTemplatesRequest{}, grpc.EmptyCallOption{})
+	response, err = rpc.GetWorkflowTemplates(cxt, &pb.GetWorkflowTemplatesRequest{RepoPattern: repoPattern, RevisionPattern: revisionPattern,
+		AllBranches: allBranches, AllTags: allTags}, grpc.EmptyCallOption{})
 	if err != nil {
 		return err
 	}
@@ -506,20 +584,30 @@ func ListWorkflowTemplates(cxt context.Context, rpc *coconut.RpcClient, cmd *cob
 		fmt.Fprintln(o, "No templates found.")
 	} else {
 		var prevRepo string
+		var prevRevision string
 		aTree := treeprint.New()
 		aTree.SetValue("Available templates in loaded configuration:")
 
+		revBranch := treeprint.New()
+
 		for _, tmpl := range templates {
-			if prevRepo != tmpl.GetRepo() {
-				fmt.Fprintln(o, aTree.String())
+			if prevRepo != tmpl.GetRepo() { // Create the root node of the tree w/ the repo name
+				fmt.Fprint(o, aTree.String())
 				aTree = treeprint.New()
 				aTree.SetValue(blue(tmpl.GetRepo()))
 				prevRepo = tmpl.GetRepo()
+				prevRevision = "" // Reinitialize the previous revision
+			}
+
+			if prevRevision != tmpl.GetRevision() { // Create the first leaf of the root node w/ the revision name
+				revBranch = aTree.AddBranch(tmpl.GetRevision)
+				revBranch.SetValue(yellow("[revision] " + tmpl.GetRevision())) // Otherwise the pointer value was set as the branch's value
+				prevRevision = tmpl.GetRevision()
 			}
-			aTree.AddNode(tmpl.GetTemplate())
+			revBranch.AddNode(tmpl.GetTemplate())
 		}
 
-		fmt.Fprintln(o, aTree.String())
+		fmt.Fprint(o, aTree.String())
 	}
 
 	return nil