forked from apptainer/singularity
-
Notifications
You must be signed in to change notification settings - Fork 0
/
inspect_linux.go
278 lines (218 loc) · 8.04 KB
/
inspect_linux.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
// Copyright (c) 2018-2019, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cli
import (
"encoding/json"
"fmt"
"log"
"os"
"path/filepath"
"strings"
"github.com/opencontainers/runtime-tools/generate"
"github.com/spf13/cobra"
"github.com/sylabs/singularity/docs"
"github.com/sylabs/singularity/internal/pkg/buildcfg"
"github.com/sylabs/singularity/internal/pkg/sylog"
"github.com/sylabs/singularity/internal/pkg/util/exec"
"github.com/sylabs/singularity/internal/pkg/runtime/engines/config"
"github.com/sylabs/singularity/internal/pkg/runtime/engines/config/oci"
singularityConfig "github.com/sylabs/singularity/internal/pkg/runtime/engines/singularity/config"
)
var (
labels bool
deffile bool
runscript bool
testfile bool
environment bool
helpfile bool
jsonfmt bool
)
func init() {
InspectCmd.Flags().SetInterspersed(false)
InspectCmd.Flags().StringVar(&AppName, "app", "", "inspect a specific app")
InspectCmd.Flags().SetAnnotation("app", "envkey", []string{"APP"})
InspectCmd.Flags().BoolVarP(&labels, "labels", "l", false, "show the labels associated with the image (default)")
InspectCmd.Flags().SetAnnotation("labels", "envkey", []string{"LABELS"})
InspectCmd.Flags().BoolVarP(&deffile, "deffile", "d", false, "show the Singularity recipe file that was used to generate the image")
InspectCmd.Flags().SetAnnotation("deffile", "envkey", []string{"DEFFILE"})
InspectCmd.Flags().BoolVarP(&runscript, "runscript", "r", false, "show the runscript for the image")
InspectCmd.Flags().SetAnnotation("runscript", "envkey", []string{"RUNSCRIPT"})
InspectCmd.Flags().BoolVarP(&testfile, "test", "t", false, "show the test script for the image")
InspectCmd.Flags().SetAnnotation("test", "envkey", []string{"TEST"})
InspectCmd.Flags().BoolVarP(&environment, "environment", "e", false, "show the environment settings for the image")
InspectCmd.Flags().SetAnnotation("environment", "envkey", []string{"ENVIRONMENT"})
InspectCmd.Flags().BoolVarP(&helpfile, "helpfile", "H", false, "inspect the runscript helpfile, if it exists")
InspectCmd.Flags().SetAnnotation("helpfile", "envkey", []string{"HELPFILE"})
InspectCmd.Flags().BoolVarP(&jsonfmt, "json", "j", false, "print structured json instead of sections")
InspectCmd.Flags().SetAnnotation("json", "envkey", []string{"JSON"})
SingularityCmd.AddCommand(InspectCmd)
}
func getLabelsFile(appName string) string {
if appName == "" {
return " cat /.singularity.d/labels.json;"
}
return fmt.Sprintf(" cat /scif/apps/%s/scif/labels.json;", appName)
}
func getRunscriptFile(appName string) string {
if appName == "" {
return " cat /.singularity.d/runscript;"
}
return fmt.Sprintf("/scif/apps/%s/scif/runscript", appName)
}
func getTestFile(appName string) string {
if appName == "" {
return " cat /.singularity.d/test;"
}
return fmt.Sprintf("/scif/apps/%s/scif/test", appName)
}
func getEnvFile(appName string) string {
if appName == "" {
return " find /.singularity.d/env -name 9*-environment.sh -exec echo -n == \\; -exec basename -z {} \\; -exec echo == \\; -exec cat {} \\; -exec echo \\;;"
}
return fmt.Sprintf(" find /scif/apps/%s/scif/env -name 9*-environment.sh -exec echo -n == \\; -exec basename -z {} \\; -exec echo == \\; -exec cat {} \\; -exec echo \\;;", appName)
}
func getHelpFile(appName string) string {
if appName == "" {
return " cat /.singularity.d/runscript.help;"
}
return fmt.Sprintf("/scif/apps/%s/scif/runscript.help", appName)
}
// InspectCmd represents the build command
var InspectCmd = &cobra.Command{
DisableFlagsInUseLine: true,
Args: cobra.ExactArgs(1),
Use: docs.InspectUse,
Short: docs.InspectShort,
Long: docs.InspectLong,
Example: docs.InspectExample,
Run: func(cmd *cobra.Command, args []string) {
// Sanity check
if _, err := os.Stat(args[0]); err != nil {
sylog.Fatalf("container not found: %s", err)
}
abspath, err := filepath.Abs(args[0])
if err != nil {
sylog.Fatalf("While determining absolute file path: %v", err)
}
name := filepath.Base(abspath)
attributes := make(map[string]string)
a := []string{"/bin/sh", "-c", ""}
prefix := "@@@start"
delimiter := "@@@end"
if helpfile {
sylog.Debugf("Inspection of helpfile selected.")
// append to a[2] to run commands in container
a[2] += fmt.Sprintf(" echo '%v\nhelpfile';", prefix)
a[2] += getHelpFile(AppName)
a[2] += fmt.Sprintf(" echo '%v';", delimiter)
}
if deffile {
sylog.Debugf("Inspection of deffile selected.")
// append to a[2] to run commands in container
a[2] += fmt.Sprintf(" echo '%v\ndeffile';", prefix)
a[2] += " cat .singularity.d/Singularity;" // apps share common definition file
a[2] += fmt.Sprintf(" echo '%v';", delimiter)
}
if runscript {
sylog.Debugf("Inspection of runscript selected.")
// append to a[2] to run commands in container
a[2] += fmt.Sprintf(" echo '%v\nrunscript';", prefix)
a[2] += getRunscriptFile(AppName)
a[2] += fmt.Sprintf(" echo '%v';", delimiter)
}
if testfile {
sylog.Debugf("Inspection of test selected.")
// append to a[2] to run commands in container
a[2] += fmt.Sprintf(" echo '%v\ntest';", prefix)
a[2] += getTestFile(AppName)
a[2] += fmt.Sprintf(" echo '%v';", delimiter)
}
if environment {
sylog.Debugf("Inspection of environment selected.")
// append to a[2] to run commands in container
a[2] += fmt.Sprintf(" echo '%v\nenvironment';", prefix)
a[2] += getEnvFile(AppName)
a[2] += fmt.Sprintf(" echo '%v';", delimiter)
}
// default to labels if nothing was appended
if labels || len(a[2]) == 0 {
sylog.Debugf("Inspection of labels as default.")
// append to a[2] to run commands in container
a[2] += fmt.Sprintf(" echo '%v\nlabels';", prefix)
a[2] += getLabelsFile(AppName)
a[2] += fmt.Sprintf(" echo '%v';", delimiter)
}
fileContents, err := getFileContent(abspath, name, a)
if err != nil {
sylog.Fatalf("While getting helpfile: %v", err)
}
contentSlice := strings.Split(fileContents, delimiter)
for _, s := range contentSlice {
s = strings.TrimSpace(s)
if strings.HasPrefix(s, prefix) {
split := strings.SplitN(s, "\n", 3)
if len(split) == 3 {
attributes[split[1]] = split[2]
} else if len(split) == 2 {
sylog.Warningf("%v metadata was not found.", split[1])
}
}
}
// format that data based on --json flag
if jsonfmt {
// store this in a struct, then marshal the struct to json
type result struct {
Data map[string]string `json:"attributes"`
T string `json:"type"`
}
d := result{
Data: attributes,
T: "container",
}
b, err := json.MarshalIndent(d, "", "\t")
if err != nil {
log.Fatal(err)
}
fmt.Println(string(b))
} else {
// iterate through sections of struct and print them
for _, value := range attributes {
fmt.Println("\n" + value + "\n")
}
}
},
TraverseChildren: true,
}
func getFileContent(abspath, name string, args []string) (string, error) {
starter := buildcfg.LIBEXECDIR + "/singularity/bin/starter-suid"
procname := "Singularity inspect"
Env := []string{sylog.GetEnvVar()}
engineConfig := singularityConfig.NewConfig()
ociConfig := &oci.Config{}
generator := generate.Generator{Config: &ociConfig.Spec}
engineConfig.OciConfig = ociConfig
generator.SetProcessArgs(args)
generator.SetProcessCwd("/")
engineConfig.SetImage(abspath)
cfg := &config.Common{
EngineName: singularityConfig.Name,
ContainerID: name,
EngineConfig: engineConfig,
}
configData, err := json.Marshal(cfg)
if err != nil {
sylog.Fatalf("CLI Failed to marshal CommonEngineConfig: %s\n", err)
}
//record from stdout and store as a string to return as the contents of the file?
cmd, err := exec.PipeCommand(starter, []string{procname}, Env, configData)
if err != nil {
sylog.Fatalf("%s", err)
}
b, err := cmd.Output()
if err != nil {
sylog.Fatalf("%s", err)
}
return string(b), nil
}