github.com/meulengracht/snapd@v0.0.0-20210719210640-8bde69bcc84e/overlord/configstate/configcore/swap_test.go

// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * 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 configcore_test

import (
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"

	. "gopkg.in/check.v1"

	"github.com/snapcore/snapd/dirs"
	"github.com/snapcore/snapd/overlord/configstate/configcore"
	"github.com/snapcore/snapd/testutil"
)

type swapCfgSuite struct {
	configcoreSuite

	configSwapFile string
}

var _ = Suite(&swapCfgSuite{})

func (s *swapCfgSuite) SetUpTest(c *C) {
	s.configcoreSuite.SetUpTest(c)

	s.systemctlArgs = nil
	s.configSwapFile = filepath.Join(dirs.GlobalRootDir, "/etc/default/swapfile")

	err := os.MkdirAll(filepath.Join(dirs.GlobalRootDir, "/etc/"), 0755)
	c.Assert(err, IsNil)

	err = ioutil.WriteFile(filepath.Join(dirs.GlobalRootDir, "/etc/environment"), nil, 0644)
	c.Assert(err, IsNil)
}

func (s *swapCfgSuite) TestConfigureSwapSizeOnlyWhenChanged(c *C) {
	// set it to 1M initially
	err := configcore.Run(coreDev, &mockConf{
		state: s.state,
		changes: map[string]interface{}{
			"swap.size": "1048576",
		},
	})
	c.Assert(err, IsNil)

	c.Check(s.configSwapFile, testutil.FileEquals, `FILE=/var/tmp/swapfile.swp
SIZE=1
`)

	c.Check(s.systemctlArgs, DeepEquals, [][]string{
		{"stop", "swapfile.service"},
		{"show", "--property=ActiveState", "swapfile.service"},
		{"start", "swapfile.service"},
	})

	s.systemctlArgs = nil

	// running it with the same changes as conf results in no calls to systemd
	err = configcore.Run(coreDev, &mockConf{
		state: s.state,
		conf: map[string]interface{}{
			"swap.size": "1048576",
		},
		changes: map[string]interface{}{
			"swap.size": "1048576",
		},
	})
	c.Assert(err, IsNil)

	c.Check(s.configSwapFile, testutil.FileEquals, `FILE=/var/tmp/swapfile.swp
SIZE=1
`)

	c.Check(s.systemctlArgs, HasLen, 0)
}

func (s *swapCfgSuite) TestConfigureSwapSize(c *C) {
	// set it to 1M initially
	err := configcore.Run(coreDev, &mockConf{
		state: s.state,
		changes: map[string]interface{}{
			"swap.size": "1048576",
		},
	})
	c.Assert(err, IsNil)

	c.Check(s.configSwapFile, testutil.FileEquals, `FILE=/var/tmp/swapfile.swp
SIZE=1
`)

	c.Check(s.systemctlArgs, DeepEquals, [][]string{
		{"stop", "swapfile.service"},
		{"show", "--property=ActiveState", "swapfile.service"},
		{"start", "swapfile.service"},
	})

	s.systemctlArgs = nil

	// now change it to empty
	err = configcore.Run(coreDev, &mockConf{
		state: s.state,
		conf: map[string]interface{}{
			"swap.size": "1048576",
		},
		changes: map[string]interface{}{
			"swap.size": "",
		},
	})
	c.Assert(err, IsNil)

	c.Check(s.configSwapFile, testutil.FileEquals, `FILE=/var/tmp/swapfile.swp
SIZE=0
`)

	c.Check(s.systemctlArgs, DeepEquals, [][]string{
		{"stop", "swapfile.service"},
		{"show", "--property=ActiveState", "swapfile.service"},
		{"start", "swapfile.service"},
	})
}

func (s *swapCfgSuite) TestSwapSizeNumberFormats(c *C) {
	tt := []struct {
		sizeStr     string
		sizeFileStr string
		err         string
	}{
		{
			sizeStr:     "1073741824",
			sizeFileStr: "1024",
		},
		{
			sizeStr:     "1024M",
			sizeFileStr: "1024",
		},
		{
			sizeStr:     "1G",
			sizeFileStr: "1024",
		},
		{
			sizeStr: "1048576K",
			err:     "invalid suffix \"K\"",
		},
		{
			sizeStr: "1073741824.4",
			err:     "invalid suffix \".4\"",
		},
		{
			sizeStr: "1",
			err:     "swap size setting must be at least one megabyte",
		},
		{
			sizeStr: "1073741825",
			err:     "swap size setting must be an integer number of megabytes",
		},
	}

	err := os.MkdirAll(filepath.Dir(s.configSwapFile), 0755)
	c.Assert(err, IsNil)

	for _, t := range tt {
		conf := configcore.PlainCoreConfig(map[string]interface{}{
			"swap.size": t.sizeStr,
		})

		err := configcore.FilesystemOnlyApply(coreDev, dirs.GlobalRootDir, conf)
		if t.err != "" {
			c.Assert(err, ErrorMatches, t.err)
		} else {
			c.Assert(err, IsNil)
			c.Check(s.configSwapFile, testutil.FileEquals, fmt.Sprintf(`FILE=/var/tmp/swapfile.swp
SIZE=%s
`, t.sizeFileStr))
		}
	}
}

func (s *swapCfgSuite) TestSwapSizeFilesystemOnlyApply(c *C) {
	conf := configcore.PlainCoreConfig(map[string]interface{}{
		"swap.size": "1024M",
	})

	// with no swapfile config in place we use sensible defaults
	err := os.MkdirAll(filepath.Dir(s.configSwapFile), 0755)
	c.Assert(err, IsNil)

	c.Assert(configcore.FilesystemOnlyApply(coreDev, dirs.GlobalRootDir, conf), IsNil)

	c.Check(s.configSwapFile, testutil.FileEquals, `FILE=/var/tmp/swapfile.swp
SIZE=1024
`)
}

func (s *swapCfgSuite) TestSwapSizeFilesystemOnlyApplyExistingConfig(c *C) {
	conf := configcore.PlainCoreConfig(map[string]interface{}{
		"swap.size": "1024M",
	})

	// we use the value from the config file if FILE is specified in the
	// existing config file
	err := os.MkdirAll(filepath.Dir(s.configSwapFile), 0755)
	c.Assert(err, IsNil)

	err = ioutil.WriteFile(s.configSwapFile, []byte(`FILE=/var/tmp/other-swapfile.swp
SIZE=0`), 0644)
	c.Assert(err, IsNil)

	err = configcore.FilesystemOnlyApply(coreDev, dirs.GlobalRootDir, conf)
	c.Assert(err, IsNil)

	c.Check(s.configSwapFile, testutil.FileEquals, `FILE=/var/tmp/other-swapfile.swp
SIZE=1024
`)
}