-
Notifications
You must be signed in to change notification settings - Fork 40
/
inspect.go
189 lines (159 loc) · 6.96 KB
/
inspect.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
/*
* Copyright (c) 2021 - present Kurtosis Technologies Inc.
* All Rights Reserved.
*/
package inspect
import (
"context"
"fmt"
"github.com/kurtosis-tech/kurtosis/api/golang/engine/kurtosis_engine_rpc_api_bindings"
"github.com/kurtosis-tech/kurtosis/api/golang/engine/lib/kurtosis_context"
"github.com/kurtosis-tech/kurtosis/cli/cli/command_framework/highlevel/enclave_id_arg"
"github.com/kurtosis-tech/kurtosis/cli/cli/command_framework/highlevel/engine_consuming_kurtosis_command"
"github.com/kurtosis-tech/kurtosis/cli/cli/command_framework/lowlevel/args"
"github.com/kurtosis-tech/kurtosis/cli/cli/command_framework/lowlevel/flags"
"github.com/kurtosis-tech/kurtosis/cli/cli/command_str_consts"
"github.com/kurtosis-tech/kurtosis/cli/cli/helpers/enclave_status_stringifier"
"github.com/kurtosis-tech/kurtosis/cli/cli/helpers/output_printers"
"github.com/kurtosis-tech/kurtosis/cli/cli/out"
"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface"
metrics_client "github.com/kurtosis-tech/metrics-library/golang/lib/client"
"github.com/kurtosis-tech/stacktrace"
"github.com/sirupsen/logrus"
"sort"
"strings"
"time"
"unicode/utf8"
)
const (
enclaveIdentifierArgKey = "enclave"
isEnclaveIdArgOptional = false
isEnclaveIdArgGreedy = false
enclaveUUIDTitleName = "UUID"
enclaveNameTitleName = "Name"
enclaveStatusTitleName = "Status"
enclaveCreationTimeTitleName = "Creation Time"
fullUuidsFlagKey = "full-uuids"
fullUuidFlagKeyDefault = "false"
headerWidthChars = 100
headerPadChar = "="
kurtosisBackendCtxKey = "kurtosis-backend"
engineClientCtxKey = "engine-client"
filesArtifactsHeader = "Files Artifacts"
)
var enclaveObjectPrintingFuncs = map[string]func(ctx context.Context, kurtosisCtx *kurtosis_context.KurtosisContext, kurtosisBackend backend_interface.KurtosisBackend, enclaveInfo *kurtosis_engine_rpc_api_bindings.EnclaveInfo, showFullUuid bool, isAPIContainerRunning bool) error{
"User Services": printUserServices,
filesArtifactsHeader: printFilesArtifacts,
}
var EnclaveInspectCmd = &engine_consuming_kurtosis_command.EngineConsumingKurtosisCommand{
CommandStr: command_str_consts.EnclaveInspectCmdStr,
ShortDescription: "Inspect an enclave",
LongDescription: "List information about the enclave's status and contents",
KurtosisBackendContextKey: kurtosisBackendCtxKey,
EngineClientContextKey: engineClientCtxKey,
Flags: []*flags.FlagConfig{
{
Key: fullUuidsFlagKey,
Usage: "If true then Kurtosis prints full UUIDs instead of shortened UUIDs. Default false.",
Type: flags.FlagType_Bool,
Default: fullUuidFlagKeyDefault,
},
},
Args: []*args.ArgConfig{
enclave_id_arg.NewEnclaveIdentifierArg(
enclaveIdentifierArgKey,
engineClientCtxKey,
isEnclaveIdArgOptional,
isEnclaveIdArgGreedy,
),
},
RunFunc: run,
}
func run(
ctx context.Context,
kurtosisBackend backend_interface.KurtosisBackend,
_ kurtosis_engine_rpc_api_bindings.EngineServiceClient,
_ metrics_client.MetricsClient,
flags *flags.ParsedFlags,
args *args.ParsedArgs,
) error {
enclaveIdentifier, err := args.GetNonGreedyArg(enclaveIdentifierArgKey)
if err != nil {
return stacktrace.Propagate(err, "Expected a value for non-greedy enclave identifier arg '%v' but none was found; this is a bug in the Kurtosis CLI!", enclaveIdentifierArgKey)
}
showFullUuids, err := flags.GetBool(fullUuidsFlagKey)
if err != nil {
return stacktrace.Propagate(err, "Expected a value for the '%v' flag but failed to get it", fullUuidsFlagKey)
}
kurtosisCtx, err := kurtosis_context.NewKurtosisContextFromLocalEngine()
if err != nil {
return stacktrace.Propagate(err, "An error occurred creating Kurtosis Context from local engine")
}
if err = PrintEnclaveInspect(ctx, kurtosisBackend, kurtosisCtx, enclaveIdentifier, showFullUuids); err != nil {
// this is already wrapped up
return err
}
return nil
}
func PrintEnclaveInspect(ctx context.Context, kurtosisBackend backend_interface.KurtosisBackend, kurtosisCtx *kurtosis_context.KurtosisContext, enclaveIdentifier string, showFullUuids bool) error {
enclaveInfo, err := kurtosisCtx.GetEnclave(ctx, enclaveIdentifier)
if err != nil {
return stacktrace.Propagate(err, "An error occurred getting the enclave for identifier '%v'", enclaveIdentifier)
}
enclaveContainersStatus := enclaveInfo.ContainersStatus
enclaveApiContainerStatus := enclaveInfo.ApiContainerStatus
keyValuePrinter := output_printers.NewKeyValuePrinter()
keyValuePrinter.AddPair(enclaveNameTitleName, enclaveInfo.GetName())
if showFullUuids {
keyValuePrinter.AddPair(enclaveUUIDTitleName, enclaveInfo.GetEnclaveUuid())
} else {
keyValuePrinter.AddPair(enclaveUUIDTitleName, enclaveInfo.GetShortenedUuid())
}
enclaveContainersStatusStr, err := enclave_status_stringifier.EnclaveContainersStatusStringifier(enclaveContainersStatus)
if err != nil {
return stacktrace.Propagate(err, "An error occurred when stringify enclave containers status")
}
keyValuePrinter.AddPair(enclaveStatusTitleName, enclaveContainersStatusStr)
enclaveCreationTime := enclaveInfo.GetCreationTime()
//TODO remove this condition after 2023-01-01 when we are sure that there is not any old enclave created without the creation time label
//TODO and add a fail loudly check
if enclaveCreationTime != nil {
enclaveCreationTimeStr := enclaveCreationTime.AsTime().Local().Format(time.RFC1123)
keyValuePrinter.AddPair(enclaveCreationTimeTitleName, enclaveCreationTimeStr)
}
isApiContainerRunning := enclaveApiContainerStatus == kurtosis_engine_rpc_api_bindings.EnclaveAPIContainerStatus_EnclaveAPIContainerStatus_RUNNING
keyValuePrinter.Print()
out.PrintOutLn("")
sortedEnclaveObjHeaders := []string{}
for header := range enclaveObjectPrintingFuncs {
sortedEnclaveObjHeaders = append(sortedEnclaveObjHeaders, header)
}
sort.Strings(sortedEnclaveObjHeaders)
headersWithPrintErrs := []string{}
for _, header := range sortedEnclaveObjHeaders {
if header == filesArtifactsHeader && !isApiContainerRunning {
// can't fetch files artifact information if APIC isn't running
continue
}
printingFunc, found := enclaveObjectPrintingFuncs[header]
if !found {
return stacktrace.NewError("No printing function found for enclave object '%v'; this is a bug in Kurtosis!", header)
}
numRunesInHeader := utf8.RuneCountInString(header) + 2 // 2 because there will be a space before and after the header
numPadChars := (headerWidthChars - numRunesInHeader) / 2
padStr := strings.Repeat(headerPadChar, numPadChars)
fmt.Printf("%v %v %v\n", padStr, header, padStr)
if err := printingFunc(ctx, kurtosisCtx, kurtosisBackend, enclaveInfo, showFullUuids, isApiContainerRunning); err != nil {
logrus.Error(err)
headersWithPrintErrs = append(headersWithPrintErrs, header)
}
fmt.Println("")
}
if len(headersWithPrintErrs) > 0 {
return stacktrace.NewError(
"Errors occurred printing the following enclave elements: %v",
strings.Join(headersWithPrintErrs, ", "),
)
}
return nil
}