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
|
// Copyright (c) 2018-2022, 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 build
import (
"encoding/json"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"runtime"
"strconv"
"strings"
"time"
"github.com/sylabs/singularity/v4/internal/pkg/buildcfg"
"github.com/sylabs/singularity/v4/pkg/build/types"
"github.com/sylabs/singularity/v4/pkg/build/types/parser"
"github.com/sylabs/singularity/v4/pkg/image"
"github.com/sylabs/singularity/v4/pkg/inspect"
"github.com/sylabs/singularity/v4/pkg/sylog"
)
func (s *stage) insertMetadata() error {
// insert help
if err := insertHelpScript(s.b); err != nil {
return fmt.Errorf("while inserting help script: %v", err)
}
// insert labels
if err := insertLabelsJSON(s.b); err != nil {
return fmt.Errorf("while inserting labels json: %v", err)
}
// insert definition
if err := insertDefinition(s.b); err != nil {
return fmt.Errorf("while inserting definition: %v", err)
}
// insert environment
if err := insertEnvScript(s.b); err != nil {
return fmt.Errorf("while inserting environment script: %v", err)
}
// insert startscript
if err := insertStartScript(s.b); err != nil {
return fmt.Errorf("while inserting startscript: %v", err)
}
// insert runscript
if err := insertRunScript(s.b); err != nil {
return fmt.Errorf("while inserting runscript: %v", err)
}
// insert test script
if err := insertTestScript(s.b); err != nil {
return fmt.Errorf("while inserting test script: %v", err)
}
// insert JSON inspect metadata (must be the last call)
if err := insertJSONInspectMetadata(s.b); err != nil {
return fmt.Errorf("while inserting JSON inspect metadata: %v", err)
}
return nil
}
func insertEnvScript(b *types.Bundle) error {
if b.RunSection("environment") && b.Recipe.ImageData.Environment.Script != "" {
sylog.Infof("Adding environment to container")
envScriptPath := filepath.Join(b.RootfsPath, "/.singularity.d/env/90-environment.sh")
_, err := os.Stat(envScriptPath)
if os.IsNotExist(err) {
err := os.WriteFile(envScriptPath, []byte("#!/bin/sh\n\n"+b.Recipe.ImageData.Environment.Script+"\n"), 0o755)
if err != nil {
return err
}
} else {
// append to script if it already exists
f, err := os.OpenFile(envScriptPath, os.O_APPEND|os.O_WRONLY, 0o755)
if err != nil {
return err
}
defer f.Close()
_, err = f.WriteString("\n" + b.Recipe.ImageData.Environment.Script + "\n")
if err != nil {
return err
}
}
}
return nil
}
// runscript and starscript should use this function to properly handle args and shebangs
func handleShebangScript(s types.Script) (string, string) {
shebang := "#!/bin/sh"
script := ""
if strings.HasPrefix(strings.TrimSpace(s.Script), "#!") {
// separate and cleanup shebang
split := strings.SplitN(s.Script, "\n", 2)
shebang = strings.TrimSpace(split[0])
if len(split) == 2 {
script = split[1]
}
} else {
script = s.Script
}
if s.Args != "" {
// add arg after trimming comments
shebang += " " + strings.Split(s.Args, "#")[0]
}
return shebang, script
}
func insertRunScript(b *types.Bundle) error {
if b.RunSection("runscript") && b.Recipe.ImageData.Runscript.Script != "" {
sylog.Infof("Adding runscript")
shebang, script := handleShebangScript(b.Recipe.ImageData.Runscript)
err := os.WriteFile(filepath.Join(b.RootfsPath, "/.singularity.d/runscript"), []byte(shebang+"\n\n"+script+"\n"), 0o755)
if err != nil {
return err
}
}
return nil
}
func insertStartScript(b *types.Bundle) error {
if b.RunSection("startscript") && b.Recipe.ImageData.Startscript.Script != "" {
sylog.Infof("Adding startscript")
shebang, script := handleShebangScript(b.Recipe.ImageData.Startscript)
err := os.WriteFile(filepath.Join(b.RootfsPath, "/.singularity.d/startscript"), []byte(shebang+"\n\n"+script+"\n"), 0o755)
if err != nil {
return err
}
}
return nil
}
func insertTestScript(b *types.Bundle) error {
if b.RunSection("test") && b.Recipe.ImageData.Test.Script != "" {
sylog.Infof("Adding testscript")
shebang, script := handleShebangScript(b.Recipe.ImageData.Test)
err := os.WriteFile(filepath.Join(b.RootfsPath, "/.singularity.d/test"), []byte(shebang+"\n\n"+script+"\n"), 0o755)
if err != nil {
return err
}
}
return nil
}
func insertHelpScript(b *types.Bundle) error {
if b.RunSection("help") && b.Recipe.ImageData.Help.Script != "" {
_, err := os.Stat(filepath.Join(b.RootfsPath, "/.singularity.d/runscript.help"))
if err != nil || b.Opts.Force {
sylog.Infof("Adding help info")
err := os.WriteFile(filepath.Join(b.RootfsPath, "/.singularity.d/runscript.help"), []byte(b.Recipe.ImageData.Help.Script+"\n"), 0o644)
if err != nil {
return err
}
} else {
sylog.Warningf("Help message already exists and force option is false, not overwriting")
}
}
return nil
}
func insertDefinition(b *types.Bundle) error {
// Check for existing definition and move it to bootstrap history
if _, err := os.Stat(filepath.Join(b.RootfsPath, "/.singularity.d/Singularity")); err == nil {
// make bootstrap_history directory if it doesn't exist
if _, err := os.Stat(filepath.Join(b.RootfsPath, "/.singularity.d/bootstrap_history")); err != nil {
err = os.Mkdir(filepath.Join(b.RootfsPath, "/.singularity.d/bootstrap_history"), 0o755)
if err != nil {
return err
}
}
// look at number of files in bootstrap_history to give correct file name
files, err := os.ReadDir(filepath.Join(b.RootfsPath, "/.singularity.d/bootstrap_history"))
if err != nil {
return err
}
// name is "Singularity" concatenated with an index based on number of other files in bootstrap_history
numFiles := strconv.Itoa(len(files))
histName := "Singularity" + numFiles
// move old definition into bootstrap_history
err = os.Rename(filepath.Join(b.RootfsPath, "/.singularity.d/Singularity"), filepath.Join(b.RootfsPath, "/.singularity.d/bootstrap_history", histName))
if err != nil {
return err
}
}
err := os.WriteFile(filepath.Join(b.RootfsPath, "/.singularity.d/Singularity"), b.Recipe.FullRaw, 0o644)
if err != nil {
return err
}
return nil
}
func insertLabelsJSON(b *types.Bundle) (err error) {
var text []byte
labels := make(map[string]string)
if err = getExistingLabels(labels, b); err != nil {
return err
}
// get labels added through SINGULARITY_LABELS environment variables
buildLabels := filepath.Join(b.RootfsPath, sLabelsPath)
content, err := os.ReadFile(buildLabels)
if err == nil {
if err := os.Remove(filepath.Join(b.RootfsPath, sLabelsPath)); err != nil {
return err
}
for k, v := range parser.GetLabels(string(content)) {
labels[k] = v
}
} else if !os.IsNotExist(err) {
return fmt.Errorf("while reading %s: %s", buildLabels, err)
}
if err = addBuildLabels(labels, b); err != nil {
return err
}
if b.RunSection("labels") && len(b.Recipe.ImageData.Labels) > 0 {
sylog.Infof("Adding labels")
// add new labels to new map and check for collisions
for key, value := range b.Recipe.ImageData.Labels {
// check if label already exists
if _, ok := labels[key]; ok {
// overwrite collision if it exists and force flag is set
if b.Opts.Force {
labels[key] = value
} else {
sylog.Warningf("Label: %s already exists and force option is false, not overwriting", key)
}
} else {
// set if it doesn't
labels[key] = value
}
}
}
// make new map into json
text, err = json.MarshalIndent(labels, "", "\t")
if err != nil {
return err
}
err = os.WriteFile(filepath.Join(b.RootfsPath, "/.singularity.d/labels.json"), []byte(text), 0o644)
return err
}
func insertJSONInspectMetadata(b *types.Bundle) error {
metadata := new(inspect.Metadata)
exe := filepath.Join(buildcfg.BINDIR, "singularity")
cmd := exec.Command(exe, "inspect", "--all", b.RootfsPath)
cmd.Stderr = os.Stderr
out, err := cmd.Output()
if err != nil {
return fmt.Errorf("while executing inspect command: %s", err)
}
if err := json.Unmarshal(out, metadata); err != nil {
return fmt.Errorf("while decoding inspect metadata: %s", err)
}
data, err := json.Marshal(metadata)
if err != nil {
return fmt.Errorf("while encoding inspect metadata: %s", err)
}
b.JSONObjects[image.SIFDescInspectMetadataJSON] = data
return nil
}
func getExistingLabels(labels map[string]string, b *types.Bundle) error {
// check for existing labels in bundle
if _, err := os.Stat(filepath.Join(b.RootfsPath, "/.singularity.d/labels.json")); err == nil {
jsonFile, err := os.Open(filepath.Join(b.RootfsPath, "/.singularity.d/labels.json"))
if err != nil {
return err
}
defer jsonFile.Close()
jsonBytes, err := io.ReadAll(jsonFile)
if err != nil {
return err
}
err = json.Unmarshal(jsonBytes, &labels)
if err != nil {
return err
}
}
return nil
}
func addBuildLabels(labels map[string]string, b *types.Bundle) error {
// schema version
labels["org.label-schema.schema-version"] = "1.0"
// build date and time, lots of time formatting
currentTime := time.Now()
year, month, day := currentTime.Date()
date := strconv.Itoa(day) + `_` + month.String() + `_` + strconv.Itoa(year)
hour, min, sec := currentTime.Clock()
time := strconv.Itoa(hour) + `:` + strconv.Itoa(min) + `:` + strconv.Itoa(sec)
zone, _ := currentTime.Zone()
timeString := currentTime.Weekday().String() + `_` + date + `_` + time + `_` + zone
labels["org.label-schema.build-date"] = timeString
// singularity version
labels["org.label-schema.usage.singularity.version"] = buildcfg.PACKAGE_VERSION
// help info if help exists in the definition and is run in the build
if b.RunSection("help") && b.Recipe.ImageData.Help.Script != "" {
labels["org.label-schema.usage"] = "/.singularity.d/runscript.help"
labels["org.label-schema.usage.singularity.runscript.help"] = "/.singularity.d/runscript.help"
}
// bootstrap header info, only if this build actually bootstrapped
if !b.Opts.Update || b.Opts.Force {
for key, value := range b.Recipe.Header {
labels["org.label-schema.usage.singularity.deffile."+key] = value
}
}
// Architecture of build
// Local builds currently always use the host architecture.
// In remote builds this label will be applied on the builder... where the
// architecture should match the remote build --arch flag.
labels["org.label-schema.build-arch"] = runtime.GOARCH
return nil
}
|