Merge pull request #251 from moul/bump-gotty-client

Improvements

Author: moul

Makefile

@@ -132,7 +132,12 @@ packages:
 
 golint:
 	@go get github.com/golang/lint/golint
-	@for dir in */; do golint $$dir; done
+	@for dir in $(shell go list ./... | grep -v /vendor/); do golint $$dir; done
+
+
+gocyclo:
+	go get github.com/fzipp/gocyclo
+	gocyclo -over 15 $(shell find . -name "*.go" -not -name "*test.go" | grep -v /vendor/)
 
 
 party:

pkg/api/api.go

@@ -639,22 +639,26 @@ type ScalewayTokensDefinition struct {
 	Token ScalewayTokenDefinition `json:"token"`
 }
 
+// ScalewayContainerData represents a Scaleway container data (S3)
 type ScalewayContainerData struct {
 	LastModified string `json:"last_modified"`
 	Name         string `json:"name"`
 	Size         string `json:"size"`
 }
 
+// ScalewayGetContainerDatas represents a list of Scaleway containers data (S3)
 type ScalewayGetContainerDatas struct {
 	Container []ScalewayContainerData `json:"container"`
 }
 
+// ScalewayContainer represents a Scaleway container (S3)
 type ScalewayContainer struct {
 	ScalewayOrganizationDefinition `json:"organization"`
 	Name                           string `json:"name"`
 	Size                           string `json:"size"`
 }
 
+// ScalewayGetContainers represents a list of Scaleway containers (S3)
 type ScalewayGetContainers struct {
 	Containers []ScalewayContainer `json:"containers"`
 }
@@ -742,6 +746,7 @@ type ScalewayUserdatas struct {
 	UserData []string `json:"user_data"`
 }
 
+// ScalewayQuota represents a map of quota (name, value)
 type ScalewayQuota map[string]int
 
 // ScalewayGetQuotas represents the response of GET /organizations/{orga_id}/quotas

pkg/api/helpers.go

@@ -284,13 +284,14 @@ func InspectIdentifiers(api *ScalewayAPI, ci chan ScalewayResolvedIdentifier, cj
 	close(cj)
 }
 
+// ConfigCreateServer represents the options sent to CreateServer and defining a server
 type ConfigCreateServer struct {
 	ImageName         string
 	Name              string
 	Bootscript        string
 	Env               string
 	AdditionalVolumes string
-	DynamicIpRequired bool
+	DynamicIPRequired bool
 	IP                string
 	CommercialType    string
 }
@@ -312,7 +313,7 @@ func CreateServer(api *ScalewayAPI, c *ConfigCreateServer) (string, error) {
 	server.CommercialType = c.CommercialType
 	server.Volumes = make(map[string]string)
 
-	server.DynamicIPRequired = &c.DynamicIpRequired
+	server.DynamicIPRequired = &c.DynamicIPRequired
 	if c.IP != "" {
 		if anonuuid.IsUUID(c.IP) == nil {
 			server.PublicIP = c.IP

pkg/cli/command.go

@@ -76,6 +76,7 @@ func (c *Command) GetContext(rawArgs []string) commands.CommandContext {
 	return ctx
 }
 
+// Streams returns command streams with default os streams if unset
 func (c *Command) Streams() *commands.Streams {
 	if c.streams != nil {
 		return c.streams

pkg/cli/main.go

@@ -29,6 +29,7 @@ var (
 	flSensitive   = flag.Bool([]string{"-sensitive"}, false, "Show sensitive data in outputs, i.e. API Token/Organization")
 )
 
+// Start is the entrypoint
 func Start(rawArgs []string, streams *commands.Streams) (int, error) {
 	if streams == nil {
 		streams = &commands.Streams{
@@ -135,7 +136,7 @@ func Start(rawArgs []string, streams *commands.Streams) (int, error) {
 		}
 	}
 
-	return 1, fmt.Errorf("scw: unknown subcommand %s\nRun 'scw help' for usage.", name)
+	return 1, fmt.Errorf("scw: unknown subcommand %s\nRun 'scw help' for usage", name)
 }
 
 // getScalewayAPI returns a ScalewayAPI using the user config file

pkg/cli/test.go

@@ -7,19 +7,19 @@ import (
 )
 
 var (
-	scwcli         string   = "../../scw"
-	publicCommands []string = []string{
+	scwcli         = "../../scw"
+	publicCommands = []string{
 		"help", "attach", "commit", "cp", "create",
 		"events", "exec", "history", "images", "info",
 		"inspect", "kill", "login", "logout", "logs",
 		"port", "ps", "rename", "restart", "rm", "rmi",
 		"run", "search", "start", "stop", "tag", "top",
 		"version", "wait",
 	}
-	secretCommands []string = []string{
+	secretCommands = []string{
 		"_patch", "_completion", "_flush-cache", "_userdata", "_billing",
 	}
-	publicOptions []string = []string{
+	publicOptions = []string{
 		"-h, --help=false",
 		"-D, --debug=false",
 		"-V, --verbose=false",

pkg/cli/x_userdata.go

@@ -42,27 +42,27 @@ func runUserdata(cmd *Command, args []string) error {
 	}
 
 	ctx := cmd.GetContext(args)
-	var Api *api.ScalewayAPI
+	var API *api.ScalewayAPI
 	var err error
 	var serverID string
 	if args[0] == "local" {
-		Api, err = api.NewScalewayAPI("", "", "", "")
+		API, err = api.NewScalewayAPI("", "", "", "")
 		if err != nil {
 			return err
 		}
-		Api.EnableMetadataAPI()
+		API.EnableMetadataAPI()
 	} else {
 		if ctx.API == nil {
 			return fmt.Errorf("You need to login first: 'scw login'")
 		}
 		serverID = ctx.API.GetServerID(args[0])
-		Api = ctx.API
+		API = ctx.API
 	}
 
 	switch len(args) {
 	case 1:
 		// List userdata
-		res, err := Api.GetUserdatas(serverID)
+		res, err := API.GetUserdatas(serverID)
 		if err != nil {
 			return err
 		}
@@ -75,7 +75,7 @@ func runUserdata(cmd *Command, args []string) error {
 		switch len(parts) {
 		case 1:
 			// Get userdatas
-			res, err := Api.GetUserdata(serverID, key)
+			res, err := API.GetUserdata(serverID, key)
 			if err != nil {
 				return err
 			}
@@ -93,14 +93,14 @@ func runUserdata(cmd *Command, args []string) error {
 				} else {
 					data = []byte(value)
 				}
-				err := Api.PatchUserdata(serverID, key, data)
+				err := API.PatchUserdata(serverID, key, data)
 				if err != nil {
 					return err
 				}
 				fmt.Fprintln(ctx.Stdout, key)
 			} else {
 				// Delete userdata
-				err := Api.DeleteUserdata(serverID, key)
+				err := API.DeleteUserdata(serverID, key)
 				if err != nil {
 					return err
 				}

pkg/commands/create.go

@@ -39,7 +39,7 @@ func RunCreate(ctx CommandContext, args CreateArgs) error {
 		Bootscript:        args.Bootscript,
 		Env:               env,
 		AdditionalVolumes: volume,
-		DynamicIpRequired: args.IP == "",
+		DynamicIPRequired: args.IP == "",
 		IP:                args.IP,
 	})
 	if err != nil {

pkg/commands/run.go

@@ -119,7 +119,7 @@ func Run(ctx CommandContext, args RunArgs) error {
 		Bootscript:        args.Bootscript,
 		Env:               env,
 		AdditionalVolumes: volume,
-		DynamicIpRequired: args.Gateway == "",
+		DynamicIPRequired: args.Gateway == "",
 		IP:                args.IP,
 	})
 	if err != nil {

pkg/commands/test.go

@@ -33,6 +33,7 @@ func getScopedCtx(sessionCtx *CommandContext) (*CommandContext, *bytes.Buffer, *
 	return &newCtx, &stdout, &stderr
 }
 
+// RealAPIContext returns a CommandContext with a configured API
 func RealAPIContext() *CommandContext {
 	config, err := config.GetConfig()
 	if err != nil {