mirror of
https://git.vectorsigma.ru/public/atlantis.git
synced 2026-07-30 16:18:47 +00:00
7ac8106f8a
This is two changes: Replacing all usages of SimpleLogger with it's interface SimpleLogging which makes it easier to swap out loggers going forward Nukes SimpleLogger in favor of StructuredLogger which allows us to better analyze logs in our log management system we choose.
101 lines
4.0 KiB
Go
101 lines
4.0 KiB
Go
// Package runtime holds code for actually running commands vs. preparing
|
|
// and constructing.
|
|
package runtime
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"regexp"
|
|
"strings"
|
|
|
|
version "github.com/hashicorp/go-version"
|
|
"github.com/pkg/errors"
|
|
"github.com/runatlantis/atlantis/server/events/models"
|
|
"github.com/runatlantis/atlantis/server/events/terraform"
|
|
"github.com/runatlantis/atlantis/server/logging"
|
|
)
|
|
|
|
const (
|
|
// lineBeforeRunURL is the line output during a remote operation right before
|
|
// a link to the run url will be output.
|
|
lineBeforeRunURL = "To view this run in a browser, visit:"
|
|
planfileSlashReplace = "::"
|
|
)
|
|
|
|
// TerraformExec brings the interface from TerraformClient into this package
|
|
// without causing circular imports.
|
|
type TerraformExec interface {
|
|
RunCommandWithVersion(log logging.SimpleLogging, path string, args []string, envs map[string]string, v *version.Version, workspace string) (string, error)
|
|
EnsureVersion(log logging.SimpleLogging, v *version.Version) error
|
|
}
|
|
|
|
// AsyncTFExec brings the interface from TerraformClient into this package
|
|
// without causing circular imports.
|
|
// It's split from TerraformExec because due to a bug in pegomock with channels,
|
|
// we can't generate a mock for it so we hand-write it for this specific method.
|
|
type AsyncTFExec interface {
|
|
// RunCommandAsync runs terraform with args. It immediately returns an
|
|
// input and output channel. Callers can use the output channel to
|
|
// get the realtime output from the command.
|
|
// Callers can use the input channel to pass stdin input to the command.
|
|
// If any error is passed on the out channel, there will be no
|
|
// further output (so callers are free to exit).
|
|
RunCommandAsync(log logging.SimpleLogging, path string, args []string, envs map[string]string, v *version.Version, workspace string) (chan<- string, <-chan terraform.Line)
|
|
}
|
|
|
|
// StatusUpdater brings the interface from CommitStatusUpdater into this package
|
|
// without causing circular imports.
|
|
type StatusUpdater interface {
|
|
UpdateProject(ctx models.ProjectCommandContext, cmdName models.CommandName, status models.CommitStatus, url string) error
|
|
}
|
|
|
|
//go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_runner.go Runner
|
|
// Runner mirrors events.StepRunner as a way to bring it into this package
|
|
type Runner interface {
|
|
Run(ctx models.ProjectCommandContext, extraArgs []string, path string, envs map[string]string) (string, error)
|
|
}
|
|
|
|
// MustConstraint returns a constraint. It panics on error.
|
|
func MustConstraint(constraint string) version.Constraints {
|
|
c, err := version.NewConstraint(constraint)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return c
|
|
}
|
|
|
|
// GetPlanFilename returns the filename (not the path) of the generated tf plan
|
|
// given a workspace and project name.
|
|
func GetPlanFilename(workspace string, projName string) string {
|
|
if projName == "" {
|
|
return fmt.Sprintf("%s.tfplan", workspace)
|
|
}
|
|
projName = strings.Replace(projName, "/", planfileSlashReplace, -1)
|
|
return fmt.Sprintf("%s-%s.tfplan", projName, workspace)
|
|
}
|
|
|
|
// isRemotePlan returns true if planContents are from a plan that was generated
|
|
// using TFE remote operations.
|
|
func IsRemotePlan(planContents []byte) bool {
|
|
// We add a header to plans generated by the remote backend so we can
|
|
// detect that they're remote in the apply phase.
|
|
remoteOpsHeaderBytes := []byte(remoteOpsHeader)
|
|
return bytes.Equal(planContents[:len(remoteOpsHeaderBytes)], remoteOpsHeaderBytes)
|
|
}
|
|
|
|
// ProjectNameFromPlanfile returns the project name that a planfile with name
|
|
// filename is for. If filename is for a project without a name then it will
|
|
// return an empty string. workspace is the workspace this project is in.
|
|
func ProjectNameFromPlanfile(workspace string, filename string) (string, error) {
|
|
r, err := regexp.Compile(fmt.Sprintf(`(.*?)-%s\.tfplan`, workspace))
|
|
if err != nil {
|
|
return "", errors.Wrap(err, "compiling project name regex, this is a bug")
|
|
}
|
|
projMatch := r.FindAllStringSubmatch(filename, 1)
|
|
if projMatch == nil {
|
|
return "", nil
|
|
}
|
|
rawProjName := projMatch[0][1]
|
|
return strings.Replace(rawProjName, planfileSlashReplace, "/", -1), nil
|
|
}
|