matterbridge/bridge/helper/helper_test.go

package helper

import (
	"io/ioutil"
	"os"
	"testing"

	"github.com/stretchr/testify/assert"
)

const testLineLength = 64

var lineSplittingTestCases = map[string]struct {
	input          string
	splitOutput    []string
	nonSplitOutput []string
}{
	"Short single-line message": {
		input:          "short",
		splitOutput:    []string{"short"},
		nonSplitOutput: []string{"short"},
	},
	"Long single-line message": {
		input: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
		splitOutput: []string{
			"Lorem ipsum dolor sit amet, consectetur adipis <clipped message>",
			"cing elit, sed do eiusmod tempor incididunt ut <clipped message>",
			" labore et dolore magna aliqua.",
		},
		nonSplitOutput: []string{"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."},
	},
	"Short multi-line message": {
		input: "I\ncan't\nget\nno\nsatisfaction!",
		splitOutput: []string{
			"I",
			"can't",
			"get",
			"no",
			"satisfaction!",
		},
		nonSplitOutput: []string{
			"I",
			"can't",
			"get",
			"no",
			"satisfaction!",
		},
	},
	"Long multi-line message": {
		input: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n" +
			"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n" +
			"Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.\n" +
			"Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
		splitOutput: []string{
			"Lorem ipsum dolor sit amet, consectetur adipis <clipped message>",
			"cing elit, sed do eiusmod tempor incididunt ut <clipped message>",
			" labore et dolore magna aliqua.",
			"Ut enim ad minim veniam, quis nostrud exercita <clipped message>",
			"tion ullamco laboris nisi ut aliquip ex ea com <clipped message>",
			"modo consequat.",
			"Duis aute irure dolor in reprehenderit in volu <clipped message>",
			"ptate velit esse cillum dolore eu fugiat nulla <clipped message>",
			" pariatur.",
			"Excepteur sint occaecat cupidatat non proident <clipped message>",
			", sunt in culpa qui officia deserunt mollit an <clipped message>",
			"im id est laborum.",
		},
		nonSplitOutput: []string{
			"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
			"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
			"Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
			"Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
		},
	},
	"Message ending with new-line.": {
		input:          "Newline ending\n",
		splitOutput:    []string{"Newline ending"},
		nonSplitOutput: []string{"Newline ending"},
	},
	"Long message containing UTF-8 multi-byte runes": {
		input: "不布人個我此而及單石業喜資富下我河下日沒一我臺空達的常景便物沒為……子大我別名解成？生賣的全直黑，我自我結毛分洲了世當，是政福那是東；斯說",
		splitOutput: []string{
			"不布人個我此而及單石業喜資富下 <clipped message>",
			"我河下日沒一我臺空達的常景便物 <clipped message>",
			"沒為……子大我別名解成？生賣的 <clipped message>",
			"全直黑，我自我結毛分洲了世當， <clipped message>",
			"是政福那是東；斯說",
		},
		nonSplitOutput: []string{"不布人個我此而及單石業喜資富下我河下日沒一我臺空達的常景便物沒為……子大我別名解成？生賣的全直黑，我自我結毛分洲了世當，是政福那是東；斯說"},
	},
	"Long message, clip three-byte rune after two bytes": {
		input: "x 人人生而自由，在尊嚴和權利上一律平等。 他們都具有理性和良知，應該以兄弟情誼的精神對待彼此。",
		splitOutput: []string{
			"x 人人生而自由，在尊嚴和權利上 <clipped message>",
			"一律平等。 他們都具有理性和良知 <clipped message>",
			"，應該以兄弟情誼的精神對待彼此。",
		},
		nonSplitOutput: []string{"x 人人生而自由，在尊嚴和權利上一律平等。 他們都具有理性和良知，應該以兄弟情誼的精神對待彼此。"},
	},
}

func TestGetSubLines(t *testing.T) {
	for testname, testcase := range lineSplittingTestCases {
		splitLines := GetSubLines(testcase.input, testLineLength, "")
		assert.Equalf(t, testcase.splitOutput, splitLines, "'%s' testcase should give expected lines with splitting.", testname)
		for _, splitLine := range splitLines {
			byteLength := len([]byte(splitLine))
			assert.True(t, byteLength <= testLineLength, "Splitted line '%s' of testcase '%s' should not exceed the maximum byte-length (%d vs. %d).", splitLine, testcase, byteLength, testLineLength)
		}

		nonSplitLines := GetSubLines(testcase.input, 0, "")
		assert.Equalf(t, testcase.nonSplitOutput, nonSplitLines, "'%s' testcase should give expected lines without splitting.", testname)
	}
}

func TestConvertWebPToPNG(t *testing.T) {
	if os.Getenv("LOCAL_TEST") == "" {
		t.Skip()
	}

	input, err := ioutil.ReadFile("test.webp")
	if err != nil {
		t.Fail()
	}

	d := &input
	err = ConvertWebPToPNG(d)
	if err != nil {
		t.Fail()
	}

	err = ioutil.WriteFile("test.png", *d, 0o644) // nolint:gosec
	if err != nil {
		t.Fail()
	}
}

var clippingOrSplittingTestCases = map[string]struct {
	inputText       string
	clipSplitLength int
	clippingMessage string
	splitMax        int
	expectedOutput  []string
}{
	"Short single-line message, split 3": {
		inputText:       "short",
		clipSplitLength: 20,
		clippingMessage: "?!?!",
		splitMax:        3,
		expectedOutput:  []string{"short"},
	},
	"Short single-line message, split 1": {
		inputText:       "short",
		clipSplitLength: 20,
		clippingMessage: "?!?!",
		splitMax:        1,
		expectedOutput:  []string{"short"},
	},
	"Short single-line message, split 0": {
		// Mainly check that we don't crash.
		inputText:       "short",
		clipSplitLength: 20,
		clippingMessage: "?!?!",
		splitMax:        0,
		expectedOutput:  []string{"short"},
	},
	"Long single-line message, noclip": {
		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
		clipSplitLength: 50,
		clippingMessage: "?!?!",
		splitMax:        10,
		expectedOutput:  []string{
			"Lorem ipsum dolor sit amet, consectetur adipiscing",
			" elit, sed do eiusmod tempor incididunt ut labore ",
			"et dolore magna aliqua.",
		},
	},
	"Long single-line message, noclip tight": {
		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
		clipSplitLength: 50,
		clippingMessage: "?!?!",
		splitMax:        3,
		expectedOutput:  []string{
			"Lorem ipsum dolor sit amet, consectetur adipiscing",
			" elit, sed do eiusmod tempor incididunt ut labore ",
			"et dolore magna aliqua.",
		},
	},
	"Long single-line message, clip custom": {
		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
		clipSplitLength: 50,
		clippingMessage: "?!?!",
		splitMax:        2,
		expectedOutput:  []string{
			"Lorem ipsum dolor sit amet, consectetur adipiscing",
			" elit, sed do eiusmod tempor incididunt ut lab?!?!",
		},
	},
	"Long single-line message, clip built-in": {
		inputText:       "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
		clipSplitLength: 50,
		clippingMessage: "",
		splitMax:        2,
		expectedOutput:  []string{
			"Lorem ipsum dolor sit amet, consectetur adipiscing",
			" elit, sed do eiusmod tempor inc <clipped message>",
		},
	},
	"Short multi-line message": {
		inputText:       "I\ncan't\nget\nno\nsatisfaction!",
		clipSplitLength: 50,
		clippingMessage: "",
		splitMax:        2,
		expectedOutput:  []string{"I\ncan't\nget\nno\nsatisfaction!"},
	},
	"Long message containing UTF-8 multi-byte runes": {
		inputText:       "人人生而自由，在尊嚴和權利上一律平等。 他們都具有理性和良知，應該以兄弟情誼的精神對待彼此。",
		clipSplitLength: 50,
		clippingMessage: "",
		splitMax:        10,
		expectedOutput:  []string{
			"人人生而自由，在尊嚴和權利上一律", // Note: only 48 bytes!
			"平等。 他們都具有理性和良知，應該", // Note: only 49 bytes!
			"以兄弟情誼的精神對待彼此。",
		},
	},
}

func TestClipOrSplitMessage(t *testing.T) {
	for testname, testcase := range clippingOrSplittingTestCases {
		actualOutput := ClipOrSplitMessage(testcase.inputText, testcase.clipSplitLength, testcase.clippingMessage, testcase.splitMax)
		assert.Equalf(t, testcase.expectedOutput, actualOutput, "'%s' testcase should give expected lines with clipping+splitting.", testname)
		for _, splitLine := range testcase.expectedOutput {
			byteLength := len([]byte(splitLine))
			assert.True(t, byteLength <= testcase.clipSplitLength, "Splitted line '%s' of testcase '%s' should not exceed the maximum byte-length (%d vs. %d).", splitLine, testname, testcase.clipSplitLength, byteLength)
		}
	}
}