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

Jump to bottom

Improve readme builder for carvel pkgs #4138

Merged
merged 3 commits into from Jan 25, 2022
Merged

Improve readme builder for carvel pkgs #4138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c1b954
Improve the readme builder for carvel pkgs
antgamdia Jan 20, 2022
96254f9
Fix tests
antgamdia Jan 20, 2022
fc27659
Merge branch 'master' into improveReadme
antgamdia Jan 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 5 additions & 34 deletions cmd/kubeapps-apis/plugins/kapp_controller/packages/v1alpha1/server_data_adapters.go
View file
Open in desktop
Expand Up @@ -88,53 +88,24 @@ func (s *Server) buildAvailablePackageDetail(pkgMetadata *datapackagingv1alpha1.
iconStringBuilder.WriteString(pkgMetadata.Spec.IconSVGBase64)
}

// build maintainers information
maintainers := []*corev1.Maintainer{}
for _, maintainer := range pkgMetadata.Spec.Maintainers {
maintainers = append(maintainers, &corev1.Maintainer{
Name: maintainer.Name,
})
}

readme := fmt.Sprintf(`## Details
// build readme
readme := buildReadme(pkgMetadata, foundPkgSemver)


### Description:
%s


### Capactiy requirements:
%s


### Release Notes:
%s


### Support:
%s


### Licenses:
%s


### ReleasedAt:
%s


`,
pkgMetadata.Spec.LongDescription,
foundPkgSemver.pkg.Spec.CapactiyRequirementsDescription,
foundPkgSemver.pkg.Spec.ReleaseNotes,
pkgMetadata.Spec.SupportDescription,
foundPkgSemver.pkg.Spec.Licenses,
foundPkgSemver.pkg.Spec.ReleasedAt,
)
// build default values
defaultValues, err := defaultValuesFromSchema(foundPkgSemver.pkg.Spec.ValuesSchema.OpenAPIv3.Raw, true)
if err != nil {
log.Warningf("Failed to parse default values from schema: %v", err)
defaultValues = "# There is an error while parsing the schema."
}

availablePackageDetail := &corev1.AvailablePackageDetail{
AvailablePackageRef: &corev1.AvailablePackageReference{
Context: &corev1.Context{
Expand Down
95 changes: 49 additions & 46 deletions cmd/kubeapps-apis/plugins/kapp_controller/packages/v1alpha1/server_test.go
View file
Open in desktop
Expand Up @@ -258,6 +258,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -275,6 +276,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1997, time.December, 25, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -351,6 +353,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -411,6 +414,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -428,6 +432,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -445,6 +450,7 @@ func TestGetAvailablePackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -559,6 +565,7 @@ func TestGetAvailablePackageVersions(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -576,6 +583,7 @@ func TestGetAvailablePackageVersions(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -593,6 +601,7 @@ func TestGetAvailablePackageVersions(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -714,6 +723,7 @@ func TestGetAvailablePackageDetail(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand All @@ -729,41 +739,29 @@ func TestGetAvailablePackageDetail(t *testing.T) {
IconUrl: "data:image/svg+xml;base64,Tm90IHJlYWxseSBTVkcK",
ShortDescription: "A great game for arcade gamers",
Categories: []string{"logging", "daemon-set"},
Readme: fmt.Sprintf(`## Details
Readme: `## Description

A few sentences but not really a readme

### Description:
%s
## Capactiy requirements

capacity description

### Capactiy requirements:
%s
## Release notes

release notes

### Release Notes:
%s
Released at: June, 6 1984

## Support

### Support:
%s

Some support information

### Licenses:
%s


### ReleasedAt:
%s
## Licenses

- my-license

`,
"A few sentences but not really a readme",
"capacity description",
"release notes",
"Some support information",
[]string{"my-license"},
&metav1.Time{},
),
AvailablePackageRef: &corev1.AvailablePackageReference{
Context: defaultContext,
Identifier: "tetris.foo.example.com",
Expand Down Expand Up @@ -816,6 +814,7 @@ func TestGetAvailablePackageDetail(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand All @@ -831,41 +830,29 @@ func TestGetAvailablePackageDetail(t *testing.T) {
IconUrl: "data:image/svg+xml;base64,Tm90IHJlYWxseSBTVkcK",
ShortDescription: "A great game for arcade gamers",
Categories: []string{"logging", "daemon-set"},
Readme: fmt.Sprintf(`## Details
Readme: `## Description

A few sentences but not really a readme

### Description:
%s
## Capactiy requirements

capacity description

### Capactiy requirements:
%s
## Release notes

release notes

### Release Notes:
%s
Released at: June, 6 1984

## Support

### Support:
%s

Some support information

### Licenses:
%s


### ReleasedAt:
%s
## Licenses

- my-license

`,
"A few sentences but not really a readme",
"capacity description",
"release notes",
"Some support information",
[]string{"my-license"},
&metav1.Time{},
),
AvailablePackageRef: &corev1.AvailablePackageReference{
Context: defaultContext,
Identifier: "tetris.foo.example.com",
Expand Down Expand Up @@ -928,6 +915,7 @@ func TestGetAvailablePackageDetail(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -1017,6 +1005,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -1061,6 +1050,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&packagingv1alpha1.PackageInstall{
Expand Down Expand Up @@ -1204,6 +1194,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -1221,6 +1212,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&packagingv1alpha1.PackageInstall{
Expand Down Expand Up @@ -1412,6 +1404,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&packagingv1alpha1.PackageInstall{
Expand Down Expand Up @@ -1517,6 +1510,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -1534,6 +1528,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&datapackagingv1alpha1.Package{
Expand All @@ -1551,6 +1546,7 @@ func TestGetInstalledPackageSummaries(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&packagingv1alpha1.PackageInstall{
Expand Down Expand Up @@ -1724,6 +1720,7 @@ func TestGetInstalledPackageDetail(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&packagingv1alpha1.PackageInstall{
Expand Down Expand Up @@ -1980,6 +1977,7 @@ func TestCreateInstalledPackage(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&kappctrlv1alpha1.App{
Expand Down Expand Up @@ -2122,6 +2120,7 @@ func TestCreateInstalledPackage(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
},
Expand Down Expand Up @@ -2187,6 +2186,7 @@ func TestCreateInstalledPackage(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&kappctrlv1alpha1.App{
Expand Down Expand Up @@ -2331,6 +2331,7 @@ func TestCreateInstalledPackage(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&kappctrlv1alpha1.App{
Expand Down Expand Up @@ -2473,6 +2474,7 @@ func TestCreateInstalledPackage(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&kappctrlv1alpha1.App{
Expand Down Expand Up @@ -2665,6 +2667,7 @@ func TestUpdateInstalledPackage(t *testing.T) {
Licenses: []string{"my-license"},
ReleaseNotes: "release notes",
CapactiyRequirementsDescription: "capacity description",
ReleasedAt: metav1.Time{time.Date(1984, time.June, 6, 0, 0, 0, 0, time.UTC)},
},
},
&packagingv1alpha1.PackageInstall{
Expand Down