-
Notifications
You must be signed in to change notification settings - Fork 37
/
kurtosis_context.go
557 lines (465 loc) · 22.9 KB
/
kurtosis_context.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
package kurtosis_context
import (
"context"
"fmt"
"github.com/Masterminds/semver/v3"
portal_constructors "github.com/kurtosis-tech/kurtosis-portal/api/golang/constructors"
portal_api "github.com/kurtosis-tech/kurtosis-portal/api/golang/generated"
"github.com/kurtosis-tech/kurtosis/api/golang/core/kurtosis_core_rpc_api_bindings"
"github.com/kurtosis-tech/kurtosis/api/golang/core/lib/enclaves"
"github.com/kurtosis-tech/kurtosis/api/golang/core/lib/services"
"github.com/kurtosis-tech/kurtosis/api/golang/engine/kurtosis_engine_rpc_api_bindings"
"github.com/kurtosis-tech/kurtosis/api/golang/kurtosis_version"
"github.com/kurtosis-tech/kurtosis/contexts-config-store/store"
"github.com/kurtosis-tech/stacktrace"
"github.com/sirupsen/logrus"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/known/emptypb"
"io"
)
const (
// NOTE: This needs to be 127.0.0.1 rather than 0.0.0.0, because Windows machines don't translate 0.0.0.0 -> 127.0.0.1
localHostIPAddressStr = "127.0.0.1"
DefaultGrpcEngineServerPortNum = uint16(9710)
DefaultGrpcProxyEngineServerPortNum = uint16(9711)
// Blank tells the engine server to use the default
defaultApiContainerVersionTag = ""
serviceLogsStreamContentChanBufferSize = 5
grpcStreamCancelContextErrorMessage = "rpc error: code = Canceled desc = context canceled"
validUuidMatchesAllowed = 1
)
var (
apiContainerLogLevel = logrus.DebugLevel
apicPortTransportProtocol = portal_api.TransportProtocol_TCP
)
// Docs available at https://docs.kurtosis.com/sdk#kurtosiscontext
type KurtosisContext struct {
engineClient kurtosis_engine_rpc_api_bindings.EngineServiceClient
portalClient portal_api.KurtosisPortalClientClient
}
// NewKurtosisContextFromLocalEngine
// Attempts to create a KurtosisContext connected to a Kurtosis engine running locally
func NewKurtosisContextFromLocalEngine() (*KurtosisContext, error) {
ctx := context.Background()
kurtosisEngineSocketStr := fmt.Sprintf("%v:%v", localHostIPAddressStr, DefaultGrpcEngineServerPortNum)
// TODO SECURITY: Use HTTPS to ensure we're connecting to the real Kurtosis API servers
conn, err := grpc.Dial(kurtosisEngineSocketStr, grpc.WithInsecure())
if err != nil {
return nil, stacktrace.Propagate(
err,
"An error occurred creating a connection to the Kurtosis Engine Server at '%v'",
kurtosisEngineSocketStr,
)
}
engineServiceClient := kurtosis_engine_rpc_api_bindings.NewEngineServiceClient(conn)
if err = validateEngineApiVersion(ctx, engineServiceClient); err != nil {
return nil, stacktrace.Propagate(err, "An error occurred validating the Kurtosis engine API version")
}
// TODO: Here we're checking whether the context is local or remote to connect to the daemon. This is because
// the daemon will not immediately run on all Kurtosis users' laptop. Once that's the case, we can remove this if
// and systematically connect to the locally running Kurtosis portal daemon.
currentContext, err := store.GetContextsConfigStore().GetCurrentContext()
if err != nil {
return nil, stacktrace.Propagate(err, "Error retrieving current context")
}
portalClient, err := CreatePortalDaemonClient(currentContext, true)
if err != nil {
return nil, stacktrace.Propagate(err, "Error building client for Kurtosis Portal daemon")
}
kurtosisContext := &KurtosisContext{
engineClient: engineServiceClient,
portalClient: portalClient,
}
return kurtosisContext, nil
}
// Docs available at https://docs.kurtosis.com/sdk#createenclaveenclaveid-enclaveid-boolean-ispartitioningenabled---enclavecontextenclavecontext-enclavecontext
func (kurtosisCtx *KurtosisContext) CreateEnclave(
ctx context.Context,
enclaveName string,
isPartitioningEnabled bool,
) (*enclaves.EnclaveContext, error) {
createEnclaveArgs := &kurtosis_engine_rpc_api_bindings.CreateEnclaveArgs{
EnclaveName: enclaveName,
ApiContainerVersionTag: defaultApiContainerVersionTag,
ApiContainerLogLevel: apiContainerLogLevel.String(),
IsPartitioningEnabled: isPartitioningEnabled,
}
response, err := kurtosisCtx.engineClient.CreateEnclave(ctx, createEnclaveArgs)
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred creating an enclave with name '%v'", enclaveName)
}
enclaveContext, err := newEnclaveContextFromEnclaveInfo(ctx, kurtosisCtx.portalClient, response.EnclaveInfo)
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred creating an enclave context from a newly-created enclave; this should never happen")
}
return enclaveContext, nil
}
// Docs available at https://docs.kurtosis.com/sdk/#getenclavecontextstring-enclaveidentifier---enclavecontextenclavecontext-enclavecontext
func (kurtosisCtx *KurtosisContext) GetEnclaveContext(ctx context.Context, enclaveIdentifier string) (*enclaves.EnclaveContext, error) {
enclaveInfo, err := kurtosisCtx.GetEnclave(ctx, enclaveIdentifier)
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred while getting enclave with identifier '%v'", enclaveIdentifier)
}
enclaveCtx, err := newEnclaveContextFromEnclaveInfo(ctx, kurtosisCtx.portalClient, enclaveInfo)
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred creating an enclave context from the returned enclave info")
}
return enclaveCtx, nil
}
// Docs available at https://docs.kurtosis.com/sdk#getenclaves---enclaves-enclaves
func (kurtosisCtx *KurtosisContext) GetEnclaves(ctx context.Context) (*Enclaves, error) {
response, err := kurtosisCtx.engineClient.GetEnclaves(ctx, &emptypb.Empty{})
if err != nil {
return nil, stacktrace.Propagate(
err,
"An error occurred getting enclaves",
)
}
enclavesByUuid := map[string]*kurtosis_engine_rpc_api_bindings.EnclaveInfo{}
enclavesByName := map[string][]*kurtosis_engine_rpc_api_bindings.EnclaveInfo{}
enclavesByShortenedUuid := map[string][]*kurtosis_engine_rpc_api_bindings.EnclaveInfo{}
for enclaveUuid, enclaveInfo := range response.EnclaveInfo {
enclavesByUuid[enclaveUuid] = response.EnclaveInfo[enclaveUuid]
enclavesByName[enclaveInfo.Name] = append(enclavesByShortenedUuid[enclaveInfo.GetName()], response.EnclaveInfo[enclaveUuid])
enclavesByShortenedUuid[enclaveInfo.ShortenedUuid] = append(enclavesByShortenedUuid[enclaveInfo.ShortenedUuid], response.EnclaveInfo[enclaveUuid])
}
return &Enclaves{
enclavesByUuid: enclavesByUuid,
enclavesByName: enclavesByName,
enclavesByShortenedUuid: enclavesByShortenedUuid,
}, nil
}
// Docs available at https://docs.kurtosis.com/sdk/#getenclavestring-enclaveidentifier---enclaveinfo-enclaveinfo
func (kurtosisCtx *KurtosisContext) GetEnclave(ctx context.Context, enclaveIdentifier string) (*kurtosis_engine_rpc_api_bindings.EnclaveInfo, error) {
enclaves, err := kurtosisCtx.GetEnclaves(ctx)
if err != nil {
return nil, stacktrace.Propagate(
err,
"An error occurred getting enclave for identifier '%v'",
enclaveIdentifier,
)
}
if enclaveInfo, found := enclaves.enclavesByUuid[enclaveIdentifier]; found {
return enclaveInfo, nil
}
if enclaveInfos, found := enclaves.enclavesByShortenedUuid[enclaveIdentifier]; found {
if len(enclaveInfos) == validUuidMatchesAllowed {
return enclaveInfos[0], nil
} else if len(enclaveInfos) > validUuidMatchesAllowed {
return nil, stacktrace.NewError("Found multiple enclaves '%v' matching shortened uuid '%v'. Please use a uuid to be more specific", enclaveInfos, enclaveIdentifier)
}
}
if enclaveInfos, found := enclaves.enclavesByName[enclaveIdentifier]; found {
if len(enclaveInfos) == validUuidMatchesAllowed {
return enclaveInfos[0], nil
} else if len(enclaveInfos) > validUuidMatchesAllowed {
return nil, stacktrace.NewError("Found multiple enclaves '%v' matching name '%v'. Please use a uuid to be more specific", enclaveInfos, enclaveIdentifier)
}
}
return nil, stacktrace.NewError("Couldn't find an enclave for identifier '%v'", enclaveIdentifier)
}
// Docs available at https://docs.kurtosis.com/sdk/#stopenclavestring-enclaveidentifier
func (kurtosisCtx *KurtosisContext) StopEnclave(ctx context.Context, enclaveIdentifier string) error {
stopEnclaveArgs := &kurtosis_engine_rpc_api_bindings.StopEnclaveArgs{
EnclaveIdentifier: enclaveIdentifier,
}
if _, err := kurtosisCtx.engineClient.StopEnclave(ctx, stopEnclaveArgs); err != nil {
return stacktrace.Propagate(err, "An error occurred stopping enclave with identifier '%v'", enclaveIdentifier)
}
return nil
}
// Docs available at https://docs.kurtosis.com/sdk/#destroyenclavestring-enclaveidentifier
func (kurtosisCtx *KurtosisContext) DestroyEnclave(ctx context.Context, enclaveIdentifier string) error {
destroyEnclaveArgs := &kurtosis_engine_rpc_api_bindings.DestroyEnclaveArgs{
EnclaveIdentifier: enclaveIdentifier,
}
if _, err := kurtosisCtx.engineClient.DestroyEnclave(ctx, destroyEnclaveArgs); err != nil {
return stacktrace.Propagate(err, "An error occurred destroying enclave with identifier '%v'", enclaveIdentifier)
}
return nil
}
// Docs available at https://docs.kurtosis.com/sdk#cleanboolean-shouldcleanall---enclavenameanduuid-removedenclavenameanduuids
func (kurtosisCtx *KurtosisContext) Clean(ctx context.Context, shouldCleanAll bool) ([]*kurtosis_engine_rpc_api_bindings.EnclaveNameAndUuid, error) {
cleanArgs := &kurtosis_engine_rpc_api_bindings.CleanArgs{
ShouldCleanAll: shouldCleanAll,
}
cleanResponse, err := kurtosisCtx.engineClient.Clean(ctx, cleanArgs)
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred when trying to perform a clean with the clean-all arg set to '%v'", shouldCleanAll)
}
return cleanResponse.RemovedEnclaveNameAndUuids, nil
}
// Docs available at https://docs.kurtosis.com/sdk#getservicelogsstring-enclaveidentifier-setserviceuuid-serviceuuids-boolean-shouldfollowlogs-loglinefilter-loglinefilter---servicelogsstreamcontent-servicelogsstreamcontent
func (kurtosisCtx *KurtosisContext) GetServiceLogs(
ctx context.Context,
enclaveIdentifier string,
userServiceUuids map[services.ServiceUUID]bool,
shouldFollowLogs bool,
logLineFilter *LogLineFilter,
) (
chan *serviceLogsStreamContent,
func(),
error,
) {
ctxWithCancel, cancelCtxFunc := context.WithCancel(ctx)
shouldCancelCtx := true
defer func() {
if shouldCancelCtx {
cancelCtxFunc()
}
}()
//this is a buffer channel for the case that users could be consuming this channel in a process and
//this process could take much time until the next channel pull, so we could be filling the buffer during that time to not let the servers thread idled
serviceLogsStreamContentChan := make(chan *serviceLogsStreamContent, serviceLogsStreamContentChanBufferSize)
getServiceLogsArgs, err := newGetServiceLogsArgs(enclaveIdentifier, userServiceUuids, shouldFollowLogs, logLineFilter)
if err != nil {
return nil, nil, stacktrace.Propagate(
err,
"An error occurred creating the service logs arguments with enclave identifier '%v', user service UUID '%+v', should follow logs value '%v' and with these conjunctive log line filters '%+v'",
enclaveIdentifier,
userServiceUuids,
shouldFollowLogs,
logLineFilter,
)
}
stream, err := kurtosisCtx.engineClient.GetServiceLogs(ctxWithCancel, getServiceLogsArgs)
if err != nil {
return nil, nil, stacktrace.Propagate(err, "An error occurred streaming service logs using args '%+v'", getServiceLogsArgs)
}
go runReceiveStreamLogsFromTheServerRoutine(
cancelCtxFunc,
enclaveIdentifier,
userServiceUuids,
serviceLogsStreamContentChan,
stream,
)
//This is an async operation, so we don't want to cancel the context if the connection is established and data is flowing
shouldCancelCtx = false
return serviceLogsStreamContentChan, cancelCtxFunc, nil
}
// Docs available at https://docs.kurtosis.com/sdk#getexistingandhistoricalenclaveidentifiers---enclaveidentifiers-enclaveidentifiers
func (kurtosisCtx *KurtosisContext) GetExistingAndHistoricalEnclaveIdentifiers(ctx context.Context) (*EnclaveIdentifiers, error) {
historicalEnclaveIdentifiers, err := kurtosisCtx.engineClient.GetExistingAndHistoricalEnclaveIdentifiers(ctx, &emptypb.Empty{})
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred while fetching existing and historical enclave identifiers")
}
return newEnclaveIdentifiers(historicalEnclaveIdentifiers.AllIdentifiers), nil
}
// ====================================================================================================
//
// Private helper methods
//
// ====================================================================================================
func runReceiveStreamLogsFromTheServerRoutine(
cancelCtxFunc context.CancelFunc,
enclaveIdentifier string,
requestedServiceUuids map[services.ServiceUUID]bool,
serviceLogsStreamContentChan chan *serviceLogsStreamContent,
stream kurtosis_engine_rpc_api_bindings.EngineService_GetServiceLogsClient,
) {
//Closing all the open resources at the end
defer func() {
cancelCtxFunc()
close(serviceLogsStreamContentChan)
}()
for {
//this is a blocking call, and the only way to unblock it from our side is to cancel the context that it was created with
getServiceLogsResponse, errReceivingStream := stream.Recv()
//stream ends case
if errReceivingStream == io.EOF {
logrus.Debug("Received an 'EOF' error from the user service logs GRPC stream")
return
}
if errReceivingStream != nil {
//context canceled case
if errReceivingStream.Error() == grpcStreamCancelContextErrorMessage {
logrus.Debug("Received a 'context canceled' error from the user service logs GRPC stream")
return
}
//error during stream case
logrus.Errorf("An error occurred receiving user service logs stream for user services '%+v' in enclave '%v'. Error:\n%v", requestedServiceUuids, enclaveIdentifier, errReceivingStream)
return
}
serviceLogsStreamContentObj := newServiceLogsStreamContentFromGrpcStreamResponse(requestedServiceUuids, getServiceLogsResponse)
serviceLogsStreamContentChan <- serviceLogsStreamContentObj
}
}
func newEnclaveContextFromEnclaveInfo(
ctx context.Context,
portalClient portal_api.KurtosisPortalClientClient,
enclaveInfo *kurtosis_engine_rpc_api_bindings.EnclaveInfo,
) (*enclaves.EnclaveContext, error) {
// for remote contexts, we need to tunnel the APIC port to the local machine
if portalClient != nil {
apicGrpcPort := enclaveInfo.GetApiContainerHostMachineInfo().GetGrpcPortOnHostMachine()
forwardApicPortArgs := portal_constructors.NewForwardPortArgs(apicGrpcPort, apicGrpcPort, &apicPortTransportProtocol)
if _, err := portalClient.ForwardPort(ctx, forwardApicPortArgs); err != nil {
return nil, stacktrace.Propagate(err, "Unable to forward remote API container port to the local machine")
}
apicGrpcProxyPort := enclaveInfo.GetApiContainerHostMachineInfo().GetGrpcProxyPortOnHostMachine()
forwardApicProxyPortArgs := portal_constructors.NewForwardPortArgs(apicGrpcProxyPort, apicGrpcProxyPort, &apicPortTransportProtocol)
if _, err := portalClient.ForwardPort(ctx, forwardApicProxyPortArgs); err != nil {
return nil, stacktrace.Propagate(err, "Unable to forward remote API container proxy port to the local machine")
}
}
enclaveContainersStatus := enclaveInfo.GetContainersStatus()
if enclaveContainersStatus != kurtosis_engine_rpc_api_bindings.EnclaveContainersStatus_EnclaveContainersStatus_RUNNING {
return nil, stacktrace.NewError(
"Enclave containers status was '%v', but we can't create an enclave context from a non-running enclave",
enclaveContainersStatus,
)
}
enclaveApiContainerStatus := enclaveInfo.GetApiContainerStatus()
if enclaveApiContainerStatus != kurtosis_engine_rpc_api_bindings.EnclaveAPIContainerStatus_EnclaveAPIContainerStatus_RUNNING {
return nil, stacktrace.NewError(
"Enclave API container status was '%v', but we can't create an enclave context without a running API container",
enclaveApiContainerStatus,
)
}
apiContainerInfo := enclaveInfo.GetApiContainerInfo()
if apiContainerInfo == nil {
return nil, stacktrace.NewError("API container was listed as running, but no API container info exists")
}
apiContainerHostMachineInfo := enclaveInfo.GetApiContainerHostMachineInfo()
if apiContainerHostMachineInfo == nil {
return nil, stacktrace.NewError("API container was listed as running, but no API container host machine info exists")
}
apiContainerHostMachineUrl := fmt.Sprintf(
"%v:%v",
apiContainerHostMachineInfo.IpOnHostMachine,
apiContainerHostMachineInfo.GrpcPortOnHostMachine,
)
// TODO SECURITY: use HTTPS!
apiContainerConn, err := grpc.Dial(apiContainerHostMachineUrl, grpc.WithInsecure())
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred connecting to the API container on host machine URL '%v'", apiContainerHostMachineUrl)
}
apiContainerClient := kurtosis_core_rpc_api_bindings.NewApiContainerServiceClient(apiContainerConn)
result := enclaves.NewEnclaveContext(
apiContainerClient,
enclaves.EnclaveUUID(enclaveInfo.EnclaveUuid),
enclaveInfo.GetName(),
)
return result, nil
}
func validateEngineApiVersion(ctx context.Context, engineServiceClient kurtosis_engine_rpc_api_bindings.EngineServiceClient) error {
getEngineInfoResponse, err := engineServiceClient.GetEngineInfo(ctx, &emptypb.Empty{})
if err != nil {
errorStr := "An error occurred getting engine info"
grpcErrorCode := status.Code(err)
if grpcErrorCode == codes.Unavailable {
errorStr = "The Kurtosis Engine Server is unavailable and is probably not running; you will need to start it using the Kurtosis CLI before you can create a connection to it"
}
return stacktrace.Propagate(err, errorStr)
}
runningEngineVersionStr := getEngineInfoResponse.GetEngineVersion()
runningEngineSemver, err := semver.StrictNewVersion(runningEngineVersionStr)
if err != nil {
logrus.Warnf("We expected the running engine version to match format X.Y.Z, but instead got '%v'; "+
"this means that we can't verify the API library and engine versions match so you may encounter runtime errors", runningEngineVersionStr)
return nil
}
libraryEngineSemver, err := semver.StrictNewVersion(kurtosis_version.KurtosisVersion)
if err != nil {
logrus.Warnf("We expected the API library version to match format X.Y.Z, but instead got '%v'; "+
"this means that we can't verify the API library and engine versions match so you may encounter runtime errors", kurtosis_version.KurtosisVersion)
return nil
}
runningEngineMajorVersion := runningEngineSemver.Major()
runningEngineMinorVersion := runningEngineSemver.Minor()
libraryEngineMajorVersion := libraryEngineSemver.Major()
libraryEngineMinorVersion := libraryEngineSemver.Minor()
doApiVersionsMatch := libraryEngineMajorVersion == runningEngineMajorVersion && libraryEngineMinorVersion == runningEngineMinorVersion
if !doApiVersionsMatch {
return stacktrace.NewError(
"An API version mismatch was detected between the running engine version '%v' and the engine version this Kurtosis SDK library expects, '%v'. You should:\n"+
" 1) upgrade your Kurtosis CLI to latest using the instructions at https://docs.kurtosis.com/install#upgrading\n"+
" 2) use the Kurtosis CLI to restart your engine via 'kurtosis engine restart'\n"+
" 3) upgrade your Kurtosis SDK library using the instructions at https://github.com/kurtosis-tech/kurtosis-engine-api-lib\n",
runningEngineSemver.String(),
libraryEngineSemver.String(),
)
}
return nil
}
func newGetServiceLogsArgs(
enclaveIdentifier string,
userServiceUUIDs map[services.ServiceUUID]bool,
shouldFollowLogs bool,
logLineFilter *LogLineFilter,
) (*kurtosis_engine_rpc_api_bindings.GetServiceLogsArgs, error) {
userServiceUuuidSet := make(map[string]bool, len(userServiceUUIDs))
for userServiceUUID, isUserServiceInSet := range userServiceUUIDs {
userServiceUUIDStr := string(userServiceUUID)
userServiceUuuidSet[userServiceUUIDStr] = isUserServiceInSet
}
grpcConjunctiveFilters, err := newGRPCConjunctiveFilters(logLineFilter)
if err != nil {
return nil, stacktrace.Propagate(err, "An error occurred creating the GRPC conjunctive log line filters '%+v'", logLineFilter)
}
getUserServiceLogsArgs := &kurtosis_engine_rpc_api_bindings.GetServiceLogsArgs{
EnclaveIdentifier: enclaveIdentifier,
ServiceUuidSet: userServiceUuuidSet,
FollowLogs: shouldFollowLogs,
ConjunctiveFilters: grpcConjunctiveFilters,
}
return getUserServiceLogsArgs, nil
}
// Even though the backend is prepared for receiving a list of conjunctive filters
// We allow users to send only one filter so far, because it covers the current supported use cases
func newGRPCConjunctiveFilters(
logLineFilter *LogLineFilter,
) ([]*kurtosis_engine_rpc_api_bindings.LogLineFilter, error) {
grpcLogLineFilters := []*kurtosis_engine_rpc_api_bindings.LogLineFilter{}
if logLineFilter == nil {
return grpcLogLineFilters, nil
}
var grpcOperator kurtosis_engine_rpc_api_bindings.LogLineOperator
switch logLineFilter.operator {
case logLineOperator_DoesContainText:
grpcOperator = kurtosis_engine_rpc_api_bindings.LogLineOperator_LogLineOperator_DOES_CONTAIN_TEXT
case logLineOperator_DoesNotContainText:
grpcOperator = kurtosis_engine_rpc_api_bindings.LogLineOperator_LogLineOperator_DOES_NOT_CONTAIN_TEXT
case logLineOperator_DoesContainMatchRegex:
grpcOperator = kurtosis_engine_rpc_api_bindings.LogLineOperator_LogLineOperator_DOES_CONTAIN_MATCH_REGEX
case logLineOperator_DoesNotContainMatchRegex:
grpcOperator = kurtosis_engine_rpc_api_bindings.LogLineOperator_LogLineOperator_DOES_NOT_CONTAIN_MATCH_REGEX
default:
return nil, stacktrace.NewError("Unrecognized log line filter operator '%v' in filter '%v'; this is a bug in Kurtosis", logLineFilter.operator, logLineFilter)
}
grpcLogLineFilter := &kurtosis_engine_rpc_api_bindings.LogLineFilter{
TextPattern: logLineFilter.textPattern,
Operator: grpcOperator,
}
grpcLogLineFilters = append(grpcLogLineFilters, grpcLogLineFilter)
return grpcLogLineFilters, nil
}
func newServiceLogsStreamContentFromGrpcStreamResponse(
requestedServiceUuids map[services.ServiceUUID]bool,
getServiceLogResponse *kurtosis_engine_rpc_api_bindings.GetServiceLogsResponse,
) *serviceLogsStreamContent {
serviceLogsByServiceUuidMap := map[services.ServiceUUID][]*ServiceLog{}
receivedServiceLogsByServiceUuid := getServiceLogResponse.GetServiceLogsByServiceUuid()
for serviceUuid := range requestedServiceUuids {
serviceUuidStr := string(serviceUuid)
serviceLogs := []*ServiceLog{}
serviceLogLine, found := receivedServiceLogsByServiceUuid[serviceUuidStr]
if found {
for _, logLineContent := range serviceLogLine.Line {
serviceLog := newServiceLog(logLineContent)
serviceLogs = append(serviceLogs, serviceLog)
}
}
serviceLogsByServiceUuidMap[serviceUuid] = serviceLogs
}
notFoundServiceUuidSet := getServiceLogResponse.NotFoundServiceUuidSet
notFoundServiceUuids := make(map[services.ServiceUUID]bool, len(notFoundServiceUuidSet))
for notFoundServiceUuidStr := range notFoundServiceUuidSet {
notFoundServiceUuid := services.ServiceUUID(notFoundServiceUuidStr)
notFoundServiceUuids[notFoundServiceUuid] = true
}
newServiceLogsStreamContentObj := newServiceLogsStreamContent(serviceLogsByServiceUuidMap, notFoundServiceUuids)
return newServiceLogsStreamContentObj
}