Add utils tests

Signed-off-by: Joffrey F <[email protected]>

Author: shin-

packager/init.go

@@ -40,9 +40,8 @@ func initFromScratch(name string) error {
 	log.Println("init from scratch")
 	fmt.Println(`
 Please indicate a list of services that will be used by your application, one per line.
-Examples of possible values: java, mysql, redis, ruby, postgres, rabbitmq...
-    `)
-	services, err := utils.ReadNewlineSeparatedList()
+Examples of possible values: java, mysql, redis, ruby, postgres, rabbitmq...`)
+	services, err := utils.ReadNewlineSeparatedList(os.Stdin)
 	if err != nil {
 		return err
 	}

utils/components.go

@@ -1,6 +1,7 @@
 package utils
 
 import (
+	"regexp"
 	"strings"
 )
 
@@ -62,11 +63,16 @@ func MatchService(inputName string) ServiceConfig {
 		imgName = keywords["default"]
 	}
 	return ServiceConfig{
-		ServiceName:  strings.Replace(inputName, " ", "_", -1),
+		ServiceName:  sanitizeServiceName(inputName),
 		ServiceImage: imgName,
 	}
 }
 
+func sanitizeServiceName(inputName string) string {
+	invalidChars, _ := regexp.Compile("[^a-z_-]")
+	return invalidChars.ReplaceAllLiteralString(inputName, "_")
+}
+
 // ServiceConfig is a stub containing basic information about a service component
 type ServiceConfig struct {
 	ServiceName  string

utils/components_test.go

@@ -0,0 +1,34 @@
+package utils
+
+import (
+	"github.com/gotestyourself/gotestyourself/assert"
+	"testing"
+)
+
+func TestMatchService(t *testing.T) {
+	assert.Equal(t, MatchService("redis"), ServiceConfig{
+		ServiceImage: "redis",
+		ServiceName:  "redis",
+	}, "incorrect service match")
+}
+
+func TestMatchServiceSanitize(t *testing.T) {
+	assert.Equal(t, MatchService("ruby on rails"), ServiceConfig{
+		ServiceImage: "rails",
+		ServiceName:  "ruby_on_rails",
+	}, "incorrect service match")
+}
+
+func TestMatchServiceNoMatch(t *testing.T) {
+	assert.Equal(t, MatchService("no-such_image"), ServiceConfig{
+		ServiceImage: "alpine",
+		ServiceName:  "no-such_image",
+	}, "incorrect default service config")
+}
+
+func TestMatchServiceNoMatchSanitize(t *testing.T) {
+	assert.Equal(t, MatchService("aspq[foo[bar]|"), ServiceConfig{
+		ServiceImage: "alpine",
+		ServiceName:  "aspq_foo_bar__",
+	}, "incorrect default service config")
+}

utils/io.go

@@ -2,7 +2,9 @@ package utils
 
 import (
 	"bufio"
+	"io"
 	"os"
+	"strings"
 )
 
 // CreateFileWithData creates a new file at the given path and writes
@@ -17,13 +19,17 @@ func CreateFileWithData(fileName string, data []byte) error {
 	return err
 }
 
-// ReadNewlineSeparatedList reads data from stdin until reaching EOF and
-// returns a slice with data from each line
-func ReadNewlineSeparatedList() ([]string, error) {
-	scanner := bufio.NewScanner(os.Stdin)
+// ReadNewlineSeparatedList reads data from the reader interface until
+// reaching EOF and returns a slice with data from each line
+func ReadNewlineSeparatedList(rd io.Reader) ([]string, error) {
+	scanner := bufio.NewScanner(rd)
 	var into []string
 	for scanner.Scan() {
-		into = append(into, scanner.Text())
+		token := strings.TrimSpace(scanner.Text())
+		if token == "" {
+			continue
+		}
+		into = append(into, token)
 	}
 	return into, scanner.Err()
 }

utils/io_test.go

@@ -0,0 +1,77 @@
+package utils
+
+import (
+    "github.com/gotestyourself/gotestyourself/assert"
+    "github.com/gotestyourself/gotestyourself/fs"
+    "testing"
+
+    "strings"
+)
+
+var dummyData = []byte("hello world\n")
+
+func TestCreateFileWithData(t *testing.T) {
+    tmpdir := fs.NewDir(t, "iotest")
+    defer tmpdir.Remove()
+    path := tmpdir.Join("file.txt")
+
+    err := CreateFileWithData(path, dummyData)
+    assert.NilError(t, err, "failed to write data to file")
+
+    manifest := fs.Expected(t,
+        fs.WithFile("file.txt", string(dummyData),
+            fs.WithMode(0644),
+        ),
+    )
+    comp := fs.Equal(tmpdir.Path(), manifest)()
+    assert.Assert(t, comp.Success())
+}
+
+func TestCreateFileWithDataOverride(t *testing.T) {
+    tmpdir := fs.NewDir(t, "iotest")
+    defer tmpdir.Remove()
+    path := tmpdir.Join("file.txt")
+
+    err := CreateFileWithData(path, []byte("oops!"))
+    assert.NilError(t, err, "failed to write data to file")
+    err = CreateFileWithData(path, dummyData)
+    assert.NilError(t, err, "failed to rewrite data to file")
+
+    manifest := fs.Expected(t,
+        fs.WithFile("file.txt", string(dummyData),
+            fs.WithMode(0644),
+        ),
+    )
+    comp := fs.Equal(tmpdir.Path(), manifest)()
+    assert.Assert(t, comp.Success())
+}
+
+func TestReadNewlineSeparatedList(t *testing.T) {
+    reader := strings.NewReader("lorem\nipsum\r\ndolor sit\namet\n")
+    results, err := ReadNewlineSeparatedList(reader)
+    assert.NilError(t, err)
+    expected := []string{
+        "lorem", "ipsum", "dolor sit", "amet",
+    }
+    assert.DeepEqual(t, results, expected)
+}
+
+func TestReadNewlineSeparatedListWithEmptyLines(t *testing.T) {
+    reader := strings.NewReader("\t\t\nlorem\n\nipsum\n   \ndolor sit\r\n\n\namet\n    ")
+    results, err := ReadNewlineSeparatedList(reader)
+    assert.NilError(t, err)
+    expected := []string{
+        "lorem", "ipsum", "dolor sit", "amet",
+    }
+    assert.DeepEqual(t, results, expected)
+}
+
+func TestReadNewlineSeparatedListSanitize(t *testing.T) {
+    reader := strings.NewReader("\t\tlorem\nipsum\n\t\t\ndolor sit     \n \t amet \t\r\r\n")
+    results, err := ReadNewlineSeparatedList(reader)
+    assert.NilError(t, err)
+    expected := []string{
+        "lorem", "ipsum", "dolor sit", "amet",
+    }
+    assert.DeepEqual(t, results, expected)
+}