Merge branch 'master' into solution.json-.exercism-dir

Author: jdsutherland

cmd/configure.go

@@ -60,14 +60,8 @@ func runConfigure(configuration config.Configuration, flags *pflag.FlagSet) erro
 	// If the command is run 'bare' and we have no token,
 	// explain how to set the token.
 	if flags.NFlag() == 0 && cfg.GetString("token") == "" {
-		baseURL := cfg.GetString("apibaseurl")
-		if baseURL != "" {
-			// If we have a base URL, then give the exact link.
-			tokenURL := config.InferSiteURL(baseURL) + "/my/settings"
-			return fmt.Errorf("There is no token configured. Find your token on %s, and call this command again with --token=<your-token>.", tokenURL)
-		}
-		// If we don't, then do our best.
-		return fmt.Errorf("There is no token configured. Find your token in your settings on the website, and call this command again with --token=<your-token>.")
+		tokenURL := config.SettingsURL(cfg.GetString("apibaseurl"))
+		return fmt.Errorf("There is no token configured. Find your token on %s, and call this command again with --token=<your-token>.", tokenURL)
 	}
 
 	// Determine the base API URL.
@@ -114,8 +108,7 @@ func runConfigure(configuration config.Configuration, flags *pflag.FlagSet) erro
 		token = cfg.GetString("token")
 	}
 
-	// Infer the URL where the token can be found.
-	tokenURL := config.InferSiteURL(cfg.GetString("apibaseurl")) + "/my/settings"
+	tokenURL := config.SettingsURL(cfg.GetString("apibaseurl"))
 
 	// If we don't have a token then explain how to set it and bail.
 	if token == "" {

cmd/download.go

@@ -49,8 +49,7 @@ Download other people's solutions by providing the UUID.
 func runDownload(cfg config.Configuration, flags *pflag.FlagSet, args []string) error {
 	usrCfg := cfg.UserViperConfig
 	if usrCfg.GetString("token") == "" {
-		tokenURL := config.InferSiteURL(usrCfg.GetString("apibaseurl")) + "/my/settings"
-		return fmt.Errorf(msgWelcomePleaseConfigure, tokenURL, BinaryName)
+		return fmt.Errorf(msgWelcomePleaseConfigure, config.SettingsURL(usrCfg.GetString("apibaseurl")), BinaryName)
 	}
 	if usrCfg.GetString("workspace") == "" || usrCfg.GetString("apibaseurl") == "" {
 		return fmt.Errorf(msgRerunConfigure, BinaryName)

cmd/download_test.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"bytes"
+	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -24,6 +26,8 @@ func TestDownloadWithoutToken(t *testing.T) {
 	err := runDownload(cfg, pflag.NewFlagSet("fake", pflag.PanicOnError), []string{})
 	if assert.Error(t, err) {
 		assert.Regexp(t, "Welcome to Exercism", err.Error())
+		// It uses the default base API url to infer the host
+		assert.Regexp(t, "exercism.io/my/settings", err.Error())
 	}
 }
 
@@ -84,17 +88,30 @@ func TestDownload(t *testing.T) {
 	}()
 
 	testCases := []struct {
-		requestor       string
-		expectedDir     string
-		flag, flagValue string
+		requestor   string
+		expectedDir string
+		flags       map[string]string
 	}{
-		{requestorSelf, "", "exercise", "bogus-exercise"},
-		{requestorSelf, "", "uuid", "bogus-id"},
-		{requestorOther, filepath.Join("users", "alice"), "uuid", "bogus-id"},
+		{
+			requestor:   requestorSelf,
+			expectedDir: "",
+			flags:       map[string]string{"exercise": "bogus-exercise"},
+		},
+		{
+			requestor:   requestorSelf,
+			expectedDir: "",
+			flags:       map[string]string{"uuid": "bogus-id"},
+		},
+		{
+			requestor:   requestorOther,
+			expectedDir: filepath.Join("users", "alice"),
+			flags:       map[string]string{"uuid": "bogus-id"},
+		},
 	}
 
 	for _, tc := range testCases {
 		tmpDir, err := ioutil.TempDir("", "download-cmd")
+		defer os.RemoveAll(tmpDir)
 		assert.NoError(t, err)
 
 		ts := fakeDownloadServer(tc.requestor)
@@ -110,12 +127,32 @@ func TestDownload(t *testing.T) {
 		}
 		flags := pflag.NewFlagSet("fake", pflag.PanicOnError)
 		setupDownloadFlags(flags)
-		flags.Set(tc.flag, tc.flagValue)
+		for name, value := range tc.flags {
+			flags.Set(name, value)
+		}
 
 		err = runDownload(cfg, flags, []string{})
 		assert.NoError(t, err)
 
-		assertDownloadedCorrectFiles(t, filepath.Join(tmpDir, tc.expectedDir), tc.requestor)
+		targetDir := filepath.Join(tmpDir, tc.expectedDir)
+		assertDownloadedCorrectFiles(t, targetDir, tc.requestor)
+
+		metadata := `{
+			"track": "bogus-track",
+			"exercise":"bogus-exercise",
+			"id":"bogus-id",
+			"url":"",
+			"handle":"alice",
+			"is_requester":%s,
+			"auto_approve":false
+		}`
+		metadata = fmt.Sprintf(metadata, tc.requestor)
+		metadata = compact(t, metadata)
+
+		path := filepath.Join(targetDir, "bogus-track", "bogus-exercise", ws.SolutionMetadataFilepath())
+		b, err := ioutil.ReadFile(path)
+		assert.NoError(t, err)
+		assert.Equal(t, metadata, string(b), "the solution metadata file")
 	}
 }
 
@@ -150,7 +187,6 @@ func fakeDownloadServer(requestor string) *httptest.Server {
 }
 
 func assertDownloadedCorrectFiles(t *testing.T, targetDir, requestor string) {
-	metadata := `{"track":"bogus-track","exercise":"bogus-exercise","id":"bogus-id","url":"","handle":"alice","is_requester":%s,"auto_approve":false}`
 	expectedFiles := []struct {
 		desc     string
 		path     string
@@ -166,11 +202,6 @@ func assertDownloadedCorrectFiles(t *testing.T, targetDir, requestor string) {
 			path:     filepath.Join(targetDir, "bogus-track", "bogus-exercise", "subdir", "file-2.txt"),
 			contents: "this is file 2",
 		},
-		{
-			desc:     "the solution metadata file",
-			path:     filepath.Join(targetDir, "bogus-track", "bogus-exercise", ws.SolutionMetadataFilepath()),
-			contents: fmt.Sprintf(metadata, requestor),
-		},
 	}
 
 	for _, file := range expectedFiles {
@@ -218,3 +249,10 @@ const payloadTemplate = `
 	}
 }
 `
+
+func compact(t *testing.T, s string) string {
+	buffer := new(bytes.Buffer)
+	err := json.Compact(buffer, []byte(s))
+	assert.NoError(t, err)
+	return buffer.String()
+}

cmd/submit.go

@@ -53,8 +53,7 @@ func runSubmit(cfg config.Configuration, flags *pflag.FlagSet, args []string) er
 	usrCfg := cfg.UserViperConfig
 
 	if usrCfg.GetString("token") == "" {
-		tokenURL := config.InferSiteURL(usrCfg.GetString("apibaseurl")) + "/my/settings"
-		return fmt.Errorf(msgWelcomePleaseConfigure, tokenURL, BinaryName)
+		return fmt.Errorf(msgWelcomePleaseConfigure, config.SettingsURL(usrCfg.GetString("apibaseurl")), BinaryName)
 	}
 
 	if usrCfg.GetString("workspace") == "" {
@@ -255,16 +254,6 @@ func runSubmit(cfg config.Configuration, flags *pflag.FlagSet, args []string) er
 	return nil
 }
 
-func initSubmitCmd() {
-	setupSubmitFlags(submitCmd.Flags())
-}
-
-func setupSubmitFlags(flags *pflag.FlagSet) {
-	flags.StringP("track", "t", "", "the track ID")
-	flags.StringP("exercise", "e", "", "the exercise ID")
-	flags.StringSliceP("files", "f", make([]string, 0), "files to submit")
-}
-
 func init() {
 	RootCmd.AddCommand(submitCmd)
 }

cmd/submit_relative_path_test.go

@@ -20,11 +20,11 @@ func TestSubmitWithoutToken(t *testing.T) {
 	cfg := config.Configuration{
 		Persister:       config.InMemoryPersister{},
 		UserViperConfig: viper.New(),
-		DefaultBaseURL:  "http://example.com",
 	}
 
 	err := runSubmit(cfg, pflag.NewFlagSet("fake", pflag.PanicOnError), []string{})
 	assert.Regexp(t, "Welcome to Exercism", err.Error())
+	assert.Regexp(t, "exercism.io/my/settings", err.Error())
 }
 
 func TestSubmitWithoutWorkspace(t *testing.T) {
@@ -368,6 +368,50 @@ func fakeSubmitServer(t *testing.T, submittedFiles map[string]string) *httptest.
 	return httptest.NewServer(handler)
 }
 
+func TestSubmitRelativePath(t *testing.T) {
+	oldOut := Out
+	oldErr := Err
+	Out = ioutil.Discard
+	Err = ioutil.Discard
+	defer func() {
+		Out = oldOut
+		Err = oldErr
+	}()
+	// The fake endpoint will populate this when it receives the call from the command.
+	submittedFiles := map[string]string{}
+	ts := fakeSubmitServer(t, submittedFiles)
+	defer ts.Close()
+
+	tmpDir, err := ioutil.TempDir("", "relative-path")
+	assert.NoError(t, err)
+
+	dir := filepath.Join(tmpDir, "bogus-track", "bogus-exercise")
+	os.MkdirAll(dir, os.FileMode(0755))
+
+	writeFakeSolution(t, dir, "bogus-track", "bogus-exercise")
+
+	v := viper.New()
+	v.Set("token", "abc123")
+	v.Set("workspace", tmpDir)
+	v.Set("apibaseurl", ts.URL)
+
+	cfg := config.Configuration{
+		Persister:       config.InMemoryPersister{},
+		UserViperConfig: v,
+	}
+
+	err = ioutil.WriteFile(filepath.Join(dir, "file.txt"), []byte("This is a file."), os.FileMode(0755))
+
+	err = os.Chdir(dir)
+	assert.NoError(t, err)
+
+	err = runSubmit(cfg, pflag.NewFlagSet("fake", pflag.PanicOnError), []string{"file.txt"})
+	assert.NoError(t, err)
+
+	assert.Equal(t, 1, len(submittedFiles))
+	assert.Equal(t, "This is a file.", submittedFiles[string(os.PathSeparator)+"file.txt"])
+}
+
 func writeFakeSolution(t *testing.T, dir, trackID, exerciseSlug string) {
 	solution := &workspace.Solution{
 		ID:          "bogus-solution-uuid",

cmd/submit_relative_path_windows_test.go

@@ -69,9 +69,17 @@ func ensureDir(f filer) error {
 // InferSiteURL guesses what the website URL is.
 // The basis for the guess is which API we're submitting to.
 func InferSiteURL(apiURL string) string {
+	if apiURL == "" {
+		apiURL = defaultBaseURL
+	}
 	if apiURL == "https://api.exercism.io/v1" {
 		return "https://exercism.io"
 	}
 	re := regexp.MustCompile("^(https?://[^/]*).*")
 	return re.ReplaceAllString(apiURL, "$1")
 }
+
+// SettingsURL provides a link to where the user can find their API token.
+func SettingsURL(apiURL string) string {
+	return fmt.Sprintf("%s%s", InferSiteURL(apiURL), "/my/settings")
+}

cmd/submit_test.go

@@ -104,6 +104,7 @@ func TestInferSiteURL(t *testing.T) {
 		{"https://v2.exercism.io/api/v1", "https://v2.exercism.io"},
 		{"https://mentors-beta.exercism.io/api/v1", "https://mentors-beta.exercism.io"},
 		{"http://localhost:3000/api/v1", "http://localhost:3000"},
+		{"", "https://exercism.io"},            // use the default
 		{"http://whatever", "http://whatever"}, // you're on your own, pal
 	}