Add test for submitting with legacy solution

Author: jdsutherland

cmd/submit_test.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"encoding/json"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
@@ -9,6 +10,7 @@ import (
 	"testing"
 
 	"github.com/exercism/cli/config"
+	"github.com/exercism/cli/visibility"
 	"github.com/exercism/cli/workspace"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
@@ -234,6 +236,51 @@ func TestSubmitOnlyEmptyFile(t *testing.T) {
 	assert.Regexp(t, "No files found", err.Error())
 }
 
+func TestSubmitExerciseWithLegacySolutionMetadataFileAndGetsMigrated(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("", "legacy-metadata-file")
+	assert.NoError(t, err)
+
+	dir := filepath.Join(tmpDir, "bogus-track", "bogus-exercise")
+	os.MkdirAll(dir, os.FileMode(0755))
+	writeFakeLegacySolution(t, dir, "bogus-track", "bogus-exercise")
+
+	file := filepath.Join(dir, "file.txt")
+	err = ioutil.WriteFile(file, []byte("This is a file."), os.FileMode(0755))
+	assert.NoError(t, err)
+
+	v := viper.New()
+	v.Set("token", "abc123")
+	v.Set("workspace", tmpDir)
+	v.Set("apibaseurl", ts.URL)
+	cfg := config.Configuration{
+		Persister:       config.InMemoryPersister{},
+		Dir:             tmpDir,
+		UserViperConfig: v,
+	}
+	solutionRelPath := filepath.Join(workspace.IgnoreSubdir, workspace.SolutionFilename)
+	expectedSolutionPathAfterMigration := filepath.Join(dir, solutionRelPath)
+
+	err = runSubmit(cfg, pflag.NewFlagSet("fake", pflag.PanicOnError), []string{file})
+	assert.NoError(t, err)
+	assert.Equal(t, "This is a file.", submittedFiles[string(os.PathSeparator)+"file.txt"])
+
+	_, err = os.Stat(expectedSolutionPathAfterMigration)
+	assert.NoError(t, err)
+}
+
 func TestSubmitFilesFromDifferentSolutions(t *testing.T) {
 	tmpDir, err := ioutil.TempDir("", "dir-1-submit")
 	assert.NoError(t, err)
@@ -305,3 +352,26 @@ func writeFakeSolution(t *testing.T, dir, trackID, exerciseSlug string) {
 	err := solution.Write(dir)
 	assert.NoError(t, err)
 }
+
+func writeFakeLegacySolution(t *testing.T, dir, trackID, exerciseSlug string) {
+	solution := &workspace.Solution{
+		ID:          "bogus-solution-uuid",
+		Track:       trackID,
+		Exercise:    exerciseSlug,
+		URL:         "http://example.com/bogus-url",
+		IsRequester: true,
+	}
+	legacySolutionFilePath := filepath.Join(dir, ".solution.json")
+
+	// Hack because ioutil.WriteFile fails on hidden files
+	visibility.ShowFile(legacySolutionFilePath)
+
+	b, err := json.Marshal(solution)
+	assert.NoError(t, err)
+
+	err = ioutil.WriteFile(legacySolutionFilePath, b, os.FileMode(0600))
+	assert.NoError(t, err)
+
+	err = visibility.HideFile(legacySolutionFilePath)
+	assert.NoError(t, err)
+}

workspace/solution.go

@@ -13,10 +13,10 @@ import (
 	"github.com/exercism/cli/visibility"
 )
 
-const ignoreSubdir = ".exercism"
-const solutionFilename = "solution.json"
+const IgnoreSubdir = ".exercism"
+const SolutionFilename = "solution.json"
 
-var solutionRelPath = filepath.Join(ignoreSubdir, solutionFilename)
+var solutionRelPath = filepath.Join(IgnoreSubdir, SolutionFilename)
 
 // Solution contains metadata about a user's solution.
 type Solution struct {
@@ -71,7 +71,7 @@ func (s *Solution) Write(dir string) error {
 		return err
 	}
 
-	path := filepath.Join(dir, ignoreSubdir)
+	path := filepath.Join(dir, IgnoreSubdir)
 	if err := createIgnoreSubdir(path); err != nil {
 		return err
 	}
@@ -106,7 +106,7 @@ func createIgnoreSubdir(path string) error {
 }
 
 func migrateLegacySolutionFile(path string, legacySolutionPath string, solutionPath string) error {
-	if err := createIgnoreSubdir(filepath.Join(path, ignoreSubdir)); err != nil {
+	if err := createIgnoreSubdir(filepath.Join(path, IgnoreSubdir)); err != nil {
 		return err
 	}
 	if err := os.Rename(legacySolutionPath, solutionPath); err != nil {

workspace/workspace.go

@@ -186,7 +186,7 @@ func (ws Workspace) SolutionDir(s string) (string, error) {
 	path := s
 	for {
 		if path == ws.Dir {
-			return "", fmt.Errorf("couldn't find %s", solutionFilename)
+			return "", fmt.Errorf("couldn't find %s", SolutionFilename)
 		}
 		if _, err := os.Lstat(path); os.IsNotExist(err) {
 			return "", err
@@ -202,13 +202,10 @@ func checkSolutionFile(path string) error {
 	legacySolutionPath := filepath.Join(path, ".solution.json")
 	solutionPath := filepath.Join(path, solutionRelPath)
 
-	if _, legacyErr := os.Lstat(legacySolutionPath); legacyErr == nil {
+	if _, err := os.Lstat(legacySolutionPath); err == nil {
 		return migrateLegacySolutionFile(path, legacySolutionPath, solutionPath)
 	} else if _, err := os.Lstat(solutionPath); err != nil {
 		return err
-	} else if legacyErr != nil && err == nil {
-		return nil
-	} else {
-		return legacyErr
 	}
+	return nil
 }