-
Notifications
You must be signed in to change notification settings - Fork 563
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
corecfg: add "system.timezone" setting to the system settings
This commit adds support for setting the timezone via the snap configuration system. This allows image customizations in UC20 that used to be done via direct manipulation of the "writable" partition in UC16/UC18. The image customization part will be fine as is but for the runtime setting we also need to fix LP: #1650688
- Loading branch information
Showing
6 changed files
with
206 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
// -*- Mode: Go; indent-tabs-mode: t -*- | ||
|
||
/* | ||
* Copyright (C) 2020 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 | ||
|
||
import ( | ||
"fmt" | ||
"os" | ||
"os/exec" | ||
"path/filepath" | ||
"regexp" | ||
|
||
"github.com/snapcore/snapd/osutil" | ||
"github.com/snapcore/snapd/overlord/configstate/config" | ||
) | ||
|
||
func init() { | ||
// add supported configuration of this module | ||
supportedConfigurations["core.system.timezone"] = true | ||
} | ||
|
||
var validTimezone = regexp.MustCompile(`^[a-zA-Z0-9+-]+(/[a-zA-Z0-9+-]+)?$`).MatchString | ||
|
||
func validateTimezoneSettings(tr config.ConfGetter) error { | ||
timezone, err := coreCfg(tr, "system.timezone") | ||
if err != nil { | ||
return err | ||
} | ||
if timezone == "" { | ||
return nil | ||
} | ||
if !validTimezone(timezone) { | ||
return fmt.Errorf("cannot set timezone %q: name not valid", timezone) | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func handleTimezoneConfiguration(tr config.ConfGetter, opts *fsOnlyContext) error { | ||
output, err := coreCfg(tr, "system.timezone") | ||
if err != nil { | ||
return nil | ||
} | ||
// nothing to do | ||
if output == "" { | ||
return nil | ||
} | ||
// runtime system | ||
if opts == nil { | ||
output, err := exec.Command("timedatectl", "set-timezone", output).CombinedOutput() | ||
if err != nil { | ||
return fmt.Errorf("cannot set timezone: %v", osutil.OutputErr(output, err)) | ||
} | ||
} else { | ||
// important to use /etc/writable/ | ||
localtimePath := filepath.Join(opts.RootDir, "/etc/writable/localtime") | ||
if err := os.MkdirAll(filepath.Dir(localtimePath), 0755); err != nil { | ||
return err | ||
} | ||
if err := os.Symlink(filepath.Join("/usr/share/zoneinfo", output), localtimePath); err != nil { | ||
return err | ||
} | ||
timezonePath := filepath.Join(opts.RootDir, "/etc/writable/timezone") | ||
if err := osutil.AtomicWriteFile(timezonePath, []byte(output+"\n"), 0644, 0); err != nil { | ||
return fmt.Errorf("cannot write timezone: %v", err) | ||
} | ||
} | ||
|
||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
// -*- Mode: Go; indent-tabs-mode: t -*- | ||
|
||
/* | ||
* Copyright (C) 2020 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 ( | ||
"os" | ||
"path/filepath" | ||
|
||
. "gopkg.in/check.v1" | ||
|
||
"github.com/snapcore/snapd/dirs" | ||
"github.com/snapcore/snapd/overlord/configstate/configcore" | ||
"github.com/snapcore/snapd/release" | ||
"github.com/snapcore/snapd/testutil" | ||
) | ||
|
||
type timezoneSuite struct { | ||
configcoreSuite | ||
} | ||
|
||
var _ = Suite(&timezoneSuite{}) | ||
|
||
func (s *timezoneSuite) SetUpTest(c *C) { | ||
s.configcoreSuite.SetUpTest(c) | ||
|
||
err := os.MkdirAll(filepath.Join(dirs.GlobalRootDir, "/etc/"), 0755) | ||
c.Assert(err, IsNil) | ||
} | ||
|
||
func (s *timezoneSuite) TestConfigureTimezoneInvalid(c *C) { | ||
invalidTimezones := []string{ | ||
"no-#", "no-ä", "no/double/dash", | ||
} | ||
|
||
for _, tz := range invalidTimezones { | ||
err := configcore.Run(&mockConf{ | ||
state: s.state, | ||
conf: map[string]interface{}{ | ||
"system.timezone": tz, | ||
}, | ||
}) | ||
c.Assert(err, ErrorMatches, `cannot set timezone.*`) | ||
} | ||
} | ||
|
||
func (s *timezoneSuite) TestConfigureTimezoneIntegration(c *C) { | ||
restore := release.MockOnClassic(false) | ||
defer restore() | ||
|
||
mockedTimedatectl := testutil.MockCommand(c, "timedatectl", "") | ||
defer mockedTimedatectl.Restore() | ||
|
||
validTimezones := []string{ | ||
"UTC", "Europe/Malta", "US/Indiana-Starke", | ||
"Etc/GMT+1", "CST6CDT", "GMT0", "GMT-0", "PST8PDT", | ||
} | ||
|
||
for _, tz := range validTimezones { | ||
err := configcore.Run(&mockConf{ | ||
state: s.state, | ||
conf: map[string]interface{}{ | ||
"system.timezone": tz, | ||
}, | ||
}) | ||
c.Assert(err, IsNil) | ||
c.Check(mockedTimedatectl.Calls(), DeepEquals, [][]string{ | ||
{"timedatectl", "set-timezone", tz}, | ||
}) | ||
mockedTimedatectl.ForgetCalls() | ||
} | ||
} | ||
|
||
func (s *timezoneSuite) TestFilesystemOnlyApply(c *C) { | ||
conf := configcore.PlainCoreConfig(map[string]interface{}{ | ||
"system.timezone": "Europe/Berlin", | ||
}) | ||
tmpDir := c.MkDir() | ||
c.Assert(configcore.FilesystemOnlyApply(tmpDir, conf, nil), IsNil) | ||
|
||
c.Check(filepath.Join(tmpDir, "/etc/writable/timezone"), testutil.FileEquals, "Europe/Berlin\n") | ||
p, err := os.Readlink(filepath.Join(tmpDir, "/etc/writable/localtime")) | ||
c.Assert(err, IsNil) | ||
c.Check(p, Equals, "/usr/share/zoneinfo/Europe/Berlin") | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,3 +3,5 @@ defaults: | |
service: | ||
rsyslog: | ||
disable: true | ||
system: | ||
timezone: Europe/Malta |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters