testserver

Documentation

Overview

Package testserver provides fake Terramate Cloud endpoints for testing purposes.

Index

• func DisableEndpoints(paths ...string) map[string]bool
• func EnableAllConfig() map[string]bool
• func GetCommit(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetDeploymentLogs(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetDeploymentLogsEvents(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetDeployments(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetDrift(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetDrifts(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetMemberships(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func GetPreview(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetPullRequest(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func GetStackDrifts(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func GetStacks(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func GetUsers(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func GetWellKnown(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func ListCheckRunsForRef(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func ListPullRequestsWithCommit(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func ListReviews(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func PatchDeployment(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PatchStackPreviews(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PostDeployment(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PostDeploymentLogs(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PostDrift(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PostPreviews(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PostStackPreviewsLogs(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func PullRequestIsMerged(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, ...)
• func PutStack(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, ...)
• func Router(store *cloudstore.Data) *httprouter.Router
• func RouterAdd(store *cloudstore.Data, router *httprouter.Router, enabled map[string]bool)
• func RouterAddCustoms(router *httprouter.Router, store *cloudstore.Data, custom Custom)
• func RouterWith(store *cloudstore.Data, enabled map[string]bool) *httprouter.Router
• type Custom
• type Handler
• type Route

Functions

func DisableEndpoints

func DisableEndpoints(paths ...string) map[string]bool

DisableEndpoints the provided path endpoints.

func EnableAllConfig

func EnableAllConfig() map[string]bool

EnableAllConfig returns a map that enables all cloud endpoints.

func GetCommit

func GetCommit(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

GetCommit returns a commit. GitHub API docs: https://docs.github.com/rest/commits/commits#get-a-commit

func GetDeploymentLogs

func GetDeploymentLogs(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, p httprouter.Params)

GetDeploymentLogs is the GET /deployments/.../logs handler.

func GetDeploymentLogsEvents

func GetDeploymentLogsEvents(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, p httprouter.Params)

GetDeploymentLogsEvents is the SSE GET /deployments/.../logs handler.

func GetDeployments

func GetDeployments(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, p httprouter.Params)

GetDeployments is the GET /deployments handler.

func GetDrift

func GetDrift(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, params httprouter.Params)

GetDrift implements the /v1/drifts/:orguuid/:stackid/:driftid endpoint.

func GetDrifts

func GetDrifts(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, p httprouter.Params)

GetDrifts implements the GET /drifts/:orguuid endpoint. Note: this is not a real endpoint.

func GetMemberships

func GetMemberships(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, _ httprouter.Params)

GetMemberships is the testserver GET /memberships handler.

func GetPreview

func GetPreview(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, p httprouter.Params)

GetPreview returns details about a preview. This is a convenience endpoint for asserting the required state in tests (it does not actually exist in the TMC API).

func GetPullRequest

func GetPullRequest(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

GetPullRequest returns a pull request. GitHub API docs: https://docs.github.com/rest/pulls/pulls#get-a-pull-request

func GetStackDrifts

func GetStackDrifts(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, params httprouter.Params)

GetStackDrifts implements the /v1/stacks/:orguuid/:stackid/drifts endpoint.

func GetStacks

func GetStacks(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, params httprouter.Params)

GetStacks is the GET /stacks handler.

func GetUsers

func GetUsers(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, _ httprouter.Params)

GetUsers implements the /v1/users endpoint.

func GetWellKnown

func GetWellKnown(store *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

GetWellKnown implements the /.well-known/cli.json endpoint.

func ListCheckRunsForRef

func ListCheckRunsForRef(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

ListCheckRunsForRef returns a list of check runs for a ref. GitHub API docs: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference

func ListPullRequestsWithCommit

func ListPullRequestsWithCommit(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

ListPullRequestsWithCommit returns a list of pull requests for a commit. GitHub API docs: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit

func ListReviews

func ListReviews(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

ListReviews returns a list of reviews for a pull request. GitHub API docs: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request

func PatchDeployment

func PatchDeployment(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PatchDeployment is the PATCH /deployments handler.

func PatchStackPreviews

func PatchStackPreviews(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PatchStackPreviews is the PATCH /v1/stack_previews/:stack_preview_id handler.

func PostDeployment

func PostDeployment(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PostDeployment is the POST /deployments handler.

func PostDeploymentLogs

func PostDeploymentLogs(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PostDeploymentLogs is the POST /deployments/.../logs handler.

func PostDrift

func PostDrift(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PostDrift implements the POST /v1/drifts/:orguuid endpoint.

func PostPreviews

func PostPreviews(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PostPreviews is the POST /v1/previews handler.

func PostStackPreviewsLogs

func PostStackPreviewsLogs(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PostStackPreviewsLogs is the POST /v1/stack_previews/:stack_preview_id/logs handler.

func PullRequestIsMerged

func PullRequestIsMerged(_ *cloudstore.Data, w http.ResponseWriter, _ *http.Request, _ httprouter.Params)

PullRequestIsMerged returns whether a pull request is merged. GitHub API docs: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged

func PutStack

func PutStack(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

PutStack is the PUT /stacks handler.

func Router

func Router(store *cloudstore.Data) *httprouter.Router

Router returns the default fake cloud router.

func RouterAdd

func RouterAdd(store *cloudstore.Data, router *httprouter.Router, enabled map[string]bool)

RouterAdd enables endpoints in an existing router.

func RouterAddCustoms

func RouterAddCustoms(router *httprouter.Router, store *cloudstore.Data, custom Custom)

RouterAddCustoms add custom routes to the fake server. This is used by very specific test cases which requires injection of custom errors in the server.

func RouterWith

func RouterWith(store *cloudstore.Data, enabled map[string]bool) *httprouter.Router

RouterWith returns the testserver router configuration only for the enabled endpoints.

Types

type Custom

type Custom struct {
	Routes map[string]Route
}

Custom declares a custom server config.

type Handler

type Handler func(store *cloudstore.Data, w http.ResponseWriter, r *http.Request, p httprouter.Params)

Handler is the testserver handler interface.

type Route

type Route struct {
	Path    string
	Handler Handler
}

Route declares an HTTP route.