Merge pull request #409 from hqhq/remove_platform

Remove platform

Author: Ma Shimiao

Makefile

@@ -6,6 +6,7 @@ BINDIR ?= $(DESTDIR)/usr/bin
 
 BUILDTAGS=
 RUNTIME ?= runc
+PLATFORM ?= linux
 
 all: tool runtimetest
 
@@ -39,7 +40,7 @@ clean:
 	rm -f oci-runtime-tool runtimetest *.1
 
 localvalidation: runtimetest
-	RUNTIME=$(RUNTIME) go test -tags "$(BUILDTAGS)" ${TESTFLAGS} -v github.com/opencontainers/runtime-tools/validation
+	RUNTIME=$(RUNTIME) PLATFORM=$(PLATFORM) go test -tags "$(BUILDTAGS)" ${TESTFLAGS} -v github.com/opencontainers/runtime-tools/validation
 
 .PHONY: test .gofmt .govet .golint
 

cmd/oci-runtime-tool/generate.go

@@ -5,7 +5,6 @@ import (
 	"bytes"
 	"fmt"
 	"os"
-	"runtime"
 	"strconv"
 	"strings"
 	"unicode"
@@ -19,7 +18,6 @@ import (
 
 var generateFlags = []cli.Flag{
 	cli.StringFlag{Name: "apparmor", Usage: "specifies the the apparmor profile for the container"},
-	cli.StringFlag{Name: "arch", Value: runtime.GOARCH, Usage: "architecture the container is created for"},
 	cli.StringSliceFlag{Name: "args", Usage: "command to run in the container"},
 	cli.StringSliceFlag{Name: "bind", Usage: "bind mount directories src:dest[:options...]"},
 	cli.StringSliceFlag{Name: "cap-add", Usage: "add Linux capabilities"},
@@ -62,7 +60,6 @@ var generateFlags = []cli.Flag{
 	cli.StringFlag{Name: "mount-label", Usage: "selinux mount context label"},
 	cli.BoolFlag{Name: "no-new-privileges", Usage: "set no new privileges bit for the container process"},
 	cli.IntFlag{Name: "oom-score-adj", Usage: "oom_score_adj for the container"},
-	cli.StringFlag{Name: "os", Value: runtime.GOOS, Usage: "operating system the container is created for"},
 	cli.StringFlag{Name: "output", Usage: "output file (defaults to stdout)"},
 	cli.StringSliceFlag{Name: "poststart", Usage: "set command to run in poststart hooks"},
 	cli.StringSliceFlag{Name: "poststop", Usage: "set command to run in poststop hooks"},
@@ -151,9 +148,6 @@ func setupSpec(g *generate.Generator, context *cli.Context) error {
 		g.SetHostname(context.String("hostname"))
 	}
 
-	g.SetPlatformOS(context.String("os"))
-	g.SetPlatformArch(context.String("arch"))
-
 	if context.IsSet("label") {
 		annotations := context.StringSlice("label")
 		for _, s := range annotations {

cmd/oci-runtime-tool/main.go

@@ -22,6 +22,11 @@ func main() {
 			Value: "error",
 			Usage: "Log level (panic, fatal, error, warn, info, or debug)",
 		},
+		cli.StringFlag{
+			Name:  "platform",
+			Value: "linux",
+			Usage: "Platform the tool targets",
+		},
 	}
 
 	app.Commands = []cli.Command{

cmd/oci-runtime-tool/validate.go

@@ -20,7 +20,8 @@ var bundleValidateCommand = cli.Command{
 	Action: func(context *cli.Context) error {
 		inputPath := context.String("path")
 		hostSpecific := context.GlobalBool("host-specific")
-		v, err := validate.NewValidatorFromPath(inputPath, hostSpecific)
+		platform := context.GlobalString("platform")
+		v, err := validate.NewValidatorFromPath(inputPath, hostSpecific, platform)
 		if err != nil {
 			return err
 		}

cmd/runtimetest/main.go

@@ -588,6 +588,8 @@ func validate(context *cli.Context) error {
 		return err
 	}
 
+	platform := context.String("platform")
+
 	defaultValidations := []validation{
 		{
 			test:        validateRootFS,
@@ -666,7 +668,7 @@ func validate(context *cli.Context) error {
 		}
 	}
 
-	if spec.Platform.OS == "linux" {
+	if platform == "linux" {
 		for _, v := range linuxValidations {
 			err := v.test(spec)
 			t.Ok(err == nil, v.description)
@@ -695,7 +697,12 @@ func main() {
 		cli.StringFlag{
 			Name:  "path",
 			Value: ".",
-			Usage: "path to the configuration",
+			Usage: "Path to the configuration",
+		},
+		cli.StringFlag{
+			Name:  "platform",
+			Value: "linux",
+			Usage: "Platform the runtime runs on",
 		},
 	}
 

generate/generate.go

@@ -6,7 +6,6 @@ import (
 	"fmt"
 	"io"
 	"os"
-	"runtime"
 	"strings"
 
 	rspec "github.com/opencontainers/runtime-spec/specs-go"
@@ -35,10 +34,6 @@ type ExportOptions struct {
 func New() Generator {
 	spec := rspec.Spec{
 		Version: rspec.Version,
-		Platform: rspec.Platform{
-			OS:   runtime.GOOS,
-			Arch: runtime.GOARCH,
-		},
 		Root: rspec.Root{
 			Path:     "",
 			Readonly: false,
@@ -346,18 +341,6 @@ func (g *Generator) RemoveAnnotation(key string) {
 	delete(g.spec.Annotations, key)
 }
 
-// SetPlatformOS sets g.spec.Process.OS.
-func (g *Generator) SetPlatformOS(os string) {
-	g.initSpec()
-	g.spec.Platform.OS = os
-}
-
-// SetPlatformArch sets g.spec.Platform.Arch.
-func (g *Generator) SetPlatformArch(arch string) {
-	g.initSpec()
-	g.spec.Platform.Arch = arch
-}
-
 // SetProcessUID sets g.spec.Process.User.UID.
 func (g *Generator) SetProcessUID(uid uint32) {
 	g.initSpec()

man/oci-runtime-tool-generate.1.md

@@ -18,10 +18,6 @@ read the configuration from `config.json`.
 **--apparmor**=PROFILE
   Specifies the apparmor profile for the container
 
-**--arch**=ARCH
-  Architecture used within the container.
-  "amd64"
-
 **--args**=OPTION
   Arguments to run within the container.  Can be specified multiple times.
   If you were going to run a command with multiple options, you would need
@@ -200,9 +196,6 @@ read the configuration from `config.json`.
 **--oom-score-adj**=adj
   Specifies oom_score_adj for the container.
 
-**--os**=OS
-  Operating system used within the container.
-
 **--output**=PATH
   Instead of writing the configuration JSON to stdout, write it to a
   file at *PATH* (overwriting the existing content if a file already

man/oci-runtime-tool.1.md

@@ -32,6 +32,9 @@ oci-runtime-tool is a collection of tools for working with the [OCI runtime spec
 **--log-level**=LEVEL
   Log level (panic, fatal, error, warn, info, or debug) (default: "error").
 
+**--platform**
+  Platform the tool targets.
+
 **-v**, **--version**
   Print version information.
 

validate/validate.go

@@ -47,15 +47,21 @@ type Validator struct {
 	spec         *rspec.Spec
 	bundlePath   string
 	HostSpecific bool
+	platform     string
 }
 
 // NewValidator creates a Validator
-func NewValidator(spec *rspec.Spec, bundlePath string, hostSpecific bool) Validator {
-	return Validator{spec: spec, bundlePath: bundlePath, HostSpecific: hostSpecific}
+func NewValidator(spec *rspec.Spec, bundlePath string, hostSpecific bool, platform string) Validator {
+	return Validator{
+		spec:         spec,
+		bundlePath:   bundlePath,
+		HostSpecific: hostSpecific,
+		platform:     platform,
+	}
 }
 
 // NewValidatorFromPath creates a Validator with specified bundle path
-func NewValidatorFromPath(bundlePath string, hostSpecific bool) (Validator, error) {
+func NewValidatorFromPath(bundlePath string, hostSpecific bool, platform string) (Validator, error) {
 	if bundlePath == "" {
 		return Validator{}, fmt.Errorf("Bundle path shouldn't be empty")
 	}
@@ -77,18 +83,17 @@ func NewValidatorFromPath(bundlePath string, hostSpecific bool) (Validator, erro
 		return Validator{}, err
 	}
 
-	return NewValidator(&spec, bundlePath, hostSpecific), nil
+	return NewValidator(&spec, bundlePath, hostSpecific, platform), nil
 }
 
 // CheckAll checks all parts of runtime bundle
 func (v *Validator) CheckAll() (msgs []string) {
+	msgs = append(msgs, v.CheckPlatform()...)
 	msgs = append(msgs, v.CheckRootfsPath()...)
 	msgs = append(msgs, v.CheckMandatoryFields()...)
 	msgs = append(msgs, v.CheckSemVer()...)
 	msgs = append(msgs, v.CheckMounts()...)
-	msgs = append(msgs, v.CheckPlatform()...)
 	msgs = append(msgs, v.CheckProcess()...)
-	msgs = append(msgs, v.CheckOS()...)
 	msgs = append(msgs, v.CheckHooks()...)
 	if v.spec.Linux != nil {
 		msgs = append(msgs, v.CheckLinux()...)
@@ -131,9 +136,9 @@ func (v *Validator) CheckRootfsPath() (msgs []string) {
 		msgs = append(msgs, fmt.Sprintf("root.path is %q, but it MUST be a child of %q", v.spec.Root.Path, absBundlePath))
 	}
 
-	if v.spec.Platform.OS == "windows" {
+	if v.platform == "windows" {
 		if v.spec.Root.Readonly {
-			msgs = append(msgs, "root.readonly field MUST be omitted or false when platform.os is windows")
+			msgs = append(msgs, "root.readonly field MUST be omitted or false when target platform is windows")
 		}
 	}
 
@@ -156,37 +161,6 @@ func (v *Validator) CheckSemVer() (msgs []string) {
 	return
 }
 
-// CheckPlatform checks v.spec.Platform
-func (v *Validator) CheckPlatform() (msgs []string) {
-	logrus.Debugf("check platform")
-
-	validCombins := map[string][]string{
-		"android":   {"arm"},
-		"darwin":    {"386", "amd64", "arm", "arm64"},
-		"dragonfly": {"amd64"},
-		"freebsd":   {"386", "amd64", "arm"},
-		"linux":     {"386", "amd64", "arm", "arm64", "mips", "mips64", "mips64le", "mipsle", "ppc64", "ppc64le", "s390x"},
-		"netbsd":    {"386", "amd64", "arm"},
-		"openbsd":   {"386", "amd64", "arm"},
-		"plan9":     {"386", "amd64"},
-		"solaris":   {"amd64"},
-		"windows":   {"386", "amd64"}}
-	platform := v.spec.Platform
-	for os, archs := range validCombins {
-		if os == platform.OS {
-			for _, arch := range archs {
-				if arch == platform.Arch {
-					return nil
-				}
-			}
-			msgs = append(msgs, fmt.Sprintf("Combination of %q and %q is invalid.", platform.OS, platform.Arch))
-		}
-	}
-	msgs = append(msgs, fmt.Sprintf("Operation system %q of the bundle is not supported yet.", platform.OS))
-
-	return
-}
-
 // CheckHooks check v.spec.Hooks
 func (v *Validator) CheckHooks() (msgs []string) {
 	logrus.Debugf("check hooks")
@@ -271,8 +245,7 @@ func (v *Validator) CheckProcess() (msgs []string) {
 	}
 	msgs = append(msgs, v.CheckRlimits()...)
 
-	if v.spec.Platform.OS == "linux" {
-
+	if v.platform == "linux" {
 		if len(process.ApparmorProfile) > 0 {
 			profilePath := filepath.Join(v.bundlePath, v.spec.Root.Path, "/etc/apparmor.d", process.ApparmorProfile)
 			_, err := os.Stat(profilePath)
@@ -288,7 +261,7 @@ func (v *Validator) CheckProcess() (msgs []string) {
 // CheckCapabilities checks v.spec.Process.Capabilities
 func (v *Validator) CheckCapabilities() (msgs []string) {
 	process := v.spec.Process
-	if v.spec.Platform.OS == "linux" {
+	if v.platform == "linux" {
 		var effective, permitted, inheritable, ambient bool
 		caps := make(map[string][]string)
 
@@ -336,7 +309,7 @@ func (v *Validator) CheckCapabilities() (msgs []string) {
 			}
 		}
 	} else {
-		logrus.Warnf("process.capabilities validation not yet implemented for OS %q", v.spec.Platform.OS)
+		logrus.Warnf("process.capabilities validation not yet implemented for OS %q", v.platform)
 	}
 
 	return
@@ -402,7 +375,7 @@ func supportedMountTypes(OS string, hostSpecific bool) (map[string]bool, error)
 func (v *Validator) CheckMounts() (msgs []string) {
 	logrus.Debugf("check mounts")
 
-	supportedTypes, err := supportedMountTypes(v.spec.Platform.OS, v.HostSpecific)
+	supportedTypes, err := supportedMountTypes(v.platform, v.HostSpecific)
 	if err != nil {
 		msgs = append(msgs, err.Error())
 		return
@@ -423,25 +396,30 @@ func (v *Validator) CheckMounts() (msgs []string) {
 	return
 }
 
-// CheckOS checks v.spec.Platform.OS
-func (v *Validator) CheckOS() (msgs []string) {
-	logrus.Debugf("check os")
+// CheckPlatform checks v.platform
+func (v *Validator) CheckPlatform() (msgs []string) {
+	logrus.Debugf("check platform")
+
+	if v.platform != "linux" && v.platform != "solaris" && v.platform != "windows" {
+		msgs = append(msgs, fmt.Sprintf("platform %q is not supported", v.platform))
+		return
+	}
 
-	if v.spec.Platform.OS != "linux" {
+	if v.platform != "linux" {
 		if v.spec.Linux != nil {
-			msgs = append(msgs, fmt.Sprintf("'linux' MUST NOT be set when platform.os is %q", v.spec.Platform.OS))
+			msgs = append(msgs, fmt.Sprintf("'linux' MUST NOT be set when target platform is %q", v.platform))
 		}
 	}
 
-	if v.spec.Platform.OS != "solaris" {
+	if v.platform != "solaris" {
 		if v.spec.Solaris != nil {
-			msgs = append(msgs, fmt.Sprintf("'solaris' MUST NOT be set when platform.os is %q", v.spec.Platform.OS))
+			msgs = append(msgs, fmt.Sprintf("'solaris' MUST NOT be set when target platform is %q", v.platform))
 		}
 	}
 
-	if v.spec.Platform.OS != "windows" {
+	if v.platform != "windows" {
 		if v.spec.Windows != nil {
-			msgs = append(msgs, fmt.Sprintf("'windows' MUST NOT be set when platform.os is %q", v.spec.Platform.OS))
+			msgs = append(msgs, fmt.Sprintf("'windows' MUST NOT be set when target platform is %q", v.platform))
 		}
 	}
 
@@ -502,7 +480,7 @@ func (v *Validator) CheckLinux() (msgs []string) {
 		}
 	}
 
-	if v.spec.Platform.OS == "linux" && !typeList[rspec.UTSNamespace].newExist && v.spec.Hostname != "" {
+	if v.platform == "linux" && !typeList[rspec.UTSNamespace].newExist && v.spec.Hostname != "" {
 		msgs = append(msgs, fmt.Sprintf("On Linux, hostname requires a new UTS namespace to be specified as well"))
 	}
 
@@ -684,15 +662,15 @@ func (v *Validator) rlimitValid(rlimit rspec.LinuxRlimit) (msgs []string) {
 		msgs = append(msgs, fmt.Sprintf("hard limit of rlimit %s should not be less than soft limit", rlimit.Type))
 	}
 
-	if v.spec.Platform.OS == "linux" {
+	if v.platform == "linux" {
 		for _, val := range defaultRlimits {
 			if val == rlimit.Type {
 				return
 			}
 		}
 		msgs = append(msgs, fmt.Sprintf("rlimit type %q is invalid", rlimit.Type))
 	} else {
-		logrus.Warnf("process.rlimits validation not yet implemented for OS %q", v.spec.Platform.OS)
+		logrus.Warnf("process.rlimits validation not yet implemented for platform %q", v.platform)
 	}
 
 	return

validate/validate_test.go

@@ -47,7 +47,7 @@ func TestCheckRootfsPath(t *testing.T) {
 		{filepath.Join(tmpBundle, rootfsNonExists), false},
 	}
 	for _, c := range cases {
-		v := NewValidator(&rspec.Spec{Root: rspec.Root{Path: c.val}}, tmpBundle, false)
+		v := NewValidator(&rspec.Spec{Root: rspec.Root{Path: c.val}}, tmpBundle, false, "linux")
 		checkErrors(t, "CheckRootfsPath "+c.val, v.CheckRootfsPath(), c.expected)
 	}
 }
@@ -64,7 +64,7 @@ func TestCheckSemVer(t *testing.T) {
 	}
 
 	for _, c := range cases {
-		v := NewValidator(&rspec.Spec{Version: c.val}, "", false)
+		v := NewValidator(&rspec.Spec{Version: c.val}, "", false, "linux")
 		checkErrors(t, "CheckSemVer "+c.val, v.CheckSemVer(), c.expected)
 	}
 }