doc(pkg): ensure all docs are <= 99 chars wide

Also make a few grammatical fixes to docs. This commit does not make
any code changes, even in cases when a line of code expands beyond 99
chars

Author: Aaron Schlesinger

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,10 +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:
+// 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
+// - 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

pkg/git/git.go

@@ -22,7 +22,8 @@ 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.
 const preReceiveHookTplStr = `#!/bin/bash

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,7 +10,8 @@ const (
 	objectStorageTick = 500
 )
 
-// Config is the envconfig (http://github.com/kelseyhightower/envconfig) compatible struct for the builder's git-receive hook
+// 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"`
@@ -36,7 +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
+// 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 {

pkg/gitreceive/storage/client.go

@@ -24,7 +24,8 @@ func GetClient(regionStr string, fs sys.FS, env sys.Env) (*Client, error) {
 		return nil, err
 	}
 
-	// the New function call guesses which signature version to use. Currently, it correctly guesses V2 for GCS and V4 for both AWS S3 and Minio
+	// the New function call guesses which signature version to use. Currently, it correctly guesses
+	// V2 for GCS and V4 for both AWS S3 and Minio
 	s3Client, err := s3.New(endpoint.URLStr, auth.accessKeyID, auth.accessKeySecret, !endpoint.Secure)
 	if err != nil {
 		return nil, err

pkg/gitreceive/storage/interfaces.go

@@ -6,7 +6,9 @@ import (
 	s3 "github.com/minio/minio-go"
 )
 
-// BucketCreator is a *(github.com/minio/minio-go).Client compatible interface, restricted to just the MakeBucket function. You can use it in your code for easier unit testing without any external dependencies
+// BucketCreator is a *(github.com/minio/minio-go).Client compatible interface, restricted to
+// just the MakeBucket function. You can use it in your code for easier unit testing without
+// any external dependencies
 type BucketCreator interface {
 	MakeBucket(bucketName string, acl s3.BucketACL, location string) error
 }
@@ -18,7 +20,8 @@ type FakeMakeBucketCall struct {
 	Location   string
 }
 
-// FakeBucketCreator is a mock function that can be swapped in for an BucketCreator, so you can unit test your code
+// FakeBucketCreator is a mock function that can be swapped in for an BucketCreator, so you
+// can unit test your code
 type FakeBucketCreator struct {
 	Fn    func(string, s3.BucketACL, string) error
 	Calls []FakeMakeBucketCall
@@ -30,7 +33,9 @@ func (f *FakeBucketCreator) MakeBucket(name string, acl s3.BucketACL, location s
 	return f.Fn(name, acl, location)
 }
 
-// ObjectStatter is a *(github.com/minio/minio-go).Client compatible interface, restricted to just the StatObject function. You can use it in your code for easier unit testing without any external dependencies
+// ObjectStatter is a *(github.com/minio/minio-go).Client compatible interface, restricted to
+// just the StatObject function. You can use it in your code for easier unit testing without
+// any external dependencies (like access to S3)
 type ObjectStatter interface {
 	StatObject(bucketName, objectKey string) (s3.ObjectInfo, error)
 }
@@ -41,7 +46,8 @@ type FakeStatObjectCall struct {
 	ObjectKey  string
 }
 
-// FakeObjectStatter is a mock function that can be swapped in for an ObjectStatter, so you can unit test your code
+// FakeObjectStatter is a mock function that can be swapped in for an ObjectStatter, so you can
+// unit test your code
 type FakeObjectStatter struct {
 	Fn    func(string, string) (s3.ObjectInfo, error)
 	Calls []FakeStatObjectCall
@@ -53,7 +59,9 @@ func (f *FakeObjectStatter) StatObject(bucketName, objectKey string) (s3.ObjectI
 	return f.Fn(bucketName, objectKey)
 }
 
-// ObjectPutter is a *(github.com/minio/minio-go).Client compatible interface, restricted to just the PutObject function. You can use it in your code for easier unit testing without any external dependencies
+// ObjectPutter is a *(github.com/minio/minio-go).Client compatible interface, restricted to just
+// the PutObject function. You can use it in your code for easier unit testing without any
+// external dependencies
 type ObjectPutter interface {
 	PutObject(bucketName, objectKey string, reader io.Reader, contentType string) (int64, error)
 }
@@ -66,7 +74,8 @@ type FakePutObjectCall struct {
 	ContentType string
 }
 
-// FakeObjectPutter is a mock function that can be swapped in for an ObjectPutter, so you can unit test your code
+// FakeObjectPutter is a mock function that can be swapped in for an ObjectPutter, so you can
+// unit test your code
 type FakeObjectPutter struct {
 	Fn    func(bucketName, objectKey string, reader io.Reader, contentType string) (int64, error)
 	Calls []FakePutObjectCall
@@ -83,25 +92,36 @@ func (f *FakeObjectPutter) PutObject(bucketName, objectKey string, reader io.Rea
 	return f.Fn(bucketName, objectKey, reader, contentType)
 }
 
-// Object is a *(github.com/minio/minio-go).Object compatible interface. Currently, ObjectGetter returns these so that FakeObjectGetters can return mock implementations
+// Object is a *(github.com/minio/minio-go).Object compatible interface. Currently, ObjectGetter
+// returns these so that FakeObjectGetters can return mock implementations
 type Object interface {
-	// This is called an interface composition - it automatically gives your interface the function in io.Reader (https://godoc.org/io#Reader) and the function in io.Closer (https://godoc.org/io#Closer)
+	// This is called an interface composition - it automatically gives your interface the function
+	// in io.Reader (https://godoc.org/io#Reader) and the function in io.Closer
+	// (https://godoc.org/io#Closer)
 	io.ReadCloser
-	// This is also an interface composition. It gives your interface the function in io.Seeker (https://godoc.org/io#Seeker)
+	// This is also an interface composition. It gives your interface the function in
+	// io.Seeker (https://godoc.org/io#Seeker)
 	io.Seeker
-	// This is also interface composition. It gives your interface the function in io.ReaderAt (https://godoc.org/io#ReaderAt)
+	// This is also interface composition. It gives your interface the function in
+	// io.ReaderAt (https://godoc.org/io#ReaderAt)
 	io.ReaderAt
-	// This function is the last one we have to add to make this interface have all the same functions as s3.Object
+	// This function is the last one we have to add to make this interface have all the same
+	// functions as s3.Object
 	Stat() (s3.ObjectInfo, error)
 }
 
-// ObjectGetter is the interface to get an object from object storage. The minio client doesn't already satisfy this interface, because the GetObject func (https://godoc.org/github.com/minio/minio-go#Client.GetObject) doesn't return an Object. Instead, it returns a *s3.Object. Use the RealObjectGetter below to use the minio client
+// ObjectGetter is the interface to get an object from object storage. The minio client doesn't
+// already satisfy this interface, because the GetObject func
+// (https://godoc.org/github.com/minio/minio-go#Client.GetObject) doesn't return an Object.
+// Instead, it returns a *s3.Object. Use the RealObjectGetter below to use the minio client
 type ObjectGetter interface {
-	// GetObject is *almost* the same function as the GetObject func in the minio client, but it returns Object instead of *s3.Object
+	// GetObject is *almost* the same function as the GetObject func in the minio client, but it
+	// returns Object instead of *s3.Object
 	GetObject(string, string) (Object, error)
 }
 
-// RealObjectGetter is an adapter to make the *s3.Client GetObject function compatible with the ObjectGetter interface
+// RealObjectGetter is an adapter to make the *s3.Client GetObject function compatible with the
+// ObjectGetter interface
 type RealObjectGetter struct {
 	Client *s3.Client
 }
@@ -113,7 +133,8 @@ func (r *RealObjectGetter) GetObject(bucket, objKey string) (Object, error) {
 		// you can return nil for an interface
 		return nil, err
 	}
-	// obj is a *s3.Object, but as we said above, it automatically implements our Object interface without any other work
+	// obj is a *s3.Object, but as we said above, it automatically implements our Object interface
+	// without any other work
 	return obj, nil
 }
 
@@ -123,7 +144,8 @@ type FakeGetObjectCall struct {
 	ObjectKey  string
 }
 
-// FakeObjectGetter is a mock function that can be swapped in for an ObjectGetter, so you can unit test your code
+// FakeObjectGetter is a mock function that can be swapped in for an ObjectGetter, so you can
+// unit test your code
 type FakeObjectGetter struct {
 	Fn    func(string, string) (Object, error)
 	Calls []FakeGetObjectCall
@@ -135,7 +157,8 @@ func (f *FakeObjectGetter) GetObject(bucketName, objectKey string) (Object, erro
 	return f.Fn(bucketName, objectKey)
 }
 
-// FakeObject is a mock function that can be swapped in for an *s3.Object, so you can unit test your code
+// FakeObject is a mock function that can be swapped in for an *s3.Object, so you can unit test
+// your code
 type FakeObject struct {
 	Data string
 }

pkg/gitreceive/storage/object.go

@@ -16,7 +16,8 @@ const (
 	octetStream = "application/octet-stream"
 )
 
-// ObjectExists determines whether the object in ${bucketName}/${objKey} exists, as reported by statter. Returns the following:
+// ObjectExists determines whether the object in ${bucketName}/${objKey} exists, as reported by
+// statter. Returns the following:
 //
 // - false, nil if statter succeeded and reported the object doesn't exist
 // - false, err with the appropriate error if the statter failed
@@ -39,7 +40,8 @@ func UploadObject(putter ObjectPutter, bucketName, objKey string, reader io.Read
 	return err
 }
 
-// WaitForObject checks statter for the object at ${bucketName}/${objKey} right away, then at every tick, then once when the timeout is up.
+// WaitForObject checks statter for the object at ${bucketName}/${objKey} right away, then at
+// every tick, then once when the timeout is up.
 // Returns nil if it finds the object before or at timeout. Otherwise returns a non-nil error
 func WaitForObject(statter ObjectStatter, bucketName, objKey string, tick, timeout time.Duration) error {
 	noExist := errors.New("object doesn't exist")
@@ -75,7 +77,9 @@ func WaitForObject(statter ObjectStatter, bucketName, objKey string, tick, timeo
 	}
 }
 
-// DownloadObject uses the given getter to download the contents the object at ${bucketName}/${objKey} and returns the object's contents in the given byte slice. Returns nil and the appropriate error if there were problems with the download
+// DownloadObject uses the given getter to download the contents the object at
+// ${bucketName}/${objKey} and returns the object's contents in the given byte slice.
+// Returns nil and the appropriate error if there were problems with the download
 func DownloadObject(getter ObjectGetter, bucketName, objKey string) ([]byte, error) {
 	reader, err := getter.GetObject(bucketName, objKey)
 	if err != nil {

pkg/gitreceive/storage/slug_builder_info.go

@@ -10,7 +10,8 @@ const (
 	slugTGZName = "slug.tgz"
 )
 
-// SlugBuilderInfo contains all of the object storage related information needed to pass to a slug builder
+// SlugBuilderInfo contains all of the object storage related information needed to pass to a
+// slug builder
 type SlugBuilderInfo struct {
 	pushKey string
 	pushURL string
@@ -21,7 +22,8 @@ type SlugBuilderInfo struct {
 // NewSlugBuilderInfo creates and populates a new SlugBuilderInfo based on the given data
 func NewSlugBuilderInfo(s3Endpoint *Endpoint, bucket, appName, slugName string, gitSha *git.SHA) *SlugBuilderInfo {
 	tarKey := fmt.Sprintf("home/%s/tar", slugName)
-	// this is where the controller tells slugrunner to download the slug from, so we have to tell slugbuilder to upload it to here
+	// this is where the controller tells slugrunner to download the slug from, so we have to
+	// tell slugbuilder to upload it to here
 	pushKey := fmt.Sprintf("home/%s:git-%s/push", appName, gitSha.Short())
 
 	return &SlugBuilderInfo{
@@ -32,16 +34,21 @@ func NewSlugBuilderInfo(s3Endpoint *Endpoint, bucket, appName, slugName string,
 	}
 }
 
-// PushKey returns the object storage key that the slug builder will store the slug in. The returned value only contains the path to the folder, not including the final filename.
+// PushKey returns the object storage key that the slug builder will store the slug in.
+// The returned value only contains the path to the folder, not including the final filename.
 func (s SlugBuilderInfo) PushKey() string { return s.pushKey }
 
-// PushURL returns the complete object storage URL that the slug builder will store the slug in. The returned value only contains the URL to the folder, not including the final filename.
+// PushURL returns the complete object storage URL that the slug builder will store the slug in.
+// The returned value only contains the URL to the folder, not including the final filename.
 func (s SlugBuilderInfo) PushURL() string { return s.pushURL }
 
-// TarKey returns the object storage key from which the slug builder will download for the tarball (from which it uses to build the slug). The returned value only contains the path to the folder, not including the final filename.
+// TarKey returns the object storage key from which the slug builder will download for the tarball
+// (from which it uses to build the slug). The returned value only contains the path to the
+// folder, not including the final filename.
 func (s SlugBuilderInfo) TarKey() string { return s.tarKey }
 
-// TarURL returns the complete object storage URL that the slug builder will download the tarball from. The returned value only contains the URL to the folder, not including the final filename.
+// TarURL returns the complete object storage URL that the slug builder will download the tarball
+// from. The returned value only contains the URL to the folder, not including the final filename.
 func (s SlugBuilderInfo) TarURL() string { return s.tarURL }
 
 // AbsoluteSlugObjectKey returns the PushKey plus the final filename of the slug