mirror of
https://git.vectorsigma.ru/public/atlantis.git
synced 2026-08-04 15:38:44 +00:00
bac2ee7619
* If output is longer than 12 lines, wrap it in markdown folding for GitLab and GitHub. * Reformat the Terraform plan output so that the + and - lines show up highlighted properly when using the diff syntax highlighting
266 lines
9.8 KiB
Go
266 lines
9.8 KiB
Go
// Copyright 2017 HootSuite Media Inc.
|
||
//
|
||
// Licensed under the Apache License, Version 2.0 (the License);
|
||
// you may not use this file except in compliance with the License.
|
||
// You may obtain a copy of the License at
|
||
// http://www.apache.org/licenses/LICENSE-2.0
|
||
// Unless required by applicable law or agreed to in writing, software
|
||
// distributed under the License is distributed on an AS IS BASIS,
|
||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
// See the License for the specific language governing permissions and
|
||
// limitations under the License.
|
||
// Modified hereafter by contributors to runatlantis/atlantis.
|
||
|
||
package events
|
||
|
||
import (
|
||
"bytes"
|
||
"fmt"
|
||
"regexp"
|
||
"strings"
|
||
"text/template"
|
||
|
||
"github.com/Masterminds/sprig"
|
||
"github.com/runatlantis/atlantis/server/events/models"
|
||
)
|
||
|
||
const (
|
||
planCommandTitle = "Plan"
|
||
applyCommandTitle = "Apply"
|
||
// maxUnwrappedLines is the maximum number of lines the Terraform output
|
||
// can be before we wrap it in an expandable template.
|
||
maxUnwrappedLines = 12
|
||
)
|
||
|
||
var (
|
||
plusDiffRegex = regexp.MustCompile(`(?m)^ \+`)
|
||
tildeDiffRegex = regexp.MustCompile(`(?m)^ ~`)
|
||
minusDiffRegex = regexp.MustCompile(`(?m)^ -`)
|
||
)
|
||
|
||
// MarkdownRenderer renders responses as markdown.
|
||
type MarkdownRenderer struct{}
|
||
|
||
// CommonData is data that all responses have.
|
||
type CommonData struct {
|
||
Command string
|
||
Verbose bool
|
||
Log string
|
||
}
|
||
|
||
// ErrData is data about an error response.
|
||
type ErrData struct {
|
||
Error string
|
||
CommonData
|
||
}
|
||
|
||
// FailureData is data about a failure response.
|
||
type FailureData struct {
|
||
Failure string
|
||
CommonData
|
||
}
|
||
|
||
// ResultData is data about a successful response.
|
||
type ResultData struct {
|
||
Results []projectResultTmplData
|
||
CommonData
|
||
}
|
||
|
||
type projectResultTmplData struct {
|
||
Workspace string
|
||
RepoRelDir string
|
||
Rendered string
|
||
}
|
||
|
||
// Render formats the data into a markdown string.
|
||
// nolint: interfacer
|
||
func (m *MarkdownRenderer) Render(res CommandResult, cmdName CommandName, log string, verbose bool, vcsHost models.VCSHostType) string {
|
||
commandStr := strings.Title(cmdName.String())
|
||
common := CommonData{commandStr, verbose, log}
|
||
if res.Error != nil {
|
||
return m.renderTemplate(unwrappedErrWithLogTmpl, ErrData{res.Error.Error(), common})
|
||
}
|
||
if res.Failure != "" {
|
||
return m.renderTemplate(failureWithLogTmpl, FailureData{res.Failure, common})
|
||
}
|
||
return m.renderProjectResults(res.ProjectResults, common, vcsHost)
|
||
}
|
||
|
||
func (m *MarkdownRenderer) renderProjectResults(results []ProjectResult, common CommonData, vcsHost models.VCSHostType) string {
|
||
var resultsTmplData []projectResultTmplData
|
||
numPlanSuccesses := 0
|
||
|
||
for _, result := range results {
|
||
resultData := projectResultTmplData{
|
||
Workspace: result.Workspace,
|
||
RepoRelDir: result.RepoRelDir,
|
||
}
|
||
if result.Error != nil {
|
||
tmpl := unwrappedErrTmpl
|
||
if m.shouldUseWrappedTmpl(vcsHost, result.Error.Error()) {
|
||
tmpl = wrappedErrTmpl
|
||
}
|
||
resultData.Rendered = m.renderTemplate(tmpl, struct {
|
||
Command string
|
||
Error string
|
||
}{
|
||
Command: common.Command,
|
||
Error: result.Error.Error(),
|
||
})
|
||
} else if result.Failure != "" {
|
||
resultData.Rendered = m.renderTemplate(failureTmpl, struct {
|
||
Command string
|
||
Failure string
|
||
}{
|
||
Command: common.Command,
|
||
Failure: result.Failure,
|
||
})
|
||
} else if result.PlanSuccess != nil {
|
||
result.PlanSuccess.TerraformOutput = m.fmtDiff(result.PlanSuccess.TerraformOutput)
|
||
if m.shouldUseWrappedTmpl(vcsHost, result.PlanSuccess.TerraformOutput) {
|
||
resultData.Rendered = m.renderTemplate(planSuccessWrappedTmpl, *result.PlanSuccess)
|
||
} else {
|
||
resultData.Rendered = m.renderTemplate(planSuccessUnwrappedTmpl, *result.PlanSuccess)
|
||
}
|
||
numPlanSuccesses++
|
||
} else if result.ApplySuccess != "" {
|
||
if m.shouldUseWrappedTmpl(vcsHost, result.ApplySuccess) {
|
||
resultData.Rendered = m.renderTemplate(applyWrappedSuccessTmpl, struct{ Output string }{result.ApplySuccess})
|
||
} else {
|
||
resultData.Rendered = m.renderTemplate(applyUnwrappedSuccessTmpl, struct{ Output string }{result.ApplySuccess})
|
||
}
|
||
|
||
} else {
|
||
resultData.Rendered = "Found no template. This is a bug!"
|
||
}
|
||
resultsTmplData = append(resultsTmplData, resultData)
|
||
}
|
||
|
||
var tmpl *template.Template
|
||
switch {
|
||
case len(resultsTmplData) == 1 && common.Command == planCommandTitle && numPlanSuccesses > 0:
|
||
tmpl = singleProjectPlanSuccessTmpl
|
||
case len(resultsTmplData) == 1 && common.Command == planCommandTitle && numPlanSuccesses == 0:
|
||
tmpl = singleProjectPlanUnsuccessfulTmpl
|
||
case len(resultsTmplData) == 1 && common.Command == applyCommandTitle:
|
||
tmpl = singleProjectApplyTmpl
|
||
case common.Command == planCommandTitle:
|
||
tmpl = multiProjectPlanTmpl
|
||
case common.Command == applyCommandTitle:
|
||
tmpl = multiProjectApplyTmpl
|
||
default:
|
||
return "no template matched–this is a bug"
|
||
}
|
||
return m.renderTemplate(tmpl, ResultData{resultsTmplData, common})
|
||
}
|
||
|
||
// shouldUseWrappedTmpl returns true if we should use the wrapped markdown
|
||
// templates that collapse the output to make the comment smaller on initial
|
||
// load.
|
||
func (m *MarkdownRenderer) shouldUseWrappedTmpl(vcsHost models.VCSHostType, output string) bool {
|
||
// Bitbucket Cloud and Server don't support the folding markdown syntax.
|
||
if vcsHost == models.BitbucketServer || vcsHost == models.BitbucketCloud {
|
||
return false
|
||
}
|
||
|
||
return strings.Count(output, "\n") > maxUnwrappedLines
|
||
}
|
||
|
||
// fmtDiff uses regex's to remove any leading whitespace in front of the
|
||
// terraform output so that the diff syntax highlighting works. Example:
|
||
// " - aws_security_group_rule.allow_all" =>
|
||
// "- aws_security_group_rule.allow_all"
|
||
// We do it for +, ~ and -.
|
||
func (m *MarkdownRenderer) fmtDiff(tfOutput string) string {
|
||
tfOutput = plusDiffRegex.ReplaceAllString(tfOutput, "+")
|
||
tfOutput = tildeDiffRegex.ReplaceAllString(tfOutput, "~")
|
||
return minusDiffRegex.ReplaceAllString(tfOutput, "-")
|
||
}
|
||
|
||
func (m *MarkdownRenderer) renderTemplate(tmpl *template.Template, data interface{}) string {
|
||
buf := &bytes.Buffer{}
|
||
if err := tmpl.Execute(buf, data); err != nil {
|
||
return fmt.Sprintf("Failed to render template, this is a bug: %v", err)
|
||
}
|
||
return buf.String()
|
||
}
|
||
|
||
// todo: refactor to remove duplication #refactor
|
||
var singleProjectApplyTmpl = template.Must(template.New("").Parse(
|
||
"{{$result := index .Results 0}}Ran {{.Command}} in dir: `{{$result.RepoRelDir}}` workspace: `{{$result.Workspace}}`\n\n{{$result.Rendered}}\n" + logTmpl))
|
||
var singleProjectPlanSuccessTmpl = template.Must(template.New("").Parse(
|
||
"{{$result := index .Results 0}}Ran {{.Command}} in dir: `{{$result.RepoRelDir}}` workspace: `{{$result.Workspace}}`\n\n{{$result.Rendered}}\n" +
|
||
"\n" +
|
||
"---\n" +
|
||
"* :fast_forward: To **apply** all unapplied plans from this pull request, comment:\n" +
|
||
" * `atlantis apply`" + logTmpl))
|
||
var singleProjectPlanUnsuccessfulTmpl = template.Must(template.New("").Parse(
|
||
"{{$result := index .Results 0}}Ran {{.Command}} in dir: `{{$result.RepoRelDir}}` workspace: `{{$result.Workspace}}`\n\n" +
|
||
"{{$result.Rendered}}\n" + logTmpl))
|
||
var multiProjectPlanTmpl = template.Must(template.New("").Funcs(sprig.TxtFuncMap()).Parse(
|
||
"Ran {{.Command}} for {{ len .Results }} projects:\n" +
|
||
"{{ range $result := .Results }}" +
|
||
"1. workspace: `{{$result.Workspace}}` dir: `{{$result.RepoRelDir}}`\n" +
|
||
"{{end}}\n" +
|
||
"{{ range $i, $result := .Results }}" +
|
||
"### {{add $i 1}}. workspace: `{{$result.Workspace}}` dir: `{{$result.RepoRelDir}}`\n" +
|
||
"{{$result.Rendered}}\n" +
|
||
"---\n{{end}}{{ if gt (len .Results) 0 }}* :fast_forward: To **apply** all unapplied plans from this pull request, comment:\n" +
|
||
" * `atlantis apply`{{end}}" +
|
||
logTmpl))
|
||
var multiProjectApplyTmpl = template.Must(template.New("").Funcs(sprig.TxtFuncMap()).Parse(
|
||
"Ran {{.Command}} for {{ len .Results }} projects:\n" +
|
||
"{{ range $result := .Results }}" +
|
||
"1. workspace: `{{$result.Workspace}}` dir: `{{$result.RepoRelDir}}`\n" +
|
||
"{{end}}\n" +
|
||
"{{ range $i, $result := .Results }}" +
|
||
"### {{add $i 1}}. workspace: `{{$result.Workspace}}` dir: `{{$result.RepoRelDir}}`\n" +
|
||
"{{$result.Rendered}}\n" +
|
||
"---\n{{end}}" +
|
||
logTmpl))
|
||
var planSuccessUnwrappedTmpl = template.Must(template.New("").Parse(
|
||
"```diff\n" +
|
||
"{{.TerraformOutput}}\n" +
|
||
"```\n\n" + planNextSteps))
|
||
var planSuccessWrappedTmpl = template.Must(template.New("").Parse(
|
||
"<details><summary>Show Output</summary>\n\n" +
|
||
"```diff\n" +
|
||
"{{.TerraformOutput}}\n" +
|
||
"```\n\n" +
|
||
planNextSteps +
|
||
"</details>"))
|
||
|
||
// planNextSteps are instructions appended after successful plans as to what
|
||
// to do next.
|
||
var planNextSteps = "* :arrow_forward: To **apply** this plan, comment:\n" +
|
||
" * `{{.ApplyCmd}}`\n" +
|
||
"* :put_litter_in_its_place: To **delete** this plan click [here]({{.LockURL}})\n" +
|
||
"* :repeat: To **plan** this project again, comment:\n" +
|
||
" * `{{.RePlanCmd}}`"
|
||
var applyUnwrappedSuccessTmpl = template.Must(template.New("").Parse(
|
||
"```diff\n" +
|
||
"{{.Output}}\n" +
|
||
"```"))
|
||
var applyWrappedSuccessTmpl = template.Must(template.New("").Parse(
|
||
"<details><summary>Show Output</summary>\n\n" +
|
||
"```diff\n" +
|
||
"{{.Output}}\n" +
|
||
"```\n" +
|
||
"</details>"))
|
||
var unwrappedErrTmplText = "**{{.Command}} Error**\n" +
|
||
"```\n" +
|
||
"{{.Error}}\n" +
|
||
"```\n"
|
||
var wrappedErrTmplText = "**{{.Command}} Error**\n" +
|
||
"<details><summary>Show Output</summary>\n\n" +
|
||
"```\n" +
|
||
"{{.Error}}\n" +
|
||
"```\n</details>"
|
||
var unwrappedErrTmpl = template.Must(template.New("").Parse(unwrappedErrTmplText))
|
||
var unwrappedErrWithLogTmpl = template.Must(template.New("").Parse(unwrappedErrTmplText + logTmpl))
|
||
var wrappedErrTmpl = template.Must(template.New("").Parse(wrappedErrTmplText))
|
||
var failureTmplText = "**{{.Command}} Failed**: {{.Failure}}\n"
|
||
var failureTmpl = template.Must(template.New("").Parse(failureTmplText))
|
||
var failureWithLogTmpl = template.Must(template.New("").Parse(failureTmplText + logTmpl))
|
||
var logTmpl = "{{if .Verbose}}\n<details><summary>Log</summary>\n <p>\n\n```\n{{.Log}}```\n</p></details>{{end}}\n"
|