From c4a5aa1901481be709a55e50d37d8543c1b8f579 Mon Sep 17 00:00:00 2001
From: "Sascha L. Teichmann" <sascha.teichmann@intevation.de>
Date: Thu, 9 Dec 2021 23:03:21 +0100
Subject: [PATCH] Continue with check framework

---
 cmd/csaf_checker/checks.go | 35 +++++++++++++++++
 cmd/csaf_checker/main.go   | 80 +++++++++++++++++++++++++++++++++-----
 cmd/csaf_checker/report.go | 15 ++++---
 3 files changed, 114 insertions(+), 16 deletions(-)
 create mode 100644 cmd/csaf_checker/checks.go

diff --git a/cmd/csaf_checker/checks.go b/cmd/csaf_checker/checks.go
new file mode 100644
index 0000000..6b9051f
--- /dev/null
+++ b/cmd/csaf_checker/checks.go
@@ -0,0 +1,35 @@
+package main
+
+type state struct {
+	domain string
+}
+
+func newState(domain string) *state {
+	return &state{domain: domain}
+}
+
+type check interface {
+	run(*state) error
+	report(*state, *Domain)
+}
+
+func run(domains []string, checks []check) (*Report, error) {
+
+	var report Report
+
+	for _, d := range domains {
+		state := newState(d)
+		for _, ch := range checks {
+			if err := ch.run(state); err != nil {
+				return nil, err
+			}
+		}
+		domain := new(Domain)
+		for _, ch := range checks {
+			ch.report(state, domain)
+		}
+		report.Domains = append(report.Domains, domain)
+	}
+
+	return &report, nil
+}
diff --git a/cmd/csaf_checker/main.go b/cmd/csaf_checker/main.go
index 78f8c9a..bb02094 100644
--- a/cmd/csaf_checker/main.go
+++ b/cmd/csaf_checker/main.go
@@ -1,6 +1,9 @@
 package main
 
 import (
+	"encoding/json"
+	"io"
+	"log"
 	"os"
 
 	"github.com/jessevdk/go-flags"
@@ -8,23 +11,80 @@ import (
 
 type options struct {
 	Output string `short:"o" long:"output" description:"File name of the generated report" value-name:"REPORT-FILE"`
+	Format string `short:"f" long:"format" choice:"json" choice:"html" description:"Format of report" default:"json"`
 }
 
-func checkParser(err error) {
+var checks = []check{
+	// TODO: Implement me!
+}
+
+func errCheck(err error) {
 	if err != nil {
 		if e, ok := err.(*flags.Error); ok && e.Type == flags.ErrHelp {
 			os.Exit(0)
 		}
-		os.Exit(1)
+		log.Fatalf("error: %v\n", err)
 	}
 }
 
-func main() {
-	var opts options
-
-	args, err := flags.Parse(&opts)
-	checkParser(err)
-
-	_ = args
-
+func writeJSON(report *Report, w io.WriteCloser) error {
+	enc := json.NewEncoder(w)
+	enc.SetIndent("", "  ")
+	err := enc.Encode(report)
+	if e := w.Close(); err != nil {
+		err = e
+	}
+	return err
+}
+
+func writeHTML(report *Report, w io.WriteCloser) error {
+	// TODO: Implement me!
+	return w.Close()
+}
+
+type nopCloser struct{ io.Writer }
+
+func (nc *nopCloser) Close() error { return nil }
+
+func writeReport(report *Report, opts *options) error {
+
+	var w io.WriteCloser
+
+	if opts.Output == "" {
+		w = &nopCloser{os.Stdout}
+	} else {
+		f, err := os.Create(opts.Output)
+		if err != nil {
+			return err
+		}
+		w = f
+	}
+
+	var writer func(*Report, io.WriteCloser) error
+
+	switch opts.Format {
+	case "json":
+		writer = writeJSON
+	default:
+		writer = writeHTML
+	}
+
+	return writer(report, w)
+}
+
+func main() {
+	opts := new(options)
+
+	domains, err := flags.Parse(opts)
+	errCheck(err)
+
+	if len(domains) == 0 {
+		log.Println("No domains given.")
+		return
+	}
+
+	report, err := run(domains, checks)
+	errCheck(err)
+
+	errCheck(writeReport(report, opts))
 }
diff --git a/cmd/csaf_checker/report.go b/cmd/csaf_checker/report.go
index d950850..7af773e 100644
--- a/cmd/csaf_checker/report.go
+++ b/cmd/csaf_checker/report.go
@@ -1,16 +1,19 @@
 package main
 
-type requirement struct {
+// Requirement a single requirement report of a domain.
+type Requirement struct {
 	Num         int      `json:"num"`
 	Description string   `json:"description"`
 	Messages    []string `json:"messages"`
 }
 
-type domain struct {
-	Name         string        `json:"name"`
-	requirements []requirement `json:"requirements"`
+// Domain are the results of a domain.
+type Domain struct {
+	Name         string         `json:"name"`
+	requirements []*Requirement `json:"requirements"`
 }
 
-type report struct {
-	Domains []domain `json:"domains"`
+// Report is the overall report.
+type Report struct {
+	Domains []*Domain `json:"domains"`
 }