server

Documentation

Overview

Package server is the main package for Atlantis. It handles the web server and executing commands that come in via pull request comments.

Index

• Constants
• type Config
• type DefaultGithubRequestValidator
  • func (d *DefaultGithubRequestValidator) Validate(r *http.Request, secret []byte) ([]byte, error)
• type DefaultGitlabRequestParser
  • func (d *DefaultGitlabRequestParser) Validate(r *http.Request, secret []byte) (interface{}, error)
• type EventsController
  • func (e *EventsController) HandleGithubCommentEvent(w http.ResponseWriter, event *github.IssueCommentEvent, githubReqID string)
  • func (e *EventsController) HandleGithubPullRequestEvent(w http.ResponseWriter, pullEvent *github.PullRequestEvent, githubReqID string)
  • func (e *EventsController) HandleGitlabCommentEvent(w http.ResponseWriter, event gitlab.MergeCommentEvent)
  • func (e *EventsController) HandleGitlabMergeRequestEvent(w http.ResponseWriter, event gitlab.MergeEvent)
  • func (e *EventsController) Post(w http.ResponseWriter, r *http.Request)
• type GithubRequestValidator
• type GitlabRequestParser
• type LockDetailData
• type LockIndexData
• type RequestLogger
  • func NewRequestLogger(logger *logging.SimpleLogger) *RequestLogger
  • func (l *RequestLogger) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type Server
  • func NewServer(config Config) (*Server, error)
  • func (s *Server) DeleteLock(w http.ResponseWriter, _ *http.Request, id string)
  • func (s *Server) DeleteLockRoute(w http.ResponseWriter, r *http.Request)
  • func (s *Server) GetLock(w http.ResponseWriter, _ *http.Request, id string)
  • func (s *Server) GetLockRoute(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Index(w http.ResponseWriter, _ *http.Request)
  • func (s *Server) Start() error
• type TemplateWriter
• type WebhookConfig

Constants

const LockRouteName = "lock-detail"

Types

type Config

type Config struct {
	AtlantisURL         string          `mapstructure:"atlantis-url"`
	DataDir             string          `mapstructure:"data-dir"`
	GithubHostname      string          `mapstructure:"gh-hostname"`
	GithubToken         string          `mapstructure:"gh-token"`
	GithubUser          string          `mapstructure:"gh-user"`
	GithubWebHookSecret string          `mapstructure:"gh-webhook-secret"`
	GitlabHostname      string          `mapstructure:"gitlab-hostname"`
	GitlabToken         string          `mapstructure:"gitlab-token"`
	GitlabUser          string          `mapstructure:"gitlab-user"`
	GitlabWebHookSecret string          `mapstructure:"gitlab-webhook-secret"`
	LogLevel            string          `mapstructure:"log-level"`
	Port                int             `mapstructure:"port"`
	RequireApproval     bool            `mapstructure:"require-approval"`
	SlackToken          string          `mapstructure:"slack-token"`
	Webhooks            []WebhookConfig `mapstructure:"webhooks"`
}

Config configures Server. The mapstructure tags correspond to flags in cmd/server.go and are used when the config is parsed from a YAML file.

type DefaultGithubRequestValidator

type DefaultGithubRequestValidator struct{}

DefaultGithubRequestValidator validates GitHub requests.

func (*DefaultGithubRequestValidator) Validate

func (d *DefaultGithubRequestValidator) Validate(r *http.Request, secret []byte) ([]byte, error)

Validate returns the JSON payload of the request. If secret is not empty, it checks that the request was signed by secret and returns an error if it was not. If secret is empty, it does not check if the request was signed.

type DefaultGitlabRequestParser

type DefaultGitlabRequestParser struct{}

DefaultGitlabRequestParser parses GitLab requests.

func (*DefaultGitlabRequestParser) Validate

func (d *DefaultGitlabRequestParser) Validate(r *http.Request, secret []byte) (interface{}, error)

Validate returns the JSON payload of the request. If secret is not empty, it checks that the request was signed by secret and returns an error if it was not. If secret is empty, it does not check if the request was signed.

type EventsController

type EventsController struct {
	CommandRunner events.CommandRunner
	PullCleaner   events.PullCleaner
	Logger        *logging.SimpleLogger
	Parser        events.EventParsing
	// GithubWebHookSecret is the secret added to this webhook via the GitHub
	// UI that identifies this call as coming from GitHub. If empty, no
	// request validation is done.
	GithubWebHookSecret    []byte
	GithubRequestValidator GithubRequestValidator
	GitlabRequestParser    GitlabRequestParser
	// GitlabWebHookSecret is the secret added to this webhook via the GitLab
	// UI that identifies this call as coming from GitLab. If empty, no
	// request validation is done.
	GitlabWebHookSecret []byte
	// SupportedVCSHosts is which VCS hosts Atlantis was configured upon
	// startup to support.
	SupportedVCSHosts []vcs.Host
}

func (*EventsController) HandleGithubCommentEvent

func (e *EventsController) HandleGithubCommentEvent(w http.ResponseWriter, event *github.IssueCommentEvent, githubReqID string)

func (*EventsController) HandleGithubPullRequestEvent

func (e *EventsController) HandleGithubPullRequestEvent(w http.ResponseWriter, pullEvent *github.PullRequestEvent, githubReqID string)

HandleGithubPullRequestEvent will delete any locks associated with the pull request

func (*EventsController) HandleGitlabCommentEvent

func (e *EventsController) HandleGitlabCommentEvent(w http.ResponseWriter, event gitlab.MergeCommentEvent)

func (*EventsController) HandleGitlabMergeRequestEvent

func (e *EventsController) HandleGitlabMergeRequestEvent(w http.ResponseWriter, event gitlab.MergeEvent)

HandleGitlabMergeRequestEvent will delete any locks associated with the merge request

func (*EventsController) Post

func (e *EventsController) Post(w http.ResponseWriter, r *http.Request)

type GithubRequestValidator

type GithubRequestValidator interface {
	// Validate returns the JSON payload of the request.
	// If secret is not empty, it checks that the request was signed
	// by secret and returns an error if it was not.
	// If secret is empty, it does not check if the request was signed.
	Validate(r *http.Request, secret []byte) ([]byte, error)
}

GithubRequestValidator validates GitHub requests.

type GitlabRequestParser

type GitlabRequestParser interface {
	// Validate validates that the request has a token header matching secret.
	// If the secret does not match it returns an error.
	// If secret is empty it does not check the token header.
	// It then parses the request as a gitlab object depending on the header
	// provided by GitLab identifying the webhook type. If the webhook type
	// is not recognized it will return nil but will not return an error.
	// Usage:
	//	event, err := GitlabRequestParser.Validate(r, secret)
	//	if err != nil {
	//		return
	//	}
	//	switch event := event.(type) {
	//	case gitlab.MergeCommentEvent:
	//		// handle
	//	case gitlab.MergeEvent:
	//		// handle
	//	default:
	//		// unsupported event
	//	}
	Validate(r *http.Request, secret []byte) (interface{}, error)
}

GitlabRequestParser parses and validates GitLab requests.

type LockDetailData

type LockDetailData struct {
	UnlockURL       string
	LockKeyEncoded  string
	LockKey         string
	RepoOwner       string
	RepoName        string
	PullRequestLink string
	LockedBy        string
	Environment     string
	Time            time.Time
}

type LockIndexData

type LockIndexData struct {
	LockURL      string
	RepoFullName string
	PullNum      int ``
	Time         time.Time
}

type RequestLogger

type RequestLogger struct {
	// contains filtered or unexported fields
}

RequestLogger logs requests and their response codes

func NewRequestLogger

func NewRequestLogger(logger *logging.SimpleLogger) *RequestLogger

func (*RequestLogger) ServeHTTP

func (l *RequestLogger) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type Server

type Server struct {
	Router             *mux.Router
	Port               int
	CommandHandler     *events.CommandHandler
	Logger             *logging.SimpleLogger
	Locker             locking.Locker
	AtlantisURL        string
	EventsController   *EventsController
	IndexTemplate      TemplateWriter
	LockDetailTemplate TemplateWriter
}

Server runs the Atlantis web server. It's used for webhook requests and the Atlantis UI.

func NewServer

func NewServer(config Config) (*Server, error)

func (*Server) DeleteLock

func (s *Server) DeleteLock(w http.ResponseWriter, _ *http.Request, id string)

func (*Server) DeleteLockRoute

func (s *Server) DeleteLockRoute(w http.ResponseWriter, r *http.Request)

func (*Server) GetLock

func (s *Server) GetLock(w http.ResponseWriter, _ *http.Request, id string)

GetLock handles a lock detail page view. getLockRoute is expected to be called before. This function was extracted to make it testable.

func (*Server) GetLockRoute

func (s *Server) GetLockRoute(w http.ResponseWriter, r *http.Request)

func (*Server) Index

func (s *Server) Index(w http.ResponseWriter, _ *http.Request)

func (*Server) Start

func (s *Server) Start() error

type TemplateWriter

type TemplateWriter interface {
	Execute(wr io.Writer, data interface{}) error
}

type WebhookConfig

type WebhookConfig struct {
	Event          string `mapstructure:"event"`
	WorkspaceRegex string `mapstructure:"workspace-regex"`
	Kind           string `mapstructure:"kind"`
	// Slack specific
	Channel string `mapstructure:"channel"`
}