Skip to content

Commit 357d864

Browse files
author
Jim Minter
committed
oc new-app support for "hidden" tag in imagestreams
1 parent 3929053 commit 357d864

File tree

5 files changed

+201
-36
lines changed

5 files changed

+201
-36
lines changed

‎pkg/cmd/cli/cmd/newapp.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,9 @@ func printHumanReadableQueryResult(r *newcmd.QueryResult, out io.Writer, baseNam
809809
if len(imageStream.Status.Tags) > 0 {
810810
set := sets.NewString()
811811
for tag := range imageStream.Status.Tags {
812-
set.Insert(tag)
812+
if !imageStream.Spec.Tags[tag].HasAnnotationTag(imageapi.TagReferenceAnnotationTagHidden) {
813+
set.Insert(tag)
814+
}
813815
}
814816
tags = strings.Join(set.List(), ", ")
815817
}

‎pkg/generate/app/imagestreamlookup.go

+9
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,15 @@ func (r ImageStreamSearcher) Search(precise bool, terms ...string) (ComponentMat
143143
}
144144
foundOtherTags = true
145145

146+
// We check the "hidden" tags annotation /after/ setting
147+
// foundOtherTags = true. The ordering matters in the case that all
148+
// the tags on the imagestream are hidden. In this case, in new-app
149+
// we should behave as the imagestream didn't exist at all. This
150+
// means not calling addMatch("", ..., nil, true) below.
151+
if stream.Spec.Tags[tag].HasAnnotationTag(imageapi.TagReferenceAnnotationTagHidden) {
152+
continue
153+
}
154+
146155
// If the user specified a tag in their search string (followTag == false),
147156
// then score this match lower.
148157
tagScore := score

‎pkg/generate/app/imagestreamlookup_test.go

+111-34
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,32 @@ func TestImageStreamByAnnotationSearcherAndResolver(t *testing.T) {
3030
streams, images := fakeImageStreams(
3131
&fakeImageStreamDesc{
3232
name: "ruby",
33-
supports: map[string]string{
34-
"ruby20": "ruby:2.0,ruby:2.1,ruby",
35-
"ruby19": "ruby:1.9,ruby:1.9.4,ruby",
33+
tags: map[string]imageapi.TagReference{
34+
"ruby20": {
35+
Annotations: map[string]string{
36+
"supports": "ruby:2.0,ruby:2.1,ruby",
37+
},
38+
},
39+
"ruby19": {
40+
Annotations: map[string]string{
41+
"supports": "ruby:1.9,ruby:1.9.4,ruby",
42+
},
43+
},
3644
},
3745
},
3846
&fakeImageStreamDesc{
3947
name: "wildfly",
40-
supports: map[string]string{
41-
"v8": "wildfly:8.0,java,jee",
42-
"v7": "wildfly:7.0,java",
48+
tags: map[string]imageapi.TagReference{
49+
"v8": {
50+
Annotations: map[string]string{
51+
"supports": "wildfly:8.0,java,jee",
52+
},
53+
},
54+
"v7": {
55+
Annotations: map[string]string{
56+
"supports": "wildfly:7.0,java",
57+
},
58+
},
4359
},
4460
},
4561
)
@@ -93,17 +109,56 @@ func TestImageStreamByAnnotationSearcherAndResolver(t *testing.T) {
93109

94110
func TestImageStreamSearcher(t *testing.T) {
95111
streams, images := fakeImageStreams(
112+
&fakeImageStreamDesc{
113+
name: "nodejs1",
114+
tags: map[string]imageapi.TagReference{
115+
"0.10": {
116+
Annotations: map[string]string{
117+
"supports": "nodejs1:0.10,nodejs1:0.1,nodejs1",
118+
"tags": "hidden",
119+
},
120+
},
121+
"4": {
122+
Annotations: map[string]string{
123+
"supports": "nodejs1:4,nodejs1",
124+
},
125+
},
126+
},
127+
},
128+
&fakeImageStreamDesc{
129+
name: "nodejs2",
130+
tags: map[string]imageapi.TagReference{
131+
"0.10": {
132+
Annotations: map[string]string{
133+
"supports": "nodejs2:0.10,nodejs2:0.1,nodejs2",
134+
"tags": "hidden",
135+
},
136+
},
137+
},
138+
},
96139
&fakeImageStreamDesc{
97140
name: "ruby20",
98-
supports: map[string]string{
99-
"stable": "ruby:1.9,ruby:1.9.4",
141+
tags: map[string]imageapi.TagReference{
142+
"stable": {
143+
Annotations: map[string]string{
144+
"supports": "ruby:1.9,ruby:1.9.4",
145+
},
146+
},
100147
},
101148
},
102149
&fakeImageStreamDesc{
103150
name: "wildfly",
104-
supports: map[string]string{
105-
"v8": "java,jee",
106-
"v7": "java",
151+
tags: map[string]imageapi.TagReference{
152+
"v8": {
153+
Annotations: map[string]string{
154+
"supports": "java,jee",
155+
},
156+
},
157+
"v7": {
158+
Annotations: map[string]string{
159+
"supports": "java",
160+
},
161+
},
107162
},
108163
latest: "v8",
109164
},
@@ -130,6 +185,15 @@ func TestImageStreamSearcher(t *testing.T) {
130185
expectMatch: true,
131186
expectTag: "v8",
132187
},
188+
{
189+
value: "nodejs1",
190+
expectMatch: true,
191+
expectTag: "4",
192+
},
193+
{
194+
value: "nodejs2",
195+
expectMatch: false,
196+
},
133197
}
134198

135199
for _, test := range tests {
@@ -138,15 +202,15 @@ func TestImageStreamSearcher(t *testing.T) {
138202
t.Errorf("Expected a search match for %s. Got none: %v", test.value, errs)
139203
}
140204
if len(searchResults) == 1 && !test.expectMatch {
141-
t.Errorf("Did not expect search a match for %s. Got a match: %#v", test.value, searchResults[0])
205+
t.Errorf("Did not expect a search match for %s. Got a match: %#v", test.value, searchResults[0])
142206
}
143207

144208
result, err := resolver.Resolve(test.value)
145209
if err != nil && test.expectMatch {
146210
t.Errorf("Expected a resolve match for %s. Got none: %v", test.value, err)
147211
}
148212
if err == nil && !test.expectMatch {
149-
t.Errorf("Did not expect resolve a match for %s. Got a match: %v", test.value, err)
213+
t.Errorf("Did not expect a resolve match for %s. Got a match: %#v", test.value, result)
150214
}
151215
if err != nil {
152216
continue
@@ -218,11 +282,26 @@ func TestMatchSupportsAnnotation(t *testing.T) {
218282
}
219283

220284
func TestAnnotationMatches(t *testing.T) {
221-
stream, images := fakeImageStream("builder", map[string]string{
222-
"ruby": "ruby,ruby:2.0,ruby:1.9",
223-
"java": "java,jee,wildfly",
224-
"wildfly": "wildfly:8.0",
225-
}, "")
285+
stream, images := fakeImageStream(&fakeImageStreamDesc{
286+
name: "builder",
287+
tags: map[string]imageapi.TagReference{
288+
"ruby": {
289+
Annotations: map[string]string{
290+
"supports": "ruby,ruby:2.0,ruby:1.9",
291+
},
292+
},
293+
"java": {
294+
Annotations: map[string]string{
295+
"supports": "java,jee,wildfly",
296+
},
297+
},
298+
"wildfly": {
299+
Annotations: map[string]string{
300+
"supports": "wildfly:8.0",
301+
},
302+
},
303+
},
304+
latest: ""})
226305
client := testImageStreamClient(nil, images)
227306
searcher := NewImageStreamByAnnotationSearcher(client, client, []string{"default"}).(*ImageStreamByAnnotationSearcher)
228307
tests := []struct {
@@ -279,9 +358,9 @@ func TestAnnotationMatches(t *testing.T) {
279358
}
280359

281360
type fakeImageStreamDesc struct {
282-
name string
283-
supports map[string]string
284-
latest string
361+
name string
362+
tags map[string]imageapi.TagReference
363+
latest string
285364
}
286365

287366
func fakeImageStreams(descs ...*fakeImageStreamDesc) (*imageapi.ImageStreamList, map[string]*imageapi.ImageStreamImage) {
@@ -290,7 +369,7 @@ func fakeImageStreams(descs ...*fakeImageStreamDesc) (*imageapi.ImageStreamList,
290369
}
291370
allImages := map[string]*imageapi.ImageStreamImage{}
292371
for _, desc := range descs {
293-
stream, images := fakeImageStream(desc.name, desc.supports, desc.latest)
372+
stream, images := fakeImageStream(desc)
294373
streams.Items = append(streams.Items, *stream)
295374
for k, v := range images {
296375
allImages[k] = v
@@ -299,10 +378,11 @@ func fakeImageStreams(descs ...*fakeImageStreamDesc) (*imageapi.ImageStreamList,
299378
return streams, allImages
300379
}
301380

302-
func fakeImageStream(name string, supports map[string]string, latest string) (*imageapi.ImageStream, map[string]*imageapi.ImageStreamImage) {
381+
func fakeImageStream(desc *fakeImageStreamDesc) (*imageapi.ImageStream, map[string]*imageapi.ImageStreamImage) {
303382
stream := &imageapi.ImageStream{
304383
ObjectMeta: kapi.ObjectMeta{
305-
Name: name,
384+
Name: desc.name,
385+
Namespace: "namespace",
306386
},
307387
Spec: imageapi.ImageStreamSpec{
308388
Tags: map[string]imageapi.TagReference{},
@@ -312,31 +392,28 @@ func fakeImageStream(name string, supports map[string]string, latest string) (*i
312392
},
313393
}
314394
images := map[string]*imageapi.ImageStreamImage{}
315-
for tag, value := range supports {
316-
stream.Spec.Tags[tag] = imageapi.TagReference{
317-
Annotations: map[string]string{
318-
"supports": value,
319-
},
320-
}
395+
for tag, value := range desc.tags {
396+
stream.Spec.Tags[tag] = value
321397
stream.Status.Tags[tag] = imageapi.TagEventList{
322398
Items: []imageapi.TagEvent{
323399
{
324400
Image: tag + "-image",
325401
},
326402
},
327403
}
328-
images[name+"@"+tag+"-image"] = &imageapi.ImageStreamImage{
404+
images[desc.name+"@"+tag+"-image"] = &imageapi.ImageStreamImage{
329405
Image: imageapi.Image{
330406
DockerImageReference: "example/" + tag,
331407
DockerImageMetadata: imageapi.DockerImage{ID: tag},
332408
},
333409
}
334410
}
335-
if len(latest) > 0 {
411+
if len(desc.latest) > 0 {
336412
stream.Spec.Tags["latest"] = imageapi.TagReference{
337413
From: &kapi.ObjectReference{
338-
Kind: "ImageStreamTag",
339-
Name: latest,
414+
Kind: "ImageStreamTag",
415+
Name: desc.latest,
416+
Namespace: "namespace",
340417
},
341418
}
342419
}

‎pkg/image/api/helper.go

+12
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ const (
3535
// containerImageEntrypointAnnotationFormatKey is a format used to identify the entrypoint of a particular
3636
// container in a pod template. It is a JSON array of strings.
3737
containerImageEntrypointAnnotationFormatKey = "openshift.io/container.%s.image.entrypoint"
38+
39+
// TagReferenceAnnotationTagHidden indicates that a given TagReference is hidden from search results
40+
TagReferenceAnnotationTagHidden = "hidden"
3841
)
3942

4043
// DefaultRegistry returns the default Docker registry (host or host:port), or false if it is not available.
@@ -1002,3 +1005,12 @@ func IndexOfImageSignature(signatures []ImageSignature, sType string, sContent [
10021005
}
10031006
return -1
10041007
}
1008+
1009+
func (tagref TagReference) HasAnnotationTag(searchTag string) bool {
1010+
for _, tag := range strings.Split(tagref.Annotations["tags"], ",") {
1011+
if tag == searchTag {
1012+
return true
1013+
}
1014+
}
1015+
return false
1016+
}

‎test/integration/newapp_test.go

+66-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import (
3131

3232
buildapi "github.com/openshift/origin/pkg/build/api"
3333
client "github.com/openshift/origin/pkg/client/testclient"
34+
clicmd "github.com/openshift/origin/pkg/cmd/cli/cmd"
3435
deployapi "github.com/openshift/origin/pkg/deploy/api"
3536
"github.com/openshift/origin/pkg/dockerregistry"
3637
"github.com/openshift/origin/pkg/generate"
@@ -1412,7 +1413,7 @@ func TestNewAppRunBuilds(t *testing.T) {
14121413
}
14131414
}
14141415

1415-
func TestBuildOutputCycleDetection(t *testing.T) {
1416+
func TestNewAppBuildOutputCycleDetection(t *testing.T) {
14161417
skipExternalGit(t)
14171418
tests := []struct {
14181419
name string
@@ -1854,6 +1855,53 @@ func TestNewAppSourceAuthRequired(t *testing.T) {
18541855
}
18551856
}
18561857

1858+
func TestNewAppListAndSearch(t *testing.T) {
1859+
tests := []struct {
1860+
name string
1861+
options clicmd.NewAppOptions
1862+
expectedOutput string
1863+
}{
1864+
{
1865+
name: "search, no oldversion",
1866+
options: clicmd.NewAppOptions{
1867+
Config: &cmd.AppConfig{
1868+
ComponentInputs: cmd.ComponentInputs{
1869+
ImageStreams: []string{"ruby"},
1870+
},
1871+
AsSearch: true,
1872+
},
1873+
},
1874+
expectedOutput: "Image streams (oc new-app --image-stream=<image-stream> [--code=<source>])\n-----\nruby\n Project: default\n Tags: latest\n\n",
1875+
},
1876+
{
1877+
name: "list, no oldversion",
1878+
options: clicmd.NewAppOptions{
1879+
Config: &cmd.AppConfig{
1880+
AsList: true,
1881+
},
1882+
},
1883+
expectedOutput: "Image streams (oc new-app --image-stream=<image-stream> [--code=<source>])\n-----\nruby\n Project: default\n Tags: latest\n\n",
1884+
},
1885+
}
1886+
for _, test := range tests {
1887+
stdout, stderr := PrepareAppConfig(test.options.Config)
1888+
test.options.Out, test.options.ErrOut = stdout, stderr
1889+
test.options.BaseName = "oc"
1890+
test.options.CommandName = "new-app"
1891+
1892+
err := test.options.RunNewApp()
1893+
if err != nil {
1894+
t.Errorf("expected err == nil, got err == %v", err)
1895+
}
1896+
if stderr.Len() > 0 {
1897+
t.Errorf("expected stderr == %q, got stderr == %q", "", stderr.Bytes())
1898+
}
1899+
if string(stdout.Bytes()) != test.expectedOutput {
1900+
t.Errorf("expected stdout == %q, got stdout == %q", test.expectedOutput, stdout.Bytes())
1901+
}
1902+
}
1903+
}
1904+
18571905
func setupLocalGitRepo(t *testing.T, passwordProtected bool, requireProxy bool) string {
18581906
// Create test directories
18591907
testDir, err := ioutil.TempDir("", "gitauth")
@@ -1976,8 +2024,18 @@ func builderImageStream() *imageapi.ImageStream {
19762024
return &imageapi.ImageStream{
19772025
ObjectMeta: kapi.ObjectMeta{
19782026
Name: "ruby",
2027+
Namespace: "default",
19792028
ResourceVersion: "1",
19802029
},
2030+
Spec: imageapi.ImageStreamSpec{
2031+
Tags: map[string]imageapi.TagReference{
2032+
"oldversion": {
2033+
Annotations: map[string]string{
2034+
"tags": "hidden",
2035+
},
2036+
},
2037+
},
2038+
},
19812039
Status: imageapi.ImageStreamStatus{
19822040
Tags: map[string]imageapi.TagEventList{
19832041
"latest": {
@@ -1987,6 +2045,13 @@ func builderImageStream() *imageapi.ImageStream {
19872045
},
19882046
},
19892047
},
2048+
"oldversion": {
2049+
Items: []imageapi.TagEvent{
2050+
{
2051+
Image: "the-image-id",
2052+
},
2053+
},
2054+
},
19902055
},
19912056
DockerImageRepository: "example/ruby:latest",
19922057
},

0 commit comments

Comments
 (0)