Skip to content

Commit 4b7d9b6

Browse files
adambkaplanadambkaplan
committed
oc: add configmaps to build via cli
1 parent 167e110 commit 4b7d9b6

File tree

7 files changed

+167
-11
lines changed

7 files changed

+167
-11
lines changed

‎pkg/oc/cli/cmd/newbuild.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ var (
6060
# Create a build config from a remote repository and inject the npmrc into a build
6161
%[1]s %[2]s https://github.com/openshift/ruby-hello-world --build-secret npmrc:.npmrc
6262
63+
# Create a build config from a remote repository and inject environment data into a build
64+
%[1]s %[2]s https://github.com/openshift/ruby-hello-world --build-config-map env:config
65+
6366
# Create a build config that gets its input from a remote repository and another Docker image
6467
%[1]s %[2]s https://github.com/openshift/ruby-hello-world --source-image=openshift/jenkins-1-centos7 --source-image-path=/var/lib/jenkins:tmp`)
6568

@@ -112,6 +115,7 @@ func NewCmdNewBuild(name, baseName string, f *clientcmd.Factory, in io.Reader, o
112115
cmd.Flags().MarkDeprecated("image", "use --image-stream instead")
113116
cmd.Flags().StringSliceVarP(&config.ImageStreams, "image-stream", "i", config.ImageStreams, "Name of an image stream to to use as a builder.")
114117
cmd.Flags().StringSliceVar(&config.DockerImages, "docker-image", config.DockerImages, "Name of a Docker image to use as a builder.")
118+
cmd.Flags().StringSliceVar(&config.ConfigMaps, "build-config-map", config.ConfigMaps, "ConfigMap and destination to use as an input for the build.")
115119
cmd.Flags().StringSliceVar(&config.Secrets, "build-secret", config.Secrets, "Secret and destination to use as an input for the build.")
116120
cmd.Flags().StringVar(&config.SourceSecret, "source-secret", "", "The name of an existing secret that should be used for cloning a private git repository.")
117121
cmd.Flags().StringVar(&config.PushSecret, "push-secret", "", "The name of an existing secret that should be used for pushing the output image.")

‎pkg/oc/generate/app/app.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ type SourceRef struct {
112112
Name string
113113
ContextDir string
114114
Secrets []buildapi.SecretBuildSource
115+
ConfigMaps []buildapi.ConfigMapBuildSource
115116

116117
SourceImage *ImageRef
117118
ImageSourcePath string
@@ -153,6 +154,7 @@ func (r *SourceRef) BuildSource() (*buildapi.BuildSource, []buildapi.BuildTrigge
153154
}
154155
source := &buildapi.BuildSource{}
155156
source.Secrets = r.Secrets
157+
source.ConfigMaps = r.ConfigMaps
156158

157159
if len(r.DockerfileContents) != 0 {
158160
source.Dockerfile = &r.DockerfileContents

‎pkg/oc/generate/app/app_test.go

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,26 @@ func TestBuildConfigWithSecrets(t *testing.T) {
9696
}
9797
}
9898

99+
func TestBuildConfigWithConfigMaps(t *testing.T) {
100+
url, err := git.Parse("https://github.com/openshift/origin.git")
101+
if err != nil {
102+
t.Fatalf("unexpected error: %v", err)
103+
}
104+
source := &SourceRef{URL: url, ConfigMaps: []buildapi.ConfigMapBuildSource{
105+
{ConfigMap: kapi.LocalObjectReference{Name: "foo"}, DestinationDir: "/var"},
106+
{ConfigMap: kapi.LocalObjectReference{Name: "bar"}},
107+
}}
108+
build := &BuildRef{Source: source}
109+
config, err := build.BuildConfig()
110+
if err != nil {
111+
t.Fatalf("unexpected error: %v", err)
112+
}
113+
configMaps := config.Spec.Source.ConfigMaps
114+
if got := len(configMaps); got != 2 {
115+
t.Errorf("expected 2 source configMaps in build config, got %d", got)
116+
}
117+
}
118+
99119
func TestBuildConfigBinaryWithImageSource(t *testing.T) {
100120
source := &SourceRef{
101121
Name: "binarybuild",

‎pkg/oc/generate/app/sourcelookup.go

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ type SourceRepository struct {
101101
remoteURL *s2igit.URL
102102
contextDir string
103103
secrets []buildapi.SecretBuildSource
104+
configMaps []buildapi.ConfigMapBuildSource
104105
info *SourceRepositoryInfo
105106
sourceImage ComponentReference
106107
sourceImageFrom string
@@ -357,7 +358,12 @@ func (r *SourceRepository) ContextDir() string {
357358
return r.contextDir
358359
}
359360

360-
// Secrets returns the secrets
361+
// ConfigMaps returns the configMap build sources
362+
func (r *SourceRepository) ConfigMaps() []buildapi.ConfigMapBuildSource {
363+
return r.configMaps
364+
}
365+
366+
// Secrets returns the secret build sources
361367
func (r *SourceRepository) Secrets() []buildapi.SecretBuildSource {
362368
return r.secrets
363369
}
@@ -390,6 +396,43 @@ func (r *SourceRepository) AddDockerfile(contents string) error {
390396
return nil
391397
}
392398

399+
// AddBuildConfigMaps adds the defined configMaps into the build. The input format for
400+
// the secrets is "<secretName>:<destinationDir>". The destinationDir is
401+
// optional and when not specified the default is the current working directory.
402+
func (r *SourceRepository) AddBuildConfigMaps(configMaps []string) error {
403+
injections := s2iapi.VolumeList{}
404+
r.configMaps = []buildapi.ConfigMapBuildSource{}
405+
for _, in := range configMaps {
406+
if err := injections.Set(in); err != nil {
407+
return err
408+
}
409+
}
410+
configMapExists := func(name string) bool {
411+
for _, c := range r.configMaps {
412+
if c.ConfigMap.Name == name {
413+
return true
414+
}
415+
}
416+
return false
417+
}
418+
for _, in := range injections {
419+
if r.GetStrategy() == generate.StrategyDocker && filepath.IsAbs(in.Destination) {
420+
return fmt.Errorf("for the docker strategy, the configMap destination directory %q must be a relative path", in.Destination)
421+
}
422+
if len(validation.ValidateConfigMapName(in.Source, false)) != 0 {
423+
return fmt.Errorf("the %q must be a valid configMap name", in.Source)
424+
}
425+
if configMapExists(in.Source) {
426+
return fmt.Errorf("the %q configMap can be used just once", in.Source)
427+
}
428+
r.configMaps = append(r.configMaps, buildapi.ConfigMapBuildSource{
429+
ConfigMap: kapi.LocalObjectReference{Name: in.Source},
430+
DestinationDir: in.Destination,
431+
})
432+
}
433+
return nil
434+
}
435+
393436
// AddBuildSecrets adds the defined secrets into a build. The input format for
394437
// the secrets is "<secretName>:<destinationDir>". The destinationDir is
395438
// optional and when not specified the default is the current working directory.
@@ -540,6 +583,7 @@ func StrategyAndSourceForRepository(repo *SourceRepository, image *ImageRef) (*B
540583
source := &SourceRef{
541584
Binary: repo.binary,
542585
Secrets: repo.secrets,
586+
ConfigMaps: repo.configMaps,
543587
RequiresAuth: repo.requiresAuth,
544588
}
545589

‎pkg/oc/generate/app/sourcelookup_test.go

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,63 @@ func TestAddBuildSecrets(t *testing.T) {
6565
}
6666
}
6767
}
68+
69+
func TestAddBuildConfigMaps(t *testing.T) {
70+
type result struct{ name, dest string }
71+
type tc struct {
72+
in []string
73+
expect []result
74+
}
75+
table := []tc{
76+
{
77+
in: []string{"config1"},
78+
expect: []result{{name: "config1", dest: "."}},
79+
},
80+
{
81+
in: []string{"config1", "config1"},
82+
},
83+
{
84+
in: []string{"config1:/var/lib/foo"},
85+
expect: []result{{name: "config1", dest: "/var/lib/foo"}},
86+
},
87+
{
88+
in: []string{"config1", "config2:/foo"},
89+
expect: []result{
90+
{
91+
name: "config1",
92+
dest: ".",
93+
},
94+
{
95+
name: "config2",
96+
dest: "/foo",
97+
},
98+
},
99+
},
100+
}
101+
repo := &SourceRepository{}
102+
repo.strategy = generate.StrategyDocker
103+
if err := repo.AddBuildSecrets([]string{"config1:/absolute/path"}); err == nil {
104+
t.Errorf("expected error for docker strategy when destDir is absolute")
105+
}
106+
for _, item := range table {
107+
repo := &SourceRepository{}
108+
err := repo.AddBuildSecrets(item.in)
109+
if err != nil && len(item.expect) != 0 {
110+
t.Errorf("unexpected error: %v", err)
111+
continue
112+
}
113+
for _, expect := range item.expect {
114+
got := repo.Secrets()
115+
found := false
116+
for _, s := range got {
117+
if s.Secret.Name == expect.name && s.DestinationDir == expect.dest {
118+
found = true
119+
break
120+
}
121+
}
122+
if !found {
123+
t.Errorf("expected %+v secret in %#v not found", expect, got)
124+
}
125+
}
126+
}
127+
}

‎pkg/oc/generate/cmd/newapp.go

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ type GenerationInputs struct {
8383
SourceImage string
8484
SourceImagePath string
8585

86-
Secrets []string
86+
Secrets []string
87+
ConfigMaps []string
8788

8889
AllowMissingImageStreamTags bool
8990

@@ -438,11 +439,15 @@ func (c *AppConfig) buildPipelines(components app.ComponentReferences, environme
438439
switch {
439440
case refInput.ExpectToBuild:
440441
glog.V(4).Infof("will add %q secrets into a build for a source build of %q", strings.Join(c.Secrets, ","), refInput.Uses)
441-
442442
if err := refInput.Uses.AddBuildSecrets(c.Secrets); err != nil {
443443
return nil, fmt.Errorf("unable to add build secrets %q: %v", strings.Join(c.Secrets, ","), err)
444444
}
445445

446+
glog.V(4).Infof("will add %q configMaps into a build for a source build of %q", strings.Join(c.ConfigMaps, ","), refInput.Uses)
447+
if err = refInput.Uses.AddBuildConfigMaps(c.ConfigMaps); err != nil {
448+
return nil, fmt.Errorf("unable to add build configMaps %q: %v", strings.Join(c.Secrets, ","), err)
449+
}
450+
446451
if refInput.Uses.GetStrategy() == generate.StrategyDocker {
447452
numDockerBuilds++
448453
}

‎test/integration/newapp_test.go

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1355,6 +1355,7 @@ func TestNewAppRunBuilds(t *testing.T) {
13551355
ContextDir: "openshift/pipeline",
13561356
Git: &buildapi.GitBuildSource{URI: "https://github.com/openshift/nodejs-ex"},
13571357
Secrets: []buildapi.SecretBuildSource{},
1358+
ConfigMaps: []buildapi.ConfigMapBuildSource{},
13581359
}) {
13591360
return fmt.Errorf("invalid bc.Spec.Source, got %#v", bc.Spec.Source)
13601361
}
@@ -1395,6 +1396,7 @@ func TestNewAppRunBuilds(t *testing.T) {
13951396
ContextDir: "openshift/pipeline",
13961397
Git: &buildapi.GitBuildSource{URI: "https://github.com/openshift/nodejs-ex"},
13971398
Secrets: []buildapi.SecretBuildSource{},
1399+
ConfigMaps: []buildapi.ConfigMapBuildSource{},
13981400
}) {
13991401
return fmt.Errorf("invalid bc.Spec.Source, got %#v", bc.Spec.Source.Git)
14001402
}
@@ -1826,11 +1828,12 @@ func TestNewAppBuildConfigEnvVarsAndSecrets(t *testing.T) {
18261828
okRouteClient := &routefake.Clientset{}
18271829

18281830
tests := []struct {
1829-
name string
1830-
config *cmd.AppConfig
1831-
expected []kapi.EnvVar
1832-
expectedSecrets map[string]string
1833-
expectedErr error
1831+
name string
1832+
config *cmd.AppConfig
1833+
expected []kapi.EnvVar
1834+
expectedSecrets map[string]string
1835+
expectedConfigMaps map[string]string
1836+
expectedErr error
18341837
}{
18351838
{
18361839
name: "explicit environment variables for buildConfig and deploymentConfig",
@@ -1843,6 +1846,7 @@ func TestNewAppBuildConfigEnvVarsAndSecrets(t *testing.T) {
18431846
OutputDocker: true,
18441847
Environment: []string{"BUILD_ENV_1=env_value_1", "BUILD_ENV_2=env_value_2"},
18451848
Secrets: []string{"foo:/var", "bar"},
1849+
ConfigMaps: []string{"this:/tmp", "that"},
18461850
},
18471851

18481852
Resolvers: cmd.Resolvers{
@@ -1859,9 +1863,10 @@ func TestNewAppBuildConfigEnvVarsAndSecrets(t *testing.T) {
18591863
RouteClient: okRouteClient.Route(),
18601864
OriginNamespace: "default",
18611865
},
1862-
expected: []kapi.EnvVar{},
1863-
expectedSecrets: map[string]string{"foo": "/var", "bar": "."},
1864-
expectedErr: nil,
1866+
expected: []kapi.EnvVar{},
1867+
expectedSecrets: map[string]string{"foo": "/var", "bar": "."},
1868+
expectedConfigMaps: map[string]string{"this": "/tmp", "that": "."},
1869+
expectedErr: nil,
18651870
},
18661871
}
18671872

@@ -1875,11 +1880,13 @@ func TestNewAppBuildConfigEnvVarsAndSecrets(t *testing.T) {
18751880
}
18761881
got := []kapi.EnvVar{}
18771882
gotSecrets := []buildapi.SecretBuildSource{}
1883+
gotConfigMaps := []buildapi.ConfigMapBuildSource{}
18781884
for _, obj := range res.List.Items {
18791885
switch tp := obj.(type) {
18801886
case *buildapi.BuildConfig:
18811887
got = tp.Spec.Strategy.SourceStrategy.Env
18821888
gotSecrets = tp.Spec.Source.Secrets
1889+
gotConfigMaps = tp.Spec.Source.ConfigMaps
18831890
break
18841891
}
18851892
}
@@ -1898,6 +1905,20 @@ func TestNewAppBuildConfigEnvVarsAndSecrets(t *testing.T) {
18981905
}
18991906
}
19001907

1908+
for configName, destDir := range test.expectedConfigMaps {
1909+
found := false
1910+
for _, got := range gotConfigMaps {
1911+
if got.ConfigMap.Name == configName && got.DestinationDir == destDir {
1912+
found = true
1913+
continue
1914+
}
1915+
}
1916+
if !found {
1917+
t.Errorf("expected configMap %q and destination %q, got %#v", configName, destDir, gotConfigMaps)
1918+
continue
1919+
}
1920+
}
1921+
19011922
if !reflect.DeepEqual(test.expected, got) {
19021923
t.Errorf("%s: unexpected output. Expected: %#v, Got: %#v", test.name, test.expected, got)
19031924
continue

0 commit comments

Comments
 (0)