ctr: improve error relative shim path error msg

addresses https://github.com/containerd/containerd/issues/6464

Return an error if a runtime provided is relative.

Add context to the usage for `ctr run --runtime` indicating that
absolute path to runtime binary must be provided.

Signed-off-by: Gavin Inglis <giinglis@amazon.com>
This commit is contained in:
Gavin Inglis 2022-02-05 00:55:47 +00:00
parent a9f61ba2c8
commit 7b045ea5f0
4 changed files with 107 additions and 2 deletions

View File

@ -134,7 +134,7 @@ var (
}, },
cli.StringFlag{ cli.StringFlag{
Name: "runtime", Name: "runtime",
Usage: "runtime name", Usage: "runtime name or absolute path to runtime binary",
Value: defaults.DefaultRuntime, Value: defaults.DefaultRuntime,
}, },
cli.StringFlag{ cli.StringFlag{

View File

@ -22,6 +22,7 @@ import (
"os" "os"
"os/exec" "os/exec"
"path/filepath" "path/filepath"
"strings"
"sync" "sync"
"github.com/containerd/containerd/containers" "github.com/containerd/containerd/containers"
@ -244,6 +245,11 @@ func (m *ShimManager) resolveRuntimePath(runtime string) (string, error) {
return runtime, nil return runtime, nil
} }
// Check if relative path to runtime binary provided
if strings.Contains(runtime, "/") {
return "", fmt.Errorf("invalid runtime name %s, correct runtime name should be either format like `io.containerd.runc.v1` or a full path to the binary", runtime)
}
// Preserve existing logic and resolve runtime path from runtime name. // Preserve existing logic and resolve runtime path from runtime name.
name := shimbinary.BinaryName(runtime) name := shimbinary.BinaryName(runtime)

View File

@ -0,0 +1,99 @@
//go:build !windows && !darwin
// +build !windows,!darwin
/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v2
import (
"os"
"testing"
)
// setupAbsoluteShimPath creates a temporary directory in $PATH with an empty
// shim executable file in it to test the exec.LookPath branch of resolveRuntimePath
func setupAbsoluteShimPath(t *testing.T) (string, error) {
tempShimDir := t.TempDir()
_, err := os.Create(tempShimDir + "/containerd-shim-runc-v2")
if err != nil {
return "", err
}
t.Setenv("PATH", tempShimDir+":"+os.Getenv("PATH"))
absoluteShimPath := tempShimDir + "/containerd-shim-runc-v2"
err = os.Chmod(absoluteShimPath, 0777)
if err != nil {
return "", err
}
return absoluteShimPath, nil
}
func TestResolveRuntimePath(t *testing.T) {
sm := &ShimManager{}
absoluteShimPath, err := setupAbsoluteShimPath(t)
if err != nil {
t.Errorf("Failed to create temporary shim path: %q", err)
}
tests := []struct {
runtime string
want string
}{
{ // Absolute path
runtime: absoluteShimPath,
want: absoluteShimPath,
},
{ // Binary name
runtime: "io.containerd.runc.v2",
want: absoluteShimPath,
},
{ // Invalid absolute path
runtime: "/fake/abs/path",
want: "",
},
{ // No name
runtime: "",
want: "",
},
{ // Relative Path
runtime: "./containerd-shim-runc-v2",
want: "",
},
{
runtime: "fake/containerd-shim-runc-v2",
want: "",
},
{
runtime: "./fake/containerd-shim-runc-v2",
want: "",
},
{ // Relative Path or Bad Binary Name
runtime: ".io.containerd.runc.v2",
want: "",
},
}
for _, c := range tests {
have, _ := sm.resolveRuntimePath(c.runtime)
if have != c.want {
t.Errorf("Expected %q, got %q", c.want, have)
}
}
}

View File

@ -85,7 +85,7 @@ func Command(ctx context.Context, config *CommandConfig) (*exec.Cmd, error) {
func BinaryName(runtime string) string { func BinaryName(runtime string) string {
// runtime name should format like $prefix.name.version // runtime name should format like $prefix.name.version
parts := strings.Split(runtime, ".") parts := strings.Split(runtime, ".")
if len(parts) < 2 { if len(parts) < 2 || parts[0] == "" {
return "" return ""
} }