Merge pull request #247 from arschles/fix-golint

fix(*): add godocs and address other golint issues

Author: arschles

pkg/builder.go

@@ -1,6 +1,7 @@
 // Package pkg provides common libraries for the Deis builder.
 //
-// The Deis builder is responsible for packaging Docker images for consumers.
+// The Deis builder is responsible for building slugs and docker images for use in the Deis
+// on the Deis PaaS platform.
 package pkg
 
 import (
@@ -19,7 +20,7 @@ const (
 	StatusLocalError
 )
 
-// Run starts the Builder service.
+// RunBuilder starts the Builder service.
 //
 // The Builder service is responsible for setting up the local container
 // environment and then listening for new builds. The main listening service

pkg/cleaner/cleaner.go

@@ -1,4 +1,5 @@
-// Package cleaner is a background process that compares the kubernetes namespace list with the folders in the local git home directory, deleting what's not in the namespace list
+// Package cleaner is a background process that compares the kubernetes namespace list with the
+// folders in the local git home directory, deleting what's not in the namespace list.
 package cleaner
 
 import (
@@ -14,9 +15,11 @@ const (
 	dotGitSuffix = ".git"
 )
 
-// Run starts the deleted app cleaner. This function listens to the Kubernetes event stream for events that indicate namespaces that were `DELETED`.
+// Run starts the deleted app cleaner. This function listens to the Kubernetes event stream for
+// events that indicate namespaces that were `DELETED`.
 // If the namespace name matches a folder on the local filesystem, this func deletes that folder.
-// Note that this function blocks until the watcher returned by `nsLister.Watch` is closed, so you should launch it in a goroutine.
+// Note that this function blocks until the watcher returned by `nsLister.Watch` is closed, so
+// you should launch it in a goroutine.
 func Run(gitHome string, nsLister k8s.NamespaceWatcher, fs sys.FS) error {
 	watcher, err := nsLister.Watch(nil, nil, "")
 	if err != nil {

pkg/conf/config.go

@@ -11,6 +11,14 @@ const (
 	builderKeyLocation = "/var/run/secrets/api/auth/builder-key"
 )
 
+// EnvConfig is a convenience function to process the envconfig (
+// https://github.com/kelseyhightower/envconfig) based configuration environment variables into
+// conf. Additional notes:
+//
+// - appName will be passed as the first parameter to envconfig.Process
+// - conf should be a pointer to an envconfig compatible struct. If you'd like to use struct
+// 	 	tags to customize your struct, see
+// 		https://github.com/kelseyhightower/envconfig#struct-tag-support
 func EnvConfig(appName string, conf interface{}) error {
 	if err := envconfig.Process(appName, conf); err != nil {
 		return err

pkg/controller/utils.go

@@ -18,7 +18,8 @@ const (
 	portEnvName = "DEIS_CONTROLLER_SERVICE_PORT"
 )
 
-// UserInfo represent the required information from a user to make a push and interact with the controller
+// UserInfo represents the required information from a user to make a push and interact with the
+// controller
 type UserInfo struct {
 	Username    string
 	Key         string
@@ -61,7 +62,7 @@ func fingerprint(key ssh.PublicKey) string {
 	return string(fp)
 }
 
-// UserInfoFromKey makes a request to the controller to get the user info from they given key
+// UserInfoFromKey makes a request to the controller to get the user info from they given key.
 func UserInfoFromKey(key ssh.PublicKey) (*UserInfo, error) {
 	fp := fingerprint(key)
 	url, err := controllerURLStr("v2", "hooks", "key", fp)

pkg/git/git.go

@@ -22,9 +22,10 @@ import (
 	"golang.org/x/crypto/ssh"
 )
 
-// prereceiveHookTplStr is the template for a pre-receive hook. The following template variables are passed into it:
+// prereceiveHookTplStr is the template for a pre-receive hook. The following template variables
+// are passed into it:
 //
-// 	.GitHome: the path to Git's home directory.
+// - .GitHome: the path to Git's home directory
 const preReceiveHookTplStr = `#!/bin/bash
 strip_remote_prefix() {
     stdbuf -i0 -o0 -e0 sed "s/^/"$'\e[1G'"/"

pkg/gitreceive/build.go

@@ -29,7 +29,8 @@ func repoCmd(repoDir, first string, others ...string) *exec.Cmd {
 	return cmd
 }
 
-// run prints the command it will execute to the debug log, then runs it and returns the result of run
+// run prints the command it will execute to the debug log, then runs it and returns the result
+// of run
 func run(cmd *exec.Cmd) error {
 	cmdStr := strings.Join(cmd.Args, " ")
 	if cmd.Dir != "" {

pkg/gitreceive/config.go

@@ -10,6 +10,8 @@ const (
 	objectStorageTick = 500
 )
 
+// Config is the envconfig (http://github.com/kelseyhightower/envconfig) compatible struct for the
+// builder's git-receive hook.
 type Config struct {
 	// k8s service discovery env vars
 	ControllerHost string `envconfig:"DEIS_CONTROLLER_SERVICE_HOST" required:"true"`
@@ -35,6 +37,8 @@ type Config struct {
 	DockerBuilderImage            string `envconfig:"DOCKERBUILDER_IMAGE_NAME" default:"quay.io/deisci/dockerbuilder:v2-beta"`
 }
 
+// App returns the application name represented by c. The app name is the same as c.Repository
+// with the last '.' and beyond stripped off.
 func (c Config) App() string {
 	li := strings.LastIndex(c.Repository, ".")
 	if li == -1 {
@@ -44,31 +48,31 @@ func (c Config) App() string {
 }
 
 // BuilderPodTickDuration returns the size of the interval used to check for
-// the end of the execution of a Pod building an application
+// the end of the execution of a Pod building an application.
 func (c Config) BuilderPodTickDuration() time.Duration {
 	return time.Duration(time.Duration(c.BuilderPodTickDurationMSec) * time.Millisecond)
 }
 
 // BuilderPodWaitDuration returns the maximum time to wait for the end
-// of the execution of a Pod building an application
+// of the execution of a Pod building an application.
 func (c Config) BuilderPodWaitDuration() time.Duration {
 	return time.Duration(time.Duration(c.BuilderPodWaitDurationMSec) * time.Millisecond)
 }
 
 // ObjectStorageTickDuration returns the size of the interval used to check for
-// the end of an operation that involves the object storage
+// the end of an operation that involves the object storage.
 func (c Config) ObjectStorageTickDuration() time.Duration {
 	return time.Duration(time.Duration(c.ObjectStorageTickDurationMSec) * time.Millisecond)
 }
 
 // ObjectStorageWaitDuration returns the maximum time to wait for the end of an
-// operation that involves the object storage
+// operation that involves the object storage.
 func (c Config) ObjectStorageWaitDuration() time.Duration {
 	return time.Duration(time.Duration(c.ObjectStorageWaitDurationMSec) * time.Millisecond)
 }
 
 // CheckDurations checks if ticks for builder and object storage are not bigger
-// than the maximum duration. In case of this it will set the tick to the default
+// than the maximum duration. In case of this it will set the tick to the default.
 func (c *Config) CheckDurations() {
 	if c.BuilderPodTickDurationMSec >= c.BuilderPodWaitDurationMSec {
 		c.BuilderPodTickDurationMSec = builderPodTick

pkg/gitreceive/git/sha.go

@@ -12,25 +12,32 @@ const (
 
 var shaRegex = regexp.MustCompile(`^[\da-f]{40}$`)
 
+// ErrInvalidGitSha is returned by NewSha if the given raw sha is invalid for any reason.
 type ErrInvalidGitSha struct {
 	sha string
 }
 
+// Error is the error interface implementation.
 func (e ErrInvalidGitSha) Error() string {
 	return fmt.Sprintf("git sha %s was invalid", e.sha)
 }
 
+// SHA is the representaton of a git sha
 type SHA struct {
 	full  string
 	short string
 }
 
+// NewSha creates a raw string to a SHA. Returns ErrInvalidGitSha if the sha was invalid.
 func NewSha(rawSha string) (*SHA, error) {
 	if !shaRegex.MatchString(rawSha) {
 		return nil, ErrInvalidGitSha{sha: rawSha}
 	}
 	return &SHA{full: rawSha, short: rawSha[0:8]}, nil
 }
 
-func (s SHA) Full() string  { return s.full }
+// Full returns the full git sha.
+func (s SHA) Full() string { return s.full }
+
+// Short returns the first 8 characters of the sha.
 func (s SHA) Short() string { return s.short }

pkg/gitreceive/run.go

@@ -23,6 +23,8 @@ func readLine(line string) (string, string, string, error) {
 	return spl[0], spl[1], spl[2], nil
 }
 
+// Run runs the git-receive hook. This func is effectively the main for the git-receive hook,
+// although it is called from the main in boot.go.
 func Run(conf *Config, fs sys.FS, env sys.Env) error {
 	log.Debug("Running git hook")
 

pkg/gitreceive/storage/auth.go

@@ -31,7 +31,7 @@ func (c *creds) isZero() bool {
 // getAuth gets storage credentials from accessKeyIDFile and accessSecretKeyFile.
 // if a key exists but not a secret, or vice-versa, returns an error.
 // if both don't exist returns emptyAuth.
-// otherwise returns a valid auth
+// otherwise returns a valid auth.
 func getAuth(fs sys.FS) (*creds, error) {
 	accessKeyIDBytes, accessKeyErr := fs.ReadFile(accessKeyIDFile)
 	accessSecretKeyBytes, accessSecretKeyErr := fs.ReadFile(accessSecretKeyFile)
@@ -50,7 +50,7 @@ func getAuth(fs sys.FS) (*creds, error) {
 	return &creds{accessKeyID: id, accessKeySecret: secret}, nil
 }
 
-// CredsOK checks if the required credentials to make a request exist
+// CredsOK checks if the required credentials to make a request exist.
 func CredsOK(fs sys.FS) bool {
 	creds, err := getAuth(fs)
 	if err != nil {