api

Documentation

Index

• Constants
• type CLICommandResult
• type CLICommandTest
• type CLIData
• type CLIStep
• type CLIStepCLICommand
• type CLIStepHTTPRequest
• type CLIStepResult
• type HTTPActions
• type HTTPBasicAuth
• type HTTPRequest
• type HTTPRequestResponseVariable
• type HTTPRequestResult
• type HTTPRequestTest
• type HTTPRequestTestHeader
• type HTTPRequestTestJSONValue
• type Lesson
  • func FetchLesson(uuid string) (*Lesson, error)
• type LessonDataCLI
• type LoginRequest
• type LoginResponse
  • func FetchAccessToken() (*LoginResponse, error)
  • func LoginWithCode(code string) (*LoginResponse, error)
• type OperatorType
• type VerificationResultStructuredErrCLI
  • func SubmitCLILesson(uuid string, results []CLIStepResult) (*VerificationResultStructuredErrCLI, error)

Constants

const BaseURLOverrideRequired = "override"

const BaseURLPlaceholder = "${baseURL}"

Types

type CLICommandResult

type CLICommandResult struct {
	ExitCode     int
	FinalCommand string `json:"-"`
	Stdout       string
	Variables    map[string]string
}

type CLICommandTest

type CLICommandTest struct {
	ExitCode           *int
	StdoutContainsAll  []string
	StdoutContainsNone []string
	StdoutLinesGt      *int
}

type CLIData

type CLIData struct {
	// ContainsCompleteDir bool
	BaseURLDefault string
	Steps          []CLIStep
}

type CLIStep

type CLIStep struct {
	CLICommand  *CLIStepCLICommand
	HTTPRequest *CLIStepHTTPRequest
}

type CLIStepCLICommand

type CLIStepCLICommand struct {
	Command string
	Tests   []CLICommandTest
}

type CLIStepHTTPRequest

type CLIStepHTTPRequest struct {
	ResponseVariables []HTTPRequestResponseVariable
	Tests             []HTTPRequestTest
	Request           HTTPRequest
}

type CLIStepResult

type CLIStepResult struct {
	CLICommandResult  *CLICommandResult
	HTTPRequestResult *HTTPRequestResult
}

type HTTPActions

type HTTPActions struct {
	DelayRequestByMs *int
}

type HTTPBasicAuth

type HTTPBasicAuth struct {
	Username string
	Password string
}

type HTTPRequest

type HTTPRequest struct {
	Method   string
	FullURL  string
	Headers  map[string]string
	BodyJSON map[string]any

	BasicAuth *HTTPBasicAuth
	Actions   HTTPActions
}

type HTTPRequestResponseVariable

type HTTPRequestResponseVariable struct {
	Name string
	Path string
}

type HTTPRequestResult

type HTTPRequestResult struct {
	Err              string `json:"-"`
	StatusCode       int
	ResponseHeaders  map[string]string
	ResponseTrailers map[string]string
	BodyString       string
	Variables        map[string]string
	Request          CLIStepHTTPRequest
}

type HTTPRequestTest

type HTTPRequestTest struct {
	StatusCode       *int
	BodyContains     *string
	BodyContainsNone *string
	HeadersContain   *HTTPRequestTestHeader
	TrailersContain  *HTTPRequestTestHeader
	JSONValue        *HTTPRequestTestJSONValue
}

Only one of these fields should be set

type HTTPRequestTestHeader

type HTTPRequestTestHeader struct {
	Key   string
	Value string
}

type HTTPRequestTestJSONValue

type HTTPRequestTestJSONValue struct {
	Path        string
	Operator    OperatorType
	IntValue    *int
	StringValue *string
	BoolValue   *bool
}

type Lesson

type Lesson struct {
	Lesson struct {
		Type          string
		LessonDataCLI *LessonDataCLI
	}
}

func FetchLesson

func FetchLesson(uuid string) (*Lesson, error)

type LessonDataCLI

type LessonDataCLI struct {
	// Readme string
	CLIData CLIData
}

type LoginRequest

type LoginRequest struct {
	Otp string `json:"otp"`
}

type LoginResponse

type LoginResponse struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
}

func FetchAccessToken

func FetchAccessToken() (*LoginResponse, error)

func LoginWithCode

func LoginWithCode(code string) (*LoginResponse, error)

type OperatorType

type OperatorType string

const (
	OpEquals      OperatorType = "eq"
	OpGreaterThan OperatorType = "gt"
	OpContains    OperatorType = "contains"
	OpNotContains OperatorType = "not_contains"
)

type VerificationResultStructuredErrCLI

type VerificationResultStructuredErrCLI struct {
	ErrorMessage    string `json:"Error"`
	FailedStepIndex int    `json:"FailedStepIndex"`
	FailedTestIndex int    `json:"FailedTestIndex"`
}

func SubmitCLILesson

func SubmitCLILesson(uuid string, results []CLIStepResult) (*VerificationResultStructuredErrCLI, error)