traefik/cmd/bug/bug.go

172 lines
4.1 KiB
Go
Raw Normal View History

2018-03-01 07:10:04 +00:00
package bug
import (
"bytes"
"fmt"
"net/url"
"os/exec"
"runtime"
"text/template"
"github.com/containous/flaeg"
2018-03-01 07:10:04 +00:00
"github.com/containous/traefik/anonymize"
"github.com/containous/traefik/cmd"
"github.com/containous/traefik/cmd/version"
)
2017-10-02 08:32:02 +00:00
const (
bugTracker = "https://github.com/containous/traefik/issues/new"
bugTemplate = `<!--
2017-06-01 19:27:22 +00:00
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
2017-06-01 19:27:22 +00:00
The issue tracker is for reporting bugs and feature requests only.
For end-user related support questions, refer to one of the following:
2017-06-01 19:27:22 +00:00
- Stack Overflow (using the "traefik" tag): https://stackoverflow.com/questions/tagged/traefik
2018-06-12 15:04:04 +00:00
- the Traefik community Slack channel: https://slack.traefik.io
2017-06-01 19:27:22 +00:00
-->
### Do you want to request a *feature* or report a *bug*?
(If you intend to ask a support question: **DO NOT FILE AN ISSUE**.
Use [Stack Overflow](https://stackoverflow.com/questions/tagged/traefik)
2018-06-12 15:04:04 +00:00
or [Slack](https://slack.traefik.io) instead.)
2017-06-01 19:27:22 +00:00
### What did you do?
<!--
HOW TO WRITE A GOOD ISSUE?
2017-06-01 19:27:22 +00:00
- Respect the issue template as more as possible.
- If it's possible use the command ` + "`" + "traefik bug" + "`" + `. See https://www.youtube.com/watch?v=Lyz62L8m93I.
- The title must be short and descriptive.
- Explain the conditions which led you to write this issue: the context.
- The context should lead to something, an idea or a problem that youre facing.
- Remain clear and concise.
- Format your messages to help the reader focus on what matters and understand the structure of your message, use Markdown syntax https://help.github.com/articles/github-flavored-markdown
-->
### What did you expect to see?
### What did you see instead?
### Output of ` + "`" + `traefik version` + "`" + `: (_What version of Traefik are you using?_)
` + "```" + `
{{.Version}}
` + "```" + `
### What is your environment & configuration (arguments, toml, provider, platform, ...)?
2017-08-23 22:59:01 +00:00
` + "```" + `json
{{.Configuration}}
` + "```" + `
<!--
Add more configuration information here.
-->
### If applicable, please paste the log output at DEBUG level (` + "`" + `--logLevel=DEBUG` + "`" + ` switch)
` + "```" + `
(paste your output here)
` + "```" + `
`
)
2018-03-01 07:10:04 +00:00
// NewCmd builds a new Bug command
func NewCmd(traefikConfiguration *cmd.TraefikConfiguration, traefikPointersConfiguration *cmd.TraefikConfiguration) *flaeg.Command {
2018-07-03 08:02:03 +00:00
// version Command init
return &flaeg.Command{
Name: "bug",
Description: `Report an issue on Traefik bugtracker`,
Config: traefikConfiguration,
DefaultPointersConfig: traefikPointersConfiguration,
2018-09-07 07:40:03 +00:00
Run: runCmd(traefikConfiguration),
Metadata: map[string]string{
"parseAllSources": "true",
},
}
}
2018-03-01 07:10:04 +00:00
func runCmd(traefikConfiguration *cmd.TraefikConfiguration) func() error {
2017-10-02 08:32:02 +00:00
return func() error {
2018-03-01 07:10:04 +00:00
body, err := createReport(traefikConfiguration)
2017-10-02 08:32:02 +00:00
if err != nil {
return err
}
2018-03-01 07:10:04 +00:00
sendReport(body)
2017-10-02 08:32:02 +00:00
return nil
}
}
2018-03-01 07:10:04 +00:00
func createReport(traefikConfiguration *cmd.TraefikConfiguration) (string, error) {
var versionPrint bytes.Buffer
if err := version.GetPrint(&versionPrint); err != nil {
2017-10-02 08:32:02 +00:00
return "", err
}
tmpl, err := template.New("bug").Parse(bugTemplate)
if err != nil {
return "", err
}
2018-01-02 09:14:03 +00:00
config, err := anonymize.Do(traefikConfiguration, true)
2017-10-02 08:32:02 +00:00
if err != nil {
return "", err
}
v := struct {
Version string
Configuration string
}{
2018-03-01 07:10:04 +00:00
Version: versionPrint.String(),
2017-10-02 08:32:02 +00:00
Configuration: config,
}
var bug bytes.Buffer
if err := tmpl.Execute(&bug, v); err != nil {
return "", err
}
return bug.String(), nil
}
2018-03-01 07:10:04 +00:00
func sendReport(body string) {
2017-10-02 08:32:02 +00:00
URL := bugTracker + "?body=" + url.QueryEscape(body)
if err := openBrowser(URL); err != nil {
fmt.Printf("Please file a new issue at %s using this template:\n\n", bugTracker)
fmt.Print(body)
}
}
func openBrowser(URL string) error {
var err error
switch runtime.GOOS {
case "linux":
err = exec.Command("xdg-open", URL).Start()
case "windows":
err = exec.Command("rundll32", "url.dll,FileProtocolHandler", URL).Start()
case "darwin":
err = exec.Command("open", URL).Start()
default:
err = fmt.Errorf("unsupported platform")
}
return err
}