File: withbootassettesting.go

package info (click to toggle)
snapd 2.71-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 79,536 kB
  • sloc: ansic: 16,114; sh: 16,105; python: 9,941; makefile: 1,890; exp: 190; awk: 40; xml: 22
file content (115 lines) | stat: -rw-r--r-- 3,556 bytes parent folder | download | duplicates (2)
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
// -*- Mode: Go; indent-tabs-mode: t -*-
//go:build withbootassetstesting

/*
 * Copyright (C) 2021 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package bootloader

import (
	"bytes"
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/snapcore/snapd/bootloader/assets"
	"github.com/snapcore/snapd/logger"
	"github.com/snapcore/snapd/snapdenv"
)

var maybeInjectOsReadlink = os.Readlink

func MockMaybeInjectOsReadlink(m func(string) (string, error)) (restore func()) {
	old := maybeInjectOsReadlink
	maybeInjectOsReadlink = m
	return func() {
		maybeInjectOsReadlink = old
	}
}

func MaybeInjectTestingBootloaderAssets() {
	// this code is ran only when snapd is built with specific testing tag

	if !snapdenv.Testing() {
		return
	}

	// log an info level message, it is a testing build of snapd anyway
	logger.Noticef("maybe inject boot assets?")

	// is there a marker file at /usr/lib/snapd/ in the snap?
	selfExe, err := maybeInjectOsReadlink("/proc/self/exe")
	if err != nil {
		panic(fmt.Sprintf("cannot readlink: %v", err))
	}

	injectPieceRaw, err := os.ReadFile(filepath.Join(filepath.Dir(selfExe), "bootassetstesting"))
	if os.IsNotExist(err) {
		logger.Noticef("no boot asset testing marker")
		return
	}
	if len(injectPieceRaw) == 0 {
		logger.Noticef("boot asset testing snippet is empty")
	}
	injectPiece := strings.TrimSpace(string(injectPieceRaw))

	// with boot assets testing enabled and the marker file present, inject
	// a mock boot config update

	grubBootconfig := assets.Internal("grub.cfg")
	if grubBootconfig == nil {
		panic("no bootconfig")
	}
	snippets := assets.SnippetsForEditions("grub.cfg:static-cmdline")
	if len(snippets) == 0 {
		panic(fmt.Sprintf("cannot obtain internal grub.cfg:static-cmdline snippets"))
	}

	internalEdition, err := editionFromConfigAsset(bytes.NewReader(grubBootconfig))
	if err != nil {
		panic(fmt.Sprintf("cannot inject boot config for asset: %v", err))
	}
	// bump the injected edition number
	injectedEdition := internalEdition + 1

	logger.Noticef("injecting grub boot assets for testing, edition: %v snippet: %q", injectedEdition, injectPiece)

	lastSnippet := string(snippets[len(snippets)-1].Snippet)
	injectedSnippet := lastSnippet + " " + injectPiece
	injectedSnippets := append(snippets,
		assets.ForEditions{FirstEdition: injectedEdition, Snippet: []byte(injectedSnippet)})

	assets.InjectSnippetsForEditions("grub.cfg:static-cmdline", injectedSnippets)

	origGrubBoot := string(grubBootconfig)
	bumpedEdition := strings.Replace(origGrubBoot,
		fmt.Sprintf("%s%d", editionHeader, internalEdition),
		fmt.Sprintf("%s%d", editionHeader, injectedEdition),
		1)
	// see data/grub.cfg for reference
	bumpedCmdlineAndEdition := strings.Replace(bumpedEdition,
		fmt.Sprintf(`set snapd_static_cmdline_args='%s'`, lastSnippet),
		fmt.Sprintf(`set snapd_static_cmdline_args='%s'`, injectedSnippet),
		1)

	assets.InjectInternal("grub.cfg", []byte(bumpedCmdlineAndEdition))
}

func init() {
	MaybeInjectTestingBootloaderAssets()
}