/
request.go
218 lines (191 loc) · 9.22 KB
/
request.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
package request
import (
"context"
"fmt"
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface/objects/service"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/service_network"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/enclave_plan_persistence"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/enclave_structure"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/kurtosis_starlark_framework"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/kurtosis_starlark_framework/builtin_argument"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/kurtosis_starlark_framework/kurtosis_plan_instruction"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/kurtosis_types"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/recipe"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/runtime_value_store"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/startosis_errors"
"github.com/kurtosis-tech/kurtosis/core/server/api_container/server/startosis_engine/startosis_validator"
"github.com/kurtosis-tech/stacktrace"
"go.starlark.net/starlark"
"net/http"
)
var defaultAcceptableCodes = []int64{
http.StatusOK,
http.StatusCreated,
http.StatusAccepted,
http.StatusNonAuthoritativeInfo,
http.StatusNoContent,
http.StatusResetContent,
http.StatusPartialContent,
http.StatusMultiStatus,
http.StatusAlreadyReported,
http.StatusIMUsed,
}
const (
defaultSkipCodeCheck = false
)
const (
RequestBuiltinName = "request"
RecipeArgName = "recipe"
ServiceNameArgName = "service_name"
AcceptableCodesArgName = "acceptable_codes"
SkipCodeCheckArgName = "skip_code_check"
)
func NewRequest(serviceNetwork service_network.ServiceNetwork, runtimeValueStore *runtime_value_store.RuntimeValueStore) *kurtosis_plan_instruction.KurtosisPlanInstruction {
return &kurtosis_plan_instruction.KurtosisPlanInstruction{
KurtosisBaseBuiltin: &kurtosis_starlark_framework.KurtosisBaseBuiltin{
Name: RequestBuiltinName,
Arguments: []*builtin_argument.BuiltinArgument{
{
Name: ServiceNameArgName,
IsOptional: false,
ZeroValueProvider: builtin_argument.ZeroValueProvider[starlark.String],
Validator: func(value starlark.Value) *startosis_errors.InterpretationError {
return builtin_argument.NonEmptyString(value, ServiceNameArgName)
},
},
{
Name: RecipeArgName,
IsOptional: false,
ZeroValueProvider: builtin_argument.ZeroValueProvider[recipe.HttpRequestRecipe],
Validator: nil,
},
{
Name: AcceptableCodesArgName,
IsOptional: true,
ZeroValueProvider: builtin_argument.ZeroValueProvider[*starlark.List],
Validator: nil,
},
{
Name: SkipCodeCheckArgName,
IsOptional: true,
ZeroValueProvider: builtin_argument.ZeroValueProvider[starlark.Bool],
Validator: nil,
},
},
},
Capabilities: func() kurtosis_plan_instruction.KurtosisPlanInstructionCapabilities {
return &RequestCapabilities{
serviceNetwork: serviceNetwork,
runtimeValueStore: runtimeValueStore,
serviceName: "", // populated at interpretation time
httpRequestRecipe: nil, // populated at interpretation time
resultUuid: "", // populated at interpretation time
acceptableCodes: nil, // populated at interpretation time
skipCodeCheck: false, // populated at interpretation time
}
},
DefaultDisplayArguments: map[string]bool{
RecipeArgName: true,
},
}
}
type RequestCapabilities struct {
serviceNetwork service_network.ServiceNetwork
runtimeValueStore *runtime_value_store.RuntimeValueStore
serviceName service.ServiceName
httpRequestRecipe recipe.HttpRequestRecipe
resultUuid string
acceptableCodes []int64
skipCodeCheck bool
}
func (builtin *RequestCapabilities) Interpret(_ string, arguments *builtin_argument.ArgumentValuesSet) (starlark.Value, *startosis_errors.InterpretationError) {
serviceNameArgumentValue, err := builtin_argument.ExtractArgumentValue[starlark.String](arguments, ServiceNameArgName)
if err != nil {
return nil, startosis_errors.WrapWithInterpretationError(err, "Unable to extract value for '%s' argument", ServiceNameArgName)
}
serviceName := service.ServiceName(serviceNameArgumentValue.GoString())
httpRequestRecipe, err := builtin_argument.ExtractArgumentValue[recipe.HttpRequestRecipe](arguments, RecipeArgName)
if err != nil {
return nil, startosis_errors.WrapWithInterpretationError(err, "Unable to extract value for '%s' argument", RecipeArgName)
}
acceptableCodes := defaultAcceptableCodes
if arguments.IsSet(AcceptableCodesArgName) {
acceptableCodesValue, err := builtin_argument.ExtractArgumentValue[*starlark.List](arguments, AcceptableCodesArgName)
if err != nil {
return nil, startosis_errors.WrapWithInterpretationError(err, "Unable to extract value for '%v' argument", acceptableCodes)
}
acceptableCodes, err = kurtosis_types.SafeCastToIntegerSlice(acceptableCodesValue)
if err != nil {
return nil, startosis_errors.WrapWithInterpretationError(err, "Unable to parse '%v' argument", acceptableCodes)
}
}
skipCodeCheck := defaultSkipCodeCheck
if arguments.IsSet(SkipCodeCheckArgName) {
skipCodeCheckArgumentValue, err := builtin_argument.ExtractArgumentValue[starlark.Bool](arguments, SkipCodeCheckArgName)
if err != nil {
return nil, startosis_errors.WrapWithInterpretationError(err, "Unable to extract value for '%s' argument", SkipCodeCheckArgName)
}
skipCodeCheck = bool(skipCodeCheckArgumentValue)
}
resultUuid, err := builtin.runtimeValueStore.CreateValue()
if err != nil {
return nil, startosis_errors.NewInterpretationError("An error occurred while generating UUID for future reference for %v instruction", RequestBuiltinName)
}
builtin.serviceName = serviceName
builtin.httpRequestRecipe = httpRequestRecipe
builtin.resultUuid = resultUuid
builtin.acceptableCodes = acceptableCodes
builtin.skipCodeCheck = skipCodeCheck
returnValue, interpretationErr := builtin.httpRequestRecipe.CreateStarlarkReturnValue(builtin.resultUuid)
if interpretationErr != nil {
return nil, startosis_errors.NewInterpretationError("An error occurred while creating return value for %v instruction", RequestBuiltinName)
}
return returnValue, nil
}
func (builtin *RequestCapabilities) Validate(_ *builtin_argument.ArgumentValuesSet, validatorEnvironment *startosis_validator.ValidatorEnvironment) *startosis_errors.ValidationError {
if validatorEnvironment.DoesServiceNameExist(builtin.serviceName) == startosis_validator.ComponentNotFound {
return startosis_errors.NewValidationError("Tried creating a request for service '%s' which doesn't exist", builtin.serviceName)
}
if validationErr := recipe.ValidateHttpRequestRecipe(builtin.httpRequestRecipe, builtin.serviceName, validatorEnvironment); validationErr != nil {
return validationErr
}
return nil
}
func (builtin *RequestCapabilities) Execute(ctx context.Context, _ *builtin_argument.ArgumentValuesSet) (string, error) {
result, err := builtin.httpRequestRecipe.Execute(ctx, builtin.serviceNetwork, builtin.runtimeValueStore, builtin.serviceName)
if err != nil {
return "", stacktrace.Propagate(err, "Error executing http recipe")
}
if !builtin.skipCodeCheck && !builtin.isAcceptableCode(result) {
return "", stacktrace.NewError("Request returned status code '%v' that is not part of the acceptable status codes '%v'", result["code"], builtin.acceptableCodes)
}
if err := builtin.runtimeValueStore.SetValue(builtin.resultUuid, result); err != nil {
return "", stacktrace.Propagate(err, "An error occurred setting value '%+v' using key UUID '%s' in the runtime value store", result, builtin.resultUuid)
}
instructionResult := builtin.httpRequestRecipe.ResultMapToString(result)
return instructionResult, err
}
func (builtin *RequestCapabilities) TryResolveWith(instructionsAreEqual bool, _ *enclave_plan_persistence.EnclavePlanInstruction, enclaveComponents *enclave_structure.EnclaveComponents) enclave_structure.InstructionResolutionStatus {
if instructionsAreEqual && enclaveComponents.HasServiceBeenUpdated(builtin.serviceName) {
return enclave_structure.InstructionIsUpdate
} else if instructionsAreEqual {
return enclave_structure.InstructionIsEqual
}
return enclave_structure.InstructionIsUnknown
}
func (builtin *RequestCapabilities) FillPersistableAttributes(builder *enclave_plan_persistence.EnclavePlanInstructionBuilder) {
builder.SetType(RequestBuiltinName)
}
func (builtin *RequestCapabilities) Description() string {
return fmt.Sprintf("Running '%v' request on service '%v'", builtin.httpRequestRecipe.RequestType(), builtin.serviceName)
}
func (builtin *RequestCapabilities) isAcceptableCode(recipeResult map[string]starlark.Comparable) bool {
isAcceptableCode := false
for _, acceptableCode := range builtin.acceptableCodes {
if recipeResult["code"] == starlark.MakeInt64(acceptableCode) {
isAcceptableCode = true
break
}
}
return isAcceptableCode
}