-
Notifications
You must be signed in to change notification settings - Fork 7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11204 from sabre1041/oci-annotations
Attach annotations to OCI artifacts
- Loading branch information
Showing
4 changed files
with
307 additions
and
6 deletions.
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
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,216 @@ | ||
/* | ||
Copyright The Helm Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package registry // import "helm.sh/helm/v3/pkg/registry" | ||
|
||
import ( | ||
"reflect" | ||
"testing" | ||
|
||
"helm.sh/helm/v3/pkg/chart" | ||
) | ||
|
||
func TestGenerateOCIChartAnnotations(t *testing.T) { | ||
|
||
tests := []struct { | ||
name string | ||
chart *chart.Metadata | ||
expect map[string]string | ||
}{ | ||
{ | ||
"Baseline chart", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
}, | ||
}, | ||
{ | ||
"Simple chart values", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Home: "https://helm.sh", | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"org.opencontainers.image.url": "https://helm.sh", | ||
}, | ||
}, | ||
{ | ||
"Maintainer without email", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Home: "https://helm.sh", | ||
Maintainers: []*chart.Maintainer{ | ||
{ | ||
Name: "John Snow", | ||
}, | ||
}, | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"org.opencontainers.image.url": "https://helm.sh", | ||
"org.opencontainers.image.authors": "John Snow", | ||
}, | ||
}, | ||
{ | ||
"Maintainer with email", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Home: "https://helm.sh", | ||
Maintainers: []*chart.Maintainer{ | ||
{Name: "John Snow", Email: "john@winterfell.com"}, | ||
}, | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"org.opencontainers.image.url": "https://helm.sh", | ||
"org.opencontainers.image.authors": "John Snow (john@winterfell.com)", | ||
}, | ||
}, | ||
{ | ||
"Multiple Maintainers", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Home: "https://helm.sh", | ||
Maintainers: []*chart.Maintainer{ | ||
{Name: "John Snow", Email: "john@winterfell.com"}, | ||
{Name: "Jane Snow"}, | ||
}, | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"org.opencontainers.image.url": "https://helm.sh", | ||
"org.opencontainers.image.authors": "John Snow (john@winterfell.com), Jane Snow", | ||
}, | ||
}, | ||
{ | ||
"Chart with Sources", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Sources: []string{ | ||
"https://github.com/helm/helm", | ||
}, | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"org.opencontainers.image.source": "https://github.com/helm/helm", | ||
}, | ||
}, | ||
} | ||
|
||
for _, tt := range tests { | ||
|
||
result := generateChartOCIAnnotations(tt.chart) | ||
|
||
if !reflect.DeepEqual(tt.expect, result) { | ||
t.Errorf("%s: expected map %v, got %v", tt.name, tt.expect, result) | ||
} | ||
|
||
} | ||
} | ||
|
||
func TestGenerateOCIAnnotations(t *testing.T) { | ||
|
||
tests := []struct { | ||
name string | ||
chart *chart.Metadata | ||
expect map[string]string | ||
}{ | ||
{ | ||
"Baseline chart", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
}, | ||
}, | ||
{ | ||
"Simple chart values with custom Annotations", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Annotations: map[string]string{ | ||
"extrakey": "extravlue", | ||
"anotherkey": "anothervalue", | ||
}, | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"extrakey": "extravlue", | ||
"anotherkey": "anothervalue", | ||
}, | ||
}, | ||
{ | ||
"Verify Chart Name and Version cannot be overridden from annotations", | ||
&chart.Metadata{ | ||
Name: "oci", | ||
Version: "0.0.1", | ||
Description: "OCI Helm Chart", | ||
Annotations: map[string]string{ | ||
"org.opencontainers.image.title": "badchartname", | ||
"org.opencontainers.image.version": "1.0.0", | ||
"extrakey": "extravlue", | ||
}, | ||
}, | ||
map[string]string{ | ||
"org.opencontainers.image.title": "oci", | ||
"org.opencontainers.image.version": "0.0.1", | ||
"org.opencontainers.image.description": "OCI Helm Chart", | ||
"extrakey": "extravlue", | ||
}, | ||
}, | ||
} | ||
|
||
for _, tt := range tests { | ||
|
||
result := generateOCIAnnotations(tt.chart) | ||
|
||
if !reflect.DeepEqual(tt.expect, result) { | ||
t.Errorf("%s: expected map %v, got %v", tt.name, tt.expect, result) | ||
} | ||
|
||
} | ||
} |
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