Merge pull request #3733 from tejal29/add_survey_command

Add a new survey command to show Skaffold User Survey form url.

Author: tejal29

cmd/skaffold/app/cmd/cmd.go

@@ -158,6 +158,7 @@ func NewSkaffoldCommand(out, err io.Writer) *cobra.Command {
 	rootCmd.AddCommand(NewCmdSchema())
 
 	rootCmd.AddCommand(NewCmdGeneratePipeline())
+	rootCmd.AddCommand(NewCmdSurvey())
 
 	templates.ActsAsRootCommand(rootCmd, nil, groups...)
 	rootCmd.PersistentFlags().StringVarP(&v, "verbosity", "v", constants.DefaultLogLevel.String(), "Log level (debug, info, warn, error, fatal, panic)")

cmd/skaffold/app/cmd/config/set.go

@@ -20,13 +20,10 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"reflect"
 	"strconv"
 	"strings"
 
-	yaml "gopkg.in/yaml.v2"
-
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
 )
 
@@ -159,22 +156,7 @@ func writeConfig(cfg *config.ContextConfig) error {
 			fullConfig.ContextConfigs = append(fullConfig.ContextConfigs, cfg)
 		}
 	}
-	return writeFullConfig(fullConfig)
-}
-
-func writeFullConfig(cfg *config.GlobalConfig) error {
-	contents, err := yaml.Marshal(cfg)
-	if err != nil {
-		return fmt.Errorf("marshaling config: %w", err)
-	}
-	configFileOrDefault, err := config.ResolveConfigFile(configFile)
-	if err != nil {
-		return err
-	}
-	if err := ioutil.WriteFile(configFileOrDefault, contents, 0644); err != nil {
-		return fmt.Errorf("writing config file: %w", err)
-	}
-	return nil
+	return config.WriteFullConfig(configFile, fullConfig)
 }
 
 func logSetConfigForUser(out io.Writer, key string, value string) {

cmd/skaffold/app/cmd/survey.go

@@ -0,0 +1,37 @@
+/*
+Copyright 2020 The Skaffold 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 cmd
+
+import (
+	"context"
+	"io"
+
+	"github.com/spf13/cobra"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/survey"
+)
+
+func NewCmdSurvey() *cobra.Command {
+	return NewCmd("survey").
+		WithDescription("Show Skaffold survey url").
+		NoArgs(showSurvey)
+}
+
+func showSurvey(context context.Context, out io.Writer) error {
+	s := survey.New(opts.GlobalConfig)
+	return s.OpenSurveyForm(context, out)
+}

docs/content/en/docs/references/cli/_index.md

@@ -87,6 +87,7 @@ Other Commands:
   credits           Export third party notices to given path (./skaffold-credits by default)
   diagnose          Run a diagnostic on Skaffold
   schema            List and print json schemas used to validate skaffold.yaml configuration
+  survey            Show Skaffold survey url
   version           Print the version information
 
 Use "skaffold <command> --help" for more information about a given command.
@@ -843,6 +844,21 @@ Usage:
 Use "skaffold options" for a list of global command-line options (applies to all commands).
 
 
+```
+
+### skaffold survey
+
+Show Skaffold survey url
+
+```
+
+
+Usage:
+  skaffold survey [options]
+
+Use "skaffold options" for a list of global command-line options (applies to all commands).
+
+
 ```
 
 ### skaffold version

go.mod

@@ -46,6 +46,7 @@ require (
 	github.com/opencontainers/go-digest v1.0.0-rc1.0.20190228220655-ac19fd6e7483
 	github.com/opencontainers/image-spec v1.0.1
 	github.com/openzipkin/zipkin-go v0.2.2 // indirect
+	github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4
 	github.com/rakyll/statik v0.1.7
 	github.com/rjeczalik/notify v0.9.2
 	github.com/russross/blackfriday/v2 v2.0.1

go.sum

@@ -617,6 +617,8 @@ github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtb
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
 github.com/peterbourgon/diskv v2.0.1+incompatible/go.mod h1:uqqh8zWWbv1HBMNONnaR/tNboyR3/BZd58JJSHlUSCU=
 github.com/pierrec/lz4 v1.0.2-0.20190131084431-473cd7ce01a1/go.mod h1:3/3N9NVKO0jef7pBehbT1qWhCMrIgbYNnFAZCqQ5LRc=
+github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4 h1:49lOXmGaUpV9Fz3gd7TFZY106KVlPVa5jcYD1gaQf98=
+github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4/go.mod h1:4OwLy04Bl9Ef3GJJCoec+30X3LQs/0/m4HFRt/2LUSA=
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.8.1-0.20171018195549-f15c970de5b7/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=

pkg/skaffold/config/util.go

@@ -55,6 +55,9 @@ var (
 	ReadConfigFile             = readConfigFileCached
 	GetConfigForCurrentKubectx = getConfigForCurrentKubectx
 	current                    = time.Now
+
+	// update global config with the time the survey was last taken
+	updateLastTaken = "skaffold config set --survey --global last-taken %s"
 )
 
 // readConfigFileCached reads the specified file and returns the contents
@@ -259,3 +262,46 @@ func lessThan(date string, duration time.Duration) bool {
 	}
 	return current().Sub(t) < duration
 }
+
+func UpdateGlobalSurveyTaken(configFile string) error {
+	// Today's date
+	today := current().Format(time.RFC3339)
+	ai := fmt.Sprintf(updateLastTaken, today)
+	aiErr := fmt.Errorf("could not automatically update the survey timestamp - please run `%s`", ai)
+
+	configFile, err := ResolveConfigFile(configFile)
+	if err != nil {
+		return aiErr
+	}
+	fullConfig, err := ReadConfigFile(configFile)
+	if err != nil {
+		return aiErr
+	}
+	if fullConfig.Global == nil {
+		fullConfig.Global = &ContextConfig{}
+	}
+	if fullConfig.Global.Survey == nil {
+		fullConfig.Global.Survey = &SurveyConfig{}
+	}
+	fullConfig.Global.Survey.LastTaken = today
+	err = WriteFullConfig(configFile, fullConfig)
+	if err != nil {
+		return aiErr
+	}
+	return err
+}
+
+func WriteFullConfig(configFile string, cfg *GlobalConfig) error {
+	contents, err := yaml.Marshal(cfg)
+	if err != nil {
+		return fmt.Errorf("marshaling config: %w", err)
+	}
+	configFileOrDefault, err := ResolveConfigFile(configFile)
+	if err != nil {
+		return err
+	}
+	if err := ioutil.WriteFile(configFileOrDefault, contents, 0644); err != nil {
+		return fmt.Errorf("writing config file: %w", err)
+	}
+	return nil
+}

pkg/skaffold/config/util_test.go

@@ -499,3 +499,63 @@ func TestGetDefaultRepo(t *testing.T) {
 		})
 	}
 }
+
+func TestUpdateGlobalSurveyTaken(t *testing.T) {
+	tests := []struct {
+		description string
+		cfg         string
+		expectedCfg *GlobalConfig
+	}{
+		{
+			description: "update global context when context is empty",
+			expectedCfg: &GlobalConfig{
+				Global:         &ContextConfig{Survey: &SurveyConfig{}},
+				ContextConfigs: []*ContextConfig{},
+			},
+		},
+		{
+			description: "update global context when survey config is not nil",
+			cfg: `
+global:
+  survey:
+    last-prompted: "some date"
+kubeContexts: []`,
+			expectedCfg: &GlobalConfig{
+				Global:         &ContextConfig{Survey: &SurveyConfig{LastPrompted: "some date"}},
+				ContextConfigs: []*ContextConfig{},
+			},
+		},
+		{
+			description: "update global context when survey config last taken is in past",
+			cfg: `
+global:
+  survey:
+    last-taken: "some date in past"
+kubeContexts: []`,
+			expectedCfg: &GlobalConfig{
+				Global:         &ContextConfig{Survey: &SurveyConfig{}},
+				ContextConfigs: []*ContextConfig{},
+			},
+		},
+	}
+	for _, test := range tests {
+		testutil.Run(t, test.description, func(t *testutil.T) {
+			cfg := t.TempFile("config", []byte(test.cfg))
+			testTime := time.Now()
+			t.Override(&ReadConfigFile, ReadConfigFileNoCache)
+			t.Override(&current, func() time.Time {
+				return testTime
+			})
+
+			// update the time
+			err := UpdateGlobalSurveyTaken(cfg)
+			t.CheckNoError(err)
+
+			actualConfig, cfgErr := ReadConfigFile(cfg)
+			t.CheckNoError(cfgErr)
+			// update time in expected cfg.
+			test.expectedCfg.Global.Survey.LastTaken = testTime.Format(time.RFC3339)
+			t.CheckDeepEqual(test.expectedCfg, actualConfig)
+		})
+	}
+}

pkg/skaffold/survey/survey.go

@@ -17,26 +17,64 @@ limitations under the License.
 package survey
 
 import (
+	"context"
+	"fmt"
 	"io"
 	"os"
 
-	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/color"
+	"github.com/pkg/browser"
+	"github.com/sirupsen/logrus"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
 )
 
 const (
-	Prompt = `Help improve Skaffold! Take a 10 seconds anonymous survey by running
-   $skaffold survey`
+	Prompt = `Help improve Skaffold! Take a 10-second anonymous survey by running
+   skaffold survey`
+
+	URL = "https://forms.gle/BMTbGQXLWSdn7vEs6"
 )
 
-// for testing
 var (
+	Form = fmt.Sprintf(`Thank you for offering your feedback on Skaffold! Understanding your experiences and opinions helps us make Skaffold better for you and other users.
+   Our survey can be found here: %s
+
+To permanently disable the survey prompt, run:
+   skaffold config set --survey --global disable-prompt true`, URL)
+
+	// for testing
 	isStdOut = stdOut
+	open     = browser.OpenURL
 )
 
-func DisplaySurveyForm(out io.Writer) {
+type Runner struct {
+	configFile string
+}
+
+func New(configFile string) *Runner {
+	return &Runner{
+		configFile: configFile,
+	}
+}
+
+func DisplaySurveyPrompt(out io.Writer) {
 	if isStdOut(out) {
-		color.Default.Fprintln(out, Prompt)
+		fmt.Fprintln(out, Prompt)
+	}
+}
+
+func (s *Runner) OpenSurveyForm(_ context.Context, out io.Writer) error {
+	_, err := fmt.Fprintln(out, Form)
+	if err != nil {
+		return err
+	}
+	if err := open(URL); err != nil {
+		logrus.Debugf("could not open url %s", URL)
+		return err
 	}
+	// Currently we will only update the global survey taken
+	// When prompting for the survey, we need to use the same field.
+	return config.UpdateGlobalSurveyTaken(s.configFile)
 }
 
 func stdOut(out io.Writer) bool {

pkg/skaffold/survey/survey_test.go

@@ -44,8 +44,10 @@ func TestDisplaySurveyForm(t *testing.T) {
 		testutil.Run(t, test.description, func(t *testutil.T) {
 			mock := func(io.Writer) bool { return test.mockStdOut }
 			t.Override(&isStdOut, mock)
+			mockOpen := func(string) error { return nil }
+			t.Override(&open, mockOpen)
 			var buf bytes.Buffer
-			DisplaySurveyForm(&buf)
+			DisplaySurveyPrompt(&buf)
 			t.CheckDeepEqual(test.expected, buf.String())
 		})
 	}