File: main.go

package info (click to toggle)
golang-github-mfridman-tparse 0.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,780 kB
  • sloc: makefile: 53; sh: 41
file content (185 lines) | stat: -rw-r--r-- 5,688 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
package main

import (
	"errors"
	"flag"
	"fmt"
	"io"
	"log"
	"os"
	"runtime/debug"

	"github.com/mfridman/tparse/internal/app"
	"github.com/mfridman/tparse/internal/utils"
	"github.com/mfridman/tparse/parse"
)

// Flags.
var (
	vPtr            = flag.Bool("v", false, "")
	versionPtr      = flag.Bool("version", false, "")
	hPtr            = flag.Bool("h", false, "")
	helpPtr         = flag.Bool("help", false, "")
	allPtr          = flag.Bool("all", false, "")
	passPtr         = flag.Bool("pass", false, "")
	skipPtr         = flag.Bool("skip", false, "")
	showNoTestsPtr  = flag.Bool("notests", false, "")
	smallScreenPtr  = flag.Bool("smallscreen", false, "")
	noColorPtr      = flag.Bool("nocolor", false, "")
	slowPtr         = flag.Int("slow", 0, "")
	fileNamePtr     = flag.String("file", "", "")
	formatPtr       = flag.String("format", "", "")
	followPtr       = flag.Bool("follow", false, "")
	followOutputPtr = flag.String("follow-output", "", "")
	sortPtr         = flag.String("sort", "name", "")
	progressPtr     = flag.Bool("progress", false, "")
	comparePtr      = flag.String("compare", "", "")
	trimPathPtr     = flag.String("trimpath", "", "")
	// Undocumented flags
	followVerbosePtr = flag.Bool("follow-verbose", false, "")

	// Legacy flags
	noBordersPtr = flag.Bool("noborders", false, "")
)

var usage = `Usage:
    go test ./... -json | tparse [options...]
    go test [packages...] -json | tparse [options...]
    go test [packages...] -json > pkgs.out ; tparse [options...] -file pkgs.out

Options:
    -h             Show help.
    -v             Show version.
    -all           Display table event for pass and skip. (Failed items always displayed)
    -pass          Display table for passed tests.
    -skip          Display table for skipped tests.
    -notests       Display packages containing no test files or empty test files.
    -smallscreen   Split subtest names vertically to fit on smaller screens.
    -slow          Number of slowest tests to display. Default is 0, display all.
    -sort          Sort table output by attribute [name, elapsed, cover]. Default is name.
    -nocolor       Disable all colors. (NO_COLOR also supported)
    -format        The output format for tables [basic, plain, markdown]. Default is basic.
    -file          Read test output from a file.
    -follow        Follow raw output from go test to stdout.
    -follow-output Write raw output from go test to a file (takes precedence over -follow).
    -progress      Print a single summary line for each package. Useful for long running test suites.
    -compare       Compare against a previous test output file. (experimental)
    -trimpath      Remove path prefix from package names in output, simplifying their display.
`

var version string

func main() {
	log.SetFlags(0)
	flag.Usage = func() {
		fmt.Fprint(flag.CommandLine.Output(), usage)
	}
	flag.Parse()

	if *vPtr || *versionPtr {
		if info, ok := debug.ReadBuildInfo(); ok {
			version = info.Main.Version
		}
		fmt.Fprintf(os.Stdout, "tparse version: %s\n", version)
		return
	}
	if *hPtr || *helpPtr {
		fmt.Print(usage)
		return
	}
	var format app.OutputFormat
	switch *formatPtr {
	case "basic":
		format = app.OutputFormatBasic
	case "plain":
		format = app.OutputFormatPlain
	case "markdown":
		format = app.OutputFormatMarkdown
	case "":
		// This was an existing flag, let's try to avoid breaking users.
		format = app.OutputFormatBasic
		if *noBordersPtr {
			format = app.OutputFormatPlain
		}
	default:
		fmt.Fprintf(os.Stderr, "invalid option:%q. The -format flag must be one of: basic, plain or markdown\n", *formatPtr)
		return
	}
	var sorter parse.PackageSorter
	switch *sortPtr {
	case "name":
		sorter = parse.SortByPackageName
	case "elapsed":
		sorter = parse.SortByElapsed
	case "cover":
		sorter = parse.SortByCoverage
	default:
		fmt.Fprintf(os.Stderr, "invalid option:%q. The -sort flag must be one of: name, elapsed or cover\n", *sortPtr)
		return
	}

	if *allPtr {
		*passPtr = true
		*skipPtr = true
	}
	// Show colors by default.
	var disableColor bool
	if _, ok := os.LookupEnv("NO_COLOR"); ok || *noColorPtr {
		disableColor = true
	}

	var followOutput io.WriteCloser
	switch {
	case *followOutputPtr != "":
		var err error
		followOutput, err = os.Create(*followOutputPtr)
		if err != nil {
			fmt.Fprintln(os.Stderr, err)
			return
		}
		*followPtr = true
	case *followPtr, *followVerbosePtr:
		followOutput = os.Stdout
	default:
		// If no follow flags are set, we should not write to followOutput.
		followOutput = utils.WriteNopCloser{Writer: io.Discard}
	}
	// TODO(mf): we should marry the options with the flags to avoid having to do this.
	options := app.Options{
		Output:              os.Stdout,
		DisableColor:        disableColor,
		FollowOutput:        *followPtr,
		FollowOutputWriter:  followOutput,
		FollowOutputVerbose: *followVerbosePtr,
		FileName:            *fileNamePtr,
		TestTableOptions: app.TestTableOptions{
			Pass:     *passPtr,
			Skip:     *skipPtr,
			Trim:     *smallScreenPtr,
			TrimPath: *trimPathPtr,
			Slow:     *slowPtr,
		},
		SummaryTableOptions: app.SummaryTableOptions{
			Trim:     *smallScreenPtr,
			TrimPath: *trimPathPtr,
		},
		Format:         format,
		Sorter:         sorter,
		ShowNoTests:    *showNoTestsPtr,
		Progress:       *progressPtr,
		ProgressOutput: os.Stdout,
		Compare:        *comparePtr,

		// Do not expose publicly.
		DisableTableOutput: false,
	}
	exitCode, err := app.Run(options)
	if err != nil {
		msg := err.Error()
		if errors.Is(err, parse.ErrNotParsable) {
			msg = "no parsable events: Make sure to run go test with -json flag"
		}
		fmt.Fprintln(os.Stderr, msg)
	}
	os.Exit(exitCode)
}