Formatting modifications based on personal preferences (#2)

* rename root to main.go

* remove unused flagval

* no longer export parseFlags

* silencing uncommented models

* formatting fixup of cfcurl and apihelper

* task for doing super basic test against cf


Former-commit-id: 124c616 [formerly 4c9fb56]
Former-commit-id: bb1110c
Former-commit-id: f1b8f5c

Author: aegershman

Taskfile.yml

@@ -19,3 +19,8 @@ tasks:
       - cmd: go mod init github.com/aegershman/cf-trueup-plugin
         ignore_error: true
       - go mod tidy
+
+  # I know, not the best solution, but it'll work while I'm hacking away at stuff
+  test:
+    cmds:
+      - cf trueup-report -o groundworks

apihelper/apihelper.go

@@ -12,42 +12,50 @@ import (
 )
 
 var (
+	// ErrOrgNotFound -
 	ErrOrgNotFound = errors.New("organization not found")
 )
 
-//Organization representation
+// Organization -
 type Organization struct {
 	URL       string
 	Name      string
 	QuotaURL  string
 	SpacesURL string
 }
 
-//Space representation
+// Space -
 type Space struct {
 	Name       string
 	SummaryURL string
 }
 
-//App representation
+// App -
 type App struct {
 	Actual float64
 	Desire float64
 	RAM    float64
 }
 
-//Service representation
+// Service -
 type Service struct {
 	Label       string
 	ServicePlan string
 }
 
+// Orgs -
 type Orgs []Organization
+
+// Spaces -
 type Spaces []Space
+
+// Apps -
 type Apps []App
+
+// Services -
 type Services []Service
 
-//CFAPIHelper to wrap cf curl results
+// CFAPIHelper wraps cf curl results
 type CFAPIHelper interface {
 	GetTarget() string
 	GetOrgs() (Orgs, error)
@@ -58,15 +66,17 @@ type CFAPIHelper interface {
 	GetSpaceAppsAndServices(string) (Apps, Services, error)
 }
 
-//APIHelper implementation
+// APIHelper -
 type APIHelper struct {
 	cli plugin.CliConnection
 }
 
+// New -
 func New(cli plugin.CliConnection) CFAPIHelper {
 	return &APIHelper{cli}
 }
 
+// GetTarget -
 func (api *APIHelper) GetTarget() string {
 	envInfo, err := cfcurl.Curl(api.cli, "/v2/info")
 	if nil != err {
@@ -81,7 +91,7 @@ func (api *APIHelper) GetTarget() string {
 	return host
 }
 
-//GetOrgs returns a struct that represents critical fields in the JSON
+// GetOrgs -
 func (api *APIHelper) GetOrgs() (Orgs, error) {
 	orgsJSON, err := cfcurl.Curl(api.cli, "/v2/organizations")
 	if nil != err {
@@ -113,7 +123,7 @@ func (api *APIHelper) GetOrgs() (Orgs, error) {
 	return orgs, nil
 }
 
-//GetOrg returns a struct that represents critical fields in the JSON
+// GetOrg -
 func (api *APIHelper) GetOrg(name string) (Organization, error) {
 	query := fmt.Sprintf("name:%s", name)
 	path := fmt.Sprintf("/v2/organizations?q=%s", url.QueryEscape(query))
@@ -145,7 +155,7 @@ func (api *APIHelper) orgResourceToOrg(o interface{}) Organization {
 	}
 }
 
-//GetQuotaMemoryLimit retruns the amount of memory (in MB) that the org is allowed
+// GetQuotaMemoryLimit returns memory quota (in MB) of a given org
 func (api *APIHelper) GetQuotaMemoryLimit(quotaURL string) (float64, error) {
 	quotaJSON, err := cfcurl.Curl(api.cli, quotaURL)
 	if nil != err {
@@ -154,7 +164,7 @@ func (api *APIHelper) GetQuotaMemoryLimit(quotaURL string) (float64, error) {
 	return quotaJSON["entity"].(map[string]interface{})["memory_limit"].(float64), nil
 }
 
-//GetOrgMemoryUsage returns the amount of memory (in MB) that the org is consuming
+// GetOrgMemoryUsage returns amount of memory (in MB) a given org is currently using
 func (api *APIHelper) GetOrgMemoryUsage(org Organization) (float64, error) {
 	usageJSON, err := cfcurl.Curl(api.cli, org.URL+"/memory_usage")
 	if nil != err {
@@ -163,7 +173,7 @@ func (api *APIHelper) GetOrgMemoryUsage(org Organization) (float64, error) {
 	return usageJSON["memory_usage_in_mb"].(float64), nil
 }
 
-//GetOrgSpaces returns the spaces in an org.
+// GetOrgSpaces returns the spaces in an org
 func (api *APIHelper) GetOrgSpaces(spacesURL string) (Spaces, error) {
 	nextURL := spacesURL
 	spaces := []Space{}
@@ -191,7 +201,7 @@ func (api *APIHelper) GetOrgSpaces(spacesURL string) (Spaces, error) {
 	return spaces, nil
 }
 
-//GetSpaceAppsAndServices returns the apps and the services in a space
+// GetSpaceAppsAndServices returns the apps and the services in a space
 func (api *APIHelper) GetSpaceAppsAndServices(summaryURL string) (Apps, Services, error) {
 	apps := []App{}
 	services := []Service{}

cfcurl/cfcurl.go

@@ -38,8 +38,8 @@ func parseOutput(output []string) (map[string]interface{}, error) {
 	return f.(map[string]interface{}), err
 }
 
-// Curl calls cf curl  and return the resulting json. This method will panic if
-// the api is depricated
+// Curl calls cf curl and returns the resulting json
+// This method will panic if the api is depricated
 func Curl(cli plugin.CliConnection, path string) (map[string]interface{}, error) {
 	output, err := cli.CliCommandWithoutTerminalOutput("curl", path)
 
@@ -50,7 +50,7 @@ func Curl(cli plugin.CliConnection, path string) (map[string]interface{}, error)
 	return parseOutput(output)
 }
 
-// CurlDepricated calls cf curl and return the resulting json, even if the api is depricated
+// CurlDepricated calls cf curl and returns the resulting json, even if the api is deprecated
 func CurlDepricated(cli plugin.CliConnection, path string) (map[string]interface{}, error) {
 	output, err := callAndValidateCLI(cli, path)
 	if nil != err {

go.mod

@@ -7,4 +7,6 @@ require (
 	github.com/cloudfoundry/cli v6.47.2+incompatible
 	github.com/onsi/ginkgo v1.10.3 // indirect
 	github.com/onsi/gomega v1.7.1 // indirect
+	golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 // indirect
+	golang.org/x/sys v0.0.0-20191008105621-543471e840be // indirect
 )

go.sum

@@ -13,12 +13,18 @@ github.com/onsi/ginkgo v1.10.3 h1:OoxbjfXVZyod1fmWYhI7SEyaD8B00ynP3T+D5GiyHOY=
 github.com/onsi/ginkgo v1.10.3/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/gomega v1.7.1 h1:K0jcRCwNQM3vFGh1ppMtDh/+7ApJrjldlX8fA0jDTLQ=
 github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd h1:nTDtHvHSdCn1m6ITfMRqtOd/9+7a3s8RBNOZ3eYZzJA=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 h1:0GoQqolDA55aaLxZyTzK/Y2ePZzZTUrRacwib7cNsYQ=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f h1:wMNYb4v58l5UBM7MYRLPG6ZhfOqbKu7X5eyFl8ZhKvA=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e h1:o3PsSEY8E4eXWkXrIP9YJALUkVZqzHJT5DOasTyn8Vs=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20191008105621-543471e840be h1:QAcqgptGM8IQBC9K/RC4o+O9YmqEm0diQn9QmZw/0mU=
+golang.org/x/sys v0.0.0-20191008105621-543471e840be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=

trueupreport.go main.go

@@ -10,41 +10,38 @@ import (
 	"github.com/cloudfoundry/cli/plugin"
 )
 
-//UsageReportCmd the plugin
+// UsageReportCmd -
 type UsageReportCmd struct {
 	apiHelper apihelper.CFAPIHelper
 }
 
-// contains CLI flag values
-type flagVal struct {
+type flags struct {
 	OrgName string
-	Format  string
 }
 
-func ParseFlags(args []string) flagVal {
+func parseFlags(args []string) flags {
 	flagSet := flag.NewFlagSet(args[0], flag.ContinueOnError)
 
-	// Create flags
 	orgName := flagSet.String("o", "", "-o orgName")
 
 	err := flagSet.Parse(args[1:])
 	if err != nil {
 
 	}
 
-	return flagVal{
+	return flags{
 		OrgName: string(*orgName),
 	}
 }
 
-//GetMetadata returns metatada
+// GetMetadata -
 func (cmd *UsageReportCmd) GetMetadata() plugin.PluginMetadata {
 	return plugin.PluginMetadata{
 		Name: "trueup-report",
 		Version: plugin.VersionType{
 			Major: 2,
 			Minor: 4,
-			Build: 0,
+			Build: 1,
 		},
 		Commands: []plugin.Command{
 			{
@@ -61,16 +58,16 @@ func (cmd *UsageReportCmd) GetMetadata() plugin.PluginMetadata {
 	}
 }
 
-//UsageReportCommand doer
+// UsageReportCommand -
 func (cmd *UsageReportCmd) UsageReportCommand(args []string) {
-	flagVals := ParseFlags(args)
+	flagss := parseFlags(args)
 
 	var orgs []models.Org
 	var err error
 	var report models.Report
 
-	if flagVals.OrgName != "" {
-		org, err := cmd.getOrg(flagVals.OrgName)
+	if flagss.OrgName != "" {
+		org, err := cmd.getOrg(flagss.OrgName)
 		if nil != err {
 			fmt.Println(err)
 			os.Exit(1)
@@ -183,7 +180,7 @@ func (cmd *UsageReportCmd) getAppsAndServices(summaryURL string) ([]models.App,
 	return apps, services, nil
 }
 
-//Run runs the plugin
+// Run -
 func (cmd *UsageReportCmd) Run(cli plugin.CliConnection, args []string) {
 	if args[0] == "trueup-report" {
 		cmd.apiHelper = apihelper.New(cli)