Skip to content

Commit 382604d

Browse files
krrrr38krrrr38
committed
ExecutableName is available on markdown renderer common data
1 parent d376d24 commit 382604d

File tree

5 files changed

+94
-77
lines changed

5 files changed

+94
-77
lines changed

‎server/controllers/events/events_controller_e2e_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1157,7 +1157,7 @@ func setupE2E(t *testing.T, repoDir string, opt setupOption) (events_controllers
11571157
pullUpdater := &events.PullUpdater{
11581158
HidePrevPlanComments: false,
11591159
VCSClient: e2eVCSClient,
1160-
MarkdownRenderer: events.NewMarkdownRenderer(false, false, false, false, false, false, ""),
1160+
MarkdownRenderer: events.NewMarkdownRenderer(false, false, false, false, false, false, "", "atlantis"),
11611161
}
11621162

11631163
autoMerger := &events.AutoMerger{

‎server/events/command_runner_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ func setup(t *testing.T, options ...func(testConfig *TestConfig)) *vcsmocks.Mock
118118
pullUpdater = &events.PullUpdater{
119119
HidePrevPlanComments: false,
120120
VCSClient: vcsClient,
121-
MarkdownRenderer: events.NewMarkdownRenderer(false, false, false, false, false, false, ""),
121+
MarkdownRenderer: events.NewMarkdownRenderer(false, false, false, false, false, false, "", "atlantis"),
122122
}
123123

124124
autoMerger = &events.AutoMerger{

‎server/events/markdown_renderer.go

+5
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ type markdownRenderer struct {
5454
disableRepoLocking bool
5555
enableDiffMarkdownFormat bool
5656
markdownTemplates *template.Template
57+
executableName string
5758
}
5859

5960
// commonData is data that all responses have.
@@ -66,6 +67,7 @@ type commonData struct {
6667
DisableApply bool
6768
DisableRepoLocking bool
6869
EnableDiffMarkdownFormat bool
70+
ExecutableName string
6971
}
7072

7173
// errData is data about an error response.
@@ -116,6 +118,7 @@ func NewMarkdownRenderer(
116118
disableRepoLocking bool,
117119
enableDiffMarkdownFormat bool,
118120
markdownTemplateOverridesDir string,
121+
executableName string,
119122
) *markdownRenderer {
120123
var templates *template.Template
121124
templates, _ = template.New("").Funcs(sprig.TxtFuncMap()).ParseFS(templatesFS, "templates/*.tmpl")
@@ -131,6 +134,7 @@ func NewMarkdownRenderer(
131134
disableRepoLocking: disableRepoLocking,
132135
enableDiffMarkdownFormat: enableDiffMarkdownFormat,
133136
markdownTemplates: templates,
137+
executableName: executableName,
134138
}
135139
}
136140

@@ -147,6 +151,7 @@ func (m *markdownRenderer) Render(res command.Result, cmdName command.Name, log
147151
DisableApply: m.disableApply,
148152
DisableRepoLocking: m.disableRepoLocking,
149153
EnableDiffMarkdownFormat: m.enableDiffMarkdownFormat,
154+
ExecutableName: m.executableName,
150155
}
151156

152157
templates := m.markdownTemplates

‎server/events/markdown_renderer_test.go

+86-75
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func TestRenderErr(t *testing.T) {
5757
},
5858
}
5959

60-
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "")
60+
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "", "atlantis")
6161
for _, c := range cases {
6262
res := command.Result{
6363
Error: c.Error,
@@ -102,7 +102,7 @@ func TestRenderFailure(t *testing.T) {
102102
},
103103
}
104104

105-
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "")
105+
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "", "atlantis")
106106
for _, c := range cases {
107107
res := command.Result{
108108
Failure: c.Failure,
@@ -121,7 +121,7 @@ func TestRenderFailure(t *testing.T) {
121121
}
122122

123123
func TestRenderErrAndFailure(t *testing.T) {
124-
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "")
124+
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "", "atlantis")
125125
res := command.Result{
126126
Error: errors.New("error"),
127127
Failure: "failure",
@@ -791,7 +791,7 @@ $$$
791791
},
792792
}
793793

794-
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "")
794+
r := events.NewMarkdownRenderer(false, false, false, false, false, false, "", "atlantis")
795795
for _, c := range cases {
796796
t.Run(c.Description, func(t *testing.T) {
797797
res := command.Result{
@@ -943,13 +943,14 @@ $$$
943943
},
944944
}
945945
r := events.NewMarkdownRenderer(
946-
false, // gitlabSupportsCommonMark
947-
true, // disableApplyAll
948-
false, // disableApply
949-
false, // disableMarkdownFolding
950-
false, // disableRepoLocking
951-
false, // enableDiffMarkdownFormat
952-
"", // MarkdownTemplateOverridesDir
946+
false, // gitlabSupportsCommonMark
947+
true, // disableApplyAll
948+
false, // disableApply
949+
false, // disableMarkdownFolding
950+
false, // disableRepoLocking
951+
false, // enableDiffMarkdownFormat
952+
"", // MarkdownTemplateOverridesDir
953+
"atlantis", // executableName
953954
)
954955
for _, c := range cases {
955956
t.Run(c.Description, func(t *testing.T) {
@@ -1095,13 +1096,14 @@ $$$
10951096
}
10961097

10971098
r := events.NewMarkdownRenderer(
1098-
false, // gitlabSupportsCommonMark
1099-
true, // disableApplyAll
1100-
true, // disableApply
1101-
false, // disableMarkdownFolding
1102-
false, // disableRepoLocking
1103-
false, // enableDiffMarkdownFormat
1104-
"", // MarkdownTemplateOverridesDir
1099+
false, // gitlabSupportsCommonMark
1100+
true, // disableApplyAll
1101+
true, // disableApply
1102+
false, // disableMarkdownFolding
1103+
false, // disableRepoLocking
1104+
false, // enableDiffMarkdownFormat
1105+
"", // MarkdownTemplateOverridesDir
1106+
"atlantis", // executableName
11051107
)
11061108
for _, c := range cases {
11071109
t.Run(c.Description, func(t *testing.T) {
@@ -1132,13 +1134,14 @@ func TestRenderCustomPolicyCheckTemplate_DisableApplyAll(t *testing.T) {
11321134
err = os.WriteFile(filePath, []byte("{{ define \"policyCheckSuccessUnwrapped\" -}}somecustometext{{- end}}\n"), 0600)
11331135
Ok(t, err)
11341136
r := events.NewMarkdownRenderer(
1135-
false, // gitlabSupportsCommonMark
1136-
true, // disableApplyAll
1137-
true, // disableApply
1138-
false, // disableMarkdownFolding
1139-
false, // disableRepoLocking
1140-
false, // enableDiffMarkdownFormat
1141-
tmpDir, // MarkdownTemplateOverridesDir
1137+
false, // gitlabSupportsCommonMark
1138+
true, // disableApplyAll
1139+
true, // disableApply
1140+
false, // disableMarkdownFolding
1141+
false, // disableRepoLocking
1142+
false, // enableDiffMarkdownFormat
1143+
tmpDir, // MarkdownTemplateOverridesDir
1144+
"atlantis", // executableName
11421145
)
11431146

11441147
rendered := r.Render(command.Result{
@@ -1163,13 +1166,14 @@ func TestRenderCustomPolicyCheckTemplate_DisableApplyAll(t *testing.T) {
11631166
// Test that if folding is disabled that it's not used.
11641167
func TestRenderProjectResults_DisableFolding(t *testing.T) {
11651168
mr := events.NewMarkdownRenderer(
1166-
false, // gitlabSupportsCommonMark
1167-
false, // disableApplyAll
1168-
false, // disableApply
1169-
true, // disableMarkdownFolding
1170-
false, // disableRepoLocking
1171-
false, // enableDiffMarkdownFormat
1172-
"", // MarkdownTemplateOverridesDir
1169+
false, // gitlabSupportsCommonMark
1170+
false, // disableApplyAll
1171+
false, // disableApply
1172+
true, // disableMarkdownFolding
1173+
false, // disableRepoLocking
1174+
false, // enableDiffMarkdownFormat
1175+
"", // MarkdownTemplateOverridesDir
1176+
"atlantis", // executableName
11731177
)
11741178

11751179
rendered := mr.Render(command.Result{
@@ -1260,6 +1264,7 @@ func TestRenderProjectResults_WrappedErr(t *testing.T) {
12601264
false, // disableRepoLocking
12611265
false, // enableDiffMarkdownFormat
12621266
"", // MarkdownTemplateOverridesDir
1267+
"atlantis", // executableName
12631268
)
12641269

12651270
rendered := mr.Render(command.Result{
@@ -1378,6 +1383,7 @@ func TestRenderProjectResults_WrapSingleProject(t *testing.T) {
13781383
false, // disableRepoLocking
13791384
false, // enableDiffMarkdownFormat
13801385
"", // MarkdownTemplateOverridesDir
1386+
"atlantis", // executableName
13811387
)
13821388
var pr command.ProjectResult
13831389
switch cmd {
@@ -1482,13 +1488,14 @@ $$$
14821488

14831489
func TestRenderProjectResults_MultiProjectApplyWrapped(t *testing.T) {
14841490
mr := events.NewMarkdownRenderer(
1485-
false, // gitlabSupportsCommonMark
1486-
false, // disableApplyAll
1487-
false, // disableApply
1488-
false, // disableMarkdownFolding
1489-
false, // disableRepoLocking
1490-
false, // enableDiffMarkdownFormat
1491-
"", // MarkdownTemplateOverridesDir
1491+
false, // gitlabSupportsCommonMark
1492+
false, // disableApplyAll
1493+
false, // disableApply
1494+
false, // disableMarkdownFolding
1495+
false, // disableRepoLocking
1496+
false, // enableDiffMarkdownFormat
1497+
"", // MarkdownTemplateOverridesDir
1498+
"atlantis", // executableName
14921499
)
14931500
tfOut := strings.Repeat("line\n", 13)
14941501
rendered := mr.Render(command.Result{
@@ -1536,13 +1543,14 @@ $$$
15361543

15371544
func TestRenderProjectResults_MultiProjectPlanWrapped(t *testing.T) {
15381545
mr := events.NewMarkdownRenderer(
1539-
false, // gitlabSupportsCommonMark
1540-
false, // disableApplyAll
1541-
false, // disableApply
1542-
false, // disableMarkdownFolding
1543-
false, // disableRepoLocking
1544-
false, // enableDiffMarkdownFormat
1545-
"", // MarkdownTemplateOverridesDir
1546+
false, // gitlabSupportsCommonMark
1547+
false, // disableApplyAll
1548+
false, // disableApply
1549+
false, // disableMarkdownFolding
1550+
false, // disableRepoLocking
1551+
false, // enableDiffMarkdownFormat
1552+
"", // MarkdownTemplateOverridesDir
1553+
"atlantis", // executableName
15461554
)
15471555
tfOut := strings.Repeat("line\n", 13) + "Plan: 1 to add, 0 to change, 0 to destroy."
15481556
rendered := mr.Render(command.Result{
@@ -1717,13 +1725,14 @@ This plan was not saved because one or more projects failed and automerge requir
17171725
for name, c := range cases {
17181726
t.Run(name, func(t *testing.T) {
17191727
mr := events.NewMarkdownRenderer(
1720-
false, // gitlabSupportsCommonMark
1721-
false, // disableApplyAll
1722-
false, // disableApply
1723-
false, // disableMarkdownFolding
1724-
false, // disableRepoLocking
1725-
false, // enableDiffMarkdownFormat
1726-
"", // MarkdownTemplateOverridesDir
1728+
false, // gitlabSupportsCommonMark
1729+
false, // disableApplyAll
1730+
false, // disableApply
1731+
false, // disableMarkdownFolding
1732+
false, // disableRepoLocking
1733+
false, // enableDiffMarkdownFormat
1734+
"", // MarkdownTemplateOverridesDir
1735+
"atlantis", // executableName
17271736
)
17281737
rendered := mr.Render(c.cr, command.Plan, "log", false, models.Github)
17291738
expWithBackticks := strings.Replace(c.exp, "$", "`", -1)
@@ -2185,15 +2194,15 @@ $$$
21852194
}
21862195

21872196
r := events.NewMarkdownRenderer(
2188-
false, // gitlabSupportsCommonMark
2189-
false, // disableApplyAll
2190-
false, // disableApply
2191-
false, // disableMarkdownFolding
2192-
false, // disableRepoLocking
2193-
false, // enableDiffMarkdownFormat
2194-
"", // MarkdownTemplateOverridesDir
2197+
false, // gitlabSupportsCommonMark
2198+
false, // disableApplyAll
2199+
false, // disableApply
2200+
false, // disableMarkdownFolding
2201+
true, // disableRepoLocking
2202+
false, // enableDiffMarkdownFormat
2203+
"", // MarkdownTemplateOverridesDir
2204+
"atlantis", // executableName
21952205
)
2196-
r.disableRepoLocking = true
21972206
for _, c := range cases {
21982207
t.Run(c.Description, func(t *testing.T) {
21992208
res := command.Result{
@@ -2624,13 +2633,14 @@ Plan: 1 to add, 2 to change, 1 to destroy.
26242633

26252634
func TestRenderProjectResultsWithEnableDiffMarkdownFormat(t *testing.T) {
26262635
r := events.NewMarkdownRenderer(
2627-
false, // gitlabSupportsCommonMark
2628-
true, // disableApplyAll
2629-
true, // disableApply
2630-
false, // disableMarkdownFolding
2631-
false, // disableRepoLocking
2632-
true, // enableDiffMarkdownFormat
2633-
"", // MarkdownTemplateOverridesDir
2636+
false, // gitlabSupportsCommonMark
2637+
true, // disableApplyAll
2638+
true, // disableApply
2639+
false, // disableMarkdownFolding
2640+
false, // disableRepoLocking
2641+
true, // enableDiffMarkdownFormat
2642+
"", // MarkdownTemplateOverridesDir
2643+
"atlantis", // executableName
26342644
)
26352645

26362646
for _, c := range cases {
@@ -2659,13 +2669,14 @@ func BenchmarkRenderProjectResultsWithEnableDiffMarkdownFormat(b *testing.B) {
26592669
var render string
26602670

26612671
r := events.NewMarkdownRenderer(
2662-
false, // gitlabSupportsCommonMark
2663-
true, // disableApplyAll
2664-
true, // disableApply
2665-
false, // disableMarkdownFolding
2666-
false, // disableRepoLocking
2667-
true, // enableDiffMarkdownFormat
2668-
"", // MarkdownTemplateOverridesDir
2672+
false, // gitlabSupportsCommonMark
2673+
true, // disableApplyAll
2674+
true, // disableApply
2675+
false, // disableMarkdownFolding
2676+
false, // disableRepoLocking
2677+
true, // enableDiffMarkdownFormat
2678+
"", // MarkdownTemplateOverridesDir
2679+
"atlantis", // executableName
26692680
)
26702681

26712682
for _, c := range cases {

‎server/server.go

+1
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,7 @@ func NewServer(userConfig UserConfig, config Config) (*Server, error) {
420420
userConfig.DisableRepoLocking,
421421
userConfig.EnableDiffMarkdownFormat,
422422
userConfig.MarkdownTemplateOverridesDir,
423+
userConfig.ExecutableName,
423424
)
424425

425426
var lockingClient locking.Locker

0 commit comments

Comments
 (0)