File: memory_test.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (161 lines) | stat: -rw-r--r-- 4,748 bytes parent folder | download | duplicates (3)
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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2022 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 cgroup_test

import (
	"os"
	"path/filepath"

	. "gopkg.in/check.v1"

	"github.com/snapcore/snapd/dirs"
	"github.com/snapcore/snapd/sandbox/cgroup"
	"github.com/snapcore/snapd/testutil"
)

type memorySuiteBase struct {
	testutil.BaseTest

	rootDir         string
	mockCgroupsFile string
}

type memoryCgroupV1Suite struct {
	memorySuiteBase
}

type memoryCgroupV2Suite struct {
	memorySuiteBase
}

var _ = Suite(&memoryCgroupV1Suite{})
var _ = Suite(&memoryCgroupV2Suite{})

var (
	cgroupContentCommon = `#subsys_name	hierarchy	num_cgroups	enabled
cpuset	6	3	1
cpu	3	133	1
devices	10	135	1`
)

func (s *memorySuiteBase) SetUpTest(c *C) {
	s.BaseTest.SetUpTest(c)

	s.rootDir = c.MkDir()
	dirs.SetRootDir(s.rootDir)
	s.AddCleanup(func() { dirs.SetRootDir("/") })

	s.AddCleanup(cgroup.MockVersion(cgroup.V1, nil))

	s.mockCgroupsFile = filepath.Join(s.rootDir, "/proc/cgroups")
	c.Assert(os.MkdirAll(filepath.Dir(s.mockCgroupsFile), 0755), IsNil)

	c.Assert(os.MkdirAll(filepath.Join(s.rootDir, "/sys/fs/cgroup"), 0755), IsNil)
}

func (s *memoryCgroupV1Suite) SetUpTest(c *C) {
	s.memorySuiteBase.SetUpTest(c)

	s.AddCleanup(cgroup.MockVersion(cgroup.V1, nil))
}

func (s *memoryCgroupV1Suite) TestCheckMemoryCgroupV1_Happy(c *C) {
	extra := "memory	2	223	1"
	content := cgroupContentCommon + "\n" + extra

	err := os.WriteFile(s.mockCgroupsFile, []byte(content), 0644)
	c.Assert(err, IsNil)
	err = cgroup.CheckMemoryCgroup()
	c.Assert(err, IsNil)
}

func (s *memoryCgroupV1Suite) TestCheckMemoryCgroupV1_Missing(c *C) {
	// note there is no file created for s.mockCgroupsFile

	err := cgroup.CheckMemoryCgroup()
	c.Assert(err, ErrorMatches, "cannot open cgroups file: open .*/cgroups: no such file or directory")
}

func (s *memoryCgroupV1Suite) TestCheckMemoryCgroupV1_NoMemoryEntry(c *C) {
	content := cgroupContentCommon

	err := os.WriteFile(s.mockCgroupsFile, []byte(content), 0644)
	c.Assert(err, IsNil)
	err = cgroup.CheckMemoryCgroup()
	c.Assert(err, ErrorMatches, "cgroup memory controller is disabled on this system")
}

func (s *memoryCgroupV1Suite) TestCheckMemoryCgroupV1_InvalidMemoryEntry(c *C) {
	extra := "memory	invalid line"
	content := cgroupContentCommon + "\n" + extra

	err := os.WriteFile(s.mockCgroupsFile, []byte(content), 0644)
	c.Assert(err, IsNil)
	err = cgroup.CheckMemoryCgroup()
	c.Assert(err, ErrorMatches, `cannot parse cgroups file: invalid line "memory\\tinvalid line"`)
}

func (s *memoryCgroupV1Suite) TestCheckMemoryCgroupV1_Disabled(c *C) {
	extra := "memory	2	223	0"
	content := cgroupContentCommon + "\n" + extra

	err := os.WriteFile(s.mockCgroupsFile, []byte(content), 0644)
	c.Assert(err, IsNil)
	err = cgroup.CheckMemoryCgroup()
	c.Assert(err, ErrorMatches, "cgroup memory controller is disabled on this system")
}

func (s *memoryCgroupV2Suite) SetUpTest(c *C) {
	s.memorySuiteBase.SetUpTest(c)

	s.AddCleanup(cgroup.MockVersion(cgroup.V2, nil))
}

func (s *memoryCgroupV2Suite) TestCheckMemoryCgroupV2_Disabled(c *C) {
	defer cgroup.MockVersion(cgroup.V2, nil)()

	content := cgroupContentCommon + "\n"

	// memory not mentioned in /proc/cgroups at all (like on 6.12+ kernels)
	err := os.WriteFile(s.mockCgroupsFile, []byte(content), 0644)
	c.Assert(err, IsNil)

	v2ControllersFile := filepath.Join(s.rootDir, "/sys/fs/cgroup/cgroup.controllers")
	// no memory
	c.Assert(os.WriteFile(v2ControllersFile, []byte("foo bar baz other\n"), 0644), IsNil)

	err = cgroup.CheckMemoryCgroup()
	c.Assert(err, ErrorMatches, "cgroup memory controller is disabled on this system")
}

func (s *memoryCgroupV2Suite) TestCheckMemoryCgroupV2_Happy(c *C) {
	defer cgroup.MockVersion(cgroup.V2, nil)()

	content := cgroupContentCommon + "\n"

	// memory not mentioned in /proc/cgroups at all (like on 6.12+ kernels)
	err := os.WriteFile(s.mockCgroupsFile, []byte(content), 0644)
	c.Assert(err, IsNil)

	v2ControllersFile := filepath.Join(s.rootDir, "/sys/fs/cgroup/cgroup.controllers")
	c.Assert(os.WriteFile(v2ControllersFile, []byte("foo bar baz memory other\n"), 0644), IsNil)

	err = cgroup.CheckMemoryCgroup()
	c.Assert(err, IsNil)
}