// 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_test
import (
"errors"
"fmt"
"strings"
"testing"
"github.com/runatlantis/atlantis/server/events"
"github.com/runatlantis/atlantis/server/events/command"
"github.com/runatlantis/atlantis/server/events/models"
. "github.com/runatlantis/atlantis/testing"
)
func TestRenderErr(t *testing.T) {
err := errors.New("err")
cases := []struct {
Description string
Command command.Name
Error error
Expected string
}{
{
"apply error",
command.Apply,
err,
"**Apply Error**\n```\nerr\n```\n",
},
{
"plan error",
command.Plan,
err,
"**Plan Error**\n```\nerr\n```\n",
},
{
"policy check error",
command.PolicyCheck,
err,
"**Policy Check Error**\n```\nerr\n```" +
"\n* :heavy_check_mark: To **approve** failing policies an authorized approver can comment:\n" +
" * `atlantis approve_policies`\n" +
"* :repeat: Or, address the policy failure by modifying the codebase and re-planning.\n\n",
},
}
r := events.MarkdownRenderer{}
for _, c := range cases {
res := command.Result{
Error: c.Error,
}
for _, verbose := range []bool{true, false} {
t.Run(fmt.Sprintf("%s_%t", c.Description, verbose), func(t *testing.T) {
s := r.Render(res, c.Command, "log", verbose, models.Github)
if !verbose {
Equals(t, c.Expected, s)
} else {
Equals(t, c.Expected+"Log
\n \n\n```\nlog```\n
Log
\n \n\n```\nlog```\n
Log
\n \n\n```\nlog```\n
Log
\n \n\n```\nlog```\n
Log
\n \n\n```\nlog```\n
"))
}
// Test that if the output is longer than 12 lines, it gets wrapped on the right
// VCS hosts during an error.
func TestRenderProjectResults_WrappedErr(t *testing.T) {
cases := []struct {
VCSHost models.VCSHostType
GitlabCommonMarkSupport bool
Output string
ShouldWrap bool
}{
{
VCSHost: models.Github,
Output: strings.Repeat("line\n", 1),
ShouldWrap: false,
},
{
VCSHost: models.Github,
Output: strings.Repeat("line\n", 13),
ShouldWrap: true,
},
{
VCSHost: models.Gitlab,
GitlabCommonMarkSupport: false,
Output: strings.Repeat("line\n", 1),
ShouldWrap: false,
},
{
VCSHost: models.Gitlab,
GitlabCommonMarkSupport: false,
Output: strings.Repeat("line\n", 13),
ShouldWrap: false,
},
{
VCSHost: models.Gitlab,
GitlabCommonMarkSupport: true,
Output: strings.Repeat("line\n", 1),
ShouldWrap: false,
},
{
VCSHost: models.Gitlab,
GitlabCommonMarkSupport: true,
Output: strings.Repeat("line\n", 13),
ShouldWrap: true,
},
{
VCSHost: models.BitbucketCloud,
Output: strings.Repeat("line\n", 1),
ShouldWrap: false,
},
{
VCSHost: models.BitbucketCloud,
Output: strings.Repeat("line\n", 13),
ShouldWrap: false,
},
{
VCSHost: models.BitbucketServer,
Output: strings.Repeat("line\n", 1),
ShouldWrap: false,
},
{
VCSHost: models.BitbucketServer,
Output: strings.Repeat("line\n", 13),
ShouldWrap: false,
},
}
for _, c := range cases {
t.Run(fmt.Sprintf("%s_%v", c.VCSHost.String(), c.ShouldWrap),
func(t *testing.T) {
mr := events.MarkdownRenderer{
GitlabSupportsCommonMark: c.GitlabCommonMarkSupport,
}
rendered := mr.Render(command.Result{
ProjectResults: []command.ProjectResult{
{
RepoRelDir: ".",
Workspace: "default",
Error: errors.New(c.Output),
},
},
}, command.Plan, "log", false, c.VCSHost)
var exp string
if c.ShouldWrap {
exp = `Ran Plan for dir: $.$ workspace: $default$
**Plan Error**
Show Output
$$$
` + c.Output + `
$$$
Show Output
$$$diff
` + c.Output + `
$$$
* :arrow_forward: To **apply** this plan, comment:
* $applycmd$
* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
* :repeat: To **plan** this project again, comment:
* $replancmd$
Show Output
$$$diff
` + c.Output + `
$$$
Show Output
$$$diff
` + tfOut + `
$$$
Show Output
$$$diff
` + tfOut + `
$$$
Show Output
$$$diff
` + tfOut + `
$$$
* :arrow_forward: To **apply** this plan, comment:
* $staging-apply-cmd$
* :put_litter_in_its_place: To **delete** this plan click [here](staging-lock-url)
* :repeat: To **plan** this project again, comment:
* $staging-replan-cmd$
Show Output
$$$diff
` + tfOut + `
$$$
* :arrow_forward: To **apply** this plan, comment:
* $production-apply-cmd$
* :put_litter_in_its_place: To **delete** this plan click [here](production-lock-url)
* :repeat: To **plan** this project again, comment:
* $production-replan-cmd$
Log
\n \n\n```\nlog```\n
Show Output
$$$diff
An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
! update in-place
-/+ destroy and then create replacement
Terraform will perform the following actions:
# module.redacted.aws_instance.redacted must be replaced
-/+ resource "aws_instance" "redacted" {
! ami = "ami-redacted" -> "ami-redacted" # forces replacement
! arn = "arn:aws:ec2:us-east-1:redacted:instance/i-redacted" -> (known after apply)
! associate_public_ip_address = false -> (known after apply)
availability_zone = "us-east-1b"
! cpu_core_count = 4 -> (known after apply)
! cpu_threads_per_core = 2 -> (known after apply)
- disable_api_termination = false -> null
- ebs_optimized = false -> null
get_password_data = false
- hibernation = false -> null
+ host_id = (known after apply)
iam_instance_profile = "remote_redacted_profile"
! id = "i-redacted" -> (known after apply)
! instance_state = "running" -> (known after apply)
instance_type = "c5.2xlarge"
! ipv6_address_count = 0 -> (known after apply)
! ipv6_addresses = [] -> (known after apply)
key_name = "RedactedRedactedRedacted"
- monitoring = false -> null
+ outpost_arn = (known after apply)
+ password_data = (known after apply)
+ placement_group = (known after apply)
! primary_network_interface_id = "eni-redacted" -> (known after apply)
! private_dns = "ip-redacted.ec2.internal" -> (known after apply)
! private_ip = "redacted" -> (known after apply)
+ public_dns = (known after apply)
+ public_ip = (known after apply)
! secondary_private_ips = [] -> (known after apply)
! security_groups = [] -> (known after apply)
source_dest_check = true
subnet_id = "subnet-redacted"
tags = {
"Name" = "redacted-redacted"
}
! tenancy = "default" -> (known after apply)
user_data = "redacted"
! volume_tags = {} -> (known after apply)
vpc_security_group_ids = [
"sg-redactedsecuritygroup",
]
+ ebs_block_device {
+ delete_on_termination = (known after apply)
+ device_name = (known after apply)
+ encrypted = (known after apply)
+ iops = (known after apply)
+ kms_key_id = (known after apply)
+ snapshot_id = (known after apply)
+ volume_id = (known after apply)
+ volume_size = (known after apply)
+ volume_type = (known after apply)
}
+ ephemeral_block_device {
+ device_name = (known after apply)
+ no_device = (known after apply)
+ virtual_name = (known after apply)
}
! metadata_options {
! http_endpoint = "enabled" -> (known after apply)
! http_put_response_hop_limit = 1 -> (known after apply)
! http_tokens = "optional" -> (known after apply)
}
+ network_interface {
+ delete_on_termination = (known after apply)
+ device_index = (known after apply)
+ network_interface_id = (known after apply)
}
! root_block_device {
! delete_on_termination = true -> (known after apply)
! device_name = "/dev/sda1" -> (known after apply)
! encrypted = false -> (known after apply)
! iops = 600 -> (known after apply)
+ kms_key_id = (known after apply)
! volume_id = "vol-redacted" -> (known after apply)
! volume_size = 200 -> (known after apply)
! volume_type = "gp2" -> (known after apply)
}
}
# module.redacted.aws_route53_record.redacted_record will be updated in-place
! resource "aws_route53_record" "redacted_record" {
fqdn = "redacted.redacted.redacted.io"
id = "redacted_redacted.redacted.redacted.io_A"
name = "redacted.redacted.redacted.io"
! records = [
- "redacted",
] -> (known after apply)
ttl = 300
type = "A"
zone_id = "redacted"
}
Plan: 1 to add, 1 to change, 1 to destroy.
$$$
* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
* :repeat: To **plan** this project again, comment:
* $atlantis plan -d path -w workspace$
Log
\n \n\n```\nlog```\n