Merge pull request #11 from UKHomeOffice/feature/216-cli-commit-id

216-cli-commit-id: Adds commit hash to violation output logs

Author: techjacker

README.md

@@ -17,6 +17,20 @@ Check the entire history of the current branch for secrets.
 
 ```
 $ git log -p | scanrepo
+
+------------------
+Violation 1
+Commit: 4cc087a1b4731d1017844cc86323df43068b0409
+File: web/src/db/seed.sql
+Reason: "SQL dump file"
+
+------------------
+Violation 2
+Commit: 142e6019248c0d53a5240242ed1a75c0cc110a0b
+File: config/passwords.ini
+Reason: "Contains word: password"
+
+...
 ```
 
 -----------------------------------------------------------

TODO.md

@@ -1,12 +1,10 @@
-- [ ] type []Stats == logger = strings.Stringer() interface -> for creating string for email
-- [ ] Add email notifications (+ interface + tests)
-
-
-- [ ] Enable analysis of private github repos (authenticate using integration ID + private key - add to secrets)
-
+### bufio.NewScanner Limitations
+```
+// Programs that need more control over error handling or large tokens,
+// or must run sequential scans on a reader, should use bufio.Reader instead.
+```
 
+### TODO
 - [ ] Analyze body of commits (added/removed lines)
-
-
 - [ ] Add concurrency (parallelize requests to github API)
 - [ ] Add context + timeout to requests to github API

cmd/scanrepo/main.go

@@ -54,9 +54,13 @@ func main() {
 
 	i := 1
 	fmt.Fprintf(os.Stderr, "Diff contains %d offenses\n\n", matches)
-	for filename, rule := range res.MatchedRules {
+	for diffKey, rule := range res.MatchedRules {
 		fmt.Fprintf(os.Stderr, "------------------\n")
 		fmt.Fprintf(os.Stderr, "Violation %d\n", i)
+		commit, filename := diffence.SplitDiffHashKey(diffKey)
+		if commit != "" {
+			fmt.Fprintf(os.Stderr, "Commit: %s\n", commit)
+		}
 		fmt.Fprintf(os.Stderr, "File: %s\n", filename)
 		fmt.Fprintf(os.Stderr, "Reason: %#v\n\n", rule[0].Caption)
 		i++

hello

@@ -1,2 +1,2 @@
-RELEASE_VERSION=0.3.1
+RELEASE_VERSION=0.4.0
 RELEASE_BUILD_PATH=./cmd/scanrepo