test: Add a check for too long or badly reflowed docstrings

This ensures that docstring comments are wrapped to 80 chars. ffrank
seemed to be making this mistake far too often, and it's a silly thing
to look for manually. As it turns out, I've made it too, as have many
others. Now we have a test that checks for most cases. There are still a
few stray cases that aren't checked automatically, but this can be
improved upon if someone is motivated to do so.

Before anyone complains about the 80 character limit: this only checks
docstring comments, not source code length or inline source code
comments. There's no excuse for having docstrings that are badly
reflowed or over 80 chars, particularly if you have an automated test.

etcd/client/resources/resources.go

@@ -114,11 +114,11 @@ func SetResources(ctx context.Context, client interfaces.Client, hostname string
 	return err
 }
 
-// GetResources collects all of the resources which match a filter from etcd.
-// If the kindfilter or hostnameFilter is empty, then it assumes no filtering...
+// GetResources collects all of the resources which match a filter from etcd. If
+// the kindfilter or hostnameFilter is empty, then it assumes no filtering...
 // TODO: Expand this with a more powerful filter based on what we eventually
 // support in our collect DSL. Ideally a server side filter like WithFilter()
-// We could do this if the pattern was $NS/exported/$kind/$hostname/$uid = $data.
+// could do this if the pattern was $NS/exported/$kind/$hostname/$uid = $data.
 func GetResources(ctx context.Context, client interfaces.Client, hostnameFilter, kindFilter []string) ([]engine.Res, error) {
 	// key structure is $NS/exported/$hostname/resources/$uid = $data
 	path := fmt.Sprintf("%s/exported/", ns)

etcd/client/simple.go

@@ -372,10 +372,8 @@ func (obj *Simple) Watcher(ctx context.Context, path string, opts ...etcd.OpOpti
 // will return an error. Remember to add the WithPrefix() option if you want to
 // watch recursively.
 // TODO: do we need to support retry and changed client connections?
-// XXX: do we need to track last successful revision and retry from there?
-// XXX: if so, use:
-// lastRev := response.Header.Revision // TODO: +1 ?
-// etcd.WithRev(rev)
+// XXX: do we need to track last successful revision and retry from there? If so
+// use: lastRev := response.Header.Revision // TODO: +1 ? and: etcd.WithRev(rev)
 func (obj *Simple) ComplexWatcher(ctx context.Context, path string, opts ...etcd.OpOption) (*interfaces.WatcherInfo, error) {
 	if obj.client == nil { // catch bugs, this often means programming error
 		return nil, fmt.Errorf("client is nil") // extra safety!

etcd/client/str/str.go

@@ -37,8 +37,9 @@ const (
 // something goes wrong.
 // XXX: since the caller of this (via the World API) has no way to tell it it's
 // done, does that mean we leak go-routines since it might still be running, but
-// perhaps even blocked??? Could this cause a dead-lock? Should we instead return
-// some sort of struct which has a close method with it to ask for a shutdown?
+// perhaps even blocked??? Could this cause a dead-lock? Should we instead
+// return some sort of struct which has a close method with it to ask for a
+// shutdown?
 func WatchStr(ctx context.Context, client interfaces.Client, key string) (chan error, error) {
 	// new key structure is $NS/strings/$key = $data
 	path := fmt.Sprintf("%s/strings/%s", ns, key)
@@ -70,8 +71,8 @@ func GetStr(ctx context.Context, client interfaces.Client, key string) (string,
 	return val, nil
 }
 
-// SetStr sets a key and hostname pair to a certain value. If the value is
-// nil, then it deletes the key. Otherwise the value should point to a string.
+// SetStr sets a key and hostname pair to a certain value. If the value is nil,
+// then it deletes the key. Otherwise the value should point to a string.
 // TODO: TTL or delete disconnect?
 func SetStr(ctx context.Context, client interfaces.Client, key string, data *string) error {
 	// key structure is $NS/strings/$key = $data

etcd/deployer/deployer.go

@@ -128,7 +128,8 @@ func calculateMax(deploys map[uint64]string) uint64 {
 // GetDeploy returns the deploy with the specified id if it exists. If you input
 // an id of 0, you'll get back an empty deploy without error. This is useful so
 // that you can pass through this function easily.
-// FIXME: implement this more efficiently so that it doesn't have to download *all* the old deploys from etcd!
+// FIXME: implement this more efficiently so that it doesn't have to download
+// *all* the old deploys from etcd!
 func (obj *SimpleDeploy) GetDeploy(ctx context.Context, id uint64) (string, error) {
 	result, err := obj.GetDeploys(ctx)
 	if err != nil {

etcd/fs/fs.go

@@ -82,9 +82,9 @@ var (
 // update the metadata pointer to point to the new blob. This might seem slow,
 // but it has the unique advantage of being relatively straight forward to
 // implement, and repeated uploads of the same file cost almost nothing. Since
-// etcd isn't meant for large file systems, this fits the desired use case.
-// This implementation is designed to have a single writer for each superblock,
-// but as many readers as you like.
+// etcd isn't meant for large file systems, this fits the desired use case. This
+// implementation is designed to have a single writer for each superblock, but
+// as many readers as you like.
 // FIXME: this is not currently thread-safe, nor is it clear if it needs to be.
 // XXX: we probably aren't updating the modification time everywhere we should!
 // XXX: because we never delete data blocks, we need to occasionally "vacuum".
@@ -656,10 +656,10 @@ func (obj *Fs) RemoveAll(path string) error {
 }
 
 // Rename moves or renames a file or directory.
-// TODO: seems it's okay to move files or directories, but you can't clobber dirs
-// but you can clobber single files. a dir can't clobber a file and a file can't
-// clobber a dir. but a file can clobber another file but a dir can't clobber
-// another dir. you can also transplant dirs or files into other dirs.
+// TODO: seems it's okay to move files or directories, but you can't clobber
+// dirs but you can clobber single files. a dir can't clobber a file and a file
+// can't clobber a dir. but a file can clobber another file but a dir can't
+// clobber another dir. you can also transplant dirs or files into other dirs.
 func (obj *Fs) Rename(oldname, newname string) error {
 	// XXX: do we need to check if dest path is inside src path?
 	// XXX: if dirs/files are next to each other, do we mess up the .Children list of the common parent?

etcd/fs/util.go

@@ -24,56 +24,53 @@ import (
 	"github.com/spf13/afero"
 )
 
-// ReadAll reads from r until an error or EOF and returns the data it read.
-// A successful call returns err == nil, not err == EOF. Because ReadAll is
-// defined to read from src until EOF, it does not treat an EOF from Read
-// as an error to be reported.
+// ReadAll reads from r until an error or EOF and returns the data it read. A
+// successful call returns err == nil, not err == EOF. Because ReadAll is
+// defined to read from src until EOF, it does not treat an EOF from Read as an
+// error to be reported.
 //func (obj *Fs) ReadAll(r io.Reader) ([]byte, error) {
 //	// NOTE: doesn't need Fs, same as ioutil.ReadAll package
 //	return afero.ReadAll(r)
 //}
 
-// ReadDir reads the directory named by dirname and returns
-// a list of sorted directory entries.
+// ReadDir reads the directory named by dirname and returns a list of sorted
+// directory entries.
 func (obj *Fs) ReadDir(dirname string) ([]os.FileInfo, error) {
 	return afero.ReadDir(obj, dirname)
 }
 
-// ReadFile reads the file named by filename and returns the contents.
-// A successful call returns err == nil, not err == EOF. Because ReadFile
-// reads the whole file, it does not treat an EOF from Read as an error
-// to be reported.
+// ReadFile reads the file named by filename and returns the contents. A
+// successful call returns err == nil, not err == EOF. Because ReadFile reads
+// the whole file, it does not treat an EOF from Read as an error to be
+// reported.
 func (obj *Fs) ReadFile(filename string) ([]byte, error) {
 	return afero.ReadFile(obj, filename)
 }
 
-// TempDir creates a new temporary directory in the directory dir
-// with a name beginning with prefix and returns the path of the
-// new directory.  If dir is the empty string, TempDir uses the
-// default directory for temporary files (see os.TempDir).
-// Multiple programs calling TempDir simultaneously
-// will not choose the same directory.  It is the caller's responsibility
-// to remove the directory when no longer needed.
+// TempDir creates a new temporary directory in the directory dir with a name
+// beginning with prefix and returns the path of the new directory. If dir is
+// the empty string, TempDir uses the default directory for temporary files (see
+// os.TempDir). Multiple programs calling TempDir simultaneously will not choose
+// the same directory. It is the caller's responsibility to remove the directory
+// when no longer needed.
 func (obj *Fs) TempDir(dir, prefix string) (name string, err error) {
 	return afero.TempDir(obj, dir, prefix)
 }
 
-// TempFile creates a new temporary file in the directory dir
-// with a name beginning with prefix, opens the file for reading
-// and writing, and returns the resulting *File.
-// If dir is the empty string, TempFile uses the default directory
-// for temporary files (see os.TempDir).
-// Multiple programs calling TempFile simultaneously
-// will not choose the same file.  The caller can use f.Name()
-// to find the pathname of the file.  It is the caller's responsibility
+// TempFile creates a new temporary file in the directory dir with a name
+// beginning with prefix, opens the file for reading and writing, and returns
+// the resulting *File. If dir is the empty string, TempFile uses the default
+// directory for temporary files (see os.TempDir). Multiple programs calling
+// TempFile simultaneously will not choose the same file. The caller can use
+// f.Name() to find the pathname of the file. It is the caller's responsibility
 // to remove the file when no longer needed.
 func (obj *Fs) TempFile(dir, prefix string) (f afero.File, err error) {
 	return afero.TempFile(obj, dir, prefix)
 }
 
-// WriteFile writes data to a file named by filename.
-// If the file does not exist, WriteFile creates it with permissions perm;
-// otherwise WriteFile truncates it before writing.
+// WriteFile writes data to a file named by filename. If the file does not
+// exist, WriteFile creates it with permissions perm; otherwise WriteFile
+// truncates it before writing.
 func (obj *Fs) WriteFile(filename string, data []byte, perm os.FileMode) error {
 	return afero.WriteFile(obj, filename, data, perm)
 }
@@ -81,9 +78,8 @@ func (obj *Fs) WriteFile(filename string, data []byte, perm os.FileMode) error {
 // Walk walks the file tree rooted at root, calling walkFn for each file or
 // directory in the tree, including root. All errors that arise visiting files
 // and directories are filtered by walkFn. The files are walked in lexical
-// order, which makes the output deterministic but means that for very
-// large directories Walk can be inefficient.
-// Walk does not follow symbolic links.
+// order, which makes the output deterministic but means that for very large
+// directories Walk can be inefficient. Walk does not follow symbolic links.
 func (obj *Fs) Walk(root string, walkFn filepath.WalkFunc) error {
 	return afero.Walk(obj, root, walkFn)
 }

etcd/world.go

@@ -132,7 +132,8 @@ func (obj *World) StrDel(ctx context.Context, namespace string) error {
 	return str.SetStr(ctx, obj.Client, namespace, nil)
 }
 
-// StrMapWatch returns a channel which spits out events on possible string changes.
+// StrMapWatch returns a channel which spits out events on possible string
+// changes.
 func (obj *World) StrMapWatch(ctx context.Context, namespace string) (chan error, error) {
 	return strmap.WatchStrMap(ctx, obj.Client, namespace)
 }