ref: f8d8c85428f527139c20369910230741dcaf2969
dir: /parser/frontmatter_test.go/
// Copyright 2015 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package parser
import (
"bytes"
"fmt"
"reflect"
"strings"
"testing"
)
func TestInterfaceToConfig(t *testing.T) {
cases := []struct {
input interface{}
mark byte
want []byte
isErr bool
}{
// TOML
{map[string]interface{}{}, TOMLLead[0], nil, false},
{
map[string]interface{}{"title": "test 1"},
TOMLLead[0],
[]byte("title = \"test 1\"\n"),
false,
},
// YAML
{map[string]interface{}{}, YAMLLead[0], []byte("{}\n"), false},
{
map[string]interface{}{"title": "test 1"},
YAMLLead[0],
[]byte("title: test 1\n"),
false,
},
// JSON
{map[string]interface{}{}, JSONLead[0], []byte("{}\n"), false},
{
map[string]interface{}{"title": "test 1"},
JSONLead[0],
[]byte("{\n \"title\": \"test 1\"\n}\n"),
false,
},
// Errors
{nil, TOMLLead[0], nil, true},
{map[string]interface{}{}, '$', nil, true},
}
for i, c := range cases {
var buf bytes.Buffer
err := InterfaceToConfig(c.input, rune(c.mark), &buf)
if err != nil {
if c.isErr {
continue
}
t.Fatalf("[%d] unexpected error value: %v", i, err)
}
if !reflect.DeepEqual(buf.Bytes(), c.want) {
t.Errorf("[%d] not equal:\nwant %q,\n got %q", i, c.want, buf.Bytes())
}
}
}
func TestInterfaceToFrontMatter(t *testing.T) {
cases := []struct {
input interface{}
mark rune
want []byte
isErr bool
}{
// TOML
{map[string]interface{}{}, '+', []byte("+++\n\n+++\n"), false},
{
map[string]interface{}{"title": "test 1"},
'+',
[]byte("+++\ntitle = \"test 1\"\n\n+++\n"),
false,
},
// YAML
{map[string]interface{}{}, '-', []byte("---\n{}\n---\n"), false}, //
{
map[string]interface{}{"title": "test 1"},
'-',
[]byte("---\ntitle: test 1\n---\n"),
false,
},
// JSON
{map[string]interface{}{}, '{', []byte("{}\n"), false},
{
map[string]interface{}{"title": "test 1"},
'{',
[]byte("{\n \"title\": \"test 1\"\n}\n"),
false,
},
// Errors
{nil, '+', nil, true},
{map[string]interface{}{}, '$', nil, true},
}
for i, c := range cases {
var buf bytes.Buffer
err := InterfaceToFrontMatter(c.input, c.mark, &buf)
if err != nil {
if c.isErr {
continue
}
t.Fatalf("[%d] unexpected error value: %v", i, err)
}
if !reflect.DeepEqual(buf.Bytes(), c.want) {
t.Errorf("[%d] not equal:\nwant %q,\n got %q", i, c.want, buf.Bytes())
}
}
}
func TestHandleTOMLMetaData(t *testing.T) {
cases := []struct {
input []byte
want interface{}
isErr bool
}{
{nil, map[string]interface{}{}, false},
{[]byte("title = \"test 1\""), map[string]interface{}{"title": "test 1"}, false},
{[]byte("a = [1, 2, 3]"), map[string]interface{}{"a": []interface{}{int64(1), int64(2), int64(3)}}, false},
{[]byte("b = [\n[1, 2],\n[3, 4]\n]"), map[string]interface{}{"b": []interface{}{[]interface{}{int64(1), int64(2)}, []interface{}{int64(3), int64(4)}}}, false},
// errors
{[]byte("z = [\n[1, 2]\n[3, 4]\n]"), nil, true},
}
for i, c := range cases {
res, err := HandleTOMLMetaData(c.input)
if err != nil {
if c.isErr {
continue
}
t.Fatalf("[%d] unexpected error value: %v", i, err)
}
if !reflect.DeepEqual(res, c.want) {
t.Errorf("[%d] not equal: given %q\nwant %#v,\n got %#v", i, c.input, c.want, res)
}
}
}
func TestHandleYAMLMetaData(t *testing.T) {
cases := []struct {
input []byte
want interface{}
isErr bool
}{
{nil, map[string]interface{}{}, false},
{[]byte("title: test 1"), map[string]interface{}{"title": "test 1"}, false},
{[]byte("a: Easy!\nb:\n c: 2\n d: [3, 4]"), map[string]interface{}{"a": "Easy!", "b": map[string]interface{}{"c": 2, "d": []interface{}{3, 4}}}, false},
{[]byte("a:\n true: 1\n false: 2"), map[string]interface{}{"a": map[string]interface{}{"true": 1, "false": 2}}, false},
// errors
{[]byte("z = not toml"), nil, true},
}
for i, c := range cases {
res, err := HandleYAMLMetaData(c.input)
if err != nil {
if c.isErr {
continue
}
t.Fatalf("[%d] unexpected error value: %v", i, err)
}
if !reflect.DeepEqual(res, c.want) {
t.Errorf("[%d] not equal: given %q\nwant %#v,\n got %#v", i, c.input, c.want, res)
}
}
}
func TestHandleJSONMetaData(t *testing.T) {
cases := []struct {
input []byte
want interface{}
isErr bool
}{
{nil, map[string]interface{}{}, false},
{[]byte("{\"title\": \"test 1\"}"), map[string]interface{}{"title": "test 1"}, false},
// errors
{[]byte("{noquotes}"), nil, true},
}
for i, c := range cases {
res, err := HandleJSONMetaData(c.input)
if err != nil {
if c.isErr {
continue
}
t.Fatalf("[%d] unexpected error value: %v", i, err)
}
if !reflect.DeepEqual(res, c.want) {
t.Errorf("[%d] not equal: given %q\nwant %#v,\n got %#v", i, c.input, c.want, res)
}
}
}
func TestHandleOrgMetaData(t *testing.T) {
cases := []struct {
input []byte
want interface{}
isErr bool
}{
{nil, map[string]interface{}{}, false},
{[]byte("#+title: test 1\n"), map[string]interface{}{"title": "test 1"}, false},
}
for i, c := range cases {
res, err := HandleOrgMetaData(c.input)
if err != nil {
if c.isErr {
continue
}
t.Fatalf("[%d] unexpected error value: %v", i, err)
}
if !reflect.DeepEqual(res, c.want) {
t.Errorf("[%d] not equal: given %q\nwant %#v,\n got %#v", i, c.input, c.want, res)
}
}
}
func TestFormatToLeadRune(t *testing.T) {
for i, this := range []struct {
kind string
expect rune
}{
{"yaml", '-'},
{"yml", '-'},
{"toml", '+'},
{"tml", '+'},
{"json", '{'},
{"js", '{'},
{"org", '#'},
{"unknown", '+'},
} {
result := FormatToLeadRune(this.kind)
if result != this.expect {
t.Errorf("[%d] got %q but expected %q", i, result, this.expect)
}
}
}
func TestDetectFrontMatter(t *testing.T) {
cases := []struct {
mark rune
want *FrontmatterType
}{
// funcs are uncomparable, so we ignore FrontmatterType.Parse in these tests
{'-', &FrontmatterType{nil, []byte(YAMLDelim), []byte(YAMLDelim), false}},
{'+', &FrontmatterType{nil, []byte(TOMLDelim), []byte(TOMLDelim), false}},
{'{', &FrontmatterType{nil, []byte("{"), []byte("}"), true}},
{'#', &FrontmatterType{nil, []byte("#+"), []byte("\n"), false}},
{'$', nil},
}
for _, c := range cases {
res := DetectFrontMatter(c.mark)
if res == nil {
if c.want == nil {
continue
}
t.Fatalf("want %v, got %v", *c.want, res)
}
if !reflect.DeepEqual(res.markstart, c.want.markstart) {
t.Errorf("markstart mismatch: want %v, got %v", c.want.markstart, res.markstart)
}
if !reflect.DeepEqual(res.markend, c.want.markend) {
t.Errorf("markend mismatch: want %v, got %v", c.want.markend, res.markend)
}
if !reflect.DeepEqual(res.includeMark, c.want.includeMark) {
t.Errorf("includeMark mismatch: want %v, got %v", c.want.includeMark, res.includeMark)
}
}
}
func TestRemoveTOMLIdentifier(t *testing.T) {
cases := []struct {
input string
want string
}{
{"a = 1", "a = 1"},
{"a = 1\r\n", "a = 1\r\n"},
{"+++\r\na = 1\r\n+++\r\n", "a = 1\r\n"},
{"+++\na = 1\n+++\n", "a = 1\n"},
{"+++\nb = \"+++ oops +++\"\n+++\n", "b = \"+++ oops +++\"\n"},
{"+++\nc = \"\"\"+++\noops\n+++\n\"\"\"\"\n+++\n", "c = \"\"\"+++\noops\n+++\n\"\"\"\"\n"},
{"+++\nd = 1\n+++", "d = 1\n"},
}
for i, c := range cases {
res := removeTOMLIdentifier([]byte(c.input))
if string(res) != c.want {
t.Errorf("[%d] given %q\nwant: %q\n got: %q", i, c.input, c.want, res)
}
}
}
func TestStringifyYAMLMapKeys(t *testing.T) {
cases := []struct {
input interface{}
want interface{}
replaced bool
}{
{
map[interface{}]interface{}{"a": 1, "b": 2},
map[string]interface{}{"a": 1, "b": 2},
true,
},
{
map[interface{}]interface{}{"a": []interface{}{1, map[interface{}]interface{}{"b": 2}}},
map[string]interface{}{"a": []interface{}{1, map[string]interface{}{"b": 2}}},
true,
},
{
map[interface{}]interface{}{true: 1, "b": false},
map[string]interface{}{"true": 1, "b": false},
true,
},
{
map[interface{}]interface{}{1: "a", 2: "b"},
map[string]interface{}{"1": "a", "2": "b"},
true,
},
{
map[interface{}]interface{}{"a": map[interface{}]interface{}{"b": 1}},
map[string]interface{}{"a": map[string]interface{}{"b": 1}},
true,
},
{
map[string]interface{}{"a": map[string]interface{}{"b": 1}},
map[string]interface{}{"a": map[string]interface{}{"b": 1}},
false,
},
{
[]interface{}{map[interface{}]interface{}{1: "a", 2: "b"}},
[]interface{}{map[string]interface{}{"1": "a", "2": "b"}},
false,
},
}
for i, c := range cases {
res, replaced := stringifyMapKeys(c.input)
if c.replaced != replaced {
t.Fatalf("[%d] Replaced mismatch: %t", i, replaced)
}
if !c.replaced {
res = c.input
}
if !reflect.DeepEqual(res, c.want) {
t.Errorf("[%d] given %q\nwant: %q\n got: %q", i, c.input, c.want, res)
}
}
}
func BenchmarkFrontmatterTags(b *testing.B) {
for _, frontmatter := range []string{"JSON", "YAML", "YAML2", "TOML"} {
for i := 1; i < 60; i += 20 {
doBenchmarkFrontmatter(b, frontmatter, i)
}
}
}
func BenchmarkStringifyMapKeysStringsOnlyInterfaceMaps(b *testing.B) {
maps := make([]map[interface{}]interface{}, b.N)
for i := 0; i < b.N; i++ {
maps[i] = map[interface{}]interface{}{
"a": map[interface{}]interface{}{
"b": 32,
"c": 43,
"d": map[interface{}]interface{}{
"b": 32,
"c": 43,
},
},
"b": []interface{}{"a", "b"},
"c": "d",
}
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
stringifyMapKeys(maps[i])
}
}
func BenchmarkStringifyMapKeysStringsOnlyStringMaps(b *testing.B) {
m := map[string]interface{}{
"a": map[string]interface{}{
"b": 32,
"c": 43,
"d": map[string]interface{}{
"b": 32,
"c": 43,
},
},
"b": []interface{}{"a", "b"},
"c": "d",
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
stringifyMapKeys(m)
}
}
func BenchmarkStringifyMapKeysIntegers(b *testing.B) {
maps := make([]map[interface{}]interface{}, b.N)
for i := 0; i < b.N; i++ {
maps[i] = map[interface{}]interface{}{
1: map[interface{}]interface{}{
4: 32,
5: 43,
6: map[interface{}]interface{}{
7: 32,
8: 43,
},
},
2: []interface{}{"a", "b"},
3: "d",
}
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
stringifyMapKeys(maps[i])
}
}
func doBenchmarkFrontmatter(b *testing.B, fileformat string, numTags int) {
yamlTemplate := `---
name: "Tags"
tags:
%s
---
`
yaml2Template := `---
name: "Tags"
tags: %s
---
`
tomlTemplate := `+++
name = "Tags"
tags = %s
+++
`
jsonTemplate := `{
"name": "Tags",
"tags": [
%s
]
}`
name := fmt.Sprintf("%s:%d", fileformat, numTags)
b.Run(name, func(b *testing.B) {
tags := make([]string, numTags)
var (
tagsStr string
frontmatterTemplate string
)
for i := 0; i < numTags; i++ {
tags[i] = fmt.Sprintf("Hugo %d", i+1)
}
if fileformat == "TOML" {
frontmatterTemplate = tomlTemplate
tagsStr = strings.Replace(fmt.Sprintf("%q", tags), " ", ", ", -1)
} else if fileformat == "JSON" {
frontmatterTemplate = jsonTemplate
tagsStr = strings.Replace(fmt.Sprintf("%q", tags), " ", ", ", -1)
} else if fileformat == "YAML2" {
frontmatterTemplate = yaml2Template
tagsStr = strings.Replace(fmt.Sprintf("%q", tags), " ", ", ", -1)
} else {
frontmatterTemplate = yamlTemplate
for _, tag := range tags {
tagsStr += "\n- " + tag
}
}
frontmatter := fmt.Sprintf(frontmatterTemplate, tagsStr)
p := page{frontmatter: []byte(frontmatter)}
b.ResetTimer()
for i := 0; i < b.N; i++ {
meta, err := p.Metadata()
if err != nil {
b.Fatal(err)
}
if meta == nil {
b.Fatal("Meta is nil")
}
}
})
}