mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
35fbfb19a1
The main item in this commit is showing of errors with a file context when running `hugo server`. This can be turned off: `hugo server --disableBrowserError` (can also be set in `config.toml`). But to get there, the error handling in Hugo needed a revision. There are some items left TODO for commits soon to follow, most notable errors in content and config files. Fixes #5284 Fixes #5290 See #5325 See #5324
131 lines
4 KiB
Go
131 lines
4 KiB
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 commands
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
"runtime"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
|
|
|
"github.com/spf13/viper"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestServer(t *testing.T) {
|
|
if isWindowsCI() {
|
|
// TODO(bep) not sure why server tests have started to fail on the Windows CI server.
|
|
t.Skip("Skip server test on appveyor")
|
|
}
|
|
assert := require.New(t)
|
|
dir, err := createSimpleTestSite(t)
|
|
assert.NoError(err)
|
|
|
|
// Let us hope that this port is available on all systems ...
|
|
port := 1331
|
|
|
|
defer func() {
|
|
os.RemoveAll(dir)
|
|
}()
|
|
|
|
stop := make(chan bool)
|
|
|
|
b := newCommandsBuilder()
|
|
scmd := b.newServerCmdSignaled(stop)
|
|
|
|
cmd := scmd.getCommand()
|
|
cmd.SetArgs([]string{"-s=" + dir, fmt.Sprintf("-p=%d", port)})
|
|
|
|
go func() {
|
|
_, err = cmd.ExecuteC()
|
|
assert.NoError(err)
|
|
}()
|
|
|
|
// There is no way to know exactly when the server is ready for connections.
|
|
// We could improve by something like https://golang.org/pkg/net/http/httptest/#Server
|
|
// But for now, let us sleep and pray!
|
|
time.Sleep(2 * time.Second)
|
|
|
|
resp, err := http.Get("http://localhost:1331/")
|
|
assert.NoError(err)
|
|
defer resp.Body.Close()
|
|
homeContent := helpers.ReaderToString(resp.Body)
|
|
|
|
assert.Contains(homeContent, "List: Hugo Commands")
|
|
|
|
// Stop the server.
|
|
stop <- true
|
|
|
|
}
|
|
|
|
func TestFixURL(t *testing.T) {
|
|
type data struct {
|
|
TestName string
|
|
CLIBaseURL string
|
|
CfgBaseURL string
|
|
AppendPort bool
|
|
Port int
|
|
Result string
|
|
}
|
|
tests := []data{
|
|
{"Basic http localhost", "", "http://foo.com", true, 1313, "http://localhost:1313/"},
|
|
{"Basic https production, http localhost", "", "https://foo.com", true, 1313, "http://localhost:1313/"},
|
|
{"Basic subdir", "", "http://foo.com/bar", true, 1313, "http://localhost:1313/bar/"},
|
|
{"Basic production", "http://foo.com", "http://foo.com", false, 80, "http://foo.com/"},
|
|
{"Production subdir", "http://foo.com/bar", "http://foo.com/bar", false, 80, "http://foo.com/bar/"},
|
|
{"No http", "", "foo.com", true, 1313, "//localhost:1313/"},
|
|
{"Override configured port", "", "foo.com:2020", true, 1313, "//localhost:1313/"},
|
|
{"No http production", "foo.com", "foo.com", false, 80, "//foo.com/"},
|
|
{"No http production with port", "foo.com", "foo.com", true, 2020, "//foo.com:2020/"},
|
|
{"No config", "", "", true, 1313, "//localhost:1313/"},
|
|
}
|
|
|
|
for i, test := range tests {
|
|
b := newCommandsBuilder()
|
|
s := b.newServerCmd()
|
|
v := viper.New()
|
|
baseURL := test.CLIBaseURL
|
|
v.Set("baseURL", test.CfgBaseURL)
|
|
s.serverAppend = test.AppendPort
|
|
s.serverPort = test.Port
|
|
result, err := s.fixURL(v, baseURL, s.serverPort)
|
|
if err != nil {
|
|
t.Errorf("Test #%d %s: unexpected error %s", i, test.TestName, err)
|
|
}
|
|
if result != test.Result {
|
|
t.Errorf("Test #%d %s: expected %q, got %q", i, test.TestName, test.Result, result)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestRemoveErrorPrefixFromLog(t *testing.T) {
|
|
assert := require.New(t)
|
|
content := `ERROR 2018/10/07 13:11:12 Error while rendering "home": template: _default/baseof.html:4:3: executing "main" at <partial "logo" .>: error calling partial: template: partials/logo.html:5:84: executing "partials/logo.html" at <$resized.AHeight>: can't evaluate field AHeight in type *resource.Image
|
|
ERROR 2018/10/07 13:11:12 Rebuild failed: logged 1 error(s)
|
|
`
|
|
|
|
withoutError := removeErrorPrefixFromLog(content)
|
|
|
|
assert.False(strings.Contains(withoutError, "ERROR"), withoutError)
|
|
|
|
}
|
|
|
|
func isWindowsCI() bool {
|
|
return runtime.GOOS == "windows" && os.Getenv("CI") != ""
|
|
}
|