api

Documentation

Index

• type CLICommandResult
• type CLICommandTestCase
• type HTTPTest
• type HTTPTestHeader
• type HTTPTestJSONValue
• type HTTPTestValidationError
  • func SubmitHTTPTestLesson(uuid string, results any) (*HTTPTestValidationError, error)
• type Lesson
  • func FetchLesson(uuid string) (*Lesson, error)
• type LessonDataCLICommand
• type LessonDataHTTPTests
• type LoginRequest
• type LoginResponse
  • func FetchAccessToken() (*LoginResponse, error)
  • func LoginWithCode(code string) (*LoginResponse, error)
• type OperatorType
• type ResponseVariable
• type StructuredErrCLICommand
  • func SubmitCLICommandLesson(uuid string, results []CLICommandResult) (*StructuredErrCLICommand, error)

Types

type CLICommandResult

type CLICommandResult struct {
	ExitCode     int
	FinalCommand string `json:"-"`
	Stdout       string
}

type CLICommandTestCase

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

type HTTPTest

type HTTPTest struct {
	StatusCode     *int
	BodyContains   *string
	HeadersContain *HTTPTestHeader
	JSONValue      *HTTPTestJSONValue
}

Only one of these fields should be set

type HTTPTestHeader

type HTTPTestHeader struct {
	Key   string
	Value string
}

type HTTPTestJSONValue

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

type HTTPTestValidationError

type HTTPTestValidationError struct {
	ErrorMessage       *string `json:"Error"`
	FailedRequestIndex *int    `json:"FailedRequestIndex"`
	FailedTestIndex    *int    `json:"FailedTestIndex"`
}

func SubmitHTTPTestLesson

func SubmitHTTPTestLesson(uuid string, results any) (*HTTPTestValidationError, error)

type Lesson

type Lesson struct {
	Lesson struct {
		Type                 string
		LessonDataHTTPTests  *LessonDataHTTPTests
		LessonDataCLICommand *LessonDataCLICommand
	}
}

func FetchLesson

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

type LessonDataCLICommand

type LessonDataCLICommand struct {
	CLICommandData struct {
		Commands []struct {
			Command string
			Tests   []CLICommandTestCase
		}
	}
}

type LessonDataHTTPTests

type LessonDataHTTPTests struct {
	HttpTests struct {
		BaseURL             *string
		ContainsCompleteDir bool
		Requests            []struct {
			ResponseVariables []ResponseVariable
			Tests             []HTTPTest
			Request           struct {
				BasicAuth *struct {
					Username string
					Password string
				}
				Headers  map[string]string
				BodyJSON map[string]interface{}
				Method   string
				Path     string
				Actions  struct {
					DelayRequestByMs *int32
				}
			}
		}
	}
}

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"
)

type ResponseVariable

type ResponseVariable struct {
	Name string
	Path string
}

type StructuredErrCLICommand

type StructuredErrCLICommand struct {
	ErrorMessage       string `json:"Error"`
	FailedCommandIndex int    `json:"FailedCommandIndex"`
	FailedTestIndex    int    `json:"FailedTestIndex"`
}

func SubmitCLICommandLesson

func SubmitCLICommandLesson(uuid string, results []CLICommandResult) (*StructuredErrCLICommand, error)