bare bones documentation

joyent · Oct 29, 2020 · 425b80a · 425b80a
1 parent 449ca62
commit 425b80a
Show file tree

Hide file tree

Showing 25 changed files with 529 additions and 206 deletions.
diff --git a/cli/config.go b/cli/config.go
@@ -14,6 +14,7 @@ import (
 	"github.com/joyent/kosh/template"
 )
 
+// Config is the interface for the configuration object for the full app
 type Config interface {
 	GetVersion() string
 
@@ -32,7 +33,7 @@ type Config interface {
 	conch.Config
 }
 
-// Config struct
+// DefaultConfig is the default configuration struct
 type DefaultConfig struct {
 	Version string
 	GitRev  string
@@ -46,15 +47,31 @@ type DefaultConfig struct {
 	logger.Logger
 }
 
-func (c *DefaultConfig) GetVersion() string       { return c.Version }
-func (c *DefaultConfig) GetURL() string           { return c.ConchURL }
-func (c *DefaultConfig) GetToken() string         { return c.ConchToken }
+// GetVersion returns the current app version
+func (c *DefaultConfig) GetVersion() string { return c.Version }
+
+// GetURL returns the current conch API url
+func (c *DefaultConfig) GetURL() string { return c.ConchURL }
+
+// GetToken returns the current conch API token
+func (c *DefaultConfig) GetToken() string { return c.ConchToken }
+
+// GetLogger returns the current logger instance
 func (c *DefaultConfig) GetLogger() logger.Logger { return c.Logger }
 
-func (c *DefaultConfig) SetURL(URL string)         { c.ConchURL = URL }
-func (c *DefaultConfig) SetToken(token string)     { c.ConchToken = token }
-func (c *DefaultConfig) GetOutputJSON() bool       { return c.OutputJSON }
-func (c *DefaultConfig) SetOutputJSON(p bool)      { c.OutputJSON = p }
+// SetURL updates the current conch API url
+func (c *DefaultConfig) SetURL(URL string) { c.ConchURL = URL }
+
+// SetToken updates the current conch API token being used
+func (c *DefaultConfig) SetToken(token string) { c.ConchToken = token }
+
+// GetOutputJSON returns whether JSON is used for output or not
+func (c *DefaultConfig) GetOutputJSON() bool { return c.OutputJSON }
+
+// SetOutputJSON sets whether to use JSOn for output or not
+func (c *DefaultConfig) SetOutputJSON(p bool) { c.OutputJSON = p }
+
+// SetLogger sets the configured logger instance
 func (c *DefaultConfig) SetLogger(l logger.Logger) { c.Logger = l }
 
 // NewConfig takes a Version and a GitRev and returns a Config object
@@ -81,6 +98,7 @@ const configTemplate = `
 ---
 `
 
+// String returns a string implementation of the config object
 func (c *DefaultConfig) String() string {
 	t, err := template.NewTemplate().Parse(configTemplate)
 	if err != nil {
@@ -100,6 +118,7 @@ func (c *DefaultConfig) ConchClient() *conch.Client {
 	return conch.New(c).UserAgent(userAgent)
 }
 
+// Renderer returns a function that will render to STDOUT
 func (c *DefaultConfig) Renderer() func(interface{}) {
 	return c.RenderTo(os.Stdout)
 }
@@ -112,6 +131,8 @@ func renderJSON(i interface{}) string {
 	return string(b)
 }
 
+// RenderTo returns a function tha renders to a given io.Writer based on the
+// configuraton and datatype
 func (c *DefaultConfig) RenderTo(w io.Writer) func(interface{}) {
 	return func(i interface{}) {
 		if c.OutputJSON {

diff --git a/cli/config_test.go b/cli/config_test.go
@@ -198,7 +198,7 @@ func TestRender(t *testing.T) {
 
 		{
 			Name: "	display(conch.GetHardwareVendors())",
-			Do: func() { display(conch.GetHardwareVendors()) },
+			Do: func() { display(conch.GetAllHardwareVendors()) },
 		},
 
 		{
@@ -208,7 +208,7 @@ func TestRender(t *testing.T) {
 
 		{
 			Name: "	display(conch.GetOrganizations())",
-			Do: func() { display(conch.GetOrganizations()) },
+			Do: func() { display(conch.GetAllOrganizations()) },
 		},
 
 		{

diff --git a/cli/hardware.go b/cli/hardware.go
@@ -26,7 +26,7 @@ func cmdCreateProduct(cfg Config) func(*cli.Cmd) {
 		cmd.Action = func() {
 			conch := cfg.ConchClient()
 			validationPlan := conch.GetValidationPlanByName(*validationPlanOpt)
-			vendor := conch.GetHardwareVendorByID(*vendor)
+			vendor := conch.GetHardwareVendorByName(*vendor)
 			create := types.HardwareProductCreate{
 				Name:             types.MojoStandardPlaceholder(*name),
 				Alias:            types.MojoStandardPlaceholder(*alias),
@@ -91,7 +91,7 @@ func hardwareCmd(cfg Config) func(*cli.Cmd) {
 
 		cmd.Command("vendors", "Work with hardware vendors", func(cmd *cli.Cmd) {
 			cmd.Command("get ls", "Get a list of all hardware vendors", func(cmd *cli.Cmd) {
-				display(conch.GetHardwareVendors())
+				display(conch.GetAllHardwareVendors())
 			})
 			cmd.Command("create", "Create a hardware vendor", func(cmd *cli.Cmd) {
 				name := cmd.StringArg("NAME", "", "The name of the hardware vendor.")
@@ -107,7 +107,7 @@ func hardwareCmd(cfg Config) func(*cli.Cmd) {
 
 			// grab the Vendor for the given ID
 			cmd.Before = func() {
-				hv = conch.GetHardwareVendorByID(*idArg)
+				hv = conch.GetHardwareVendorByName(*idArg)
 				if (hv == types.HardwareVendor{}) {
 					fmt.Println("Hardware Vendor not found for " + *idArg)
 					cli.Exit(1)

diff --git a/cli/organizations.go b/cli/organizations.go
@@ -16,7 +16,7 @@ func organizationsCmd(cfg Config) func(cmd *cli.Cmd) {
 		}
 		cmd.Command("get ls", "Get a list of all organizations", func(cmd *cli.Cmd) {
 			cmd.Action = func() {
-				display(conch.GetOrganizations())
+				display(conch.GetAllOrganizations())
 			}
 		})