Files
snapd/overlord/patch/patch6_3.go
Miguel Pires d097436c1c many: fix formatting w/ gofmt 1.19
Go 1.19 includes some changes to gofmt which intend to make lists and
heading clearer when rendered (https://go.dev/doc/go1.19). This commit
is the result of running the new gofmt and manually fixing some of it.
This was necessary because the new gofmt assumed lines beginning w/ tabs
to start lists or examples. While this is often true in our codebase,
we occasionally also use tabs to indent the lines after a TODO or FIXME
prefix or in yaml (e.g., excerpts of a snap.yaml). This meant that a lot of the
reformatted comments were broken and had to be fixed manually.

Signed-off-by: Miguel Pires <miguel.pires@canonical.com>
2023-01-16 14:23:11 +01:00

113 lines
2.8 KiB
Go

// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2019 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 patch
import (
"encoding/json"
"errors"
"fmt"
"github.com/snapcore/snapd/logger"
"github.com/snapcore/snapd/overlord/state"
"github.com/snapcore/snapd/snap/channel"
)
// normChan will take a potentially unclean channel from the state
// (with leading or trailing extra "/") and return a cleaned version.
func normChan(in string) string {
out, err := channel.Full(in)
if err != nil {
logger.Noticef("cannot parse channel string %q: %v", in, err)
return in
}
return out
}
// patch6_3:
// - ensure channel spec is valid
func patch6_3(st *state.State) error {
var snaps map[string]*json.RawMessage
if err := st.Get("snaps", &snaps); err != nil && !errors.Is(err, state.ErrNoState) {
return fmt.Errorf("internal error: cannot get snaps: %s", err)
}
// Migrate snapstate
dirty := false
for name, raw := range snaps {
var snapst map[string]interface{}
if err := json.Unmarshal([]byte(*raw), &snapst); err != nil {
return err
}
ch, _ := snapst["channel"].(string)
if ch != "" {
normed := normChan(ch)
if normed != ch {
snapst["channel"] = normed
data, err := json.Marshal(snapst)
if err != nil {
return err
}
newRaw := json.RawMessage(data)
snaps[name] = &newRaw
dirty = true
}
}
}
if dirty {
st.Set("snaps", snaps)
}
// migrate tasks' snap setup
for _, task := range st.Tasks() {
chg := task.Change()
if chg != nil && chg.Status().Ready() {
continue
}
// check task snap-setup
var snapsup map[string]interface{}
err := task.Get("snap-setup", &snapsup)
if err != nil && !errors.Is(err, state.ErrNoState) {
return fmt.Errorf("internal error: cannot get snap-setup of task %s: %s", task.ID(), err)
}
if err == nil {
ch, _ := snapsup["channel"].(string)
if ch != "" {
normed := normChan(ch)
if normed != ch {
snapsup["channel"] = normed
task.Set("snap-setup", snapsup)
}
}
}
// check tasks "old-channel" data
var oldCh string
task.Get("old-channel", &oldCh)
if oldCh != "" {
normed := normChan(oldCh)
if normed != oldCh {
task.Set("old-channel", normed)
}
}
}
return nil
}