handler

package

v0.1.2 Latest Latest Go to latest Published: Sep 29, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/G-Research/tfe-plan-bot

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Health() http.Handler
type Base
- func (b *Base) Evaluate(ctx context.Context, installationID int64, requestReviews bool, ...) error
- func (b *Base) EvaluateFetchedConfig(ctx context.Context, prctx pull.Context, requestReviews bool, ...) error
- func (b *Base) EvaluateWorkspace(ctx context.Context, prctx pull.Context, requestReviews bool, ...) error
- func (b *Base) PostStatus(ctx context.Context, prctx pull.Context, wkcfg plan.WorkspaceConfig, ...) error
- func (b *Base) PreparePRContext(ctx context.Context, installationID int64, pr *github.PullRequest) (context.Context, zerolog.Logger)
type CheckRun
- func (h *CheckRun) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error
- func (h *CheckRun) Handles() []string
type ConfigFetcher
- func (cf *ConfigFetcher) ConfigForPR(ctx context.Context, prctx pull.Context, client *github.Client) (FetchedConfig, error)
type CrossOrgMembershipContext
- func NewCrossOrgMembershipContext(ctx context.Context, client *github.Client, orgName string, ...) *CrossOrgMembershipContext
- func (c *CrossOrgMembershipContext) IsCollaborator(org, repo, user, desiredPerm string) (bool, error)
- func (c *CrossOrgMembershipContext) IsOrgMember(org, user string) (bool, error)
- func (c *CrossOrgMembershipContext) IsTeamMember(team, user string) (bool, error)
- func (c *CrossOrgMembershipContext) OrganizationMembers(org string) ([]string, error)
- func (c *CrossOrgMembershipContext) TeamMembers(team string) ([]string, error)
type FetchedConfig
- func (fc FetchedConfig) Description() string
- func (fc FetchedConfig) Invalid() bool
- func (fc FetchedConfig) Missing() bool
- func (fc FetchedConfig) String() string
- func (fc FetchedConfig) Valid() bool
type HealthCheck
type IssueComment
- func (h *IssueComment) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error
- func (h *IssueComment) Handles() []string
type PullEvaluationOptions
- func (p *PullEvaluationOptions) FillDefaults()
type PullRequest
- func (h *PullRequest) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error
- func (h *PullRequest) Handles() []string
type PullRequestReview
- func (h *PullRequestReview) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error
- func (h *PullRequestReview) Handles() []string
type Status
- func (h *Status) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error
- func (h *Status) Handles() []string

Constants ¶

View Source

const (
	DefaultPolicyPath         = ".tfe-plan.yml"
	DefaultStatusCheckContext = "TFE"
	DefaultAppName            = "tfe-plan-bot"

	LogKeyGitHubSHA = "github_sha"
)

View Source

const (
	LogKeyAudit string = "audit"
)

Variables ¶

This section is empty.

Functions ¶

func Health ¶

func Health() http.Handler

Types ¶

type Base ¶

type Base struct {
	githubapp.ClientCreator

	Installations     githubapp.InstallationsService
	PullOpts          *PullEvaluationOptions
	ConfigFetcher     *ConfigFetcher
	BaseConfig        *baseapp.HTTPConfig
	TFEClientProvider *plan.ClientProvider
	HTTPClient        *http.Client
}

func (*Base) Evaluate ¶

func (b *Base) Evaluate(ctx context.Context, installationID int64, requestReviews bool, loc pull.Locator) error

func (*Base) EvaluateFetchedConfig ¶

func (b *Base) EvaluateFetchedConfig(ctx context.Context, prctx pull.Context, requestReviews bool, client *github.Client, fetchedConfig FetchedConfig) error

func (*Base) EvaluateWorkspace ¶

func (b *Base) EvaluateWorkspace(ctx context.Context, prctx pull.Context, requestReviews bool, client *github.Client, fetchedConfig FetchedConfig, wkcfg plan.WorkspaceConfig) error

func (*Base) PostStatus ¶

func (b *Base) PostStatus(ctx context.Context, prctx pull.Context, wkcfg plan.WorkspaceConfig, runID string, client *github.Client, state, message string) error

func (*Base) PreparePRContext ¶

func (b *Base) PreparePRContext(ctx context.Context, installationID int64, pr *github.PullRequest) (context.Context, zerolog.Logger)

type CheckRun ¶

type CheckRun struct {
	Base
}

func (*CheckRun) Handle ¶

func (h *CheckRun) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error

func (*CheckRun) Handles ¶

func (h *CheckRun) Handles() []string

type ConfigFetcher ¶

type ConfigFetcher struct {
	PolicyPath string
}

func (*ConfigFetcher) ConfigForPR ¶

func (cf *ConfigFetcher) ConfigForPR(ctx context.Context, prctx pull.Context, client *github.Client) (FetchedConfig, error)

ConfigForPR fetches the policy configuration for a PR. It returns an error only if the existence of the policy could not be determined. If the policy does not exist or is invalid, the returned error is nil and the appropriate fields are set on the FetchedConfig.

type CrossOrgMembershipContext ¶

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

func NewCrossOrgMembershipContext ¶

func NewCrossOrgMembershipContext(ctx context.Context, client *github.Client, orgName string, installations githubapp.InstallationsService, clientCreator githubapp.ClientCreator) *CrossOrgMembershipContext

func (*CrossOrgMembershipContext) IsCollaborator ¶

func (c *CrossOrgMembershipContext) IsCollaborator(org, repo, user, desiredPerm string) (bool, error)

func (*CrossOrgMembershipContext) IsOrgMember ¶

func (c *CrossOrgMembershipContext) IsOrgMember(org, user string) (bool, error)

func (*CrossOrgMembershipContext) IsTeamMember ¶

func (c *CrossOrgMembershipContext) IsTeamMember(team, user string) (bool, error)

func (*CrossOrgMembershipContext) OrganizationMembers ¶

func (c *CrossOrgMembershipContext) OrganizationMembers(org string) ([]string, error)

func (*CrossOrgMembershipContext) TeamMembers ¶

func (c *CrossOrgMembershipContext) TeamMembers(team string) ([]string, error)

type FetchedConfig ¶

type FetchedConfig struct {
	Owner  string
	Repo   string
	Ref    string
	Path   string
	Config *plan.Config
	Error  error
}

func (FetchedConfig) Description ¶

func (fc FetchedConfig) Description() string

func (FetchedConfig) Invalid ¶

func (fc FetchedConfig) Invalid() bool

func (FetchedConfig) Missing ¶

func (fc FetchedConfig) Missing() bool

func (FetchedConfig) String ¶

func (fc FetchedConfig) String() string

func (FetchedConfig) Valid ¶

func (fc FetchedConfig) Valid() bool

type HealthCheck ¶

type HealthCheck struct {
	Status  string `json:"status"`
	Version string `json:"version"`
}

type IssueComment ¶

type IssueComment struct {
	Base
}

func (*IssueComment) Handle ¶

func (h *IssueComment) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error

Handle issue_comment See https://developer.github.com/v3/activity/events/types/#issuecommentevent

func (*IssueComment) Handles ¶

func (h *IssueComment) Handles() []string

type PullEvaluationOptions ¶

type PullEvaluationOptions struct {
	AppName    string `yaml:"app_name"`
	ConfigPath string `yaml:"config_path"`

	// StatusCheckContext will be used to create the status context. It will be used in the following
	// pattern: <StatusCheckContext>/<TFE Organization Name>/<TFE Workspace Name>
	StatusCheckContext string `yaml:"status_check_context"`
}

func (*PullEvaluationOptions) FillDefaults ¶

func (p *PullEvaluationOptions) FillDefaults()

type PullRequest ¶

type PullRequest struct {
	Base
}

func (*PullRequest) Handle ¶

func (h *PullRequest) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error

Handle pull_request https://developer.github.com/v3/activity/events/types/#requestevent

func (*PullRequest) Handles ¶

func (h *PullRequest) Handles() []string

type PullRequestReview ¶

type PullRequestReview struct {
	Base
}

func (*PullRequestReview) Handle ¶

func (h *PullRequestReview) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error

Handle pull_request_review https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent

func (*PullRequestReview) Handles ¶

func (h *PullRequestReview) Handles() []string

type Status ¶

type Status struct {
	Base
}

func (*Status) Handle ¶

func (h *Status) Handle(ctx context.Context, eventType, deliveryID string, payload []byte) error

Handle status https://developer.github.com/v3/activity/events/types/#statusevent

func (*Status) Handles ¶

func (h *Status) Handles() []string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL