File: sysparams_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 (154 lines) | stat: -rw-r--r-- 4,840 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
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2023 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 sysparams_test

import (
	"errors"
	"os"
	"path"
	"testing"

	. "gopkg.in/check.v1"

	"github.com/snapcore/snapd/dirs"
	"github.com/snapcore/snapd/osutil"
	"github.com/snapcore/snapd/snap/sysparams"
	"github.com/snapcore/snapd/testutil"
)

func TestSysParamsTest(t *testing.T) { TestingT(t) }

type sysParamsTestSuite struct {
	testutil.BaseTest
}

var _ = Suite(&sysParamsTestSuite{})

func (s *sysParamsTestSuite) SetUpTest(c *C) {
	dirs.SetRootDir(c.MkDir())
}

func (s *sysParamsTestSuite) TestOpenNewEmpty(c *C) {
	// Opening the file when it doesn't exist, should not create
	// the file unless Write is called. And that an empty write
	// provides empty members
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, IsNil)
	c.Assert(ssp, NotNil)
	c.Check(sspPath, testutil.FileAbsent)

	// Save the file
	err = ssp.Write()
	c.Check(err, IsNil)

	// Verify the contents of the file, and that the file
	// has the correct permissions
	c.Assert(sspPath, testutil.FileEquals, "homedirs=\n")

	stat, err := os.Stat(sspPath)
	c.Assert(err, IsNil)
	c.Check(stat.Mode(), Equals, os.FileMode(0644))
}

func (s *sysParamsTestSuite) TestWriteFailure(c *C) {
	// Opening the file when it doesn't exist, should not create
	// the file unless Write is called. And that an empty write
	// provides empty members
	ssp, err := sysparams.Open("")
	c.Check(err, IsNil)
	c.Assert(ssp, NotNil)
	c.Check(dirs.SnapSystemParamsUnder(dirs.GlobalRootDir), testutil.FileAbsent)

	r := sysparams.MockOsutilAtomicWriteFile(func(filename string, data []byte, perm os.FileMode, flags osutil.AtomicWriteFlags) error {
		return errors.New("some write error")
	})
	defer r()

	err = ssp.Write()
	c.Assert(err, ErrorMatches, "cannot write system-params: some write error")
}

func (s *sysParamsTestSuite) TestOpenExisting(c *C) {
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)
	c.Assert(os.WriteFile(sspPath, []byte("homedirs=my-path/foo/bar,foo\n"), 0644), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, IsNil)
	c.Assert(ssp, NotNil)
	c.Assert(ssp.Homedirs, Equals, "my-path/foo/bar,foo")
}

func (s *sysParamsTestSuite) TestOpenExistingEmpty(c *C) {
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)
	c.Assert(os.WriteFile(sspPath, []byte("\n"), 0644), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, IsNil)
	c.Check(ssp.Homedirs, Equals, "")
}

func (s *sysParamsTestSuite) TestOpenExistingWithInvalidContent(c *C) {
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)
	c.Assert(os.WriteFile(sspPath, []byte("xuifu93\n"), 0644), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, ErrorMatches, `cannot parse system-params: invalid line: "xuifu93"`)
	c.Check(ssp, IsNil)
}

func (s *sysParamsTestSuite) TestOpenExistingWithComments(c *C) {
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)
	c.Assert(os.WriteFile(sspPath, []byte("# this is a comment line\n"), 0644), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, IsNil)
	c.Check(ssp.Homedirs, Equals, "")
}

func (s *sysParamsTestSuite) TestOpenExistingWithDoubleEqual(c *C) {
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)
	c.Assert(os.WriteFile(sspPath, []byte("homedirs=my-path/foo/bar,foo=bar\n"), 0644), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, IsNil)
	c.Check(ssp.Homedirs, Equals, "my-path/foo/bar,foo=bar")
}

func (s *sysParamsTestSuite) TestOpenExistingWithDuplicateLine(c *C) {
	contents := `
homedirs=foo/bar
homedirs=foo/baz
`
	sspPath := dirs.SnapSystemParamsUnder(dirs.GlobalRootDir)
	c.Assert(os.MkdirAll(path.Dir(sspPath), 0755), IsNil)
	c.Assert(os.WriteFile(sspPath, []byte(contents), 0644), IsNil)

	ssp, err := sysparams.Open("")
	c.Check(err, ErrorMatches, `cannot parse system-params: duplicate entry found: "homedirs"`)
	c.Check(ssp, IsNil)
}