Augment report with --before and --after files (#6)

pcj · web-flow · commit 690a0ff10085 · 2022-12-24T17:04:36.000-07:00
diff --git a/README.md b/README.md
@@ -23,4 +23,7 @@ bazel aquery //pkg:target-name --output proto > before.pb
 > The file extensions are relevant; the proto decoder will be `protojson` if
 `.json`, `prototext` if `.text.pb` and `proto` otherwise.
 
-An HTML report and accessory files will be written to the given `--report_dir`.
+An HTML report and accessory files will be written to the given `--report_dir`
+that will look something like:
+
+<img width="934" alt="image" src="https://user-images.githubusercontent.com/50580/209453563-064db4dd-4068-4d2f-8bb3-35c425bfb8b5.png">
diff --git a/pkg/report/BUILD.bazel b/pkg/report/BUILD.bazel
@@ -4,6 +4,7 @@ go_library(
     name = "report",
     srcs = [
         "assets.go",
+        "files.go",
         "html.go",
     ],
     embedsrcs = [
@@ -23,5 +24,4 @@ go_test(
     name = "report_test",
     srcs = ["html_test.go"],
     embed = [":report"],
-    deps = ["@com_github_google_go_cmp//cmp"],
 )
diff --git a/pkg/report/files.go b/pkg/report/files.go
@@ -0,0 +1,30 @@
+package report
+
+import (
+	"io"
+	"os"
+)
+
+func copyFile(src string, dest string) error {
+	srcFile, err := os.Open(src)
+	if err != nil {
+		return err
+	}
+	defer srcFile.Close()
+
+	destFile, err := os.Create(dest)
+	if err != nil {
+		return err
+	}
+	defer destFile.Close()
+
+	_, err = io.Copy(destFile, srcFile)
+	if err != nil {
+		return err
+	}
+	err = destFile.Sync()
+	if err != nil {
+		return err
+	}
+	return nil
+}
diff --git a/pkg/report/html.go b/pkg/report/html.go
@@ -26,32 +26,48 @@ type Html struct {
 }
 
 func (r *Html) Emit(dir string) error {
+	if err := r.emitFile(dir, r.BeforeFile); err != nil {
+		return err
+	}
+	r.BeforeFile = filepath.Base(r.BeforeFile)
+
+	if err := r.emitFile(dir, r.AfterFile); err != nil {
+		return err
+	}
+	r.AfterFile = filepath.Base(r.AfterFile)
+
 	for _, action := range r.Before.Actions {
 		if err := r.emitAction(dir, action); err != nil {
 			return err
 		}
 	}
+
 	for _, action := range r.After.Actions {
 		if err := r.emitAction(dir, action); err != nil {
 			return err
 		}
 	}
+
 	for _, pair := range r.Equal {
 		if err := r.emitOutputPairDiff(dir, pair); err != nil {
 			return err
 		}
 	}
+
 	for _, pair := range r.NonEqual {
 		if err := r.emitOutputPairDiff(dir, pair); err != nil {
 			return err
 		}
 	}
+
 	if err := r.emitIndexHtml(dir); err != nil {
 		return err
 	}
+
 	if err := r.emitStyleCss(dir); err != nil {
 		return err
 	}
+
 	return nil
 }
 
@@ -65,6 +81,15 @@ func (r *Html) emitAction(dir string, action *dipb.Action) error {
 	return nil
 }
 
+func (r *Html) emitFile(dir string, original string) error {
+	filename := filepath.Join(dir, filepath.Base(original))
+	basedir := filepath.Dir(filename)
+	if err := os.MkdirAll(basedir, os.ModePerm); err != nil {
+		return err
+	}
+	return copyFile(original, filename)
+}
+
 func (r *Html) emitActionJson(dir string, action *dipb.Action) error {
 	filename := filepath.Join(dir, action.Id+".json")
 	basedir := filepath.Dir(filename)
diff --git a/pkg/report/index.html.tmpl b/pkg/report/index.html.tmpl
@@ -8,8 +8,8 @@
 <body class="markdown-body container-lg">
     <h1><code>aquerydiff</code> report</h1>
     <ul>
-        <li>before file: <code>{{.BeforeFile}}</code></li>
-        <li>after file: <code>{{.AfterFile}}</code></li>
+        <li><code>--before</code> <a href="{{.BeforeFile}}">{{.BeforeFile}}</a></li>
+        <li><code>--after</code> <a href="{{.AfterFile}}">{{.AfterFile}}</a></li>
     </ul>
 
     <h2>Actions present only in <code>--before</code>:</h2>
diff --git a/pkg/report/style.css b/pkg/report/style.css
@@ -2,6 +2,7 @@
     --color-border-muted: hsla(210, 18%, 87%, 1);
     --color-neutral-muted: rgba(175, 184, 193, 0.2);
     --color-accent-fg: #0969da;
+    --color-success-fg: #1a7f37;
 }
 
 a {
@@ -92,7 +93,7 @@ th.outputfile {
 td.mnemonic {
     vertical-align: top;
     text-align: right;
-    color: crimson;
+    color: var(--color-success-fg);
 }
 
 .links {

Original file line number	Diff line number	Diff line change
`@@ -26,32 +26,48 @@ type Html struct {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`func (r *Html) Emit(dir string) error {`
	`29`	`+ if err := r.emitFile(dir, r.BeforeFile); err != nil {`
	`30`	`+ return err`
	`31`	`+ }`
	`32`	`+ r.BeforeFile = filepath.Base(r.BeforeFile)`
	`33`	`+`
	`34`	`+ if err := r.emitFile(dir, r.AfterFile); err != nil {`
	`35`	`+ return err`
	`36`	`+ }`
	`37`	`+ r.AfterFile = filepath.Base(r.AfterFile)`
	`38`	`+`
`29`	`39`	`for _, action := range r.Before.Actions {`
`30`	`40`	`if err := r.emitAction(dir, action); err != nil {`
`31`	`41`	`return err`
`32`	`42`	`}`
`33`	`43`	`}`
	`44`	`+`
`34`	`45`	`for _, action := range r.After.Actions {`
`35`	`46`	`if err := r.emitAction(dir, action); err != nil {`
`36`	`47`	`return err`
`37`	`48`	`}`
`38`	`49`	`}`
	`50`	`+`
`39`	`51`	`for _, pair := range r.Equal {`
`40`	`52`	`if err := r.emitOutputPairDiff(dir, pair); err != nil {`
`41`	`53`	`return err`
`42`	`54`	`}`
`43`	`55`	`}`
	`56`	`+`
`44`	`57`	`for _, pair := range r.NonEqual {`
`45`	`58`	`if err := r.emitOutputPairDiff(dir, pair); err != nil {`
`46`	`59`	`return err`
`47`	`60`	`}`
`48`	`61`	`}`
	`62`	`+`
`49`	`63`	`if err := r.emitIndexHtml(dir); err != nil {`
`50`	`64`	`return err`
`51`	`65`	`}`
	`66`	`+`
`52`	`67`	`if err := r.emitStyleCss(dir); err != nil {`
`53`	`68`	`return err`
`54`	`69`	`}`
	`70`	`+`
`55`	`71`	`return nil`
`56`	`72`	`}`
`57`	`73`
`@@ -65,6 +81,15 @@ func (r Html) emitAction(dir string, action dipb.Action) error {`
`65`	`81`	`return nil`
`66`	`82`	`}`
`67`	`83`
	`84`	`+func (r *Html) emitFile(dir string, original string) error {`
	`85`	`+ filename := filepath.Join(dir, filepath.Base(original))`
	`86`	`+ basedir := filepath.Dir(filename)`
	`87`	`+ if err := os.MkdirAll(basedir, os.ModePerm); err != nil {`
	`88`	`+ return err`
	`89`	`+ }`
	`90`	`+ return copyFile(original, filename)`
	`91`	`+}`
	`92`	`+`
`68`	`93`	`func (r Html) emitActionJson(dir string, action dipb.Action) error {`
`69`	`94`	`filename := filepath.Join(dir, action.Id+".json")`
`70`	`95`	`basedir := filepath.Dir(filename)`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`--color-border-muted: hsla(210, 18%, 87%, 1);`
`3`	`3`	`--color-neutral-muted: rgba(175, 184, 193, 0.2);`
`4`	`4`	`--color-accent-fg: #0969da;`
	`5`	`+ --color-success-fg: #1a7f37;`
`5`	`6`	`}`
`6`	`7`
`7`	`8`	`a {`
`@@ -92,7 +93,7 @@ th.outputfile {`
`92`	`93`	`td.mnemonic {`
`93`	`94`	`vertical-align: top;`
`94`	`95`	`text-align: right;`
`95`		`- color: crimson;`
	`96`	`+ color: var(--color-success-fg);`
`96`	`97`	`}`
`97`	`98`
`98`	`99`	`.links {`