-
Notifications
You must be signed in to change notification settings - Fork 144
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rebase the specerror framework ; complete rfc code of config.md #458
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package specerror | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| rfc2119 "github.com/opencontainers/runtime-tools/error" | ||
| ) | ||
|
|
||
| // define error codes | ||
| const ( | ||
| // ConfigInRootBundleDir represents "This REQUIRED file MUST reside in the root of the bundle directory" | ||
| ConfigInRootBundleDir = "This REQUIRED file MUST reside in the root of the bundle directory." | ||
| // ConfigConstName represents "This REQUIRED file MUST be named `config.json`." | ||
| ConfigConstName = "This REQUIRED file MUST be named `config.json`." | ||
| // ArtifactsInSingleDir represents "When supplied, while these artifacts MUST all be present in a single directory on the local filesystem, that directory itself is not part of the bundle." | ||
| ArtifactsInSingleDir = "When supplied, while these artifacts MUST all be present in a single directory on the local filesystem, that directory itself is not part of the bundle." | ||
| ) | ||
|
|
||
| var ( | ||
| containerFormatRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "bundle.md#container-format"), nil | ||
| } | ||
| ) | ||
|
|
||
| func init() { | ||
| register(ConfigInRootBundleDir, rfc2119.Must, containerFormatRef) | ||
| register(ConfigConstName, rfc2119.Must, containerFormatRef) | ||
| register(ArtifactsInSingleDir, rfc2119.Must, containerFormatRef) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| package specerror | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| rfc2119 "github.com/opencontainers/runtime-tools/error" | ||
| ) | ||
|
|
||
| // define error codes | ||
| const ( | ||
| // DefaultFilesystems represents "The following filesystems SHOULD be made available in each container's filesystem:" | ||
| DefaultFilesystems = "The following filesystems SHOULD be made available in each container's filesystem:" | ||
| ) | ||
|
|
||
| var ( | ||
| defaultFilesystemsRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config-linux.md#default-filesystems"), nil | ||
| } | ||
| ) | ||
|
|
||
| func init() { | ||
| register(DefaultFilesystems, rfc2119.Should, defaultFilesystemsRef) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| package specerror | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| rfc2119 "github.com/opencontainers/runtime-tools/error" | ||
| ) | ||
|
|
||
| // define error codes | ||
| const ( | ||
| // SpecVersionInSemVer represents "**`ociVersion`** (string, Required) MUST be in [SemVer v2.0.0][semver-v2.0.0] format and specifies the version of the Open Container Initiative Runtime Specification with which the bundle complies." | ||
| SpecVersionInSemVer = "**`ociVersion`** (string, Required) MUST be in [SemVer v2.0.0][semver-v2.0.0] format and specifies the version of the Open Container Initiative Runtime Specification with which the bundle complies." | ||
| // RootOnWindowsRequired represents "On Windows, for Windows Server Containers, this field is REQUIRED." | ||
| RootOnWindowsRequired = "On Windows, for Windows Server Containers, this field is REQUIRED." | ||
| // RootOnHyperVNotSet represents "For [Hyper-V Containers](config-windows.md#hyperv), this field MUST NOT be set." | ||
| RootOnHyperVNotSet = "For [Hyper-V Containers](config-windows.md#hyperv), this field MUST NOT be set." | ||
| // RootOnNonHyperVRequired represents "On all other platforms, this field is REQUIRED." | ||
| RootOnNonHyperVRequired = "On all other platforms, this field is REQUIRED." | ||
| // RootPathOnWindowsGUID represents "On Windows, `path` MUST be a [volume GUID path][naming-a-volume]." | ||
| RootPathOnWindowsGUID = "On Windows, `path` MUST be a [volume GUID path][naming-a-volume]." | ||
| // RootPathOnPosixConvention represents "The value SHOULD be the conventional `rootfs`." | ||
| RootPathOnPosixConvention = "The value SHOULD be the conventional `rootfs`." | ||
| // RootPathExist represents "A directory MUST exist at the path declared by the field." | ||
| RootPathExist = "A directory MUST exist at the path declared by the field." | ||
| // RootReadonlyImplement represents "**`readonly`** (bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false." | ||
| RootReadonlyImplement = "**`readonly`** (bool, OPTIONAL) If true then the root filesystem MUST be read-only inside the container, defaults to false." | ||
| // RootReadonlyOnWindowsFalse represents "* On Windows, this field MUST be omitted or false." | ||
| RootReadonlyOnWindowsFalse = "On Windows, this field MUST be omitted or false." | ||
| // MountsInOrder represents "The runtime MUST mount entries in the listed order." | ||
| MountsInOrder = "The runtime MUST mount entries in the listed order." | ||
| // MountsDestAbs represents "Destination of mount point: path inside container. This value MUST be an absolute path." | ||
| MountsDestAbs = "Destination of mount point: path inside container. This value MUST be an absolute path." | ||
| // MountsDestOnWindowsNotNested represents "Windows: one mount destination MUST NOT be nested within another mount (e.g., c:\\foo and c:\\foo\\bar)." | ||
| MountsDestOnWindowsNotNested = "Windows: one mount destination MUST NOT be nested within another mount (e.g., c:\\foo and c:\\foo\\bar)." | ||
| // MountsOptionsOnWindowsROSupport represents "Windows: runtimes MUST support `ro`, mounting the filesystem read-only when `ro` is given." | ||
| MountsOptionsOnWindowsROSupport = "Windows: runtimes MUST support `ro`, mounting the filesystem read-only when `ro` is given." | ||
| // ProcRequiredAtStart represents "This property is REQUIRED when [`start`](runtime.md#start) is called." | ||
| ProcRequiredAtStart = "This property is REQUIRED when [`start`](runtime.md#start) is called." | ||
| // ProcessConsoleSizeIgnore represents "Runtimes MUST ignore `consoleSize` if `terminal` is `false` or unset." | ||
| ProcessConsoleSizeIgnore = "Runtimes MUST ignore `consoleSize` if `terminal` is `false` or unset." | ||
| // ProcCwdAbs represents "** cwd ** (string, REQUIRED) is the working directory that will be set for the executable. This value MUST be an absolute path." | ||
| ProcCwdAbs = "** cwd ** (string, REQUIRED) is the working directory that will be set for the executable. This value MUST be an absolute path." | ||
| // ProcArgsOneEntryRequired represents "This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics as `execvp`'s *file*." | ||
| ProcArgsOneEntryRequired = "This specification extends the IEEE standard in that at least one entry is REQUIRED, and that entry is used with the same semantics as `execvp`'s *file*." | ||
| // PosixProcRlimitsTypeGeneError represents "The runtime MUST [generate an error](runtime.md#errors) for any values which cannot be mapped to a relevant kernel interface." | ||
| PosixProcRlimitsTypeGeneError = "The runtime MUST [generate an error](runtime.md#errors) for any values which cannot be mapped to a relevant kernel interface." | ||
| // PosixProcRlimitsTypeGet represents "For each entry in `rlimits`, a [`getrlimit(3)`][getrlimit.3] on `type` MUST succeed." | ||
| PosixProcRlimitsTypeGet = "For each entry in `rlimits`, a [`getrlimit(3)`][getrlimit.3] on `type` MUST succeed." | ||
| // PosixProcRlimitsSoftMatchCur represents "`rlim.rlim_cur` MUST match the configured value." | ||
| PosixProcRlimitsSoftMatchCur = "`rlim.rlim_cur` MUST match the configured value." | ||
| // PosixProcRlimitsHardMatchMax represents "`rlim.rlim_max` MUST match the configured value." | ||
| PosixProcRlimitsHardMatchMax = "`rlim.rlim_max` MUST match the configured value." | ||
| // PosixProcRlimitsErrorOnDup represents "If `rlimits` contains duplicated entries with same `type`, the runtime MUST [generate an error](runtime.md#errors)." | ||
| PosixProcRlimitsErrorOnDup = "If `rlimits` contains duplicated entries with same `type`, the runtime MUST [generate an error](runtime.md#errors)." | ||
| // LinuxProcCapError represents "Any value which cannot be mapped to a relevant kernel interface MUST cause an error." | ||
| LinuxProcCapError = "Any value which cannot be mapped to a relevant kernel interface MUST cause an error." | ||
| // LinuxProcOomScoreAdjSet represents "If `oomScoreAdj` is set, the runtime MUST set `oom_score_adj` to the given value." | ||
| LinuxProcOomScoreAdjSet = "If `oomScoreAdj` is set, the runtime MUST set `oom_score_adj` to the given value." | ||
| // LinuxProcOomScoreAdjNotSet represents "If `oomScoreAdj` is not set, the runtime MUST NOT change the value of `oom_score_adj`." | ||
| LinuxProcOomScoreAdjNotSet = "If `oomScoreAdj` is not set, the runtime MUST NOT change the value of `oom_score_adj`." | ||
| // PlatformSpecConfOnWindowsSet represents "This MUST be set if the target platform of this spec is `windows`." | ||
| PlatformSpecConfOnWindowsSet = "This MUST be set if the target platform of this spec is `windows`." | ||
| // PosixHooksPathAbs represents "This specification extends the IEEE standard in that **`path`** MUST be absolute." | ||
| PosixHooksPathAbs = "This specification extends the IEEE standard in that **`path`** MUST be absolute." | ||
| // PosixHooksTimeoutPositive represents "If set, `timeout` MUST be greater than zero." | ||
| PosixHooksTimeoutPositive = "If set, `timeout` MUST be greater than zero." | ||
| // PosixHooksCalledInOrder represents "Hooks MUST be called in the listed order." | ||
| PosixHooksCalledInOrder = "Hooks MUST be called in the listed order." | ||
| // PosixHooksStateToStdin represents "The [state](runtime.md#state) of the container MUST be passed to hooks over stdin so that they may do work appropriate to the current state of the container." | ||
| PosixHooksStateToStdin = "The [state](runtime.md#state) of the container MUST be passed to hooks over stdin so that they may do work appropriate to the current state of the container." | ||
| // PrestartTiming represents "The pre-start hooks MUST be called after the [`start`](runtime.md#start) operation is called but [before the user-specified program command is executed](runtime.md#lifecycle)." | ||
| PrestartTiming = "The pre-start hooks MUST be called after the [`start`](runtime.md#start) operation is called but [before the user-specified program command is executed](runtime.md#lifecycle)." | ||
| // PoststartTiming represents "The post-start hooks MUST be called [after the user-specified process is executed](runtime.md#lifecycle) but before the [`start`](runtime.md#start) operation returns." | ||
| PoststartTiming = "The post-start hooks MUST be called [after the user-specified process is executed](runtime.md#lifecycle) but before the [`start`](runtime.md#start) operation returns." | ||
| // PoststopTiming represents "The post-stop hooks MUST be called [after the container is deleted](runtime.md#lifecycle) but before the [`delete`](runtime.md#delete) operation returns." | ||
| PoststopTiming = "The post-stop hooks MUST be called [after the container is deleted](runtime.md#lifecycle) but before the [`delete`](runtime.md#delete) operation returns." | ||
| // AnnotationsKeyValueMap represents "Annotations MUST be a key-value map." | ||
| AnnotationsKeyValueMap = "Annotations MUST be a key-value map." | ||
| // AnnotationsKeyString represents "Keys MUST be strings." | ||
| AnnotationsKeyString = "Keys MUST be strings." | ||
| // AnnotationsKeyRequired represents "Keys MUST NOT be an empty string." | ||
| AnnotationsKeyRequired = "Keys MUST NOT be an empty string." | ||
| // AnnotationsKeyReversedDomain represents "Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`." | ||
| AnnotationsKeyReversedDomain = "Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`." | ||
| // AnnotationsKeyReservedNS represents "Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications." | ||
| AnnotationsKeyReservedNS = "Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications." | ||
| // AnnotationsKeyIgnoreUnknown represents "Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key." | ||
| AnnotationsKeyIgnoreUnknown = "Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key." | ||
| // AnnotationsValueString represents "Values MUST be strings." | ||
| AnnotationsValueString = "Values MUST be strings." | ||
| // ExtensibilityIgnoreUnknownProp represents "Runtimes that are reading or processing this configuration file MUST NOT generate an error if they encounter an unknown property." | ||
| ExtensibilityIgnoreUnknownProp = "Runtimes that are reading or processing this configuration file MUST NOT generate an error if they encounter an unknown property.\nInstead they MUST ignore unknown properties." | ||
| // ValidValues represents "Runtimes that are reading or processing this configuration file MUST generate an error when invalid or unsupported values are encountered." | ||
| ValidValues = "Runtimes that are reading or processing this configuration file MUST generate an error when invalid or unsupported values are encountered." | ||
| ) | ||
|
|
||
| var ( | ||
| specificationVersionRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#specification-version"), nil | ||
| } | ||
| rootRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#root"), nil | ||
| } | ||
| mountsRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#mounts"), nil | ||
| } | ||
| processRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#process"), nil | ||
| } | ||
| posixProcessRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#posix-process"), nil | ||
| } | ||
| linuxProcessRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#linux-process"), nil | ||
| } | ||
| platformSpecificConfigurationRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#platform-specific-configuration"), nil | ||
| } | ||
| posixPlatformHooksRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#posix-platform-hooks"), nil | ||
| } | ||
| prestartRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#prestart"), nil | ||
| } | ||
| poststartRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#poststart"), nil | ||
| } | ||
| poststopRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#poststop"), nil | ||
| } | ||
| annotationsRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#annotations"), nil | ||
| } | ||
| extensibilityRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#extensibility"), nil | ||
| } | ||
| validValuesRef = func(version string) (reference string, err error) { | ||
| return fmt.Sprintf(referenceTemplate, version, "config.md#valid-values"), nil | ||
| } | ||
| ) | ||
|
|
||
| func init() { | ||
| register(SpecVersionInSemVer, rfc2119.Must, specificationVersionRef) | ||
| register(RootOnWindowsRequired, rfc2119.Required, rootRef) | ||
| register(RootOnHyperVNotSet, rfc2119.Must, rootRef) | ||
| register(RootOnNonHyperVRequired, rfc2119.Required, rootRef) | ||
| register(RootPathOnWindowsGUID, rfc2119.Must, rootRef) | ||
| register(RootPathOnPosixConvention, rfc2119.Should, rootRef) | ||
| register(RootPathExist, rfc2119.Must, rootRef) | ||
| register(RootReadonlyImplement, rfc2119.Must, rootRef) | ||
| register(RootReadonlyOnWindowsFalse, rfc2119.Must, rootRef) | ||
| register(MountsInOrder, rfc2119.Must, mountsRef) | ||
| register(MountsDestAbs, rfc2119.Must, mountsRef) | ||
| register(MountsDestOnWindowsNotNested, rfc2119.Must, mountsRef) | ||
| register(MountsOptionsOnWindowsROSupport, rfc2119.Must, mountsRef) | ||
| register(ProcRequiredAtStart, rfc2119.Required, processRef) | ||
| register(ProcessConsoleSizeIgnore, rfc2119.Must, processRef) | ||
| register(ProcCwdAbs, rfc2119.Must, processRef) | ||
| register(ProcArgsOneEntryRequired, rfc2119.Required, processRef) | ||
| register(PosixProcRlimitsTypeGeneError, rfc2119.Must, posixProcessRef) | ||
| register(PosixProcRlimitsTypeGet, rfc2119.Must, posixProcessRef) | ||
| register(PosixProcRlimitsSoftMatchCur, rfc2119.Must, posixProcessRef) | ||
| register(PosixProcRlimitsHardMatchMax, rfc2119.Must, posixProcessRef) | ||
| register(PosixProcRlimitsErrorOnDup, rfc2119.Must, posixProcessRef) | ||
| register(LinuxProcCapError, rfc2119.Must, linuxProcessRef) | ||
| register(LinuxProcOomScoreAdjSet, rfc2119.Must, linuxProcessRef) | ||
| register(LinuxProcOomScoreAdjNotSet, rfc2119.Must, linuxProcessRef) | ||
| register(PlatformSpecConfOnWindowsSet, rfc2119.Must, platformSpecificConfigurationRef) | ||
| register(PosixHooksPathAbs, rfc2119.Must, posixPlatformHooksRef) | ||
| register(PosixHooksTimeoutPositive, rfc2119.Must, posixPlatformHooksRef) | ||
| register(PosixHooksCalledInOrder, rfc2119.Must, posixPlatformHooksRef) | ||
| register(PosixHooksStateToStdin, rfc2119.Must, posixPlatformHooksRef) | ||
| register(PrestartTiming, rfc2119.Must, prestartRef) | ||
| register(PoststartTiming, rfc2119.Must, poststartRef) | ||
| register(PoststopTiming, rfc2119.Must, poststopRef) | ||
| register(AnnotationsKeyValueMap, rfc2119.Must, annotationsRef) | ||
| register(AnnotationsKeyString, rfc2119.Must, annotationsRef) | ||
| register(AnnotationsKeyRequired, rfc2119.Must, annotationsRef) | ||
| register(AnnotationsKeyReversedDomain, rfc2119.Should, annotationsRef) | ||
| register(AnnotationsKeyReservedNS, rfc2119.Must, annotationsRef) | ||
| register(AnnotationsKeyIgnoreUnknown, rfc2119.Must, annotationsRef) | ||
| register(AnnotationsValueString, rfc2119.Must, annotationsRef) | ||
| register(ExtensibilityIgnoreUnknownProp, rfc2119.Must, extensibilityRef) | ||
| register(ValidValues, rfc2119.Must, validValuesRef) | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really our only
config-linux.mdrequirement? Either way, I'd rather get this PR landed, because the change feels to big to wait until it's complete and perfect.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no，these items were already recorded in runtime tools implementation. I add them first. The whole rfc errors will come later.