Go reportcard (#45)

* improvement of code based on golint suggestion

* Comment improvments based on goreport suggestions

* more updates to comment based on goreportcard

* Adding download badge

* Add go report card badge

Author: faisaltheparttimecoder

Makefile

@@ -51,7 +51,7 @@ codecov_tests:
 	MOCK_DATA_TEST_RUNNER=$(MOCK_DATA_TEST_RUNNER) PGPASSWORD=$(PGPASSWORD) PGDATABASE=$(PGDATABASE) PGUSER=$(PGUSER) PGHOST=$(PGHOST) PGPORT=$(PGPORT) GOFLAGS="-count=1" go test -v . -coverprofile=coverage.txt -covermode=atomic
 	@echo "#### Finished Mock Data Test"
 	make drop_db
-.PHONY: unit_tests
+.PHONY: codecov_tests
 
 # Run all mock data test
 tests:

README.md

@@ -1,5 +1,4 @@
-# Mock Data [![go version](https://img.shields.io/github/go-mod/go-version/pivotal-gss/mock-data?filename=go.mod&style=flat&logo=go&label=Go)](https://golang.org/dl/) [![CI](https://img.shields.io/github/workflow/status/pivotal-gss/mock-data/CI?logo=github&style=flat&label=CI)](https://github.com/pivotal-gss/mock-data/actions/workflows/ci.yml) [![CI](https://img.shields.io/github/workflow/status/pivotal-gss/mock-data/Tests?logo=github&style=flat&label=Tests)](https://github.com/pivotal-gss/mock-data/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/pivotal-gss/mock-data/branch/master/graph/badge.svg)](https://codecov.io/gh/pivotal-gss/mock-data) [![Go Report Card](https://goreportcard.com/badge/github.com/pivotal-gss/mock-data?logo=go)](https://goreportcard.com/report/github.com/pivotal-gss/mock-data)
-
+# Mock Data [![go version](https://img.shields.io/github/go-mod/go-version/pivotal-gss/mock-data?filename=go.mod&style=flat&logo=go&label=Go)](https://golang.org/dl/) [![CI](https://img.shields.io/github/workflow/status/pivotal-gss/mock-data/CI?logo=github&style=flat&label=CI)](https://github.com/pivotal-gss/mock-data/actions/workflows/ci.yml) [![CI](https://img.shields.io/github/workflow/status/pivotal-gss/mock-data/Tests?logo=github&style=flat&label=Tests)](https://github.com/pivotal-gss/mock-data/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/pivotal-gss/mock-data/branch/master/graph/badge.svg)](https://codecov.io/gh/pivotal-gss/mock-data) [![Go Report Card](https://goreportcard.com/badge/github.com/pivotal-gss/mock-data?logo=go)](https://goreportcard.com/report/github.com/pivotal-gss/mock-data) [![Github Releases Stats of mock-data](https://img.shields.io/github/downloads/pivotal-gss/mock-data/total.svg?logo=github&label=Downloads)](https://somsubhra.github.io/github-release-stats/?username=pivotal-gss&repository=mock-data)
     Here are my tables
     Load them [with data] for me
     I don't care how
@@ -124,9 +123,9 @@ provided `/usr/local/bin` is part of the $PATH environment variable.
     ```
     docker image tag ghcr.io/pivotal-gss/mock-data mock
     ```
-+ For mac users to connect to the host database you can run the below command
++ For mac users to connect to the host (or local host) database you can run the below command
     ```
-    docker run mock -a host.docker.internal <flags...>
+    docker run mock [subcommand] -a host.docker.internal <flags...>
     ```
   eg
     ```
@@ -182,11 +181,11 @@ To customize this repository, follow the steps
     ```
     go run . <commands> <flags.........>
     ```
-6. Run the golang linter to analyzes & fix source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.
+6. [Recommended] Run the golang linter to analyzes & fix source code programming errors, bugs, stylistic errors, and suspicious constructs.
     ```
     golangci-lint run
     ```
-   to install golangci-lint check [here](https://golangci-lint.run/usage/install/), config file `.golangci.yml` is provided with the repo
+   to install golangci-lint check [here](https://golangci-lint.run/usage/install/), config file `.golangci.yml` has been provided with this repo
 7. To run test, use 
     ```
     # Edit the database environment variables on the "Makefile"

cmd.go

@@ -12,7 +12,7 @@ var (
 	cmdOptions Command
 )
 
-// Command: Root command line options
+// Command the root command line options
 type Command struct {
 	Debug            bool
 	Username         string
@@ -30,13 +30,13 @@ type Command struct {
 	URI              string
 }
 
-// Database command line options
+// Database sub command line options
 type Database struct {
 	FakeDB          bool
 	FakeDBTableRows bool
 }
 
-// Tables: Table command line options
+// Tables sub command line options
 type Tables struct {
 	FakeNewTables    bool
 	TotalTables      int

constraintsRestore_test.go

@@ -68,7 +68,7 @@ func TestFixPKey(t *testing.T) {
 		})
 		t.Run("check_for_any_available_constraint_"+conStr, func(t *testing.T) {
 			if got := len(data); got <= 0 {
-				t.Errorf("TestFixPKey = %v, want > 0 %v constriants", got, conStr)
+				t.Errorf("TestFixPKey = %v, want > 0 %v constraints", got, conStr)
 			}
 		})
 		for _, ck := range data {
@@ -116,7 +116,7 @@ func TestFixFKey(t *testing.T) {
 	})
 	t.Run("check_for_any_available_constraint_FOREIGN", func(t *testing.T) {
 		if got := len(data); got <= 0 {
-			t.Errorf("TestFixFKey = %v, want > 0 %v constriants", got, "FOREIGN")
+			t.Errorf("TestFixFKey = %v, want > 0 %v constraints", got, "FOREIGN")
 		}
 	})
 	for _, ck := range data {