- Added support for custom cli descriptions.

cmd/centry/runtime.go

@@ -55,7 +55,7 @@ func NewRuntime(inputArgs []string, context *Context) (*Runtime, error) {
 	runtime.cli = &cli.App{
 		Name:      context.manifest.Config.Name,
 		HelpName:  context.manifest.Config.Name,
-		Usage:     "A tool for building declarative CLI's over bash scripts, written in go.", // TODO: Set from manifest config
+		Usage:     context.manifest.Config.Description,
 		UsageText: "",
 		Version:   context.manifest.Config.Version,
 

cmd/centry/runtime_test.go

@@ -252,6 +252,18 @@ func TestMain(t *testing.T) {
 
 		g.Describe("output", func() {
 			out := execQuiet("")
+
+			g.It("should display the program name", func() {
+				expected := `NAME:
+   centry`
+				test.AssertStringContains(g, out.Stdout, expected)
+			})
+
+			g.It("should display the program description", func() {
+				expected := "A manifest file used for testing purposes"
+				test.AssertStringContains(g, out.Stdout, expected)
+			})
+
 			g.It("should display available commands", func() {
 				expected := `COMMANDS:
    commandtest  Command tests
@@ -275,6 +287,16 @@ func TestMain(t *testing.T) {
 
 				test.AssertStringContains(g, out.Stdout, expected)
 			})
+
+			g.Describe("default config output", func() {
+				g.It("should display the default program description", func() {
+					expected := `NAME:
+   name - A new cli application`
+					out := execQuiet("", "test/data/runtime_test_default_config.yaml")
+					test.AssertNoError(g, out.Error)
+					test.AssertStringContains(g, out.Stdout, expected)
+				})
+			})
 		})
 
 		g.Describe("command help output", func() {
@@ -334,10 +356,11 @@ OPTIONS:
 				out := execQuiet("helptest placeholder --help")
 				test.AssertStringContains(g, out.Stdout, expected)
 			})
+		})
 
-			g.Describe("placeholder subcommand help", func() {
-				g.It("should display full help", func() {
-					expected := `NAME:
+		g.Describe("placeholder subcommand help output", func() {
+			g.It("should display full help", func() {
+				expected := `NAME:
    centry helptest placeholder subcommand1 - Description for placeholder subcommand1
 
 USAGE:
@@ -347,14 +370,15 @@ OPTIONS:
    --opt1 value  Help text for opt1
    --help, -h    Show help (default: false)`
 
-					out := execQuiet("helptest placeholder subcommand1 --help")
-					test.AssertStringContains(g, out.Stdout, expected)
-				})
+				out := execQuiet("helptest placeholder subcommand1 --help")
+				test.AssertStringContains(g, out.Stdout, expected)
 			})
 		})
 	})
 }
 
+const defaultManifestPath string = "test/data/runtime_test.yaml"
+
 type execResult struct {
 	Source   string
 	ExitCode int
@@ -363,15 +387,27 @@ type execResult struct {
 	Stderr   string
 }
 
-func execQuiet(source string) *execResult {
-	return execCentry(source, true)
+func execQuiet(source string, params ...string) *execResult {
+	manifestPath := defaultManifestPath
+	if len(params) > 0 {
+		if params[0] != "" {
+			manifestPath = params[0]
+		}
+	}
+	return execCentry(source, true, manifestPath)
 }
 
-func execWithLogging(source string) *execResult {
-	return execCentry(source, false)
+func execWithLogging(source string, params ...string) *execResult {
+	manifestPath := defaultManifestPath
+	if len(params) > 0 {
+		if params[0] != "" {
+			manifestPath = params[0]
+		}
+	}
+	return execCentry(source, false, manifestPath)
 }
 
-func execCentry(source string, quiet bool) *execResult {
+func execCentry(source string, quiet bool, manifestPath string) *execResult {
 	var exitCode int
 	var runtimeErr error
 
@@ -380,7 +416,7 @@ func execCentry(source string, quiet bool) *execResult {
 			source = fmt.Sprintf("--quiet %s", source)
 		}
 		context := NewContext(CLI, io.Headless())
-		runtime, err := NewRuntime(strings.Split(fmt.Sprintf("test/data/runtime_test.yaml %s", source), " "), context)
+		runtime, err := NewRuntime(strings.Split(fmt.Sprintf("%s %s", manifestPath, source), " "), context)
 		if err != nil {
 			exitCode = 1
 			runtimeErr = err

examples/centry/centry.yaml

@@ -72,6 +72,7 @@ options:
 
 config:
   name: centry
+  description: A tool for building declarative CLI's over bash scripts, written in go
   version: 1.0.0
   log:
     level: info

internal/pkg/config/manifest.go

@@ -54,9 +54,10 @@ func (o Option) Annotation(namespace, key string) (*Annotation, error) {
 
 // Config defines the structure for the configuration section
 type Config struct {
-	Name    string    `yaml:"name,omitempty"`
-	Version string    `yaml:"version,omitempty"`
-	Log     LogConfig `yaml:"log,omitempty"`
+	Name        string    `yaml:"name,omitempty"`
+	Description string    `yaml:"description,omitempty"`
+	Version     string    `yaml:"version,omitempty"`
+	Log         LogConfig `yaml:"log,omitempty"`
 }
 
 // LogConfig defines the structure for log configuration section

schemas/manifest.json

@@ -44,6 +44,7 @@
       "type": "object",
       "properties": {
         "name": { "type": "string", "minLength": 1 },
+        "description": { "type": "string", "minLength": 1 },
         "version": { "type": "string", "minLength": 1 },
         "log": {
           "type": "object",

test/data/manifest_test_valid.yaml

@@ -31,6 +31,7 @@ options:
 
 config:
   name: centry
+  description: A description from manifest file
   version: 1.0.0
   log:
     level: debug

test/data/runtime_test.yaml

@@ -43,6 +43,7 @@ options:
 
 config:
   name: centry
+  description: A manifest file used for testing purposes
   version: 1.0.0
   log:
     level: debug

test/data/runtime_test_default_config.yaml

@@ -0,0 +1,4 @@
+commands: []
+config:
+  name: name
+  version: version