Slack import unit tests (mattermost#4201)

* Slack Import unit tests (for some functions).

Covers the completely self contained functions in the Slack Importer
that are straightforward to unit test.

JSON processing functions are not yet unit tested.

* Unit tests for Slack Import JSON parsing.

This tests the 3 functions for parsing JSON, using a sample set of
Slack data for posts, channels, and users.

api/slackimport.go

@@ -75,39 +75,39 @@ func SlackConvertChannelName(channelName string) string {
 	return newName
 }
 
-func SlackParseChannels(data io.Reader) []SlackChannel {
+func SlackParseChannels(data io.Reader) ([]SlackChannel, error) {
 	decoder := json.NewDecoder(data)
 
 	var channels []SlackChannel
 	if err := decoder.Decode(&channels); err != nil {
 		l4g.Warn(utils.T("api.slackimport.slack_parse_channels.error"))
-		return channels
+		return channels, err
 	}
-	return channels
+	return channels, nil
 }
 
-func SlackParseUsers(data io.Reader) []SlackUser {
+func SlackParseUsers(data io.Reader) ([]SlackUser, error) {
 	decoder := json.NewDecoder(data)
 
 	var users []SlackUser
 	if err := decoder.Decode(&users); err != nil {
 		// This actually returns errors that are ignored.
 		// In this case it is erroring because of a null that Slack
 		// introduced. So we just return the users here.
-		return users
+		return users, err
 	}
-	return users
+	return users, nil
 }
 
-func SlackParsePosts(data io.Reader) []SlackPost {
+func SlackParsePosts(data io.Reader) ([]SlackPost, error) {
 	decoder := json.NewDecoder(data)
 
 	var posts []SlackPost
 	if err := decoder.Decode(&posts); err != nil {
 		l4g.Warn(utils.T("api.slackimport.slack_parse_posts.error"))
-		return posts
+		return posts, err
 	}
-	return posts
+	return posts, nil
 }
 
 func SlackAddUsers(teamId string, slackusers []SlackUser, log *bytes.Buffer) map[string]*model.User {
@@ -401,13 +401,13 @@ func SlackImport(fileData multipart.File, fileSize int64, teamID string) (*model
 			return model.NewLocAppError("SlackImport", "api.slackimport.slack_import.open.app_error", map[string]interface{}{"Filename": file.Name}, err.Error()), log
 		}
 		if file.Name == "channels.json" {
-			channels = SlackParseChannels(reader)
+			channels, _ = SlackParseChannels(reader)
 		} else if file.Name == "users.json" {
-			users = SlackParseUsers(reader)
+			users, _ = SlackParseUsers(reader)
 		} else {
 			spl := strings.Split(file.Name, "/")
 			if len(spl) == 2 && strings.HasSuffix(spl[1], ".json") {
-				newposts := SlackParsePosts(reader)
+				newposts, _ := SlackParsePosts(reader)
 				channel := spl[0]
 				if _, ok := posts[channel]; ok == false {
 					posts[channel] = newposts

api/slackimport_test.go

@@ -0,0 +1,179 @@
+// Copyright (c) 2016 Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package api
+
+import (
+	"os"
+	"testing"
+)
+
+func TestSlackConvertTimeStamp(t *testing.T) {
+
+	testTimeStamp := "1469785419.000033"
+
+	result := SlackConvertTimeStamp(testTimeStamp)
+
+	if result != 1469785419000 {
+		t.Fatalf("Unexpected timestamp value %v returned.", result)
+	}
+}
+
+func TestSlackConvertChannelName(t *testing.T) {
+	var testData = []struct {
+		input  string
+		output string
+	}{
+		{"test-channel", "test-channel"},
+		{"_test_channel_", "test_channel"},
+		{"__test", "test"},
+		{"-t", "slack-channel-t"},
+		{"a", "slack-channel-a"},
+	}
+
+	for _, td := range testData {
+		if td.output != SlackConvertChannelName(td.input) {
+			t.Fatalf("Did not convert channel name correctly: %v", td.input)
+		}
+	}
+}
+
+func TestSlackConvertUserMentions(t *testing.T) {
+	users := []SlackUser{
+		{Id: "U00000A0A", Username: "firstuser"},
+		{Id: "U00000B1B", Username: "seconduser"},
+	}
+
+	posts := map[string][]SlackPost{
+		"test-channel": {
+			{
+				Text: "<!channel>: Hi guys.",
+			},
+			{
+				Text: "Calling <!here|@here>.",
+			},
+			{
+				Text: "Yo <!everyone>.",
+			},
+			{
+				Text: "Regular user test <@U00000B1B|seconduser> and <@U00000A0A>.",
+			},
+		},
+	}
+
+	expectedPosts := map[string][]SlackPost{
+		"test-channel": {
+			{
+				Text: "@channel: Hi guys.",
+			},
+			{
+				Text: "Calling @here.",
+			},
+			{
+				Text: "Yo @all.",
+			},
+			{
+				Text: "Regular user test @seconduser and @firstuser.",
+			},
+		},
+	}
+
+	convertedPosts := SlackConvertUserMentions(users, posts)
+
+	for channelName, channelPosts := range convertedPosts {
+		for postIdx, post := range channelPosts {
+			if post.Text != expectedPosts[channelName][postIdx].Text {
+				t.Fatalf("Converted post text not as expected: %v", post.Text)
+			}
+		}
+	}
+}
+
+func TestSlackConvertChannelMentions(t *testing.T) {
+	channels := []SlackChannel{
+		{Id: "C000AA00A", Name: "one"},
+		{Id: "C000BB11B", Name: "two"},
+	}
+
+	posts := map[string][]SlackPost{
+		"test-channel": {
+			{
+				Text: "Go to <#C000AA00A>.",
+			},
+			{
+				User: "U00000A0A",
+				Text: "Try <#C000BB11B|two> for this.",
+			},
+		},
+	}
+
+	expectedPosts := map[string][]SlackPost{
+		"test-channel": {
+			{
+				Text: "Go to !one.",
+			},
+			{
+				Text: "Try !two for this.",
+			},
+		},
+	}
+
+	convertedPosts := SlackConvertChannelMentions(channels, posts)
+
+	for channelName, channelPosts := range convertedPosts {
+		for postIdx, post := range channelPosts {
+			if post.Text != expectedPosts[channelName][postIdx].Text {
+				t.Fatalf("Converted post text not as expected: %v", post.Text)
+			}
+		}
+	}
+
+}
+
+func TestSlackParseChannels(t *testing.T) {
+	file, err := os.Open("../tests/slack-import-test-channels.json")
+	if err != nil {
+		t.Fatalf("Failed to open data file: %v", err)
+	}
+
+	channels, err := SlackParseChannels(file)
+	if err != nil {
+		t.Fatalf("Error occurred parsing channels: %v", err)
+	}
+
+	if len(channels) != 6 {
+		t.Fatalf("Unexpected number of channels: %v", len(channels))
+	}
+}
+
+func TestSlackParseUsers(t *testing.T) {
+	file, err := os.Open("../tests/slack-import-test-users.json")
+	if err != nil {
+		t.Fatalf("Failed to open data file: %v", err)
+	}
+
+	users, err := SlackParseUsers(file)
+	if err != nil {
+		t.Fatalf("Error occurred parsing users: %v", err)
+	}
+
+	if len(users) != 11 {
+		t.Fatalf("Unexpected number of users: %v", len(users))
+	}
+}
+
+func TestSlackParsePosts(t *testing.T) {
+	file, err := os.Open("../tests/slack-import-test-posts.json")
+	if err != nil {
+		t.Fatalf("Failed to open data file: %v", err)
+	}
+
+	posts, err := SlackParsePosts(file)
+	if err != nil {
+		t.Fatalf("Error occurred parsing posts: %v", err)
+	}
+
+	if len(posts) != 8 {
+		t.Fatalf("Unexpected number of posts: %v", len(posts))
+	}
+}