Skip to content

Commit

Permalink
Rename refresh hook to post-refresh.
Browse files Browse the repository at this point in the history
  • Loading branch information
stolowski authored and mvo5 committed Sep 27, 2017
1 parent 78c90fa commit 3f8ea6a
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion overlord/hookstate/hookmgr.go
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ func (m *HookManager) doRunHook(task *state.Task, tomb *tomb.Tomb) error {
if handlersCount == 0 {
// Do not report error if hook handler doesn't exist as long as the hook is optional.
// This is to avoid issues when downgrading to an old core snap that doesn't know about
// particular hook type and a task for it exists (e.g. "after-refresh" hook).
// particular hook type and a task for it exists (e.g. "post-refresh" hook).
if hooksup.Optional {
return nil
}
Expand Down
10 changes: 5 additions & 5 deletions overlord/hookstate/hooks.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import (

func init() {
snapstate.SetupInstallHook = SetupInstallHook
snapstate.SetupAfterRefreshHook = SetupAfterRefreshHook
snapstate.SetupPostRefreshHook = SetupPostRefreshHook
snapstate.SetupRemoveHook = SetupRemoveHook
}

Expand All @@ -45,14 +45,14 @@ func SetupInstallHook(st *state.State, snapName string) *state.Task {
return task
}

func SetupAfterRefreshHook(st *state.State, snapName string) *state.Task {
func SetupPostRefreshHook(st *state.State, snapName string) *state.Task {
hooksup := &HookSetup{
Snap: snapName,
Hook: "after-refresh",
Hook: "post-refresh",
Optional: true,
}

summary := fmt.Sprintf(i18n.G("Run after-refresh hook of %q snap if present"), hooksup.Snap)
summary := fmt.Sprintf(i18n.G("Run post-refresh hook of %q snap if present"), hooksup.Snap)
task := HookTask(st, summary, hooksup, nil)

return task
Expand Down Expand Up @@ -93,6 +93,6 @@ func setupHooks(hookMgr *HookManager) {
}

hookMgr.Register(regexp.MustCompile("^install$"), handlerGenerator)
hookMgr.Register(regexp.MustCompile("^after-refresh$"), handlerGenerator)
hookMgr.Register(regexp.MustCompile("^post-refresh$"), handlerGenerator)
hookMgr.Register(regexp.MustCompile("^remove$"), handlerGenerator)
}
6 changes: 3 additions & 3 deletions overlord/snapstate/snapstate.go
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ func doInstall(st *state.State, snapst *SnapState, snapsup *SnapSetup, flags int

// run refresh hook when updating existing snap, otherwise run install hook
if snapst.IsInstalled() && !snapsup.Flags.Revert {
refreshHook := SetupAfterRefreshHook(st, snapsup.Name())
refreshHook := SetupPostRefreshHook(st, snapsup.Name())
addTask(refreshHook)
prev = refreshHook
}
Expand Down Expand Up @@ -275,8 +275,8 @@ var SetupInstallHook = func(st *state.State, snapName string) *state.Task {
panic("internal error: snapstate.SetupInstallHook is unset")
}

var SetupAfterRefreshHook = func(st *state.State, snapName string) *state.Task {
panic("internal error: snapstate.SetupAfterRefreshHook is unset")
var SetupPostRefreshHook = func(st *state.State, snapName string) *state.Task {
panic("internal error: snapstate.SetupPostRefreshHook is unset")
}

var SetupRemoveHook = func(st *state.State, snapName string) *state.Task {
Expand Down
16 changes: 8 additions & 8 deletions overlord/snapstate/snapstate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ func (s *snapmgrTestSuite) SetUpTest(c *C) {
}

oldSetupInstallHook := snapstate.SetupInstallHook
oldSetupAfterRefreshHook := snapstate.SetupAfterRefreshHook
oldSetupPostRefreshHook := snapstate.SetupPostRefreshHook
oldSetupRemoveHook := snapstate.SetupRemoveHook
snapstate.SetupInstallHook = hookstate.SetupInstallHook
snapstate.SetupAfterRefreshHook = hookstate.SetupAfterRefreshHook
snapstate.SetupPostRefreshHook = hookstate.SetupPostRefreshHook
snapstate.SetupRemoveHook = hookstate.SetupRemoveHook

var err error
Expand All @@ -109,7 +109,7 @@ func (s *snapmgrTestSuite) SetUpTest(c *C) {

s.reset = func() {
snapstate.SetupInstallHook = oldSetupInstallHook
snapstate.SetupAfterRefreshHook = oldSetupAfterRefreshHook
snapstate.SetupPostRefreshHook = oldSetupPostRefreshHook
snapstate.SetupRemoveHook = oldSetupRemoveHook

restore2()
Expand Down Expand Up @@ -243,10 +243,10 @@ func verifyUpdateTasks(c *C, opts, discards int, ts *state.TaskSet, st *state.St
expected = append(expected,
"set-auto-aliases",
"setup-aliases",
"run-hook[after-refresh]",
"run-hook[post-refresh]",
"start-snap-services")

c.Assert(ts.Tasks()[len(expected)-2].Summary(), Matches, `Run after-refresh hook of .*`)
c.Assert(ts.Tasks()[len(expected)-2].Summary(), Matches, `Run post-refresh hook of .*`)
for i := 0; i < discards; i++ {
expected = append(expected,
"clear-snap",
Expand Down Expand Up @@ -397,7 +397,7 @@ version: 1.0`)
runHooks := tasksWithKind(ts, "run-hook")
// hook tasks for refresh and for configure hook only; no install hook
c.Assert(runHooks, HasLen, 2)
c.Assert(runHooks[0].Summary(), Equals, `Run after-refresh hook of "some-snap" snap if present`)
c.Assert(runHooks[0].Summary(), Equals, `Run post-refresh hook of "some-snap" snap if present`)
c.Assert(runHooks[1].Summary(), Equals, `Run configure hook of "some-snap" snap if present`)
}

Expand Down Expand Up @@ -1692,10 +1692,10 @@ func (s *snapmgrTestSuite) TestUpdateRunThrough(c *C) {
SnapID: "services-snap-id",
})

// check after-refresh hook
// check post-refresh hook
task = ts.Tasks()[11]
c.Assert(task.Kind(), Equals, "run-hook")
c.Assert(task.Summary(), Matches, `Run after-refresh hook of "services-snap" snap if present`)
c.Assert(task.Summary(), Matches, `Run post-refresh hook of "services-snap" snap if present`)

// verify snaps in the system state
var snapst snapstate.SnapState
Expand Down
2 changes: 1 addition & 1 deletion snap/hooktypes.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var supportedHooks = []*HookType{
newHookType(regexp.MustCompile("^prepare-device$")),
newHookType(regexp.MustCompile("^configure$")),
newHookType(regexp.MustCompile("^install$")),
newHookType(regexp.MustCompile("^after-refresh$")),
newHookType(regexp.MustCompile("^post-refresh$")),
newHookType(regexp.MustCompile("^remove$")),
newHookType(regexp.MustCompile("^prepare-(?:plug|slot)-[-a-z0-9]+$")),
newHookType(regexp.MustCompile("^connect-(?:plug|slot)-[-a-z0-9]+$")),
Expand Down
4 changes: 2 additions & 2 deletions tests/main/install-hook/task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ execute: |
snap get snap-hooks installed | MATCH 1
snap get snap-hooks foo | MATCH bar
echo "Verify that after-refresh hook was not executed"
echo "Verify that post-refresh hook was not executed"
if snap get snap-install-hooks refreshed; then
echo "'refreshed' config value not expected on first install"
exit 1
Expand All @@ -25,7 +25,7 @@ execute: |
install_local snap-hooks
snap get snap-hooks installed | MATCH 2
echo "Verify that after-refresh hook was executed"
echo "Verify that post-refresh hook was executed"
snap get snap-hooks refreshed | MATCH 1
snap connect snap-hooks:home
Expand Down

0 comments on commit 3f8ea6a

Please sign in to comment.