// +build go1.11 package main import ( "fmt" "html/template" "io/ioutil" "log" "os" "os/exec" "path" "sort" "time" "github.com/rclone/rclone/fs" "github.com/skratchdot/open-golang/open" ) const timeFormat = "2006-01-02-150405" // Report holds the info to make a report on a series of test runs type Report struct { LogDir string // output directory for logs and report StartTime time.Time // time started DateTime string // directory name for output Duration time.Duration // time the run took Failed Runs // failed runs Passed Runs // passed runs Runs []ReportRun // runs to report Version string // rclone version Previous string // previous test name if known IndexHTML string // path to the index.html file URL string // online version } // ReportRun is used in the templates to report on a test run type ReportRun struct { Name string Runs Runs } // NewReport initialises and returns a Report func NewReport() *Report { r := &Report{ StartTime: time.Now(), Version: fs.Version, } r.DateTime = r.StartTime.Format(timeFormat) // Find previous log directory if possible names, err := ioutil.ReadDir(*outputDir) if err == nil && len(names) > 0 { r.Previous = names[len(names)-1].Name() } // Create output directory for logs and report r.LogDir = path.Join(*outputDir, r.DateTime) err = os.MkdirAll(r.LogDir, 0777) if err != nil { log.Fatalf("Failed to make log directory: %v", err) } // Online version r.URL = *urlBase + r.DateTime + "/index.html" return r } // End should be called when the tests are complete func (r *Report) End() { r.Duration = time.Since(r.StartTime) sort.Sort(r.Failed) sort.Sort(r.Passed) r.Runs = []ReportRun{ {Name: "Failed", Runs: r.Failed}, {Name: "Passed", Runs: r.Passed}, } } // AllPassed returns true if there were no failed tests func (r *Report) AllPassed() bool { return len(r.Failed) == 0 } // RecordResult should be called with a Run when it has finished to be // recorded into the Report func (r *Report) RecordResult(t *Run) { if !t.passed() { r.Failed = append(r.Failed, t) } else { r.Passed = append(r.Passed, t) } } // Title returns a human readable summary title for the Report func (r *Report) Title() string { if r.AllPassed() { return fmt.Sprintf("PASS: All tests finished OK in %v", r.Duration) } return fmt.Sprintf("FAIL: %d tests failed in %v", len(r.Failed), r.Duration) } // LogSummary writes the summary to the log file func (r *Report) LogSummary() { log.Printf("Logs in %q", r.LogDir) // Summarise results log.Printf("SUMMARY") log.Println(r.Title()) if !r.AllPassed() { for _, t := range r.Failed { log.Printf(" * %s", toShell(t.nextCmdLine())) log.Printf(" * Failed tests: %v", t.failedTests) } } } // LogHTML writes the summary to index.html in LogDir func (r *Report) LogHTML() { r.IndexHTML = path.Join(r.LogDir, "index.html") out, err := os.Create(r.IndexHTML) if err != nil { log.Fatalf("Failed to open index.html: %v", err) } defer func() { err := out.Close() if err != nil { log.Fatalf("Failed to close index.html: %v", err) } }() err = reportTemplate.Execute(out, r) if err != nil { log.Fatalf("Failed to execute template: %v", err) } _ = open.Start("file://" + r.IndexHTML) } var reportHTML = ` {{ .Title }}

{{ .Title }}

{{ if .Previous}}{{ end }}
Version{{ .Version }}
Test{{ .DateTime}}
Duration{{ .Duration }}
Previous{{ .Previous }}
UpOlder Tests
{{ range .Runs }} {{ if .Runs }}

{{ .Name }}: {{ len .Runs }}

{{ $prevBackend := "" }} {{ $prevRemote := "" }} {{ range .Runs}} {{ end }}
Backend Remote Test SubDir FastList Failed Logs
{{ if ne $prevBackend .Backend }}{{ .Backend }}{{ end }}{{ $prevBackend = .Backend }} {{ if ne $prevRemote .Remote }}{{ .Remote }}{{ end }}{{ $prevRemote = .Remote }} {{ .Path }} {{ .SubDir }} {{ .FastList }} {{ .FailedTests }} {{ range $i, $v := .Logs }}#{{ $i }} {{ end }}
{{ end }} {{ end }} ` var reportTemplate = template.Must(template.New("Report").Parse(reportHTML)) // EmailHTML sends the summary report to the email address supplied func (r *Report) EmailHTML() { if *emailReport == "" || r.IndexHTML == "" { return } log.Printf("Sending email summary to %q", *emailReport) cmdLine := []string{"mail", "-a", "Content-Type: text/html", *emailReport, "-s", "rclone integration tests: " + r.Title()} cmd := exec.Command(cmdLine[0], cmdLine[1:]...) in, err := os.Open(r.IndexHTML) if err != nil { log.Fatalf("Failed to open index.html: %v", err) } cmd.Stdin = in cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr err = cmd.Run() if err != nil { log.Fatalf("Failed to send email: %v", err) } _ = in.Close() } // uploadTo uploads a copy of the report online to the dir given func (r *Report) uploadTo(uploadDir string) { dst := path.Join(*uploadPath, uploadDir) log.Printf("Uploading results to %q", dst) cmdLine := []string{"rclone", "sync", "--stats-log-level", "NOTICE", r.LogDir, dst} cmd := exec.Command(cmdLine[0], cmdLine[1:]...) cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr err := cmd.Run() if err != nil { log.Fatalf("Failed to upload results: %v", err) } } // Upload uploads a copy of the report online func (r *Report) Upload() { if *uploadPath == "" || r.IndexHTML == "" { return } // Upload into dated directory r.uploadTo(r.DateTime) // And again into current r.uploadTo("current") }