Skip to content
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.

Sign up for GitHub

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

oc new-app support for "hidden" tag in imagestreams #12100

Merged
merged 1 commit into from
Dec 2, 2016
Merged

oc new-app support for "hidden" tag in imagestreams #12100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion pkg/cmd/cli/cmd/newapp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,7 +809,9 @@ func printHumanReadableQueryResult(r *newcmd.QueryResult, out io.Writer, baseNam
if len(imageStream.Status.Tags) > 0 {
set := sets.NewString()
for tag := range imageStream.Status.Tags {
set.Insert(tag)
if !imageStream.Spec.Tags[tag].HasAnnotationTag(imageapi.TagReferenceAnnotationTagHidden) {
set.Insert(tag)
}
}
tags = strings.Join(set.List(), ", ")
}
Expand Down
9 changes: 9 additions & 0 deletions pkg/generate/app/imagestreamlookup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,15 @@ func (r ImageStreamSearcher) Search(precise bool, terms ...string) (ComponentMat
}
foundOtherTags = true

// We check the "hidden" tags annotation /after/ setting
// foundOtherTags = true. The ordering matters in the case that all
// the tags on the imagestream are hidden. In this case, in new-app
// we should behave as the imagestream didn't exist at all. This
// means not calling addMatch("", ..., nil, true) below.
if stream.Spec.Tags[tag].HasAnnotationTag(imageapi.TagReferenceAnnotationTagHidden) {
continue
}

// If the user specified a tag in their search string (followTag == false),
// then score this match lower.
tagScore := score
Expand Down
145 changes: 111 additions & 34 deletions pkg/generate/app/imagestreamlookup_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,32 @@ func TestImageStreamByAnnotationSearcherAndResolver(t *testing.T) {
streams, images := fakeImageStreams(
&fakeImageStreamDesc{
name: "ruby",
supports: map[string]string{
"ruby20": "ruby:2.0,ruby:2.1,ruby",
"ruby19": "ruby:1.9,ruby:1.9.4,ruby",
tags: map[string]imageapi.TagReference{
"ruby20": {
Annotations: map[string]string{
"supports": "ruby:2.0,ruby:2.1,ruby",
},
},
"ruby19": {
Annotations: map[string]string{
"supports": "ruby:1.9,ruby:1.9.4,ruby",
},
},
},
},
&fakeImageStreamDesc{
name: "wildfly",
supports: map[string]string{
"v8": "wildfly:8.0,java,jee",
"v7": "wildfly:7.0,java",
tags: map[string]imageapi.TagReference{
"v8": {
Annotations: map[string]string{
"supports": "wildfly:8.0,java,jee",
},
},
"v7": {
Annotations: map[string]string{
"supports": "wildfly:7.0,java",
},
},
},
},
)
Expand Down Expand Up @@ -93,17 +109,56 @@ func TestImageStreamByAnnotationSearcherAndResolver(t *testing.T) {

func TestImageStreamSearcher(t *testing.T) {
streams, images := fakeImageStreams(
&fakeImageStreamDesc{
name: "nodejs1",
tags: map[string]imageapi.TagReference{
"0.10": {
Annotations: map[string]string{
"supports": "nodejs1:0.10,nodejs1:0.1,nodejs1",
"tags": "hidden",
},
},
"4": {
Annotations: map[string]string{
"supports": "nodejs1:4,nodejs1",
},
},
},
},
&fakeImageStreamDesc{
name: "nodejs2",
tags: map[string]imageapi.TagReference{
"0.10": {
Annotations: map[string]string{
"supports": "nodejs2:0.10,nodejs2:0.1,nodejs2",
"tags": "hidden",
},
},
},
},
&fakeImageStreamDesc{
name: "ruby20",
supports: map[string]string{
"stable": "ruby:1.9,ruby:1.9.4",
tags: map[string]imageapi.TagReference{
"stable": {
Annotations: map[string]string{
"supports": "ruby:1.9,ruby:1.9.4",
},
},
},
},
&fakeImageStreamDesc{
name: "wildfly",
supports: map[string]string{
"v8": "java,jee",
"v7": "java",
tags: map[string]imageapi.TagReference{
"v8": {
Annotations: map[string]string{
"supports": "java,jee",
},
},
"v7": {
Annotations: map[string]string{
"supports": "java",
},
},
},
latest: "v8",
},
Expand All @@ -130,6 +185,15 @@ func TestImageStreamSearcher(t *testing.T) {
expectMatch: true,
expectTag: "v8",
},
{
value: "nodejs1",
expectMatch: true,
expectTag: "4",
},
{
value: "nodejs2",
expectMatch: false,
},
}

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

result, err := resolver.Resolve(test.value)
if err != nil && test.expectMatch {
t.Errorf("Expected a resolve match for %s. Got none: %v", test.value, err)
}
if err == nil && !test.expectMatch {
t.Errorf("Did not expect resolve a match for %s. Got a match: %v", test.value, err)
t.Errorf("Did not expect a resolve match for %s. Got a match: %#v", test.value, result)
}
if err != nil {
continue
Expand Down Expand Up @@ -218,11 +282,26 @@ func TestMatchSupportsAnnotation(t *testing.T) {
}

func TestAnnotationMatches(t *testing.T) {
stream, images := fakeImageStream("builder", map[string]string{
"ruby": "ruby,ruby:2.0,ruby:1.9",
"java": "java,jee,wildfly",
"wildfly": "wildfly:8.0",
}, "")
stream, images := fakeImageStream(&fakeImageStreamDesc{
name: "builder",
tags: map[string]imageapi.TagReference{
"ruby": {
Annotations: map[string]string{
"supports": "ruby,ruby:2.0,ruby:1.9",
},
},
"java": {
Annotations: map[string]string{
"supports": "java,jee,wildfly",
},
},
"wildfly": {
Annotations: map[string]string{
"supports": "wildfly:8.0",
},
},
},
latest: ""})
client := testImageStreamClient(nil, images)
searcher := NewImageStreamByAnnotationSearcher(client, client, []string{"default"}).(*ImageStreamByAnnotationSearcher)
tests := []struct {
Expand Down Expand Up @@ -279,9 +358,9 @@ func TestAnnotationMatches(t *testing.T) {
}

type fakeImageStreamDesc struct {
name string
supports map[string]string
latest string
name string
tags map[string]imageapi.TagReference
latest string
}

func fakeImageStreams(descs ...*fakeImageStreamDesc) (*imageapi.ImageStreamList, map[string]*imageapi.ImageStreamImage) {
Expand All @@ -290,7 +369,7 @@ func fakeImageStreams(descs ...*fakeImageStreamDesc) (*imageapi.ImageStreamList,
}
allImages := map[string]*imageapi.ImageStreamImage{}
for _, desc := range descs {
stream, images := fakeImageStream(desc.name, desc.supports, desc.latest)
stream, images := fakeImageStream(desc)
streams.Items = append(streams.Items, *stream)
for k, v := range images {
allImages[k] = v
Expand All @@ -299,10 +378,11 @@ func fakeImageStreams(descs ...*fakeImageStreamDesc) (*imageapi.ImageStreamList,
return streams, allImages
}

func fakeImageStream(name string, supports map[string]string, latest string) (*imageapi.ImageStream, map[string]*imageapi.ImageStreamImage) {
func fakeImageStream(desc *fakeImageStreamDesc) (*imageapi.ImageStream, map[string]*imageapi.ImageStreamImage) {
stream := &imageapi.ImageStream{
ObjectMeta: kapi.ObjectMeta{
Name: name,
Name: desc.name,
Namespace: "namespace",
},
Spec: imageapi.ImageStreamSpec{
Tags: map[string]imageapi.TagReference{},
Expand All @@ -312,31 +392,28 @@ func fakeImageStream(name string, supports map[string]string, latest string) (*i
},
}
images := map[string]*imageapi.ImageStreamImage{}
for tag, value := range supports {
stream.Spec.Tags[tag] = imageapi.TagReference{
Annotations: map[string]string{
"supports": value,
},
}
for tag, value := range desc.tags {
stream.Spec.Tags[tag] = value
stream.Status.Tags[tag] = imageapi.TagEventList{
Items: []imageapi.TagEvent{
{
Image: tag + "-image",
},
},
}
images[name+"@"+tag+"-image"] = &imageapi.ImageStreamImage{
images[desc.name+"@"+tag+"-image"] = &imageapi.ImageStreamImage{
Image: imageapi.Image{
DockerImageReference: "example/" + tag,
DockerImageMetadata: imageapi.DockerImage{ID: tag},
},
}
}
if len(latest) > 0 {
if len(desc.latest) > 0 {
stream.Spec.Tags["latest"] = imageapi.TagReference{
From: &kapi.ObjectReference{
Kind: "ImageStreamTag",
Name: latest,
Kind: "ImageStreamTag",
Name: desc.latest,
Namespace: "namespace",
},
}
}
Expand Down
12 changes: 12 additions & 0 deletions pkg/image/api/helper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ const (
// containerImageEntrypointAnnotationFormatKey is a format used to identify the entrypoint of a particular
// container in a pod template. It is a JSON array of strings.
containerImageEntrypointAnnotationFormatKey = "openshift.io/container.%s.image.entrypoint"

// TagReferenceAnnotationTagHidden indicates that a given TagReference is hidden from search results
TagReferenceAnnotationTagHidden = "hidden"
)

// DefaultRegistry returns the default Docker registry (host or host:port), or false if it is not available.
Expand Down Expand Up @@ -1002,3 +1005,12 @@ func IndexOfImageSignature(signatures []ImageSignature, sType string, sContent [
}
return -1
}

func (tagref TagReference) HasAnnotationTag(searchTag string) bool {
for _, tag := range strings.Split(tagref.Annotations["tags"], ",") {
if tag == searchTag {
return true
}
}
return false
}
2 changes: 1 addition & 1 deletion test/cmd/newapp.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ os::cmd::try_until_success 'oc get imagestreamtags wildfly:8.1'

os::cmd::expect_success_and_text 'oc new-app --search --image-stream=mongodb' "Tags:\s+2.4, 2.6, 3.2, latest"
os::cmd::expect_success_and_text 'oc new-app --search --image-stream=mysql' "Tags:\s+5.5, 5.6, latest"
os::cmd::expect_success_and_text 'oc new-app --search --image-stream=nodejs' "Tags:\s+0.10, 4, latest"
os::cmd::expect_success_and_text 'oc new-app --search --image-stream=nodejs' "Tags:\s+4, latest"
os::cmd::expect_success_and_text 'oc new-app --search --image-stream=perl' "Tags:\s+5.16, 5.20, latest"
os::cmd::expect_success_and_text 'oc new-app --search --image-stream=php' "Tags:\s+5.5, 5.6, latest"
os::cmd::expect_success_and_text 'oc new-app --search --image-stream=postgresql' "Tags:\s+9.2, 9.4, 9.5, latest"
Expand Down
Loading