File: markdown_test.go

package info (click to toggle)
golang-github-bep-goportabletext 0.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 176 kB
  • sloc: makefile: 2
file content (96 lines) | stat: -rw-r--r-- 2,382 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Copyright 2025 Bjørn Erik Pedersen
// SPDX-License-Identifier: MIT

package goportabletext_test

import (
	"encoding/json"
	"io"
	"strings"
	"testing"

	"github.com/bep/goportabletext"
	"github.com/bep/goportabletext/internal/portabletext"
	"github.com/bep/goportabletext/internal/ptesting"
	"github.com/go-quicktest/qt"
)

func TestToMarkdownSamples(t *testing.T) {
	// Used during develoopment.
	pinnedName := ""
	testHelper(t, newSamplesHelper(t), pinnedName)
}

func BenchmarkToMarkdown(b *testing.B) {
	bh := func(h ptesting.BlockContentToMarkdownHelper) {
		h.ForEachGoldenPair(func(sourceName, targetName, sourceContent, targetContent string) error {
			blocks, err := portabletext.Parse(strings.NewReader(sourceContent))
			if err != nil {
				b.Fatal(err)
			}
			opts := goportabletext.ToMarkdownOptions{
				Dst: io.Discard,
				Src: blocks,
			}
			b.Run(sourceName, func(b *testing.B) {
				for i := 0; i < b.N; i++ {
					err := goportabletext.ToMarkdown(opts)
					if err != nil {
						b.Fatal(err)
					}
				}
			})
			return nil
		})
	}

	bh(newSamplesHelper(b))
}

func newSamplesHelper(t testing.TB) ptesting.BlockContentToMarkdownHelper {
	b, err := ptesting.NewSamplesBlockContentToMarkdownHelper()
	qt.Assert(t, qt.IsNil(err))
	return b
}

func dosToUnix(s string) string {
	return strings.ReplaceAll(s, "\r\n", "\n")
}

func jsonToMap(s string) any {
	var m any
	if err := json.Unmarshal([]byte(s), &m); err != nil {
		panic(err)
	}
	return m
}

func testHelper(t *testing.T, h ptesting.BlockContentToMarkdownHelper, pinnedName string) {
	t.Helper()
	if ptesting.IsCI() {
		// Make sure we run all tests in CI.
		pinnedName = ""
	}

	err := h.ForEachGoldenPair(func(sourceName, targetName, sourceContent, targetContent string) error {
		if pinnedName != "" && sourceName != pinnedName {
			return nil
		}
		checkSrc := func(src any) {
			var buff strings.Builder
			opts := goportabletext.ToMarkdownOptions{
				Dst: &buff,
				Src: src,
			}
			qt.Assert(t, qt.IsNil(goportabletext.ToMarkdown(opts)))
			result := dosToUnix(buff.String())
			targetContent = dosToUnix(targetContent)
			qt.Assert(t, qt.Equals(result, targetContent), qt.Commentf("input:\n%s\nexpected:\n%s\ngot:\n%s", sourceName, targetName, result))
		}
		checkSrc(strings.NewReader(sourceContent))
		checkSrc(jsonToMap(sourceContent))
		return nil
	})

	qt.Assert(t, qt.IsNil(err))
}