TASK: parsing tests

Author: Florian Heinze

cmd/root.go

@@ -43,6 +43,7 @@ func Execute(version, commit string) {
 	})
 	addDevScriptTasksAsCommands(RootCmd)
 	RootCmd.AddCommand(buildInitCommand())
+	RootCmd.AddCommand(buildTestTaskCommand())
 	// TODO: fix autocompletion
 	if err := RootCmd.Execute(); err != nil {
 		fmt.Println(err)

cmd/task.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/gookit/color"
 	"github.com/spf13/cobra"
 	"log"
 	"main/utils"
@@ -13,9 +14,9 @@ import (
 func buildTaskCommand(task utils.DevScriptTask, devScriptPath string) *cobra.Command {
 	var cmd = &cobra.Command{
 		// IMPORTANT: never color Use! You will not be able to run the command otherwise.
-		Use:     task.Usage,
-		Short:   task.Short,
-		Long:    task.Long,
+		Use:     task.Name,
+		Short:   task.Title,
+		Long:    color.Bold.Text(task.Title) + "\n" + task.Description,
 		Args:    cobra.ArbitraryArgs,
 		GroupID: utils.GROUP_ID_TASKS,
 		// If this is true all flags will be passed to the command as arguments.
@@ -33,7 +34,7 @@ func buildTaskCommand(task utils.DevScriptTask, devScriptPath string) *cobra.Com
 			if argsAsString == "--help" || argsAsString == "-h" {
 				cmd.Help()
 			} else {
-				execDevScriptWithArguments(devScriptPath, append([]string{task.Usage}, args...))
+				execDevScriptWithArguments(devScriptPath, append([]string{task.Name}, args...))
 			}
 		},
 	}

cmd/test.go

@@ -0,0 +1,15 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// This is a hack add a hint to cobra rendering
+func buildTestTaskCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "test",
+		Short: "Test Task",
+		Run: func(cmd *cobra.Command, args []string) {
+		},
+	}
+}

utils/DevScriptTask.go

@@ -1,7 +1,7 @@
 package utils
 
 type DevScriptTask struct {
-	Usage string
-	Short string
-	Long  string
+	Name        string
+	Title       string
+	Description string
 }

utils/parse_comments.go

@@ -0,0 +1,21 @@
+package utils
+
+import (
+	"regexp"
+)
+
+func taskTitleFromComments(comments string) string {
+	reqex := regexp.MustCompile(`^.*`)
+	return reqex.FindString(comments)
+}
+
+func taskDescriptionFromComments(comments string) string {
+	//reqex := regexp.MustCompile(`(?ms)(?:\n|\r\n|\r)(.*?)((?:\n|\r\n|\r)^Usage:|Examples:|\n$)`)
+	reqex := regexp.MustCompile(`(?ms)(?:\n|\r\n|\r)(.*)`)
+	match := reqex.FindStringSubmatch(comments)
+	if len(match) > 1 {
+		// return capture group `(.*?)`
+		return match[1]
+	}
+	return ""
+}

utils/parse_comments_test.go

@@ -0,0 +1,71 @@
+package utils
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestParseComments_TitleAndDescription(t *testing.T) {
+	// title only
+	comment := "some title"
+	titleExpected := "some title"
+	titleActual := taskTitleFromComments(comment)
+	assert.Equal(t, titleExpected, titleActual)
+	descriptionExpected := ""
+	descriptionActual := taskDescriptionFromComments(comment)
+	assert.Equal(t, descriptionExpected, descriptionActual)
+
+	// title only with linebreak
+	comment = "some title\n"
+	titleExpected = "some title"
+	titleActual = taskTitleFromComments(comment)
+	assert.Equal(t, titleExpected, titleActual)
+	descriptionExpected = ""
+	descriptionActual = taskDescriptionFromComments(comment)
+	assert.Equal(t, descriptionExpected, descriptionActual)
+
+	// title with comment
+	comment = ""
+	comment += "some title\n"
+	comment += "Description Line 1\n"
+	comment += "Description Line 2\n"
+	titleExpected = "some title"
+	titleActual = taskTitleFromComments(comment)
+	assert.Equal(t, titleExpected, titleActual)
+	descriptionExpected = "Description Line 1\n"
+	descriptionExpected += "Description Line 2\n"
+	descriptionActual = taskDescriptionFromComments(comment)
+	assert.Equal(t, descriptionExpected, descriptionActual)
+
+	// title with comment and Usage or Examples
+	//
+	/*
+		comment = ""
+		comment += "some title\n"
+		comment += "Description Line 1\n"
+		comment += "Description Line 2\n"
+		comment += "Usage:\n"
+		titleExpected = "some title"
+		titleActual = taskTitleFromComments(comment)
+		assert.Equal(t, titleExpected, titleActual)
+		descriptionExpected = "Description Line 1\n"
+		descriptionExpected += "Description Line 2"
+		descriptionActual = taskDescriptionFromComments(comment)
+		assert.Equal(t, descriptionExpected, descriptionActual)
+
+		// title with comment and "Examples:"
+		comment = ""
+		comment += "some title\n"
+		comment += "Description Line 1\n"
+		comment += "Description Line 2\n"
+		comment += "Examples:\n"
+		titleExpected = "some title"
+		titleActual = taskTitleFromComments(comment)
+		assert.Equal(t, titleExpected, titleActual)
+		descriptionExpected = "Description Line 1\n"
+		// TODO: fix reqex to exclude \n of last line
+		descriptionExpected += "Description Line 2\n"
+		descriptionActual = taskDescriptionFromComments(comment)
+		assert.Equal(t, descriptionExpected, descriptionActual)
+	*/
+}

utils/dev_script.go utils/parse_dev_script_tasks.goutils/dev_script.go renamed to utils/parse_dev_script_tasks.go

@@ -25,13 +25,13 @@ func ParseDevScriptTasks(devScriptPath string) []DevScriptTask {
 	var results = []DevScriptTask{}
 	for _, match := range matches {
 		task := match[taskIndex]
-		comments := processComments(match[commentsIndex])
+		comments := prepareComments(match[commentsIndex])
 
 		if !strings.HasPrefix(task, "_") {
 			results = append(results, DevScriptTask{
-				Usage: task,
-				Short: extractShortFromComments(comments),
-				Long:  comments,
+				Name:        task,
+				Title:       taskTitleFromComments(comments),
+				Description: taskDescriptionFromComments(comments),
 			})
 		}
 	}
@@ -40,12 +40,7 @@ func ParseDevScriptTasks(devScriptPath string) []DevScriptTask {
 
 // https://regex101.com/r/Jo4uSX/1
 // `|\n$` matches new line and end of string
-func processComments(comments string) string {
+func prepareComments(comments string) string {
 	reqex := regexp.MustCompile(`(?m)^# ?|\n$`)
 	return reqex.ReplaceAllString(comments, "")
 }
-
-func extractShortFromComments(comments string) string {
-	reqex := regexp.MustCompile(`^.*`)
-	return reqex.FindString(comments)
-}

utils/dev_script_test.go utils/parse_dev_script_tasks_test.goutils/dev_script_test.go renamed to utils/parse_dev_script_tasks_test.go

@@ -7,23 +7,23 @@ import (
 
 func TestParseDevScriptTasks_TasksSyntax(t *testing.T) {
 	expected := []DevScriptTask{
-		{Usage: "task-syntax-1a"},
-		{Usage: "task-syntax-1b"},
-		{Usage: "task-syntax-1c"},
-		{Usage: "task-syntax-2a"},
-		{Usage: "task-syntax-2b"},
-		{Usage: "task-syntax-2c"},
-		{Usage: "task-syntax-3a"},
+		{Name: "task-syntax-1a"},
+		{Name: "task-syntax-1b"},
+		{Name: "task-syntax-1c"},
+		{Name: "task-syntax-2a"},
+		{Name: "task-syntax-2b"},
+		{Name: "task-syntax-2c"},
+		{Name: "task-syntax-3a"},
 	}
 	actual := ParseDevScriptTasks("./fixtures/tasks_syntax.sh")
 	assert.Equal(t, expected, actual)
 }
 
 func TestParseDevScriptTasks_IgnoreTasksStartingWithUnderscore(t *testing.T) {
 	expected := []DevScriptTask{
-		{Usage: "task-not-starting-with-underscore"},
-		{Usage: "task-not-starting-with-underscore_"},
-		{Usage: "task-not-starting-with_underscore"},
+		{Name: "task-not-starting-with-underscore"},
+		{Name: "task-not-starting-with-underscore_"},
+		{Name: "task-not-starting-with_underscore"},
 		// should not be parsed
 		// {Usage: "_task-without-underscore"},
 		// {Usage: "__task-without-underscore"},
@@ -35,7 +35,7 @@ func TestParseDevScriptTasks_IgnoreTasksStartingWithUnderscore(t *testing.T) {
 
 func TestParseDevScriptTasks_IgnoreCommentedOutTasks(t *testing.T) {
 	expected := []DevScriptTask{
-		{Usage: "task"},
+		{Name: "task"},
 		// should not be parsed
 		// {Usage: "task-commented-out"},
 	}
@@ -46,31 +46,31 @@ func TestParseDevScriptTasks_IgnoreCommentedOutTasks(t *testing.T) {
 func TestParseDevScriptTasks_TaskCommentsShouldBeParsed(t *testing.T) {
 	expected := []DevScriptTask{
 		{
-			Usage: "one-line-comment-block",
-			Short: "one line comment block - 1",
+			Name:  "one-line-comment-block",
+			Title: "one line comment block - 1",
 			// TODO: fix trailing \n
-			Long: "one line comment block - 1",
+			Description: "one line comment block - 1",
 		},
 		{
-			Usage: "multiline-comment-block",
-			Short: "multiline comment block - 1",
+			Name:  "multiline-comment-block",
+			Title: "multiline comment block - 1",
 			// TODO: fix trailing \n
-			Long: "multiline comment block - 1\nmultiline comment block - 2\nmultiline comment block - 3",
+			Description: "multiline comment block - 1\nmultiline comment block - 2\nmultiline comment block - 3",
 		},
 		{
-			Usage: "empty-lines-in-comment-block",
-			Short: "multiline comment block with empty lines - 1",
+			Name:  "empty-lines-in-comment-block",
+			Title: "multiline comment block with empty lines - 1",
 			// TODO: fix trailing \n
-			Long: "multiline comment block with empty lines - 1\n\nmultiline comment block with empty lines - 2\n\nmultiline comment block with empty lines - 3",
+			Description: "multiline comment block with empty lines - 1\n\nmultiline comment block with empty lines - 2\n\nmultiline comment block with empty lines - 3",
 		},
 		{
-			Usage: "leading-spaces-or-none-in-comment-block",
-			Short: "leading space missing",
+			Name:  "leading-spaces-or-none-in-comment-block",
+			Title: "leading space missing",
 			// TODO: fix trailing \n
 			// remove # and one space always if present
 			// keep \n but remove spaces if they are the only chars after #
 			// also keep empty lines
-			Long: "leading space missing\n  keep leading-spaces used for indents\n\n\n\ncomment block end",
+			Description: "leading space missing\n  keep leading-spaces used for indents\n\n\n\ncomment block end",
 		},
 	}
 	actual := ParseDevScriptTasks("./fixtures/tasks_with_comments.sh")