added poseidon with aws to k8s changes
This commit is contained in:
Elmar Kresse
344
pkg/dto/dto.go
Normal file
344
pkg/dto/dto.go
Normal file
@ -0,0 +1,344 @@
|
||||
package dto
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"path"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var (
|
||||
// UserAgentOut for outgoing requests (without libraries). The Git Hash will be replaced by main.go.
|
||||
UserAgentOut = "Poseidon/" + UserAgentVCSPlaceholder + " Go-http-client/1.1"
|
||||
UserAgentFiltered = "Poseidon/" + UserAgentVCSPlaceholder + " (" + UserAgentFilterTokenPlaceholder + ") Go-http-client/1.1"
|
||||
)
|
||||
|
||||
const (
|
||||
UserAgentVCSPlaceholder = "<7 Git Hash>"
|
||||
UserAgentFilterTokenPlaceholder = "FilterToken"
|
||||
)
|
||||
|
||||
// RunnerRequest is the expected json structure of the request body for the ProvideRunner function.
|
||||
type RunnerRequest struct {
|
||||
ExecutionEnvironmentID int `json:"executionEnvironmentId"`
|
||||
InactivityTimeout int `json:"inactivityTimeout"`
|
||||
}
|
||||
|
||||
// ExecutionRequest is the expected json structure of the request body for the ExecuteCommand function.
|
||||
type ExecutionRequest struct {
|
||||
Command string
|
||||
PrivilegedExecution bool
|
||||
TimeLimit int
|
||||
Environment map[string]string
|
||||
}
|
||||
|
||||
// FullCommand joins the environment variables.
|
||||
// It does not handle the TimeLimit or the PrivilegedExecution flag.
|
||||
func (er *ExecutionRequest) FullCommand() string {
|
||||
var command string
|
||||
command += "env"
|
||||
|
||||
if er.Environment == nil {
|
||||
er.Environment = make(map[string]string)
|
||||
}
|
||||
er.Environment["CODEOCEAN"] = "true"
|
||||
|
||||
for variable, value := range er.Environment {
|
||||
command += fmt.Sprintf(" %s=%s", variable, value)
|
||||
}
|
||||
command += fmt.Sprintf(" %s", WrapBashCommand(er.Command))
|
||||
return command
|
||||
}
|
||||
|
||||
// BashEscapeCommand escapes the passed command and surrounds it with double-quotes.
|
||||
// The escaping includes the characters ", \, $, ` (comma-separated) as they are the exceptional characters
|
||||
// that still have a special meaning with double quotes. See the Bash Manual - Chapter Quoting.
|
||||
// We only handle the dollar-character and the backquote because the %q format already escapes the other two.
|
||||
func BashEscapeCommand(command string) string {
|
||||
command = fmt.Sprintf("%q", command)
|
||||
command = strings.ReplaceAll(command, "$", "\\$")
|
||||
command = strings.ReplaceAll(command, "`", "\\`")
|
||||
return command
|
||||
}
|
||||
|
||||
// WrapBashCommand escapes the passed command and wraps it into a new bash command.
|
||||
func WrapBashCommand(command string) string {
|
||||
return fmt.Sprintf("/bin/bash -c %s", BashEscapeCommand(command))
|
||||
}
|
||||
|
||||
// EnvironmentID is an id of an environment.
|
||||
type EnvironmentID int
|
||||
|
||||
// NewEnvironmentID parses a string into an EnvironmentID.
|
||||
func NewEnvironmentID(id string) (EnvironmentID, error) {
|
||||
environment, err := strconv.Atoi(id)
|
||||
return EnvironmentID(environment), err
|
||||
}
|
||||
|
||||
// ToString pareses an EnvironmentID back to a string.
|
||||
func (e EnvironmentID) ToString() string {
|
||||
return strconv.Itoa(int(e))
|
||||
}
|
||||
|
||||
// ExecutionEnvironmentData is the expected json structure of the response body
|
||||
// for routes returning an execution environment.
|
||||
type ExecutionEnvironmentData struct {
|
||||
ExecutionEnvironmentRequest
|
||||
ID int `json:"id"`
|
||||
}
|
||||
|
||||
// StatisticalExecutionEnvironmentData is the expected json structure of the response body
|
||||
// for routes returning statistics about execution environments.
|
||||
type StatisticalExecutionEnvironmentData struct {
|
||||
ID int `json:"id"`
|
||||
PrewarmingPoolSize uint `json:"prewarmingPoolSize"`
|
||||
IdleRunners uint `json:"idleRunners"`
|
||||
UsedRunners uint `json:"usedRunners"`
|
||||
}
|
||||
|
||||
// ExecutionEnvironmentRequest is the expected json structure of the request body
|
||||
// for the create execution environment function.
|
||||
type ExecutionEnvironmentRequest struct {
|
||||
PrewarmingPoolSize uint `json:"prewarmingPoolSize"`
|
||||
CPULimit uint `json:"cpuLimit"`
|
||||
MemoryLimit uint `json:"memoryLimit"`
|
||||
Image string `json:"image"`
|
||||
NetworkAccess bool `json:"networkAccess"`
|
||||
ExposedPorts []uint16 `json:"exposedPorts"`
|
||||
}
|
||||
|
||||
// MappedPort contains the mapping from exposed port inside the container to the host address
|
||||
// outside the container.
|
||||
type MappedPort struct {
|
||||
ExposedPort uint `json:"exposedPort"`
|
||||
HostAddress string `json:"hostAddress"`
|
||||
}
|
||||
|
||||
// RunnerResponse is the expected response when providing a runner.
|
||||
type RunnerResponse struct {
|
||||
ID string `json:"runnerId"`
|
||||
MappedPorts []*MappedPort `json:"mappedPorts"`
|
||||
}
|
||||
|
||||
// ExecutionResponse is the expected response when creating an execution for a runner.
|
||||
type ExecutionResponse struct {
|
||||
WebSocketURL string `json:"websocketUrl"`
|
||||
}
|
||||
|
||||
// ListFileSystemResponse is the expected response when listing the file system.
|
||||
type ListFileSystemResponse struct {
|
||||
Files []FileHeader `json:"files"`
|
||||
}
|
||||
|
||||
// UpdateFileSystemRequest is the expected json structure of the request body for the update file system route.
|
||||
type UpdateFileSystemRequest struct {
|
||||
Delete []FilePath `json:"delete"`
|
||||
Copy []File `json:"copy"`
|
||||
}
|
||||
|
||||
// FilePath specifies the path of a file and is part of the UpdateFileSystemRequest.
|
||||
type FilePath string
|
||||
|
||||
// EntryType specifies the type of the object (file/link/directory/...)
|
||||
type EntryType string
|
||||
|
||||
// These are the common entry types. You find others in the man pages `info ls`.
|
||||
const (
|
||||
EntryTypeRegularFile EntryType = "-"
|
||||
EntryTypeLink EntryType = "l"
|
||||
)
|
||||
|
||||
// FileHeader specifies the information provided for listing a File.
|
||||
type FileHeader struct {
|
||||
Name FilePath `json:"name"`
|
||||
EntryType EntryType `json:"entryType"`
|
||||
LinkTarget FilePath `json:"linkTarget,omitempty"`
|
||||
Size int `json:"size"`
|
||||
ModificationTime int `json:"modificationTime"`
|
||||
Permissions string `json:"permissions"`
|
||||
Owner string `json:"owner"`
|
||||
Group string `json:"group"`
|
||||
}
|
||||
|
||||
// File is a DTO for transmitting file contents. It is part of the UpdateFileSystemRequest.
|
||||
type File struct {
|
||||
Path FilePath `json:"path"`
|
||||
Content []byte `json:"content"`
|
||||
}
|
||||
|
||||
// Cleaned returns the cleaned path of the FilePath.
|
||||
func (f FilePath) Cleaned() string {
|
||||
return path.Clean(string(f))
|
||||
}
|
||||
|
||||
// CleanedPath returns the cleaned path of the file.
|
||||
func (f File) CleanedPath() string {
|
||||
return f.Path.Cleaned()
|
||||
}
|
||||
|
||||
// IsDirectory returns true iff the path of the File ends with a /.
|
||||
func (f File) IsDirectory() bool {
|
||||
return strings.HasSuffix(string(f.Path), "/")
|
||||
}
|
||||
|
||||
// ByteContent returns the content of the File. If the File is a directory, the content will be empty.
|
||||
func (f File) ByteContent() []byte {
|
||||
if f.IsDirectory() {
|
||||
return []byte("")
|
||||
} else {
|
||||
return f.Content
|
||||
}
|
||||
}
|
||||
|
||||
// Formatter mirrors the available Formatters of logrus for configuration purposes.
|
||||
type Formatter string
|
||||
|
||||
const (
|
||||
FormatterText = "TextFormatter"
|
||||
FormatterJSON = "JSONFormatter"
|
||||
)
|
||||
|
||||
// ContextKey is the type for keys in a request context that is used for passing data to the next handler.
|
||||
type ContextKey string
|
||||
|
||||
// Keys to reference information (for logging or monitoring).
|
||||
const (
|
||||
KeyRunnerID = "runner_id"
|
||||
KeyEnvironmentID = "environment_id"
|
||||
KeyRunnerDestroyReason = "destroy_reason"
|
||||
)
|
||||
|
||||
// LoggedContextKeys defines which keys will be logged if a context is passed to logrus. See ContextHook.
|
||||
var LoggedContextKeys = []ContextKey{KeyRunnerID, KeyEnvironmentID, KeyRunnerDestroyReason}
|
||||
|
||||
// WebSocketMessageType is the type for the messages from Poseidon to the client.
|
||||
type WebSocketMessageType string
|
||||
|
||||
const (
|
||||
WebSocketOutputStdout WebSocketMessageType = "stdout"
|
||||
WebSocketOutputStderr WebSocketMessageType = "stderr"
|
||||
WebSocketOutputError WebSocketMessageType = "error"
|
||||
WebSocketMetaStart WebSocketMessageType = "start"
|
||||
WebSocketMetaTimeout WebSocketMessageType = "timeout"
|
||||
WebSocketExit WebSocketMessageType = "exit"
|
||||
)
|
||||
|
||||
var (
|
||||
ErrUnknownWebSocketMessageType = errors.New("unknown WebSocket message type")
|
||||
// ErrOOMKilled is the exact message that CodeOcean expects to further handle these specific cases.
|
||||
ErrOOMKilled = errors.New("the allocation was OOM Killed")
|
||||
ErrMissingType = errors.New("type is missing")
|
||||
ErrMissingData = errors.New("data is missing")
|
||||
ErrInvalidType = errors.New("invalid type")
|
||||
ErrNotSupported = errors.New("not supported")
|
||||
)
|
||||
|
||||
// WebSocketMessage is the type for all messages send in the WebSocket to the client.
|
||||
// Depending on the MessageType the Data or ExitCode might not be included in the marshaled json message.
|
||||
type WebSocketMessage struct {
|
||||
Type WebSocketMessageType
|
||||
Data string
|
||||
ExitCode uint8
|
||||
}
|
||||
|
||||
// MarshalJSON implements the json.Marshaler interface.
|
||||
// This converts the WebSocketMessage into the expected schema (see docs/websocket.schema.json).
|
||||
func (m WebSocketMessage) MarshalJSON() (res []byte, err error) {
|
||||
switch m.Type {
|
||||
case WebSocketOutputStdout, WebSocketOutputStderr, WebSocketOutputError:
|
||||
res, err = json.Marshal(struct {
|
||||
MessageType WebSocketMessageType `json:"type"`
|
||||
Data string `json:"data"`
|
||||
}{m.Type, m.Data})
|
||||
case WebSocketMetaStart, WebSocketMetaTimeout:
|
||||
res, err = json.Marshal(struct {
|
||||
MessageType WebSocketMessageType `json:"type"`
|
||||
}{m.Type})
|
||||
case WebSocketExit:
|
||||
res, err = json.Marshal(struct {
|
||||
MessageType WebSocketMessageType `json:"type"`
|
||||
ExitCode uint8 `json:"data"`
|
||||
}{m.Type, m.ExitCode})
|
||||
}
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error marshaling WebSocketMessage: %w", err)
|
||||
} else if res == nil {
|
||||
return nil, ErrUnknownWebSocketMessageType
|
||||
}
|
||||
return res, nil
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements the json.Unmarshaler interface.
|
||||
// It is used by tests in order to ReceiveNextWebSocketMessage.
|
||||
func (m *WebSocketMessage) UnmarshalJSON(rawMessage []byte) error {
|
||||
messageMap := make(map[string]interface{})
|
||||
err := json.Unmarshal(rawMessage, &messageMap)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error unmarshiling raw WebSocket message: %w", err)
|
||||
}
|
||||
messageType, ok := messageMap["type"]
|
||||
if !ok {
|
||||
return ErrMissingType
|
||||
}
|
||||
messageTypeString, ok := messageType.(string)
|
||||
if !ok {
|
||||
return fmt.Errorf("value of key type must be a string: %w", ErrInvalidType)
|
||||
}
|
||||
switch messageType := WebSocketMessageType(messageTypeString); messageType {
|
||||
case WebSocketExit:
|
||||
data, ok := messageMap["data"]
|
||||
if !ok {
|
||||
return ErrMissingData
|
||||
}
|
||||
// json.Unmarshal converts any number to a float64 in the massageMap, so we must first cast it to the float.
|
||||
exit, ok := data.(float64)
|
||||
if !ok {
|
||||
return fmt.Errorf("value of key data must be a number: %w", ErrInvalidType)
|
||||
}
|
||||
if exit != float64(uint8(exit)) {
|
||||
return fmt.Errorf("value of key data must be uint8: %w", ErrInvalidType)
|
||||
}
|
||||
m.Type = messageType
|
||||
m.ExitCode = uint8(exit)
|
||||
case WebSocketOutputStdout, WebSocketOutputStderr, WebSocketOutputError:
|
||||
data, ok := messageMap["data"]
|
||||
if !ok {
|
||||
return ErrMissingData
|
||||
}
|
||||
text, ok := data.(string)
|
||||
if !ok {
|
||||
return fmt.Errorf("value of key data must be a string: %w", ErrInvalidType)
|
||||
}
|
||||
m.Type = messageType
|
||||
m.Data = text
|
||||
case WebSocketMetaStart, WebSocketMetaTimeout:
|
||||
m.Type = messageType
|
||||
default:
|
||||
return ErrUnknownWebSocketMessageType
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ClientError is the response interface if the request is not valid.
|
||||
type ClientError struct {
|
||||
Message string `json:"message"`
|
||||
}
|
||||
|
||||
// InternalServerError is the response interface that is returned when an error occurs.
|
||||
type InternalServerError struct {
|
||||
Message string `json:"message"`
|
||||
ErrorCode ErrorCode `json:"errorCode"`
|
||||
}
|
||||
|
||||
// ErrorCode is the type for error codes expected by CodeOcean.
|
||||
type ErrorCode string
|
||||
|
||||
const (
|
||||
Errork8sUnreachable ErrorCode = "k8s_UNREACHABLE"
|
||||
Errork8sOverload ErrorCode = "k8s_OVERLOAD"
|
||||
Errork8sInternalServerError ErrorCode = "k8s_INTERNAL_SERVER_ERROR"
|
||||
PrewarmingPoolDepleting ErrorCode = "PREWARMING_POOL_DEPLETING"
|
||||
ErrorUnknown ErrorCode = "UNKNOWN"
|
||||
)
|
||||
Reference in New Issue
Block a user