many: fix test cases to work with different DistroLibExecDir #3222

morphis · 2017-04-24T10:55:41Z

This is needed to allow execution of our unit tests within the package build on other distributions like Fedora.

zyga

Just quick comments. I'll read more soon

zyga · 2017-04-24T11:58:20Z

cmd/cmd.go

@@ -90,7 +91,7 @@ func ExecInCoreSnap() {
 	// ensure we do not re-exec into an older version of snapd, look
 	// for info file and ignore version of core that do not yet have
 	// it
-	fullInfo := filepath.Join(corePath, "/usr/lib/snapd/info")


Wait, this feels wrong. If core path is the path where core is mounted the rest of the string can be a constant because it's not depending on the distribution anymore.

I will look into this again. However all tests except refresh-delta-from-core on Ubuntu 14.04 seem to pass. However for Fedora/SUSE/Arch/... this might fail. We really need CI for all of these.

This looks correct now.

Wait, this is not what I expected (the diff looked different before). So on Fedora the core path is /var/lib/snapd/snap/core/current/ but then the dirs.DistroLibExecDir will contain /usr/libexec/snapd, I don't understand how this is supposed to work.

@zyga Please note that the code now uses dirs.CoreLibExecDir which will expand to /usr/lib/snapd even on Fedora. A previous version of the code was using dirs.DistroLibExecDir which is, as you pointed out, wrong.

In summary: The new code filepath.Join(corePath, dirs.CoreLibExecDir, "info") will take the corePath as determined before through /proc/self/exe and append dirs.CoreLibExecDir so that we end up with /snap/core/current/usr/libexec/snapd/info on Ubuntu and /var/lib/snapd/snap/core/current/usr/libexec/snapd/info

zyga · 2017-04-24T12:00:40Z

cmd/snap/cmd_run_test.go

@@ -449,8 +450,8 @@ func (s *SnapSuite) TestSnapRunIsReexeced(c *check.C) {
 		readlink string
 		expected bool
 	}{
-		{filepath.Join(dirs.SnapMountDir, "/usr/lib/snapd/snapd"), true},
-		{"/usr/lib/snapd/snapd", false},
+		{filepath.Join(dirs.SnapMountDir, dirs.DistroLibExecDir, "snapd"), true},


Again, isn't this constant?

For now yes, but when we have switch to different core/base snaps it may not. Using dirs.CoreLibExecDir here now.

using CoreLibExecDir is fine. For core/base split I don't know how it will work yet so it's hard to say.

zyga · 2017-04-25T11:25:40Z

cmd/cmd.go

@@ -90,7 +91,7 @@ func ExecInCoreSnap() {
 	// ensure we do not re-exec into an older version of snapd, look
 	// for info file and ignore version of core that do not yet have
 	// it
-	fullInfo := filepath.Join(corePath, "/usr/lib/snapd/info")


This looks correct now.

zyga · 2017-04-25T11:26:56Z

cmd/snap/main_test.go

-func mockSnapConfine() func() {
-	snapConfine := filepath.Join(dirs.DistroLibExecDir, "snap-confine")
-	if err := os.MkdirAll(dirs.DistroLibExecDir, 0755); err != nil {
+func mockSnapConfine(reexec bool) func() {


Just nitpick. I'd prefer a flag like ReExecEnabled or something similar. The false/true that is in tests above is hard to grok just by looking.

Let me change that.

Or even simpler, pass libExecDir as a parameter.

Using libExecDir now.

niemeyer · 2017-04-26T11:53:50Z

cmd/snap/cmd_run.go

@@ -228,7 +228,11 @@ func isReexeced() bool {
 }

 func runSnapConfine(info *snap.Info, securityTag, snapApp, command, hook string, args []string) error {
-	snapConfine := filepath.Join(dirs.DistroLibExecDir, "snap-confine")
+	libExecDir := dirs.DistroLibExecDir
+	if isReexeced() {


This should be done only once in this function. Right now it's being done twice, and it's also bogus because code right below will test for a path that does not exist. Proper way is likely to bring the code currently at the bottom here, and make sure snapConfine points to the proper thing upfront.

Reworked the logic a bit.

niemeyer · 2017-04-26T11:55:42Z

cmd/snap/main_test.go

-func mockSnapConfine() func() {
-	snapConfine := filepath.Join(dirs.DistroLibExecDir, "snap-confine")
-	if err := os.MkdirAll(dirs.DistroLibExecDir, 0755); err != nil {
+func mockSnapConfine(reexec bool) func() {


Or even simpler, pass libExecDir as a parameter.

Conan-Kudo · 2017-04-27T10:11:41Z

I'm confused... Why are so many things changing from DistroLibExecDir to CoreLibExecDir? That seems to indicate it'd be running/testing a completely different/wrong thing...

morphis · 2017-04-27T10:18:59Z

@Conan-Kudo Many of the changes are for paths are in the code path for the re-execution feature which never worked on Fedora/Suse. So you never saw anything going wrong. This PR fixes those cases and brings us a bit closer to working re-execution too.

mvo5 · 2017-04-27T10:47:45Z

Looks good, but some review comments (like #3222 (comment) are not addressed yet)

morphis · 2017-04-27T12:06:19Z

Fixed all review comments and rebased on latest master

mvo5 · 2017-04-27T15:21:53Z

Some unit test failures, e.g. https://travis-ci.org/snapcore/snapd/builds/226369117#L2580

morphis · 2017-04-28T10:00:19Z

@mvo5 Pushed a change to fix the failing unit tests.

zyga · 2017-05-05T09:48:41Z

interfaces/builtin/content_test.go

@@ -195,11 +199,11 @@ apps:

 func (s *ContentSuite) TestResolveSpecialVariable(c *C) {
 	info := snaptest.MockInfo(c, "name: name", &snap.SideInfo{Revision: snap.R(42)})
-	c.Check(builtin.ResolveSpecialVariable("foo", info), Equals, "/snap/name/42/foo")


Sorry for taking so long to verify this. This part is incorrect. The generated mount profile is only processed after pivot_root has happened so it must use the internal layout.

How that? On Debian & Ubuntu we have /snap and on Fedora we have /var/lib/snapd/snap in and outside of the snap or do I miss anything?

You are missing one thing. After pivot_root whatever the snap mount directory is it ends up being /snap. Only then do we process those mount directives so the hard-coded paths are actually always correct.

Running the following

$ snap run --shell hello-world bash-4.3$ echo $SNAP /var/lib/snapd/snap/hello-world/27

Please also note that I didn't change builting.ResolveSpecialVariable. It is using dirs.BaseSnapMountDir already without this PR. See https://github.com/snapcore/snapd/blob/master/interfaces/builtin/content.go#L123

As discussed on IRC there are a host of bugs here:

snap execution environment should look the same everywhere

$SNAP is always /snap/$SNAP_NAME/$SNAP_REVISION when seen from inside snap execution environment

various other things are wrong but we'll discuss and fix them in separate PRs

The code is now changed to use /snap as static prefix.

Silly question - if the code got changed to use /snap as static prefix, do we still need to change:

- "/snap/foo" + filepath.Join(dirs.CoreSnapMountDir, "foo")

I guess the answer is yes to make it more obvious when we mean "context-is-inside-core" and "context-is-outside"(?)

I would say, we should do it this way, With that we always have a clear bind to the context and know what we're dealing with.

zyga · 2017-05-05T10:48:06Z

tests/unit/go/task.yaml


 execute: |
    mkdir -p /tmp/unit-tests/src/github.com/snapcore
    cp -ar $PROJECT_PATH /tmp/unit-tests/src/github.com/snapcore
    chown -R test:12345 /tmp/unit-tests
    su -l -c "cd /tmp/unit-tests/src/github.com/snapcore/snapd && GOPATH=/tmp/unit-tests ./run-checks --unit" test
+
+    mv /etc/os-release /etc/os-release.orig


This is more of a prepare: stage to me but the actual section looks curious. Is this intentional?

Fixed and reworked the test case a bit more.

niemeyer · 2017-05-10T17:26:53Z

dirs/dirs.go

@@ -126,9 +128,11 @@ func SetRootDir(rootdir string) {

 	switch release.ReleaseInfo.ID {
 	case "fedora", "centos", "rhel", "arch":
-		SnapMountDir = filepath.Join(rootdir, "/var/lib/snapd/snap")
+		BaseSnapMountDir = "/var/lib/snapd/snap"


We can't use the "BaseSnap" term here, even more when we have a matching variable with "CoreSnap". Base snaps are around the block and this is unrelated.

HostSnapMountDir would make more sense, ne?

HostSnapMountDir still has a notion of not saying that it is absolute or not. BaseSnapMountDir was my attempt to word that. What about RawSnapMountDir?

That makes it Raw, except other things raw are not Raw. Still pretty misleading and error prone. Not to mention "raw" doesn't really say much in this context.

See the suggestion in the other point.

niemeyer · 2017-05-10T17:27:34Z

dirs/dirs.go

@@ -179,7 +183,8 @@ func SetRootDir(rootdir string) {
 		DistroLibExecDir = filepath.Join(rootdir, "/usr/lib/snapd")
 	}

-	CoreLibExecDir = filepath.Join(rootdir, "/usr/lib/snapd")
+	CoreLibExecDir = "/usr/lib/snapd"
+	CoreSnapMountDir = "/snap"


What's the line for deciding what has a prefix or not? Why do we have BaseSnapMountDir with rootdir, but the ones above not? Hard to guess on call sites, which makes it quite error prone.

We need a variable which has just the clean mount dir without the root prefix as otherwise we end up with something $prefix/$prefix/$snapmountdir in the unit tests. See https://github.com/snapcore/snapd/pull/3222/files#diff-76f691a17e89c1330742e51bb468ef76R203 as an example. The only place where it is ever being used are unit tests. I can move these variables into test code and keep it away from dirs/dirs.go but actually it would be nice to keep these things in a central place.

Also CoreLibExecDir/CoreSnapMountDir are needed as these describe where in the core snap those directories are located. These are different on Fedora than the outside SnapMountDir/LibExecDir so we have to keep them distinct.

if a unit test tries to write to those Core* dirs missing the rootdir will creates errors

The unit test doesn't try to write into those dirs. They are used for example in the content interface where we check if the mount entries generated are ok. @zyga told me that those should never use SnapMountDir (which might be prefixed) but the mount dir without any prefix so /snap on Ubuntu and /var/lib/snapd/snap on Fedora.

I suggest keeping the rootdir as originally, and stripping GlobalRootDir out of it when really needed. That makes it consistent.

@niemeyer Doing that now. Please have another look.

pedronis · 2017-05-11T12:41:23Z

dirs/dirs.go

+	// CoreLibExecDir is similar to CoreSnapMountDir but for the
+	// LibExecDir used by snapd.
+	CoreLibExecDir            string
+	DistroLibExecDir          string
 	SnapBlobDir               string


we probably want a newline to separate things here

Will add one.

…as used

codecov-io · 2017-05-17T13:48:25Z

Codecov Report

Merging #3222 into master will decrease coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #3222      +/-   ##
==========================================
- Coverage   77.16%   77.15%   -0.01%     
==========================================
  Files         373      373              
  Lines       25793    25792       -1     
==========================================
- Hits        19902    19900       -2     
  Misses       4134     4134              
- Partials     1757     1758       +1

Impacted Files	Coverage Δ
dirs/dirs.go	`96.77% <ø> (-0.06%)`	⬇️
cmd/snap/cmd_run.go	`64.51% <100%> (ø)`	⬆️
interfaces/builtin/content.go	`80.73% <100%> (ø)`	⬆️
cmd/cmd.go	`100% <100%> (ø)`	⬆️
overlord/snapstate/snapstate.go	`81.28% <0%> (-0.24%)`	⬇️
overlord/ifacestate/helpers.go	`65.54% <0%> (ø)`	⬆️
interfaces/sorting.go	`96.66% <0%> (+3.33%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1495246...999789f. Read the comment docs.

zyga · 2017-05-19T11:51:36Z

dirs/dirs.go

+	SnapMountDir string
+
+	// CoreSnapMountDir is the path of the snap mount dir inside
+	// the snap confinement environment. Give this nature it will


Given its nature maybe?

zyga

My head hurts with all the new snap variables everywhere. LGTM

zyga · 2017-05-19T11:52:30Z

dirs/dirs.go

+	// These are directories which are static inside the core snap and
+	// can never be prefixed as they will be always absolute once we
+	// are in the snap confinement environment.
+	CoreLibExecDir = "/usr/lib/snapd"


Why don't we const those?

zyga · 2017-05-19T11:54:29Z

interfaces/builtin/content.go

@@ -116,13 +117,23 @@ func (iface *contentInterface) path(slot *interfaces.Slot, name string) []string
 	return out
 }

+const (


This would feel better with a dedicated type.

zyga · 2017-05-19T12:17:40Z

interfaces/builtin/content.go

+const (
+	SnapMountDir = iota
+	SnapDataDir
+	SnapCommonDir


Wait, are those even used?

Hm, they aren't. Seems to be a leftover. Good spot!

Drop these now.

…-in-tests

morphis · 2017-05-23T13:21:27Z

@pedronis @zyga @Conan-Kudo @niemeyer Can you have another look so we get this reviewed and merged soon?

…-in-tests

mvo5

Looks good, some comments inline. I am in favour of merging even if imperfect and do a followup to ease the burden of fixing this branch, it has a lot of conflicts potential.

mvo5 · 2017-06-07T08:49:55Z

cmd/snap/cmd_run_test.go

@@ -98,7 +98,7 @@ func (s *SnapSuite) TestSnapRunAppIntegration(c *check.C) {
 	// mock installed snap
 	dirs.SetRootDir(c.MkDir())
 	defer func() { dirs.SetRootDir("/") }()
-	defer mockSnapConfine()()
+	defer mockSnapConfine(dirs.DistroLibExecDir)()


Pardon my ignorance, but it looks like the argument for mockSnapConfine() is always dirs.DistroLibExecDir - do we really need this new argument in this case?

There is exactly one case where it isn't. See https://github.com/snapcore/snapd/pull/3222/files/f78d7918f26f71239000599fd11db988cd605cc0#diff-78f744cbc3eb83652f8ed773dceac016R466

Aha, silly me. I even found this in subsequent reading but then forgot to delete the comment. Sorry for the noise.

mvo5 · 2017-06-07T08:51:10Z

cmd/snap/cmd_run_test.go

-		{filepath.Join(dirs.SnapMountDir, "/usr/lib/snapd/snapd"), true},
-		{"/usr/lib/snapd/snapd", false},
+		{filepath.Join(dirs.SnapMountDir, dirs.CoreLibExecDir, "snapd"), true},
+		{fmt.Sprintf("%s/snapd", dirs.DistroLibExecDir), false},


filepath.Join() is probably more natural here

mvo5 · 2017-06-07T08:56:09Z

interfaces/builtin/content_test.go

@@ -195,11 +199,11 @@ apps:

 func (s *ContentSuite) TestResolveSpecialVariable(c *C) {
 	info := snaptest.MockInfo(c, "name: name", &snap.SideInfo{Revision: snap.R(42)})
-	c.Check(builtin.ResolveSpecialVariable("foo", info), Equals, "/snap/name/42/foo")


Silly question - if the code got changed to use /snap as static prefix, do we still need to change:

- "/snap/foo" + filepath.Join(dirs.CoreSnapMountDir, "foo")

I guess the answer is yes to make it more obvious when we mean "context-is-inside-core" and "context-is-outside"(?)

mvo5 · 2017-06-07T09:00:50Z

overlord/snapstate/snapstate_test.go

@@ -2689,7 +2719,7 @@ version: 1.0`)
 		{
 			// ensure only local install was run, i.e. first action is pseudo-action current
 			op:  "current",
-			old: "/snap/mock/100001",
+			old: filepath.Join(dirs.StripRootDir(dirs.SnapMountDir), "mock/100001"),


This feels a bit repetitive and relatively long, I wonder if we could compute the dirs only once at the beginning of the test. OTOH it was repetitive before so maybe that is something for a later branch.

+1 (change + later branch)

mvo5 · 2017-06-07T09:02:37Z

overlord/snapstate/snapstate_test.go

@@ -4987,6 +5017,9 @@ func (s *snapmgrTestSuite) TestTrySetsTryModeJailMode(c *C) {
 	s.testTrySetsTryMode(snapstate.Flags{JailMode: true}, c)
 }
 func (s *snapmgrTestSuite) TestTrySetsTryModeClassic(c *C) {
+	if !dirs.SupportsClassicConfinement() {


Would it be possible to move everything that needs classic confinement into a single snapmgrWithClassicConfinementTestSuite and simply skip the entire suite on the above condition?

Not sure, something I would have to look into but would prefer to do it with a follow up PR to not put more burden on this one.

mvo5 · 2017-06-07T09:03:48Z

overlord/snapstate/snapstate_test.go

@@ -5046,6 +5082,9 @@ func (s *snapmgrTestSuite) TestTryUndoRemovesTryFlagLeavesJailMode(c *C) {
 	s.testTrySetsTryMode(snapstate.Flags{JailMode: true}, c)
 }
 func (s *snapmgrTestSuite) TestTryUndoRemovesTryFlagLeavesClassic(c *C) {
+	if !dirs.SupportsClassicConfinement() {


Slightly strange that SupportsClassicConfinement() is a member of dirs - I understand why but still feels wrong. Anyway, not something to be concerned about for this branch.

…-in-tests

niemeyer

LGTM assuming it drops the function mentioned below.

niemeyer · 2017-06-12T18:52:28Z

snap/info.go

+}
+
+// MountDirWithBasePath returns the base directory where it gets mounted of the snap with the given name and revision.
+func MountDirWithBasePath(basePath, name string, revision Revision) string {


Let's please drop this function. We don't need a special (and long) name for filepath.Join. :-)

…-in-tests

zyga reviewed Apr 24, 2017

View reviewed changes

morphis force-pushed the f/dynamic-mount-dir-in-tests branch from 5f64f6c to 417b113 Compare April 25, 2017 06:17

zyga reviewed Apr 25, 2017

View reviewed changes

niemeyer requested changes Apr 26, 2017

View reviewed changes

morphis force-pushed the f/dynamic-mount-dir-in-tests branch from 417b113 to 8c30864 Compare April 27, 2017 12:05

morphis force-pushed the f/dynamic-mount-dir-in-tests branch from 1d1612e to 76d7ec3 Compare April 28, 2017 09:59

zyga requested changes May 5, 2017

View reviewed changes

zyga reviewed May 5, 2017

View reviewed changes

morphis force-pushed the f/dynamic-mount-dir-in-tests branch 8 times, most recently from 448507e to fe8cb4f Compare May 10, 2017 04:50

niemeyer requested changes May 10, 2017

View reviewed changes

morphis force-pushed the f/dynamic-mount-dir-in-tests branch from 9d17651 to b22a99f Compare May 11, 2017 09:32

pedronis reviewed May 11, 2017

View reviewed changes

morphis force-pushed the f/dynamic-mount-dir-in-tests branch 4 times, most recently from dc66df4 to 003c870 Compare May 15, 2017 10:08

many: fix test cases to work with different DistroLibExecDir

0281474

morphis added 6 commits May 17, 2017 14:50

interfaces/builtin: always use /snap for the content interface

2c626ed

tests: reload systemd units on reset

88adec0

many: change BaseSnapMountDir to RawSnapMountDir and add documentation

10612e6

interfaces/builtin: fix another case where the wrong snap mount dir w…

ceb483f

…as used

dirs: add a few new lines to separate things visually

2f3b287

dirs,overlord: drop RawSnapMountDir and strip prefix instead

9b771dd

morphis force-pushed the f/dynamic-mount-dir-in-tests branch from 003c870 to 9b771dd Compare May 17, 2017 12:51

zyga reviewed May 19, 2017

View reviewed changes

morphis added 4 commits May 19, 2017 14:38

interfaces/builtin: drop unused constants

97cde96

Merge remote-tracking branch 'origin/master' into f/dynamic-mount-dir…

f0969ab

…-in-tests

Merge remote-tracking branch 'origin/master' into f/dynamic-mount-dir…

9e05477

…-in-tests

dirs: make CoreSnapMountDir and CoreLibExecDir const

94cc0e1

Merge remote-tracking branch 'origin/master' into f/dynamic-mount-dir…

f78d791

…-in-tests

mvo5 reviewed Jun 7, 2017

View reviewed changes

morphis added 2 commits June 7, 2017 15:35

Merge remote-tracking branch 'origin/master' into f/dynamic-mount-dir…

a004317

…-in-tests

cmd/snap: use filepath.Join instead of fmt.Sprintf

69bc196

mvo5 approved these changes Jun 7, 2017

View reviewed changes

Conan-Kudo approved these changes Jun 7, 2017

View reviewed changes

niemeyer approved these changes Jun 12, 2017

View reviewed changes

zyga approved these changes Jun 12, 2017

View reviewed changes

morphis added 4 commits June 14, 2017 10:08

Merge remote-tracking branch 'origin/master' into f/dynamic-mount-dir…

5cecbe2

…-in-tests

Merge remote-tracking branch 'origin/master' into f/dynamic-mount-dir…

8967f3a

…-in-tests

Drop MountDirWithBasePath as requested

cea541b

Convert revision to string

999789f

morphis force-pushed the f/dynamic-mount-dir-in-tests branch from 1f78b74 to 999789f Compare June 19, 2017 08:01

mvo5 merged commit 0719d6b into snapcore:master Jun 19, 2017

many: fix test cases to work with different DistroLibExecDir #3222

many: fix test cases to work with different DistroLibExecDir #3222

Conversation

morphis commented Apr 24, 2017 • edited

zyga left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morphis Apr 24, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Conan-Kudo commented Apr 27, 2017

morphis commented Apr 27, 2017

mvo5 commented Apr 27, 2017

morphis commented Apr 27, 2017

mvo5 commented Apr 27, 2017

morphis commented Apr 28, 2017

Choose a reason for hiding this comment

morphis May 5, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morphis May 11, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented May 17, 2017 • edited

Codecov Report

Choose a reason for hiding this comment

zyga left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morphis commented May 23, 2017

mvo5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

niemeyer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

morphis commented Apr 24, 2017 •

edited

morphis Apr 24, 2017 •

edited

morphis May 5, 2017 •

edited

morphis May 11, 2017 •

edited

codecov-io commented May 17, 2017 •

edited