Port #4078 to Helm v3

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
pull/6619/head
Martin Hickey 6 years ago
parent 7ffc879f13
commit 6e429174cb

@ -71,6 +71,7 @@ func newGetCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
cmd.AddCommand(newGetValuesCmd(cfg, out)) cmd.AddCommand(newGetValuesCmd(cfg, out))
cmd.AddCommand(newGetManifestCmd(cfg, out)) cmd.AddCommand(newGetManifestCmd(cfg, out))
cmd.AddCommand(newGetHooksCmd(cfg, out)) cmd.AddCommand(newGetHooksCmd(cfg, out))
cmd.AddCommand(newGetNotesCmd(cfg, out))
return cmd return cmd
} }

@ -0,0 +1,57 @@
/*
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 main
import (
"fmt"
"io"
"github.com/spf13/cobra"
"helm.sh/helm/v3/cmd/helm/require"
"helm.sh/helm/v3/pkg/action"
)
var getNotesHelp = `
This command shows notes provided by the chart of a named release.
`
func newGetNotesCmd(cfg *action.Configuration, out io.Writer) *cobra.Command {
client := action.NewGet(cfg)
cmd := &cobra.Command{
Use: "notes [flags] RELEASE_NAME",
Short: "displays the notes of the named release",
Long: getNotesHelp,
Args: require.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
res, err := client.Run(args[0])
if err != nil {
return err
}
if len(res.Info.Notes) > 0 {
fmt.Fprintf(out, "NOTES:\n%s\n", res.Info.Notes)
}
return nil
},
}
f := cmd.Flags()
f.IntVar(&client.Version, "revision", 0, "get the named release with revision")
return cmd
}

@ -0,0 +1,38 @@
/*
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 main
import (
"testing"
"helm.sh/helm/v3/pkg/release"
)
func TestGetNotesCmd(t *testing.T) {
tests := []cmdTestCase{{
name: "get notes of a deployed release",
cmd: "get notes the-limerick",
golden: "output/get-notes.txt",
rels: []*release.Release{release.Mock(&release.MockReleaseOptions{Name: "the-limerick"})},
}, {
name: "get notes without args",
cmd: "get notes",
golden: "output/get-notes-no-args.txt",
wantError: true,
}}
runTestCmd(t, tests)
}

@ -0,0 +1,3 @@
Error: "helm get notes" requires 1 argument
Usage: helm get notes [flags] RELEASE_NAME

@ -0,0 +1,2 @@
NOTES:
Some mock release notes!

@ -24,3 +24,5 @@ kind: Secret
metadata: metadata:
name: fixture name: fixture
NOTES:
Some mock release notes!

@ -90,6 +90,7 @@ func Mock(opts *MockReleaseOptions) *Release {
LastDeployed: date, LastDeployed: date,
Status: scode, Status: scode,
Description: "Release mock", Description: "Release mock",
Notes: "Some mock release notes!",
} }
return &Release{ return &Release{

Loading…
Cancel
Save