Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit 4b4cfa0

Browse files
author
Ian Campbell
committed
Define constants for all parameter names
Signed-off-by: Ian Campbell <ijc@docker.com>
1 parent 2965541 commit 4b4cfa0

6 files changed

Lines changed: 20 additions & 13 deletions

File tree

internal/commands/cnab.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ func resolveBundle(dockerCli command.Cli, name string, pullRef bool, insecureReg
199199

200200
func requiredClaimBindMount(c claim.Claim, targetContextName string, dockerCli command.Cli) (bindMount, error) {
201201
var specifiedOrchestrator string
202-
if rawOrchestrator, ok := c.Parameters[internal.Namespace+"orchestrator"]; ok {
202+
if rawOrchestrator, ok := c.Parameters[internal.ParameterOrchestratorName]; ok {
203203
specifiedOrchestrator = rawOrchestrator.(string)
204204
}
205205

internal/commands/parameters.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ func withCommandLineParameters(overrides []string) parameterOperation {
3737

3838
func withOrchestratorParameters(orchestrator string, kubeNamespace string) parameterOperation {
3939
return func(bndl *bundle.Bundle, params map[string]string) error {
40-
if _, ok := bndl.Parameters[internal.Namespace+"orchestrator"]; ok {
41-
params[internal.Namespace+"orchestrator"] = orchestrator
40+
if _, ok := bndl.Parameters[internal.ParameterOrchestratorName]; ok {
41+
params[internal.ParameterOrchestratorName] = orchestrator
4242
}
43-
if _, ok := bndl.Parameters[internal.Namespace+"kubernetes-namespace"]; ok {
44-
params[internal.Namespace+"kubernetes-namespace"] = kubeNamespace
43+
if _, ok := bndl.Parameters[internal.ParameterKubernetesNamespaceName]; ok {
44+
params[internal.ParameterKubernetesNamespaceName] = kubeNamespace
4545
}
4646
return nil
4747
}

internal/commands/parameters_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ func TestWithOrchestratorParameters(t *testing.T) {
5858
{
5959
name: "Bundle with orchestrator params",
6060
parameters: map[string]bundle.ParameterDefinition{
61-
internal.Namespace + "orchestrator": {},
62-
internal.Namespace + "kubernetes-namespace": {},
61+
internal.ParameterOrchestratorName: {},
62+
internal.ParameterKubernetesNamespaceName: {},
6363
},
6464
expected: map[string]string{
65-
internal.Namespace + "orchestrator": "kubernetes",
66-
internal.Namespace + "kubernetes-namespace": "my-namespace",
65+
internal.ParameterOrchestratorName: "kubernetes",
66+
internal.ParameterKubernetesNamespaceName: "my-namespace",
6767
},
6868
},
6969
{

internal/commands/render.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func runRender(dockerCli command.Cli, appname string, opts renderOptions) error
5757
if err != nil {
5858
return err
5959
}
60-
c.Parameters[internal.Namespace+"render-format"] = opts.formatDriver
60+
c.Parameters[internal.ParameterRenderFormatName] = opts.formatDriver
6161

6262
if err := a.Run(c, nil, nil); err != nil {
6363
return fmt.Errorf("render failed: %s", errBuf)

internal/names.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ const (
3737
// CredentialDockerContextPath is the path to the credential containing a Docker context
3838
CredentialDockerContextPath = "/cnab/app/context.dockercontext"
3939

40+
// ParameterOrchestratorName is the name of the parameter containing the orchestrator
41+
ParameterOrchestratorName = Namespace + "orchestrator"
42+
// ParameterKubernetesNamespaceName is the name of the parameter containing the kubernetes namespace
43+
ParameterKubernetesNamespaceName = Namespace + "kubernetes-namespace"
44+
// ParameterRenderFormatName is the name of the parameter containing the kubernetes namespace
45+
ParameterRenderFormatName = Namespace + "render-format"
46+
4047
// DockerStackOrchestratorEnvVar is the environment variable set by the CNAB runtime to select
4148
// the stack orchestrator.
4249
DockerStackOrchestratorEnvVar = "DOCKER_STACK_ORCHESTRATOR"

internal/packager/cnab.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ func ToCNAB(app *types.App, invocationImageName string) (*bundle.Bundle, error)
1212
mapping := ExtractCNABParameterMapping(app.Parameters())
1313
flatParameters := app.Parameters().Flatten()
1414
parameters := map[string]bundle.ParameterDefinition{
15-
internal.Namespace + "orchestrator": {
15+
internal.ParameterOrchestratorName: {
1616
DataType: "string",
1717
AllowedValues: []interface{}{
1818
"",
@@ -33,7 +33,7 @@ func ToCNAB(app *types.App, invocationImageName string) (*bundle.Bundle, error)
3333
internal.ActionStatusName,
3434
},
3535
},
36-
internal.Namespace + "kubernetes-namespace": {
36+
internal.ParameterKubernetesNamespaceName: {
3737
DataType: "string",
3838
DefaultValue: "",
3939
Destination: &bundle.Location{
@@ -49,7 +49,7 @@ func ToCNAB(app *types.App, invocationImageName string) (*bundle.Bundle, error)
4949
internal.ActionStatusName,
5050
},
5151
},
52-
internal.Namespace + "render-format": {
52+
internal.ParameterRenderFormatName: {
5353
DataType: "string",
5454
AllowedValues: []interface{}{
5555
"yaml",

0 commit comments

Comments
 (0)