traefik/cmd/bug/bug.go

package bug

import (
	"bytes"
	"fmt"
	"net/url"
	"os/exec"
	"runtime"
	"text/template"

	"github.com/containous/flaeg"
	"github.com/containous/traefik/anonymize"
	"github.com/containous/traefik/cmd"
	"github.com/containous/traefik/cmd/version"
)

const (
	bugTracker  = "https://github.com/containous/traefik/issues/new"
	bugTemplate = `<!--
DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.

The issue tracker is for reporting bugs and feature requests only.
For end-user related support questions, refer to one of the following:

- Stack Overflow (using the "traefik" tag): https://stackoverflow.com/questions/tagged/traefik
- the Traefik community Slack channel: https://slack.traefik.io

-->

### 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)
or [Slack](https://slack.traefik.io) instead.)



### What did you do?

<!--

HOW TO WRITE A GOOD ISSUE?

- 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 you’re 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, ...)?

` + "```" + `json
{{.Configuration}}
` + "```" + `

<!--
Add more configuration information here.
-->

### If applicable, please paste the log output at DEBUG level (` + "`" + `--logLevel=DEBUG` + "`" + ` switch)

` + "```" + `
(paste your output here)
` + "```" + `

`
)

// NewCmd builds a new Bug command
func NewCmd(traefikConfiguration *cmd.TraefikConfiguration, traefikPointersConfiguration *cmd.TraefikConfiguration) *flaeg.Command {

	// version Command init
	return &flaeg.Command{
		Name:                  "bug",
		Description:           `Report an issue on Traefik bugtracker`,
		Config:                traefikConfiguration,
		DefaultPointersConfig: traefikPointersConfiguration,
		Run:                   runCmd(traefikConfiguration),
		Metadata: map[string]string{
			"parseAllSources": "true",
		},
	}
}

func runCmd(traefikConfiguration *cmd.TraefikConfiguration) func() error {
	return func() error {

		body, err := createReport(traefikConfiguration)
		if err != nil {
			return err
		}

		sendReport(body)

		return nil
	}
}

func createReport(traefikConfiguration *cmd.TraefikConfiguration) (string, error) {
	var versionPrint bytes.Buffer
	if err := version.GetPrint(&versionPrint); err != nil {
		return "", err
	}

	tmpl, err := template.New("bug").Parse(bugTemplate)
	if err != nil {
		return "", err
	}

	config, err := anonymize.Do(traefikConfiguration, true)
	if err != nil {
		return "", err
	}

	v := struct {
		Version       string
		Configuration string
	}{
		Version:       versionPrint.String(),
		Configuration: config,
	}

	var bug bytes.Buffer
	if err := tmpl.Execute(&bug, v); err != nil {
		return "", err
	}

	return bug.String(), nil
}

func sendReport(body string) {
	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
}