Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

o/registrystate: manage accesses to registries #14544

Merged
merged 7 commits into from
Oct 15, 2024
Merged

o/registrystate: manage accesses to registries #14544

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
00b806c
o/registrystate: manage accesses to registries
MiguelPires Sep 26, 2024
8ac66ce
o/registrystate: document Context; other improvements
MiguelPires Oct 2, 2024
895a6b3
Merge branch 'master' into registry-get-tx
MiguelPires Oct 8, 2024
8c2c328
o/registrystate: improve comment, names
MiguelPires Oct 11, 2024
c268103
many: simplify registry access for reads
MiguelPires Oct 11, 2024
6fcf0c8
o/h/ctlcmd: minor improvements
MiguelPires Oct 11, 2024
b250f2b
o/registrystate: return callback from GetStoredTransaction
MiguelPires Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions daemon/api_registry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ func getView(c *Command, r *http.Request, _ *auth.UserState) Response {
fields = strutil.CommaSeparatedList(fieldStr)
}

// TODO: replace access w/ GetTransaction
results, err := registrystateGetViaView(st, account, registryName, view, fields)
if err != nil {
return toAPIError(err)
Expand All @@ -86,6 +87,7 @@ func setView(c *Command, r *http.Request, _ *auth.UserState) Response {
return BadRequest("cannot decode registry request body: %v", err)
}

// TODO: replace w/ GetTransaction + call ctx.Done() then return changeID
err := registrystateSetViaView(st, account, registryName, view, values)
if err != nil {
return toAPIError(err)
Expand Down
10 changes: 10 additions & 0 deletions overlord/hookstate/ctlcmd/export_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ import (
"github.com/snapcore/snapd/client/clientutil"
"github.com/snapcore/snapd/overlord/devicestate"
"github.com/snapcore/snapd/overlord/hookstate"
"github.com/snapcore/snapd/overlord/registrystate"
"github.com/snapcore/snapd/overlord/servicestate"
"github.com/snapcore/snapd/overlord/snapstate"
"github.com/snapcore/snapd/overlord/state"
"github.com/snapcore/snapd/registry"
"github.com/snapcore/snapd/snap"
"github.com/snapcore/snapd/testutil"
)
Expand Down Expand Up @@ -177,3 +179,11 @@ func MockNewStatusDecorator(f func(ctx context.Context, isGlobal bool, uid strin
newStatusDecorator = f
return restore
}

func MockRegistrystateGetTransaction(f func(*registrystate.Context, *state.State, *registry.View) (*registrystate.Transaction, error)) (restore func()) {
old := registrystateGetTransaction
registrystateGetTransaction = f
return func() {
registrystateGetTransaction = old
}
}
5 changes: 4 additions & 1 deletion overlord/hookstate/ctlcmd/get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ import (
"github.com/snapcore/snapd/snap"
)

var registrystateGetTransaction = registrystate.GetTransaction

type getCommand struct {
baseCommand

Expand Down Expand Up @@ -369,7 +371,8 @@ func (c *getCommand) getRegistryValues(ctx *hookstate.Context, plugName string,
return fmt.Errorf("cannot get registry: %v", err)
}

tx, err := registrystate.RegistryTransaction(ctx, view.Registry())
regCtx := registrystate.NewContext(ctx)
tx, err := registrystateGetTransaction(regCtx, ctx.State(), view)
if err != nil {
return err
}
Expand Down
52 changes: 0 additions & 52 deletions overlord/hookstate/ctlcmd/get_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,57 +641,6 @@ func (s *registrySuite) TestRegistryGetNoRequest(c *C) {
c.Check(stderr, IsNil)
}

func (s *registrySuite) TestRegistryGetHappensTransactionally(c *C) {
s.state.Lock()
err := registrystate.SetViaView(s.state, s.devAccID, "network", "write-wifi", map[string]interface{}{
"ssid": "my-ssid",
})
s.state.Unlock()
c.Assert(err, IsNil)

// registry transaction is created when snapctl runs for the first time
stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"get", "--view", ":read-wifi"}, 0)
c.Assert(err, IsNil)
c.Check(string(stdout), Equals, `{
"ssid": "my-ssid"
}
`)
c.Check(stderr, IsNil)

s.state.Lock()
err = registrystate.SetViaView(s.state, s.devAccID, "network", "write-wifi", map[string]interface{}{
"ssid": "other-ssid",
})
s.state.Unlock()
c.Assert(err, IsNil)

// the new write wasn't reflected because it didn't run in the same transaction
stdout, stderr, err = ctlcmd.Run(s.mockContext, []string{"get", "--view", ":read-wifi"}, 0)
c.Assert(err, IsNil)
c.Check(string(stdout), Equals, `{
"ssid": "my-ssid"
}
`)
c.Check(stderr, IsNil)

// make a new context so we get a new transaction
s.state.Lock()
task := s.state.NewTask("test-task", "my test task")
setup := &hookstate.HookSetup{Snap: "test-snap", Revision: snap.R(1), Hook: "test-hook"}
s.mockContext, err = hookstate.NewContext(task, s.state, setup, s.mockHandler, "")
s.state.Unlock()
c.Assert(err, IsNil)

// now we get the new data
stdout, stderr, err = ctlcmd.Run(s.mockContext, []string{"get", "--view", ":read-wifi"}, 0)
c.Assert(err, IsNil)
c.Check(string(stdout), Equals, `{
"ssid": "other-ssid"
}
`)
c.Check(stderr, IsNil)
}

func (s *registrySuite) TestRegistryGetInvalid(c *C) {
type testcase struct {
args []string
Expand Down Expand Up @@ -804,7 +753,6 @@ func (s *registrySuite) TestRegistryGetAndSetAssertionNotFound(c *C) {
c.Assert(err, ErrorMatches, fmt.Sprintf("cannot set registry: registry assertion %s/network not found", s.devAccID))
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

}

func (s *registrySuite) TestRegistryGetAndSetViewNotFound(c *C) {
Expand Down
10 changes: 6 additions & 4 deletions overlord/hookstate/ctlcmd/set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,13 +235,15 @@ func setRegistryValues(ctx *hookstate.Context, plugName string, requests map[str
return fmt.Errorf("cannot set registry: %v", err)
}

tx, err := registrystate.RegistryTransaction(ctx, view.Registry())
if registrystate.IsRegistryHook(ctx) && !strings.HasPrefix(ctx.HookName(), "change-view-") {
return fmt.Errorf("cannot modify registry in %q hook", ctx.HookName())
}

regCtx := registrystate.NewContext(ctx)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we cannot use onDone on regCtx here, so not sure why we don't pass ctx and GetTransaction makes then its Context?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The registrystate.Context is a way to defer the creation of the change or updating of state until the right time. For a registry hook, that might be when it ends. The API will not block but it will trigger it and then get the change (it'll need minor changes for that) and include it in the http response

tx, err := registrystateGetTransaction(regCtx, ctx.State(), view)
if err != nil {
return err
}

// TODO: once we have hooks, check that we don't set values in the wrong hooks
// (e.g., "registry-changed" hooks can only read data)

return registrystate.SetViaViewInTx(tx, view, requests)
}
118 changes: 78 additions & 40 deletions overlord/hookstate/ctlcmd/set_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"github.com/snapcore/snapd/overlord/hookstate/hooktest"
"github.com/snapcore/snapd/overlord/registrystate"
"github.com/snapcore/snapd/overlord/state"
"github.com/snapcore/snapd/registry"
"github.com/snapcore/snapd/snap"
)

Expand Down Expand Up @@ -405,6 +406,16 @@ func (s *setAttrSuite) TestSetCommandFailsOutsideOfValidContext(c *C) {
}

func (s *registrySuite) TestRegistrySetSingleView(c *C) {
s.state.Lock()
tx, err := registrystate.NewTransaction(s.state, s.devAccID, "network")
s.state.Unlock()
c.Assert(err, IsNil)

restore := ctlcmd.MockRegistrystateGetTransaction(func(*registrystate.Context, *state.State, *registry.View) (*registrystate.Transaction, error) {
return tx, nil
})
defer restore()

stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "ssid=other-ssid"}, 0)
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
Expand All @@ -413,56 +424,34 @@ func (s *registrySuite) TestRegistrySetSingleView(c *C) {
c.Assert(s.mockContext.Done(), IsNil)
s.mockContext.Unlock()

s.state.Lock()
val, err := registrystate.GetViaView(s.state, s.devAccID, "network", "read-wifi", []string{"ssid"})
s.state.Unlock()
val, err := tx.Get("wifi.ssid")
c.Assert(err, IsNil)
c.Assert(val, DeepEquals, map[string]interface{}{"ssid": "other-ssid"})
c.Assert(val, DeepEquals, "other-ssid")
}

func (s *registrySuite) TestRegistrySetManyViews(c *C) {
stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "ssid=other-ssid", "password=other-secret"}, 0)
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)
s.mockContext.Lock()
c.Assert(s.mockContext.Done(), IsNil)
s.mockContext.Unlock()

s.state.Lock()
val, err := registrystate.GetViaView(s.state, s.devAccID, "network", "read-wifi", []string{"ssid", "password"})
tx, err := registrystate.NewTransaction(s.state, s.devAccID, "network")
s.state.Unlock()
c.Assert(err, IsNil)
c.Assert(val, DeepEquals, map[string]interface{}{
"ssid": "other-ssid",
"password": "other-secret",

restore := ctlcmd.MockRegistrystateGetTransaction(func(*registrystate.Context, *state.State, *registry.View) (*registrystate.Transaction, error) {
return tx, nil
})
}
defer restore()

func (s *registrySuite) TestRegistrySetHappensTransactionally(c *C) {
// sets values in a transaction
stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "ssid=my-ssid"}, 0)
stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "ssid=other-ssid", "password=other-secret"}, 0)
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

s.state.Lock()
_, err = registrystate.GetViaView(s.state, s.devAccID, "network", "read-wifi", []string{"ssid"})
s.state.Unlock()
c.Assert(err, ErrorMatches, ".*matching rules don't map to any values")

// commit transaction
s.mockContext.Lock()
c.Assert(s.mockContext.Done(), IsNil)
s.mockContext.Unlock()
val, err := tx.Get("wifi.ssid")
c.Assert(err, IsNil)
c.Assert(val, Equals, "other-ssid")

s.state.Lock()
val, err := registrystate.GetViaView(s.state, s.devAccID, "network", "read-wifi", []string{"ssid"})
s.state.Unlock()
val, err = tx.Get("wifi.psk")
c.Assert(err, IsNil)
c.Assert(val, DeepEquals, map[string]interface{}{
"ssid": "my-ssid",
})
c.Assert(val, Equals, "other-secret")
}

func (s *registrySuite) TestRegistrySetInvalid(c *C) {
Expand Down Expand Up @@ -491,21 +480,70 @@ func (s *registrySuite) TestRegistrySetInvalid(c *C) {
}

func (s *registrySuite) TestRegistrySetExclamationMark(c *C) {
stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "ssid=other-ssid", "password=other-secret"}, 0)
s.state.Lock()
tx, err := registrystate.NewTransaction(s.state, s.devAccID, "network")
s.state.Unlock()
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

stdout, stderr, err = ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "password!"}, 0)
err = tx.Set("wifi.ssid", "foo")
c.Assert(err, IsNil)

err = tx.Set("wifi.psk", "bar")
c.Assert(err, IsNil)

restore := ctlcmd.MockRegistrystateGetTransaction(func(*registrystate.Context, *state.State, *registry.View) (*registrystate.Transaction, error) {
return tx, nil
})
defer restore()

stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"set", "--view", ":write-wifi", "password!"}, 0)
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

stdout, stderr, err = ctlcmd.Run(s.mockContext, []string{"get", "--view", ":read-wifi"}, 0)
c.Assert(err, IsNil)
c.Check(string(stdout), Equals, `{
"ssid": "other-ssid"
"ssid": "foo"
}
`)
c.Check(stderr, IsNil)
s.state.Lock()
}

func (s *registrySuite) TestRegistryOnlyChangeViewCanSet(c *C) {
s.state.Lock()
defer s.state.Unlock()
task := s.state.NewTask("run-hook", "")

setup := &hookstate.HookSetup{Snap: "test-snap", Hook: "save-view-plug"}
ctx, err := hookstate.NewContext(task, s.state, setup, s.mockHandler, "")
c.Assert(err, IsNil)

tx, err := registrystate.NewTransaction(s.state, s.devAccID, "network")
c.Assert(err, IsNil)

restore := ctlcmd.MockRegistrystateGetTransaction(func(*registrystate.Context, *state.State, *registry.View) (*registrystate.Transaction, error) {
return tx, nil
})
defer restore()

s.state.Unlock()
stdout, stderr, err := ctlcmd.Run(ctx, []string{"set", "--view", ":write-wifi", "password=thing"}, 0)
s.state.Lock()
c.Assert(err, ErrorMatches, `cannot modify registry in "save-view-plug" hook`)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

setup.Hook = "change-view-plug"
ctx, err = hookstate.NewContext(task, s.state, setup, s.mockHandler, "")
c.Assert(err, IsNil)

s.state.Unlock()
stdout, stderr, err = ctlcmd.Run(ctx, []string{"set", "--view", ":write-wifi", "password=thing"}, 0)
s.state.Lock()
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

}
47 changes: 13 additions & 34 deletions overlord/hookstate/ctlcmd/unset_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
"github.com/snapcore/snapd/overlord/hookstate/hooktest"
"github.com/snapcore/snapd/overlord/registrystate"
"github.com/snapcore/snapd/overlord/state"
"github.com/snapcore/snapd/registry"
"github.com/snapcore/snapd/snap"
)

Expand Down Expand Up @@ -164,52 +165,30 @@ func (s *unsetSuite) TestCommandWithoutContext(c *C) {

func (s *registrySuite) TestRegistryUnsetManyViews(c *C) {
s.state.Lock()
err := registrystate.SetViaView(s.state, s.devAccID, "network", "write-wifi", map[string]interface{}{"ssid": "my-ssid", "password": "my-secret"})
tx, err := registrystate.NewTransaction(s.state, s.devAccID, "network")
s.state.Unlock()
c.Assert(err, IsNil)

stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"unset", "--view", ":write-wifi", "ssid", "password"}, 0)
err = tx.Set("wifi.ssid", "foo")
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)
s.mockContext.Lock()
c.Assert(s.mockContext.Done(), IsNil)
s.mockContext.Unlock()

s.state.Lock()
_, err = registrystate.GetViaView(s.state, s.devAccID, "network", "write-wifi", []string{"ssid", "password"})
s.state.Unlock()
c.Assert(err, ErrorMatches, `cannot get "ssid", "password" .*: matching rules don't map to any values`)
}

func (s *registrySuite) TestRegistryUnsetHappensTransactionally(c *C) {
s.state.Lock()
err := registrystate.SetViaView(s.state, s.devAccID, "network", "write-wifi", map[string]interface{}{"ssid": "my-ssid"})
s.state.Unlock()
err = tx.Set("wifi.psk", "bar")
c.Assert(err, IsNil)

stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"unset", "--view", ":write-wifi", "ssid"}, 0)
ctlcmd.MockRegistrystateGetTransaction(func(*registrystate.Context, *state.State, *registry.View) (*registrystate.Transaction, error) {
return tx, nil
})

stdout, stderr, err := ctlcmd.Run(s.mockContext, []string{"unset", "--view", ":write-wifi", "ssid", "password"}, 0)
c.Assert(err, IsNil)
c.Check(stdout, IsNil)
c.Check(stderr, IsNil)

s.state.Lock()
val, err := registrystate.GetViaView(s.state, s.devAccID, "network", "read-wifi", []string{"ssid"})
s.state.Unlock()
c.Assert(err, IsNil)
c.Assert(val, DeepEquals, map[string]interface{}{
"ssid": "my-ssid",
})

// commit transaction
s.mockContext.Lock()
c.Assert(s.mockContext.Done(), IsNil)
s.mockContext.Unlock()
_, err = tx.Get("wifi.ssid")
c.Assert(err, ErrorMatches, `no value was found under path "wifi.ssid"`)

s.state.Lock()
_, err = registrystate.GetViaView(s.state, s.devAccID, "network", "read-wifi", []string{"ssid"})
s.state.Unlock()
c.Assert(err, ErrorMatches, `cannot get "ssid" .*: matching rules don't map to any values`)
_, err = tx.Get("wifi.psk")
c.Assert(err, ErrorMatches, `no value was found under path "wifi.psk"`)
}

func (s *registrySuite) TestRegistryUnsetInvalid(c *C) {
Expand Down
Loading
Loading