Merge remote-tracking branch 'upstream/master' into development

Author: Smarticles101

CHANGELOG.md

@@ -7,6 +7,12 @@ The exercism CLI follows [semantic versioning](http://semver.org/).
 ## Next Release
 * **Your contribution here**
 
+## v3.0.11 (2018-11-18)
+* [#752](https://github.com/exercism/cli/pull/752) Improve error message on upgrade command - [@farisj]
+* [#759](https://github.com/exercism/cli/pull/759) Update shell tab completion for bash and zsh - [@nywilken]
+* [#762](https://github.com/exercism/cli/pull/762) Improve usage documentation - [@Smarticles101]
+* [#766](https://github.com/exercism/cli/pull/766) Tweak messaging to work for teams edition - [@kytrinyx]
+
 ## v3.0.10 (2018-10-03)
 * official release of v3.0.10-alpha.1 - [@nywilken]
 
@@ -402,8 +408,12 @@ All changes by [@msgehard]
 * Implement login and logout
 * Build on Travis
 
-[@alebaffa]: https://github.com/alebaffa
 [@AlexWheeler]: https://github.com/AlexWheeler
+[@Dparker1990]: https://github.com/Dparker1990
+[@LegalizeAdulthood]: https://github.com/LegalizeAdulthood
+[@Tonkpils]: https://github.com/Tonkpils
+[@TrevorBramble]: https://github.com/TrevorBramble
+[@alebaffa]: https://github.com/alebaffa
 [@ambroff]: https://github.com/ambroff
 [@andrewsardone]: https://github.com/andrewsardone
 [@anxiousmodernman]: https://github.com/anxiousmodernman
@@ -414,27 +424,26 @@ All changes by [@msgehard]
 [@cookrn]: https://github.com/cookrn
 [@daveyarwood]: https://github.com/daveyarwood
 [@devonestes]: https://github.com/devonestes
-[@Dparker1990]: https://github.com/Dparker1990
 [@djquan]: https://github.com/djquan
 [@dmmulroy]: https://github.com/dmmulroy
 [@dpritchett]: https://github.com/dpritchett
 [@eToThePiIPower]: https://github.com/eToThePiIPower
 [@ebautistabar]: https://github.com/ebautistabar
 [@elimisteve]: https://github.com/elimisteve
 [@ests]: https://github.com/ests
+[@farisj]: https://github.com/farisj
 [@glebedel]: https://github.com/glebedel
 [@harimp]: https://github.com/harimp
 [@hjljo]: https://github.com/hjljo
 [@isbadawi]: https://github.com/isbadawi
-[@jdsutherland]: https://github.com/jdsutherland
 [@jbaiter]: https://github.com/jbaiter
+[@jdsutherland]: https://github.com/jdsutherland
 [@jgsqware]: https://github.com/jgsqware
 [@jish]: https://github.com/jish
 [@jppunnett]: https://github.com/jppunnett
-[@kytrinyx]: https://github.com/kytrinyx
 [@katrinleinweber]: https://github.com/katrinleinweber
+[@kytrinyx]: https://github.com/kytrinyx
 [@lcowell]: https://github.com/lcowell
-[@LegalizeAdulthood]: https://github.com/LegalizeAdulthood
 [@manusajith]: https://github.com/manusajith
 [@morphatic]: https://github.com/morphatic
 [@mrageh]: https://github.com/mrageh
@@ -452,7 +461,6 @@ All changes by [@msgehard]
 [@sfairchild]: https://github.com/sfairchild
 [@simonjefford]: https://github.com/simonjefford
 [@srt32]: https://github.com/srt32
-[@Tonkpils]: https://github.com/Tonkpils
-[@TrevorBramble]: https://github.com/TrevorBramble
 [@williandrade]: https://github.com/williandrade
 [@zabawaba99]: https://github.com/zabawaba99
+[@Smarticles101]: https://github.com/Smarticles101

RELEASE.md

@@ -24,9 +24,12 @@ $ sudo GCO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=5 ./make.bash --no-clean
 Make sure all the recent changes are reflected in the "next release" section
 of the Changelog. Make this a separate commit from bumping the version.
 
+You can view changes using the /compare/ view:
+https://github.com/exercism/cli/compare/$PREVIOUS_RELEASE...master
+
 ## Bump the version
 
-Edit the `Version` constant in `exercism/main.go`, and edit the Changelog.
+Edit the `Version` constant in `cmd/version.go`, and edit the Changelog.
 
 All the changes in the "next release" section should be moved to a new section
 that describes the version number, and gives it a date.
@@ -51,25 +54,15 @@ VERSION matches the value of the `Version` constant.
 
 Upload all the binaries from `release/*`.
 
-Paste the release text and describe the new changes (`tail -n +57 RELEASE.md | head -n 16 | pbcopy`):
+Paste the release text and describe the new changes.
 
 ```
-### Exercism Command-Line Interface (CLI)
-
-Exercism takes place in two places: the discussions happen on the website, and you work on exercises locally. The CLI bridges the gap, allowing you to fetch exercises and submit solutions to the site.
-
-This is a stand-alone binary, which means that you don't need to install any particular language or environment in order to use it.
-
-To install, download the archive that matches your operating system and architecture, unpack the archive, and put the binary somewhere on your path.
-
-You will need to configure the CLI with your [Exercism API Key](http://exercism.io/account/key) before submitting.
+To install, follow the interactive installation instructions at https://exercism.io/cli-walkthrough
 
-For more detailed instructions, see the [CLI page on Exercism](http://exercism.io/cli).
+---
 
-#### Recent changes
+[describe changes in this release]
 
-* ABC...
-* XYZ...
 ```
 
 ## Update Homebrew

cmd/cmd.go

@@ -1,5 +1,12 @@
 package cmd
 
+import (
+	"fmt"
+
+	"github.com/exercism/cli/config"
+	"github.com/spf13/viper"
+)
+
 const msgWelcomePleaseConfigure = `
 
     Welcome to Exercism!
@@ -33,3 +40,18 @@ const msgMissingMetadata = `
     Please see https://exercism.io/cli-v1-to-v2 for instructions on how to fix it.
 
 `
+
+// validateUserConfig validates the presense of required user config values
+func validateUserConfig(cfg *viper.Viper) error {
+	if cfg.GetString("token") == "" {
+		return fmt.Errorf(
+			msgWelcomePleaseConfigure,
+			config.SettingsURL(cfg.GetString("apibaseurl")),
+			BinaryName,
+		)
+	}
+	if cfg.GetString("workspace") == "" || cfg.GetString("apibaseurl") == "" {
+		return fmt.Errorf(msgRerunConfigure, BinaryName)
+	}
+	return nil
+}

cmd/configure_test.go

@@ -18,14 +18,6 @@ import (
 )
 
 func TestBareConfigure(t *testing.T) {
-	oldErr := Err
-	defer func() {
-		Err = oldErr
-	}()
-
-	var buf bytes.Buffer
-	Err = &buf
-
 	flags := pflag.NewFlagSet("fake", pflag.PanicOnError)
 	setupConfigureFlags(flags)
 
@@ -40,7 +32,9 @@ func TestBareConfigure(t *testing.T) {
 	}
 
 	err = runConfigure(cfg, flags)
-	assert.Regexp(t, "no token configured", err.Error())
+	if assert.Error(t, err) {
+		assert.Regexp(t, "no token configured", err.Error())
+	}
 }
 
 func TestConfigureShow(t *testing.T) {
@@ -49,8 +43,7 @@ func TestConfigureShow(t *testing.T) {
 		Err = oldErr
 	}()
 
-	var buf bytes.Buffer
-	Err = &buf
+	Err = &bytes.Buffer{}
 
 	flags := pflag.NewFlagSet("fake", pflag.PanicOnError)
 	setupConfigureFlags(flags)
@@ -82,7 +75,7 @@ func TestConfigureShow(t *testing.T) {
 	assert.NotRegexp(t, "override.example", Err)
 
 	assert.Regexp(t, "configured-token", Err)
-	assert.NotRegexp(t, "token-overrid", Err)
+	assert.NotRegexp(t, "token-override", Err)
 
 	assert.Regexp(t, "configured-workspace", Err)
 	assert.NotRegexp(t, "workspace-override", Err)
@@ -150,17 +143,12 @@ func TestConfigureToken(t *testing.T) {
 	defer ts.Close()
 
 	oldOut := Out
-	oldErr := Err
 	Out = ioutil.Discard
 	defer func() {
 		Out = oldOut
-		Err = oldErr
 	}()
 
 	for _, tc := range testCases {
-		var buf bytes.Buffer
-		Err = &buf
-
 		flags := pflag.NewFlagSet("fake", pflag.PanicOnError)
 		setupConfigureFlags(flags)
 
@@ -238,17 +226,12 @@ func TestConfigureAPIBaseURL(t *testing.T) {
 	}
 
 	oldOut := Out
-	oldErr := Err
 	Out = ioutil.Discard
 	defer func() {
 		Out = oldOut
-		Err = oldErr
 	}()
 
 	for _, tc := range testCases {
-		var buf bytes.Buffer
-		Err = &buf
-
 		flags := pflag.NewFlagSet("fake", pflag.PanicOnError)
 		setupConfigureFlags(flags)
 
@@ -398,8 +381,9 @@ func TestConfigureDefaultWorkspaceWithoutClobbering(t *testing.T) {
 	assert.NoError(t, err)
 
 	err = runConfigure(cfg, flags)
-	assert.Error(t, err)
-	assert.Regexp(t, "already something", err.Error())
+	if assert.Error(t, err) {
+		assert.Regexp(t, "already something", err.Error())
+	}
 }
 
 func TestConfigureExplicitWorkspaceWithoutClobberingNonDirectory(t *testing.T) {

cmd/download.go

@@ -50,11 +50,8 @@ Download other people's solutions by providing the UUID.
 
 func runDownload(cfg config.Config, flags *pflag.FlagSet, args []string) error {
 	usrCfg := cfg.UserViperConfig
-	if usrCfg.GetString("token") == "" {
-		return fmt.Errorf(msgWelcomePleaseConfigure, config.SettingsURL(usrCfg.GetString("apibaseurl")), BinaryName)
-	}
-	if usrCfg.GetString("workspace") == "" || usrCfg.GetString("apibaseurl") == "" {
-		return fmt.Errorf(msgRerunConfigure, BinaryName)
+	if err := validateUserConfig(usrCfg); err != nil {
+		return err
 	}
 
 	uuid, err := flags.GetString("uuid")

cmd/submit.go

@@ -53,12 +53,8 @@ var submitCmd = &cobra.Command{
 func runSubmit(cfg config.Config, flags *pflag.FlagSet, args []string) error {
 	usrCfg := cfg.UserViperConfig
 
-	if usrCfg.GetString("token") == "" {
-		return fmt.Errorf(msgWelcomePleaseConfigure, config.SettingsURL(usrCfg.GetString("apibaseurl")), BinaryName)
-	}
-
-	if usrCfg.GetString("workspace") == "" {
-		return fmt.Errorf(msgRerunConfigure, BinaryName)
+	if err := validateUserConfig(usrCfg); err != nil {
+		return err
 	}
 
 	for i, arg := range args {
@@ -136,15 +132,28 @@ func runSubmit(cfg config.Config, flags *pflag.FlagSet, args []string) error {
 		return err
 	}
 	if verbose, _ := flags.GetBool("verbose"); verbose {
-		fmt.Fprintf(os.Stderr, migrationStatus.String())
+		fmt.Fprintf(Err, migrationStatus.String())
 	}
 	metadata, err := workspace.NewExerciseMetadata(exerciseDir)
 	if err != nil {
 		return err
 	}
 
+	if exercise.Slug != metadata.Exercise {
+		// TODO: error msg should suggest running future doctor command
+		msg := `
+
+	The exercise directory does not match exercise slug in metadata:
+
+		expected '%[1]s' but got '%[2]s'
+
+	Please rename the directory '%[1]s' to '%[2]s' and try again.
+
+		`
+		return fmt.Errorf(msg, exercise.Slug, metadata.Exercise)
+	}
+
 	if !metadata.IsRequester {
-		// TODO: add test
 		msg := `
 
     The solution you are submitting is not connected to your account.
@@ -263,7 +272,7 @@ func runSubmit(cfg config.Config, flags *pflag.FlagSet, args []string) error {
     %s
 `
 	suffix := "View it at:\n\n    "
-	if metadata.AutoApprove {
+	if metadata.AutoApprove && metadata.Team == "" {
 		suffix = "You can complete the exercise and unlock the next core exercise at:\n"
 	}
 	fmt.Fprintf(Err, msg, suffix)