mirror of
https://github.com/rclone/rclone.git
synced 2024-12-23 07:29:35 +01:00
f97c4c8d9d
- Make integration tests use a config file - Output individual logs for each test - Make HTML report and open browser - Optionally email and upload results
261 lines
6.1 KiB
Go
261 lines
6.1 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"html/template"
|
|
"io/ioutil"
|
|
"log"
|
|
"os"
|
|
"os/exec"
|
|
"path"
|
|
"sort"
|
|
"time"
|
|
|
|
"github.com/ncw/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 = `<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>{{ .Title }}</title>
|
|
<style>
|
|
table {
|
|
border-collapse: collapse;
|
|
border-spacing: 0;
|
|
border: 1px solid #ddd;
|
|
}
|
|
table.tests {
|
|
width: 100%;
|
|
}
|
|
table, th, td {
|
|
border: 1px solid black;
|
|
}
|
|
.Failed {
|
|
color: red;
|
|
}
|
|
.Passed {
|
|
color: green;
|
|
}
|
|
.false {
|
|
font-weight: lighter;
|
|
}
|
|
.true {
|
|
font-weight: bold;
|
|
}
|
|
|
|
th, td {
|
|
text-align: left;
|
|
padding: 4px;
|
|
}
|
|
|
|
tr:nth-child(even) {
|
|
background-color: #f2f2f2
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>{{ .Title }}</h1>
|
|
|
|
<table>
|
|
<tr><th>Version</th><td>{{ .Version }}</td></tr>
|
|
<tr><th>Date</th><td>{{ .DateTime}} [<a href="{{ .URL }}">online</a>]</td></tr>
|
|
<tr><th>Duration</th><td>{{ .Duration }}</td></tr>
|
|
{{ if .Previous}}<tr><th>Previous</th><td><a href="../{{ .Previous }}/index.html">{{ .Previous }}</a></td></tr>{{ end }}
|
|
<tr><th>Up</th><td><a href="../">Older Tests</a></td></tr>
|
|
</table>
|
|
|
|
{{ range .Runs }}
|
|
{{ if .Runs }}
|
|
<h2 class="{{ .Name }}">{{ .Name }}: {{ len .Runs }}</h2>
|
|
<table class="{{ .Name }} tests">
|
|
<tr>
|
|
<th>Backend</th>
|
|
<th>Remote</th>
|
|
<th>Test</th>
|
|
<th>SubDir</th>
|
|
<th>FastList</th>
|
|
<th>Failed</th>
|
|
<th>Logs</th>
|
|
</tr>
|
|
{{ $prevBackend := "" }}
|
|
{{ $prevRemote := "" }}
|
|
{{ range .Runs}}
|
|
<tr>
|
|
<td>{{ if ne $prevBackend .Backend }}{{ .Backend }}{{ end }}{{ $prevBackend = .Backend }}</td>
|
|
<td>{{ if ne $prevRemote .Remote }}{{ .Remote }}{{ end }}{{ $prevRemote = .Remote }}</td>
|
|
<td>{{ .Path }}</td>
|
|
<td><span class="{{ .SubDir }}">{{ .SubDir }}</span></td>
|
|
<td><span class="{{ .FastList }}">{{ .FastList }}</span></td>
|
|
<td>{{ .FailedTests }}</td>
|
|
<td>{{ range $i, $v := .Logs }}<a href="{{ $v }}">#{{ $i }}</a> {{ end }}</td>
|
|
</tr>
|
|
{{ end }}
|
|
</table>
|
|
{{ end }}
|
|
{{ end }}
|
|
</body>
|
|
</html>
|
|
`
|
|
|
|
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()
|
|
}
|
|
|
|
// Upload uploads a copy of the report online
|
|
func (r *Report) Upload() {
|
|
if *uploadPath == "" || r.IndexHTML == "" {
|
|
return
|
|
}
|
|
dst := path.Join(*uploadPath, r.DateTime)
|
|
log.Printf("Uploading results to %q", dst)
|
|
cmdLine := []string{"rclone", "copy", "-v", 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)
|
|
}
|
|
}
|