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 EventsController
  • func (e *EventsController) HandleCommentEvent(w http.ResponseWriter, event *github.IssueCommentEvent, githubReqID string)
  • func (e *EventsController) HandlePullRequestEvent(w http.ResponseWriter, pullEvent *github.PullRequestEvent, githubReqID string)
  • func (e *EventsController) Post(w http.ResponseWriter, r *http.Request)
• type GHRequestValidation
  • func (g *GHRequestValidation) Validate(r *http.Request, secret []byte) ([]byte, error)
• type GHRequestValidator
• 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

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"`
	LogLevel            string `mapstructure:"log-level"`
	Port                int    `mapstructure:"port"`
	RequireApproval     bool   `mapstructure:"require-approval"`
}

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 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
	Validator           GHRequestValidator
}

func (*EventsController) HandleCommentEvent

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

func (*EventsController) HandlePullRequestEvent

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

HandlePullRequestEvent will delete any locks associated with the pull request

func (*EventsController) Post

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

type GHRequestValidation

type GHRequestValidation struct{}

GHRequestValidation implements the GHRequestValidator interface.

func (*GHRequestValidation) Validate

func (g *GHRequestValidation) 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 GHRequestValidator

type GHRequestValidator 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)
}

GHRequestValidator validates GitHub 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 listens for GitHub events and runs the necessary Atlantis command

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
}