Update README and various errata (#537)

- Update build command in README and various spelling fixes
- Add example to CONTRIBUTING page
- Remove golint warnings
- Clean up some error messages and comments

Author: themattman

CONTRIBUTING.md

@@ -53,11 +53,19 @@ To run unit and integration tests:
 ```
 go test -v ./...
 ```
-If TOOLS_TESTING_UNIT is set to a true value in the environment, unit tests will run.
-If TOOLS_TESTING_INTEGRATION is set to a true value in the environment, integration tests will run.
+
+If `TOOLS_TESTING_UNIT` is set to a true value in the shell environment, unit tests will run.
+
+If `TOOLS_TESTING_INTEGRATION` is set to a true value in the shell environment, integration tests will run.
 
 Integration tests require a `mongod` (running on port 33333) while unit tests do not.
 
+Example of how to run a specific integration test:
+
+```
+TOOLS_TESTING_INTEGRATION=true go test -v ./... -run TestImportDocuments
+```
+
 To run the quality assurance tests, you need to have the latest stable version of the rebuilt tools, `mongod`, `mongos`, and `mongo` in your current working directory.
 
 ```

README.md

@@ -26,7 +26,7 @@ cd mongo-tools
 
 Then run `./make build` to build all the tools, placing them in the `bin` directory inside the repository.
 
-You can also build a subset of the tools using the `-tools` option. For example, `./make build -tools=mongodump,mongorestore` builds only `mongodump` and `mongorestore`.
+You can also build a subset of the tools using the `-pkgs` option. For example, `./make build -pkgs=mongodump,mongorestore` builds only `mongodump` and `mongorestore`.
 
 To use the build/test scripts in this repository, you **_must_** set GOROOT to your Go root directory. This may depend on how you installed Go.
 

common/db/optime.go

@@ -88,7 +88,7 @@ func (ot OpTime) String() string {
 		return fmt.Sprintf("{Timestamp: %v, Term: %v, Hash: %v}", ot.Timestamp, nil, *ot.Hash)
 	} else if ot.Term != nil && ot.Hash == nil {
 		return fmt.Sprintf("{Timestamp: %v, Term: %v, Hash: %v}", ot.Timestamp, *ot.Term, nil)
-	} else {
-		return fmt.Sprintf("{Timestamp: %v, Term: %v, Hash: %v}", ot.Timestamp, nil, nil)
 	}
+
+	return fmt.Sprintf("{Timestamp: %v, Term: %v, Hash: %v}", ot.Timestamp, nil, nil)
 }

common/idx/index_catalog.go

@@ -225,11 +225,11 @@ func (i *IndexCatalog) DeleteIndexes(database, collection string, dropCmd bson.D
 				i.addIndex(database, collection, idIndexName, idIndex)
 			}
 			return nil
-		} else {
-			// Drop an index by name.
-			delete(collIndexes, indexToDrop)
-			return nil
 		}
+
+		// Drop an index by name.
+		delete(collIndexes, indexToDrop)
+		return nil
 	case bson.D:
 		var toDelete []string
 		// Drop an index by key pattern.

mongofiles/mongofiles.go

@@ -170,7 +170,7 @@ func (mf *MongoFiles) ValidateCommand(args []string) error {
 	}
 
 	if mf.StorageOptions.GridFSPrefix == "" {
-		return fmt.Errorf("--prefix can not be blank")
+		return fmt.Errorf("--prefix cannot be blank")
 	}
 
 	mf.Command = args[0]

mongoimport/mongoimport.go

@@ -161,7 +161,7 @@ func (imp *MongoImport) validateSettings(args []string) error {
 			}
 			if imp.InputOptions.FieldFile != nil &&
 				*imp.InputOptions.FieldFile == "" {
-				return fmt.Errorf("--fieldFile can not be empty string")
+				return fmt.Errorf("--fieldFile cannot be empty string")
 			}
 			if imp.InputOptions.Fields != nil &&
 				imp.InputOptions.FieldFile != nil {
@@ -185,19 +185,19 @@ func (imp *MongoImport) validateSettings(args []string) error {
 	} else {
 		// input type is JSON
 		if imp.InputOptions.HeaderLine {
-			return fmt.Errorf("can not use --headerline when input type is JSON")
+			return fmt.Errorf("cannot use --headerline when input type is JSON")
 		}
 		if imp.InputOptions.Fields != nil {
-			return fmt.Errorf("can not use --fields when input type is JSON")
+			return fmt.Errorf("cannot use --fields when input type is JSON")
 		}
 		if imp.InputOptions.FieldFile != nil {
-			return fmt.Errorf("can not use --fieldFile when input type is JSON")
+			return fmt.Errorf("cannot use --fieldFile when input type is JSON")
 		}
 		if imp.IngestOptions.IgnoreBlanks {
-			return fmt.Errorf("can not use --ignoreBlanks when input type is JSON")
+			return fmt.Errorf("cannot use --ignoreBlanks when input type is JSON")
 		}
 		if imp.InputOptions.ColumnsHaveTypes {
-			return fmt.Errorf("can not use --columnsHaveTypes when input type is JSON")
+			return fmt.Errorf("cannot use --columnsHaveTypes when input type is JSON")
 		}
 	}
 
@@ -211,7 +211,7 @@ func (imp *MongoImport) validateSettings(args []string) error {
 		if imp.IngestOptions.Mode == "" {
 			imp.IngestOptions.Mode = modeUpsert
 		} else if imp.IngestOptions.Mode == modeInsert {
-			return fmt.Errorf("can not use --upsertFields with --mode=insert")
+			return fmt.Errorf("cannot use --upsertFields with --mode=insert")
 		}
 		imp.upsertFields = strings.Split(imp.IngestOptions.UpsertFields, ",")
 		if err := validateFields(imp.upsertFields, imp.InputOptions.UseArrayIndexFields); err != nil {

mongoimport/typed_fields.go

@@ -90,7 +90,7 @@ func ColumnNames(fs []ColumnSpec) (s []string) {
 }
 
 // ParseTypedHeader produces a ColumnSpec from a header item, extracting type
-// information from the it. The parseGrace is passed along to the new ColumnSpec.
+// information from it. The parseGrace is passed along to the new ColumnSpec.
 func ParseTypedHeader(header string, parseGrace ParseGrace) (f ColumnSpec, err error) {
 	match := columnTypeRE.FindStringSubmatch(header)
 	if len(match) != 4 {

mongoimport/typed_fields_test.go

@@ -27,7 +27,7 @@ func init() {
 func TestTypedHeaderParser(t *testing.T) {
 	testtype.SkipUnlessTestType(t, testtype.UnitTestType)
 
-	Convey("Using 'zip.string(),number.double(),foo.auto()'", t, func() {
+	Convey("Using 'zip.string(),number.double(),foo.auto(),bar.date(January 2, (2006))'", t, func() {
 		var headers = []string{"zip.string()", "number.double()", "foo.auto()", `bar.date(January 2\, \(2006\))`}
 		var colSpecs []ColumnSpec
 		var err error