create: add support for --bundle and --pid-file

[dfr]

Issue number:
#26

Description of changes:
This adds the commonly used --bundle and --pid-file options to create, while preserving the existing support for supplying the bundle path as a positional argument. With this, I was able to get my experimental freebsd port of buildah to use runj as its OCI runtime.

Testing done:
Adhoc testing with my hacked buildah, also testing that the containerd shim still works with this change

Terms of contribution:
By submitting this pull request, I agree that this contribution is licensed under the terms found in the LICENSE file.

[dfr]

I think the failing check is a problem with CI, not with this change:

make
go build -o bin/runj ./cmd/runj
go: missing Git command. See https://golang.org/s/gogetcmd
error obtaining VCS status: exec: "git": executable file not found in $PATH
	Use -buildvcs=false to disable VCS stamping.

[emaste]

I opened #28 to fix CI

[emaste]

When I try this branch in CI with #28 applied I get

=== RUN   TestRenderConfigBasic
    conf_test.go:19: 
        	Error Trace:	conf_test.go:19
        	Error:      	Not equal: 
        	            	expected: "basic {\n  path = \"/tmp/test/basic/root\";\n  persist;\n}\n"
        	            	actual  : "basic {\n  path = \"/tmp/test/basic/root\";\n  ip4 = inherit;\n  ip6 = inherit;\n  allow.raw_sockets;\n  persist;\n}\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -2,2 +2,5 @@
        	            	   path = "/tmp/test/basic/root";
        	            	+  ip4 = inherit;
        	            	+  ip6 = inherit;
        	            	+  allow.raw_sockets;
        	            	   persist;
        	Test:       	TestRenderConfigBasic
--- FAIL: TestRenderConfigBasic (0.00s)
FAIL
FAIL	go.sbk.wtf/runj/jail	0.007s
?   	go.sbk.wtf/runj/oci	[no test files]
?   	go.sbk.wtf/runj/runtimespec	[no test files]
?   	go.sbk.wtf/runj/state	[no test files]
FAIL
*** Error code 1

[dfr]

This is due to the hacks I added to support networking. I’ll rearrange things so that this part is in a different branch so that the PR is cleaner. When Sam is back from holiday, I think it’s time to start brainstorming FreeBSD extension to the spec.

…

On Thu, 5 May 2022 at 19:01, Ed Maste ***@***.***> wrote: When I try this branch in CI with #28 <#28> applied I get === RUN TestRenderConfigBasic conf_test.go:19: Error Trace: conf_test.go:19 Error: Not equal: expected: "basic {\n path = \"/tmp/test/basic/root\";\n persist;\n}\n" actual : "basic {\n path = \"/tmp/test/basic/root\";\n ip4 = inherit;\n ip6 = inherit;\n allow.raw_sockets;\n persist;\n}\n" Diff: --- Expected +++ Actual @@ -2,2 +2,5 @@ path = "/tmp/test/basic/root"; + ip4 = inherit; + ip6 = inherit; + allow.raw_sockets; persist; Test: TestRenderConfigBasic --- FAIL: TestRenderConfigBasic (0.00s) FAIL FAIL go.sbk.wtf/runj/jail 0.007s ? go.sbk.wtf/runj/oci [no test files] ? go.sbk.wtf/runj/runtimespec [no test files] ? go.sbk.wtf/runj/state [no test files] FAIL *** Error code 1 — Reply to this email directly, view it on GitHub <#27 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABOTJJJI24XTC6RTY2RW43VIQEI3ANCNFSM5UE3JFDQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[dfr]

It turns out that --bundle and --pid-file are required by the OCI Runtime CLI specification: https://github.com/opencontainers/runtime-tools/blob/master/docs/command-line-interface.md

[samuelkarp]

Hey @dfr, that repository is a collection of tools for working with the specification, not the specification itself. You can find the spec here: https://github.com/opencontainers/runtime-spec.

[dfr]

The document I linked seems to be part of the 'Runtime compliance testing' tools and https://github.com/opencontainers/runtime-tools/blob/master/docs/runtime-compliance-testing.md includes the words:

In order to be tested for compliance, runtimes MUST support at least one of the following APIs:

Version 1.0.1 of the OCI Runtime Command Line Interface.

It seems counter intuitive (to me anyway) that each runtime can make its own choices for how to define the interface and this document in runtime-tools seems to suggest that the compliance testing process requires a core subset of the CLI interface.

[samuelkarp]

I agree that it's confusing, but the runtime-tools repository is not part of the spec. The OCI does not currently run a compliance program for the runtime spec (and has only recently started a conformance program for the distribution spec).

[dfr]

I rebased this to pick up @emaste's CI fix

[samuelkarp]

Do you have a specific need for runj to support CWD here as the default or are you more interested in just adding support for --bundle? CWD does not currently work with your PR (the jail utility requires an absolute pathname and there's no current code to compute that).

I'm going to remove support for CWD for now while I'm working on this code and we can add it back in a separate PR if you need it.

[samuelkarp]

I've merged this (with some minor modifications) as 889c370. Thank you for the contribution!

[dfr]

I don't think I need the CWD part - I was just going with the language used in the 'OCI Runtime Command Line Interface' doc in runtime-tools.

…

On Tue, 7 Jun 2022 at 02:14, Samuel Karp ***@***.***> wrote: Closed #27 <#27>. — Reply to this email directly, view it on GitHub <#27 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABOTJLQWHC2GTZG3IXOEYLVN2O7NANCNFSM5UE3JFDQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>