hugo/tpl/data/data_test.go
Bjørn Erik Pedersen 43d446522a tpl/data: Revise error handling in getJSON and getCSV
The most important part being: Log ERROR, but do not stop the build on remote errors.

Fixes #5076
2018-09-11 16:46:25 +02:00

263 lines
6.2 KiB
Go

// Copyright 2017 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 data
import (
"fmt"
"net/http"
"net/http/httptest"
"path/filepath"
"strings"
"testing"
jww "github.com/spf13/jwalterweatherman"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGetCSV(t *testing.T) {
t.Parallel()
for i, test := range []struct {
sep string
url string
content string
expect interface{}
}{
// Remotes
{
",",
`http://success/`,
"gomeetup,city\nyes,Sydney\nyes,San Francisco\nyes,Stockholm\n",
[][]string{{"gomeetup", "city"}, {"yes", "Sydney"}, {"yes", "San Francisco"}, {"yes", "Stockholm"}},
},
{
",",
`http://error.extra.field/`,
"gomeetup,city\nyes,Sydney\nyes,San Francisco\nyes,Stockholm,EXTRA\n",
false,
},
{
",",
`http://error.no.sep/`,
"gomeetup;city\nyes;Sydney\nyes;San Francisco\nyes;Stockholm\n",
false,
},
{
",",
`http://nofound/404`,
``,
false,
},
// Locals
{
";",
"pass/semi",
"gomeetup;city\nyes;Sydney\nyes;San Francisco\nyes;Stockholm\n",
[][]string{{"gomeetup", "city"}, {"yes", "Sydney"}, {"yes", "San Francisco"}, {"yes", "Stockholm"}},
},
{
";",
"fail/no-file",
"",
false,
},
} {
msg := fmt.Sprintf("Test %d", i)
ns := newTestNs()
// Setup HTTP test server
var srv *httptest.Server
srv, ns.client = getTestServer(func(w http.ResponseWriter, r *http.Request) {
if !haveHeader(r.Header, "Accept", "text/csv") && !haveHeader(r.Header, "Accept", "text/plain") {
http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
return
}
if r.URL.Path == "/404" {
http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
return
}
w.Header().Add("Content-type", "text/csv")
w.Write([]byte(test.content))
})
defer func() { srv.Close() }()
// Setup local test file for schema-less URLs
if !strings.Contains(test.url, ":") && !strings.HasPrefix(test.url, "fail/") {
f, err := ns.deps.Fs.Source.Create(filepath.Join(ns.deps.Cfg.GetString("workingDir"), test.url))
require.NoError(t, err, msg)
f.WriteString(test.content)
f.Close()
}
// Get on with it
got, err := ns.GetCSV(test.sep, test.url)
require.NoError(t, err, msg)
if _, ok := test.expect.(bool); ok {
require.Equal(t, 1, int(ns.deps.Log.LogCountForLevelsGreaterThanorEqualTo(jww.LevelError)))
require.Nil(t, got)
continue
}
require.Equal(t, 0, int(ns.deps.Log.LogCountForLevelsGreaterThanorEqualTo(jww.LevelError)))
require.NotNil(t, got, msg)
assert.EqualValues(t, test.expect, got, msg)
}
}
func TestGetJSON(t *testing.T) {
t.Parallel()
for i, test := range []struct {
url string
content string
expect interface{}
}{
{
`http://success/`,
`{"gomeetup":["Sydney","San Francisco","Stockholm"]}`,
map[string]interface{}{"gomeetup": []interface{}{"Sydney", "San Francisco", "Stockholm"}},
},
{
`http://malformed/`,
`{gomeetup:["Sydney","San Francisco","Stockholm"]}`,
jww.LevelError,
},
{
`http://nofound/404`,
``,
jww.LevelError,
},
// Locals
{
"pass/semi",
`{"gomeetup":["Sydney","San Francisco","Stockholm"]}`,
map[string]interface{}{"gomeetup": []interface{}{"Sydney", "San Francisco", "Stockholm"}},
},
{
"fail/no-file",
"",
jww.LevelError,
},
} {
msg := fmt.Sprintf("Test %d", i)
ns := newTestNs()
// Setup HTTP test server
var srv *httptest.Server
srv, ns.client = getTestServer(func(w http.ResponseWriter, r *http.Request) {
if !haveHeader(r.Header, "Accept", "application/json") {
http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest)
return
}
if r.URL.Path == "/404" {
http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound)
return
}
w.Header().Add("Content-type", "application/json")
w.Write([]byte(test.content))
})
defer func() { srv.Close() }()
// Setup local test file for schema-less URLs
if !strings.Contains(test.url, ":") && !strings.HasPrefix(test.url, "fail/") {
f, err := ns.deps.Fs.Source.Create(filepath.Join(ns.deps.Cfg.GetString("workingDir"), test.url))
require.NoError(t, err, msg)
f.WriteString(test.content)
f.Close()
}
// Get on with it
got, err := ns.GetJSON(test.url)
if _, ok := test.expect.(bool); ok {
require.Error(t, err, msg)
continue
}
if errLevel, ok := test.expect.(jww.Threshold); ok {
logCount := ns.deps.Log.LogCountForLevelsGreaterThanorEqualTo(errLevel)
require.True(t, logCount >= 1, fmt.Sprintf("got log count %d", logCount))
continue
}
require.NoError(t, err, msg)
require.Equal(t, 0, int(ns.deps.Log.LogCountForLevelsGreaterThanorEqualTo(jww.LevelError)), msg)
require.NotNil(t, got, msg)
assert.EqualValues(t, test.expect, got, msg)
}
}
func TestParseCSV(t *testing.T) {
t.Parallel()
for i, test := range []struct {
csv []byte
sep string
exp string
err bool
}{
{[]byte("a,b,c\nd,e,f\n"), "", "", true},
{[]byte("a,b,c\nd,e,f\n"), "~/", "", true},
{[]byte("a,b,c\nd,e,f"), "|", "a,b,cd,e,f", false},
{[]byte("q,w,e\nd,e,f"), ",", "qwedef", false},
{[]byte("a|b|c\nd|e|f|g"), "|", "abcdefg", true},
{[]byte("z|y|c\nd|e|f"), "|", "zycdef", false},
} {
msg := fmt.Sprintf("Test %d: %v", i, test)
csv, err := parseCSV(test.csv, test.sep)
if test.err {
assert.Error(t, err, msg)
continue
}
require.NoError(t, err, msg)
act := ""
for _, v := range csv {
act = act + strings.Join(v, "")
}
assert.Equal(t, test.exp, act, msg)
}
}
func haveHeader(m http.Header, key, needle string) bool {
var s []string
var ok bool
if s, ok = m[key]; !ok {
return false
}
for _, v := range s {
if v == needle {
return true
}
}
return false
}