// Copyright 2022 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT package gitdiff import ( "fmt" "html/template" "strings" "testing" "code.gitea.io/gitea/modules/highlight" "github.com/stretchr/testify/assert" ) func BenchmarkHighlightDiff(b *testing.B) { for b.Loop() { // still fast enough: BenchmarkHighlightDiff-12 1000000 1027 ns/op // TODO: the real bottleneck is that "diffLineWithHighlight" is called twice when rendering "added" and "removed" lines by the caller // Ideally the caller should cache the diff result, and then use the diff result to render "added" and "removed" lines separately hcd := newHighlightCodeDiff() codeA := template.HTML(`x foo y`) codeB := template.HTML(`x bar y`) hcd.diffLineWithHighlight(DiffLineDel, codeA, codeB) } } func TestDiffWithHighlight(t *testing.T) { t.Run("DiffLineAddDel", func(t *testing.T) { t.Run("WithDiffTags", func(t *testing.T) { hcd := newHighlightCodeDiff() codeA := template.HTML(`x foo y`) codeB := template.HTML(`x bar y`) outDel := hcd.diffLineWithHighlight(DiffLineDel, codeA, codeB) assert.Equal(t, `x foo y`, string(outDel)) outAdd := hcd.diffLineWithHighlight(DiffLineAdd, codeA, codeB) assert.Equal(t, `x bar y`, string(outAdd)) }) t.Run("NoRedundantTags", func(t *testing.T) { // the equal parts only contain spaces, in this case, don't use "added/removed" tags // because the diff lines already have a background color to indicate the change hcd := newHighlightCodeDiff() codeA := template.HTML(" \tfoo ") codeB := template.HTML(" bar \n") outDel := hcd.diffLineWithHighlight(DiffLineDel, codeA, codeB) assert.Equal(t, string(codeA), string(outDel)) outAdd := hcd.diffLineWithHighlight(DiffLineAdd, codeA, codeB) assert.Equal(t, string(codeB), string(outAdd)) }) }) t.Run("CleanUp", func(t *testing.T) { hcd := newHighlightCodeDiff() codeA := template.HTML(` this is a comment`) codeB := template.HTML(` this is updated comment`) outDel := hcd.diffLineWithHighlight(DiffLineDel, codeA, codeB) assert.Equal(t, ` this is a comment`, string(outDel)) outAdd := hcd.diffLineWithHighlight(DiffLineAdd, codeA, codeB) assert.Equal(t, ` this is updated comment`, string(outAdd)) codeA = `line1` + "\n" + `line2` codeB = `line1` + "\n" + `line!` outDel = hcd.diffLineWithHighlight(DiffLineDel, codeA, codeB) assert.Equal(t, `line1`+"\n"+`line2`, string(outDel)) outAdd = hcd.diffLineWithHighlight(DiffLineAdd, codeA, codeB) assert.Equal(t, `line1`+"\n"+`line!`, string(outAdd)) }) t.Run("OpenCloseTags", func(t *testing.T) { hcd := newHighlightCodeDiff() hcd.placeholderTokenMap['O'], hcd.placeholderTokenMap['C'] = "", "" assert.Equal(t, "", string(hcd.recoverOneDiff("OC"))) assert.Equal(t, "", string(hcd.recoverOneDiff("O"))) assert.Empty(t, string(hcd.recoverOneDiff("C"))) }) t.Run("ComplexDiff1", func(t *testing.T) { oldCode, _ := highlight.RenderCodeFast("a.go", "Go", `xxx || yyy`) newCode, _ := highlight.RenderCodeFast("a.go", "Go", `bot.xxx || bot.yyy`) hcd := newHighlightCodeDiff() out := hcd.diffLineWithHighlight(DiffLineAdd, oldCode, newCode) assert.Equal(t, strings.ReplaceAll(` bot . xxx || bot . yyy`, "\n", ""), string(out)) }) forceTokenAsPlaceholder := func(hcd *highlightCodeDiff, r rune, token string) rune { // for testing purpose only hcd.tokenPlaceholderMap[token] = r hcd.placeholderTokenMap[r] = token return r } t.Run("ComplexDiff2", func(t *testing.T) { // When running "diffLineWithHighlight", the newly inserted "added-code", and "removed-code" tags may break the original layout. // The newly inserted tags can appear in any position, because the "diff" algorithm can make outputs like: // * Equal: // * Insert: xxyy // * Equal: zz // Then the newly inserted tags will make this output, the tags mismatch. // * xxyy zz // So we need to fix it to: // * xx yy zz hcd := newHighlightCodeDiff() hcd.diffCodeAddedOpen = forceTokenAsPlaceholder(hcd, '[', "") hcd.diffCodeClose = forceTokenAsPlaceholder(hcd, ']', "") forceTokenAsPlaceholder(hcd, '{', "") forceTokenAsPlaceholder(hcd, '}', "") assert.Equal(t, `aaxxyyzzbb`, string(hcd.recoverOneDiff("aa{xx[yy]zz}bb"))) assert.Equal(t, `aaxxyyzzbb`, string(hcd.recoverOneDiff("aa[xx{yy}zz]bb"))) assert.Equal(t, `aaxxyyzzbb`, string(hcd.recoverOneDiff("aa{xx[yy}zz]bb"))) assert.Equal(t, `aaxxyyzzbb`, string(hcd.recoverOneDiff("aa[xx{yy]zz}bb"))) assert.Equal(t, `aaxxyyzzbbcc`, string(hcd.recoverOneDiff("aa[xx{yy][zz}bb]cc"))) // And do a simple test for "diffCodeRemovedOpen", it shares the same logic as "diffCodeAddedOpen" hcd = newHighlightCodeDiff() hcd.diffCodeRemovedOpen = forceTokenAsPlaceholder(hcd, '[', "") hcd.diffCodeClose = forceTokenAsPlaceholder(hcd, ']', "") forceTokenAsPlaceholder(hcd, '{', "") forceTokenAsPlaceholder(hcd, '}', "") assert.Equal(t, `aaxxyyzzbbcc`, string(hcd.recoverOneDiff("aa[xx{yy][zz}bb]cc"))) }) } func TestDiffWithHighlightPlaceholder(t *testing.T) { hcd := newHighlightCodeDiff() output := hcd.diffLineWithHighlight(DiffLineDel, "a='\U00100000'", "a='\U0010FFFD''") assert.Empty(t, hcd.placeholderTokenMap[0x00100000]) assert.Empty(t, hcd.placeholderTokenMap[0x0010FFFD]) expected := fmt.Sprintf(`a='%s'`, "\U00100000") assert.Equal(t, expected, string(output)) hcd = newHighlightCodeDiff() output = hcd.diffLineWithHighlight(DiffLineAdd, "a='\U00100000'", "a='\U0010FFFD'") expected = fmt.Sprintf(`a='%s'`, "\U0010FFFD") assert.Equal(t, expected, string(output)) } func TestDiffWithHighlightPlaceholderExhausted(t *testing.T) { hcd := newHighlightCodeDiff() hcd.placeholderMaxCount = 0 placeHolderAmp := string(rune(0xFFFD)) output := hcd.diffLineWithHighlight(DiffLineDel, `<`, `>`) assert.Equal(t, placeHolderAmp+"lt;", string(output)) output = hcd.diffLineWithHighlight(DiffLineAdd, `<`, `>`) assert.Equal(t, placeHolderAmp+"gt;", string(output)) output = hcd.diffLineWithHighlight(DiffLineDel, `foo`, `bar`) assert.Equal(t, "foo", string(output)) output = hcd.diffLineWithHighlight(DiffLineAdd, `foo`, `bar`) assert.Equal(t, "bar", string(output)) } func TestDiffWithHighlightTagMatch(t *testing.T) { f := func(t *testing.T, lineType DiffLineType) { totalOverflow := 0 for i := 0; ; i++ { hcd := newHighlightCodeDiff() hcd.placeholderMaxCount = i output := string(hcd.diffLineWithHighlight(lineType, `<`, `>`)) totalOverflow += hcd.placeholderOverflowCount assert.Equal(t, strings.Count(output, "