Add 'get notes' subcommand based on similar v2 code.

Signed-off-by: Michael Nelson <minelson@vmware.com>
pull/6645/head
Michael Nelson 6 years ago
parent 0227ade173
commit b6054d63b2

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

@ -0,0 +1,56 @@
/*
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 RELEASE_NAME [flags]",
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
},
}
cmd.Flags().IntVar(&client.Version, "revision", 0, "get the named release with revision")
return cmd
}

@ -0,0 +1,46 @@
/*
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 flummoxed-chickadee",
golden: "output/get-notes.txt",
rels: []*release.Release{
release.Mock(&release.MockReleaseOptions{
Name: "flummoxed-chickadee",
Notes: "Release notes",
}),
},
},
{
name: "get notes requires release name arg",
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 RELEASE_NAME [flags]

@ -0,0 +1,2 @@
NOTES:
Release notes

@ -45,6 +45,7 @@ type MockReleaseOptions struct {
Chart *chart.Chart
Status Status
Namespace string
Notes string
}
// Mock creates a mock release object based on options set by MockReleaseOptions. This function should typically not be used outside of testing.
@ -90,6 +91,7 @@ func Mock(opts *MockReleaseOptions) *Release {
LastDeployed: date,
Status: scode,
Description: "Release mock",
Notes: opts.Notes,
}
return &Release{

Loading…
Cancel
Save