Add shim start opts

mxpv · mxpv · commit 993b863993e2 · 2021-04-15T11:55:24.000-07:00
Signed-off-by: Maksym Pavlenko &lt;pavlenko.maksym@gmail.com&gt;
diff --git a/runtime/v2/example/example.go b/runtime/v2/example/example.go
@@ -42,7 +42,7 @@ type service struct {
 }
 
 // StartShim is a binary call that executes a new shim returning the address
-func (s *service) StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (string, error) {
+func (s *service) StartShim(ctx context.Context, opts shim.StartOpts) (string, error) {
 	return "", nil
 }
 
diff --git a/runtime/v2/runc/v1/service.go b/runtime/v2/runc/v1/service.go
@@ -126,12 +126,12 @@ func newCommand(ctx context.Context, id, containerdBinary, containerdAddress, co
 	return cmd, nil
 }
 
-func (s *service) StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (_ string, retErr error) {
-	cmd, err := newCommand(ctx, id, containerdBinary, containerdAddress, containerdTTRPCAddress)
+func (s *service) StartShim(ctx context.Context, opts shim.StartOpts) (_ string, retErr error) {
+	cmd, err := newCommand(ctx, opts.ID, opts.ContainerdBinary, opts.Address, opts.TTRPCAddress)
 	if err != nil {
 		return "", err
 	}
-	address, err := shim.SocketAddress(ctx, containerdAddress, id)
+	address, err := shim.SocketAddress(ctx, opts.Address, opts.ID)
 	if err != nil {
 		return "", err
 	}
diff --git a/runtime/v2/runc/v2/service.go b/runtime/v2/runc/v2/service.go
@@ -171,12 +171,12 @@ func readSpec() (*spec, error) {
 	return &s, nil
 }
 
-func (s *service) StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (_ string, retErr error) {
-	cmd, err := newCommand(ctx, id, containerdBinary, containerdAddress, containerdTTRPCAddress)
+func (s *service) StartShim(ctx context.Context, opts shim.StartOpts) (_ string, retErr error) {
+	cmd, err := newCommand(ctx, opts.ID, opts.ContainerdBinary, opts.Address, opts.TTRPCAddress)
 	if err != nil {
 		return "", err
 	}
-	grouping := id
+	grouping := opts.ID
 	spec, err := readSpec()
 	if err != nil {
 		return "", err
@@ -187,7 +187,7 @@ func (s *service) StartShim(ctx context.Context, id, containerdBinary, container
 			break
 		}
 	}
-	address, err := shim.SocketAddress(ctx, containerdAddress, grouping)
+	address, err := shim.SocketAddress(ctx, opts.Address, grouping)
 	if err != nil {
 		return "", err
 	}
diff --git a/runtime/v2/shim/shim.go b/runtime/v2/shim/shim.go
@@ -51,14 +51,22 @@ type Publisher interface {
 	io.Closer
 }
 
+// StartOpts describes shim start configuration received from containerd
+type StartOpts struct {
+	ID               string
+	ContainerdBinary string
+	Address          string
+	TTRPCAddress     string
+}
+
 // Init func for the creation of a shim server
 type Init func(context.Context, string, Publisher, func()) (Shim, error)
 
 // Shim server interface
 type Shim interface {
 	shimapi.TaskService
 	Cleanup(ctx context.Context) (*shimapi.DeleteResponse, error)
-	StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (string, error)
+	StartShim(ctx context.Context, opts StartOpts) (string, error)
 }
 
 // OptsKey is the context key for the Opts value.
@@ -219,7 +227,13 @@ func run(id string, initFunc Init, config Config) error {
 		}
 		return nil
 	case "start":
-		address, err := service.StartShim(ctx, idFlag, containerdBinaryFlag, addressFlag, ttrpcAddress)
+		opts := StartOpts{
+			ID:               idFlag,
+			ContainerdBinary: containerdBinaryFlag,
+			Address:          addressFlag,
+			TTRPCAddress:     ttrpcAddress,
+		}
+		address, err := service.StartShim(ctx, opts)
 		if err != nil {
 			return err
 		}

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ type service struct {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`// StartShim is a binary call that executes a new shim returning the address`
`45`		`-func (s *service) StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (string, error) {`
	`45`	`+func (s *service) StartShim(ctx context.Context, opts shim.StartOpts) (string, error) {`
`46`	`46`	`return "", nil`
`47`	`47`	`}`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -126,12 +126,12 @@ func newCommand(ctx context.Context, id, containerdBinary, containerdAddress, co`
`126`	`126`	`return cmd, nil`
`127`	`127`	`}`
`128`	`128`
`129`		`-func (s *service) StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (_ string, retErr error) {`
`130`		`- cmd, err := newCommand(ctx, id, containerdBinary, containerdAddress, containerdTTRPCAddress)`
	`129`	`+func (s *service) StartShim(ctx context.Context, opts shim.StartOpts) (_ string, retErr error) {`
	`130`	`+ cmd, err := newCommand(ctx, opts.ID, opts.ContainerdBinary, opts.Address, opts.TTRPCAddress)`
`131`	`131`	`if err != nil {`
`132`	`132`	`return "", err`
`133`	`133`	`}`
`134`		`- address, err := shim.SocketAddress(ctx, containerdAddress, id)`
	`134`	`+ address, err := shim.SocketAddress(ctx, opts.Address, opts.ID)`
`135`	`135`	`if err != nil {`
`136`	`136`	`return "", err`
`137`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,12 +171,12 @@ func readSpec() (*spec, error) {`
`171`	`171`	`return &s, nil`
`172`	`172`	`}`
`173`	`173`
`174`		`-func (s *service) StartShim(ctx context.Context, id, containerdBinary, containerdAddress, containerdTTRPCAddress string) (_ string, retErr error) {`
`175`		`- cmd, err := newCommand(ctx, id, containerdBinary, containerdAddress, containerdTTRPCAddress)`
	`174`	`+func (s *service) StartShim(ctx context.Context, opts shim.StartOpts) (_ string, retErr error) {`
	`175`	`+ cmd, err := newCommand(ctx, opts.ID, opts.ContainerdBinary, opts.Address, opts.TTRPCAddress)`
`176`	`176`	`if err != nil {`
`177`	`177`	`return "", err`
`178`	`178`	`}`
`179`		`- grouping := id`
	`179`	`+ grouping := opts.ID`
`180`	`180`	`spec, err := readSpec()`
`181`	`181`	`if err != nil {`
`182`	`182`	`return "", err`
`@@ -187,7 +187,7 @@ func (s *service) StartShim(ctx context.Context, id, containerdBinary, container`
`187`	`187`	`break`
`188`	`188`	`}`
`189`	`189`	`}`
`190`		`- address, err := shim.SocketAddress(ctx, containerdAddress, grouping)`
	`190`	`+ address, err := shim.SocketAddress(ctx, opts.Address, grouping)`
`191`	`191`	`if err != nil {`
`192`	`192`	`return "", err`
`193`	`193`	`}`