shithub: hugo

Download patch

ref: 15b64d51da48807c5f896f17b33d8c0d054c9461
parent: 148fedd227b8f4f5af8f72cb6841653140f82dfe
author: Bjørn Erik Pedersen <[email protected]>
date: Sat Mar 25 10:37:04 EDT 2017 

all: Propagate baseURL error to the callers


--- a/commands/benchmark.go
+++ b/commands/benchmark.go
@@ -54,7 +54,10 @@
 		return err
 	}
 
-	c := newCommandeer(cfg)
+	c, err := newCommandeer(cfg)
+	if err != nil {
+		return err
+	}
 
 	var memProf *os.File
 	if memProfileFile != "" {
--- a/commands/commandeer.go
+++ b/commands/commandeer.go
@@ -16,6 +16,7 @@
 import (
 	"github.com/spf13/hugo/deps"
 	"github.com/spf13/hugo/helpers"
+	"github.com/spf13/hugo/hugofs"
 )
 
 type commandeer struct {
@@ -35,12 +36,14 @@
 // be configured before it is created.
 func (c *commandeer) PathSpec() *helpers.PathSpec {
 	c.configured = true
-	if c.pathSpec == nil {
-		c.pathSpec = helpers.NewPathSpec(c.Fs, c.Cfg)
-	}
 	return c.pathSpec
 }
 
-func newCommandeer(cfg *deps.DepsCfg) *commandeer {
-	return &commandeer{DepsCfg: cfg}
+func newCommandeer(cfg *deps.DepsCfg) (*commandeer, error) {
+	fs := hugofs.NewDefault(cfg.Language)
+	ps, err := helpers.NewPathSpec(fs, cfg.Cfg)
+	if err != nil {
+		return nil, err
+	}
+	return &commandeer{DepsCfg: cfg, pathSpec: ps}, nil
 }
--- a/commands/hugo.go
+++ b/commands/hugo.go
@@ -118,7 +118,10 @@
 			return err
 		}
 
-		c := newCommandeer(cfg)
+		c, err := newCommandeer(cfg)
+		if err != nil {
+			return err
+		}
 
 		if buildWatch {
 			cfg.Cfg.Set("disableLiveReload", true)
@@ -287,7 +290,10 @@
 
 	cfg.Cfg = config
 
-	c := newCommandeer(cfg)
+	c, err := newCommandeer(cfg)
+	if err != nil {
+		return nil, err
+	}
 
 	for _, cmdV := range append([]*cobra.Command{hugoCmdV}, subCmdVs...) {
 		c.initializeFlags(cmdV)
--- a/commands/list.go
+++ b/commands/list.go
@@ -49,7 +49,10 @@
 			return err
 		}
 
-		c := newCommandeer(cfg)
+		c, err := newCommandeer(cfg)
+		if err != nil {
+			return err
+		}
 
 		c.Set("buildDrafts", true)
 
@@ -87,7 +90,10 @@
 			return err
 		}
 
-		c := newCommandeer(cfg)
+		c, err := newCommandeer(cfg)
+		if err != nil {
+			return err
+		}
 
 		c.Set("buildFuture", true)
 
@@ -125,7 +131,10 @@
 			return err
 		}
 
-		c := newCommandeer(cfg)
+		c, err := newCommandeer(cfg)
+		if err != nil {
+			return err
+		}
 
 		c.Set("buildExpired", true)
 
--- a/commands/new.go
+++ b/commands/new.go
@@ -93,7 +93,10 @@
 		return err
 	}
 
-	c := newCommandeer(cfg)
+	c, err := newCommandeer(cfg)
+	if err != nil {
+		return err
+	}
 
 	if flagChanged(cmd.Flags(), "format") {
 		c.Set("metaDataFormat", configFormat)
@@ -220,7 +223,10 @@
 		return newUserError("theme name needs to be provided")
 	}
 
-	c := newCommandeer(cfg)
+	c, err := newCommandeer(cfg)
+	if err != nil {
+		return err
+	}
 
 	createpath := c.PathSpec().AbsPathify(filepath.Join(c.Cfg.GetString("themesDir"), args[0]))
 	jww.INFO.Println("creating theme at", createpath)
--- a/commands/server.go
+++ b/commands/server.go
@@ -106,7 +106,10 @@
 		return err
 	}
 
-	c := newCommandeer(cfg)
+	c, err := newCommandeer(cfg)
+	if err != nil {
+		return err
+	}
 
 	if flagChanged(cmd.Flags(), "disableLiveReload") {
 		c.Set("disableLiveReload", disableLiveReload)
--- a/deps/deps.go
+++ b/deps/deps.go
@@ -65,7 +65,7 @@
 	return nil
 }
 
-func New(cfg DepsCfg) *Deps {
+func New(cfg DepsCfg) (*Deps, error) {
 	var (
 		logger = cfg.Logger
 		fs     = cfg.Fs
@@ -92,6 +92,12 @@
 		fs = hugofs.NewDefault(cfg.Language)
 	}
 
+	ps, err := helpers.NewPathSpec(fs, cfg.Language)
+
+	if err != nil {
+		return nil, err
+	}
+
 	d := &Deps{
 		Fs:                  fs,
 		Log:                 logger,
@@ -98,20 +104,25 @@
 		templateProvider:    cfg.TemplateProvider,
 		translationProvider: cfg.TranslationProvider,
 		WithTemplate:        cfg.WithTemplate,
-		PathSpec:            helpers.NewPathSpec(fs, cfg.Language),
+		PathSpec:            ps,
 		ContentSpec:         helpers.NewContentSpec(cfg.Language),
 		Cfg:                 cfg.Language,
 		Language:            cfg.Language,
 	}
 
-	return d
+	return d, nil
 }
 
 // ForLanguage creates a copy of the Deps with the language dependent
 // parts switched out.
 func (d Deps) ForLanguage(l *helpers.Language) (*Deps, error) {
+	var err error
 
-	d.PathSpec = helpers.NewPathSpec(d.Fs, l)
+	d.PathSpec, err = helpers.NewPathSpec(d.Fs, l)
+	if err != nil {
+		return nil, err
+	}
+
 	d.ContentSpec = helpers.NewContentSpec(l)
 	d.Cfg = l
 	d.Language = l
--- a/helpers/baseURL.go
+++ b/helpers/baseURL.go
@@ -69,6 +69,5 @@
 		return result, err
 	}
 
-	// TODO(bep) output consider saving original URL?
 	return BaseURL{url: base, urlStr: base.String()}, nil
 }
--- a/helpers/baseURL_test.go
+++ b/helpers/baseURL_test.go
@@ -48,4 +48,14 @@
 	require.NoError(t, err)
 	require.Equal(t, "webcal://[email protected]", p)
 
+	// Test with "non-URLs". Some people will try to use these as a way to get
+	// relative URLs working etc.
+	b, err = newBaseURLFromString("/")
+	require.NoError(t, err)
+	require.Equal(t, "/", b.String())
+
+	b, err = newBaseURLFromString("")
+	require.NoError(t, err)
+	require.Equal(t, "", b.String())
+
 }
--- a/helpers/path_test.go
+++ b/helpers/path_test.go
@@ -59,7 +59,7 @@
 		v := viper.New()
 		l := NewDefaultLanguage(v)
 		v.Set("removePathAccents", test.removeAccents)
-		p := NewPathSpec(hugofs.NewMem(v), l)
+		p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 		output := p.MakePath(test.input)
 		if output != test.expected {
@@ -71,7 +71,7 @@
 func TestMakePathSanitized(t *testing.T) {
 	v := viper.New()
 	l := NewDefaultLanguage(v)
-	p := NewPathSpec(hugofs.NewMem(v), l)
+	p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 	tests := []struct {
 		input    string
@@ -99,7 +99,7 @@
 	v.Set("disablePathToLower", true)
 
 	l := NewDefaultLanguage(v)
-	p := NewPathSpec(hugofs.NewMem(v), l)
+	p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 	tests := []struct {
 		input    string
--- a/helpers/pathspec.go
+++ b/helpers/pathspec.go
@@ -60,11 +60,15 @@
 }
 
 // NewPathSpec creats a new PathSpec from the given filesystems and Language.
-func NewPathSpec(fs *hugofs.Fs, cfg config.Provider) *PathSpec {
+func NewPathSpec(fs *hugofs.Fs, cfg config.Provider) (*PathSpec, error) {
 
-	// TODO(bep) output error handling
-	baseURL, _ := newBaseURLFromString(cfg.GetString("baseURL"))
+	baseURLstr := cfg.GetString("baseURL")
+	baseURL, err := newBaseURLFromString(baseURLstr)
 
+	if err != nil {
+		return nil, fmt.Errorf("Failed to create baseURL from %q: %s", baseURLstr, err)
+	}
+
 	ps := &PathSpec{
 		fs:                             fs,
 		disablePathToLower:             cfg.GetBool("disablePathToLower"),
@@ -87,7 +91,7 @@
 		ps.language = language
 	}
 
-	return ps
+	return ps, nil
 }
 
 // PaginatePath returns the configured root path used for paginator pages.
--- a/helpers/pathspec_test.go
+++ b/helpers/pathspec_test.go
@@ -40,8 +40,9 @@
 	v.Set("staticDir", "thestatic")
 	v.Set("theme", "thetheme")
 
-	p := NewPathSpec(hugofs.NewMem(v), l)
+	p, err := NewPathSpec(hugofs.NewMem(v), l)
 
+	require.NoError(t, err)
 	require.True(t, p.canonifyURLs)
 	require.True(t, p.defaultContentLanguageInSubdir)
 	require.True(t, p.disablePathToLower)
--- a/helpers/testhelpers_test.go
+++ b/helpers/testhelpers_test.go
@@ -8,7 +8,8 @@
 
 func newTestPathSpec(fs *hugofs.Fs, v *viper.Viper) *PathSpec {
 	l := NewDefaultLanguage(v)
-	return NewPathSpec(fs, l)
+	ps, _ := NewPathSpec(fs, l)
+	return ps
 }
 
 func newTestDefaultPathSpec(configKeyValues ...interface{}) *PathSpec {
--- a/helpers/url_test.go
+++ b/helpers/url_test.go
@@ -28,7 +28,7 @@
 
 	v := viper.New()
 	l := NewDefaultLanguage(v)
-	p := NewPathSpec(hugofs.NewMem(v), l)
+	p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 	tests := []struct {
 		input    string
@@ -89,7 +89,7 @@
 	for _, test := range tests {
 		v.Set("baseURL", test.baseURL)
 		l := NewLanguage(lang, v)
-		p := NewPathSpec(hugofs.NewMem(v), l)
+		p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 		output := p.AbsURL(test.input, addLanguage)
 		expected := test.expected
@@ -167,7 +167,7 @@
 		v.Set("baseURL", test.baseURL)
 		v.Set("canonifyURLs", test.canonify)
 		l := NewLanguage(lang, v)
-		p := NewPathSpec(hugofs.NewMem(v), l)
+		p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 		output := p.RelURL(test.input, addLanguage)
 
@@ -255,7 +255,7 @@
 		v := viper.New()
 		v.Set("uglyURLs", d.ugly)
 		l := NewDefaultLanguage(v)
-		p := NewPathSpec(hugofs.NewMem(v), l)
+		p, _ := NewPathSpec(hugofs.NewMem(v), l)
 
 		output := p.URLPrep(d.input)
 		if d.output != output {
--- a/hugolib/hugo_sites.go
+++ b/hugolib/hugo_sites.go
@@ -92,7 +92,13 @@
 		if d == nil {
 			cfg.Language = s.Language
 			cfg.WithTemplate = s.withSiteTemplates(cfg.WithTemplate)
-			d = deps.New(cfg)
+
+			var err error
+			d, err = deps.New(cfg)
+			if err != nil {
+				return err
+			}
+
 			s.Deps = d
 
 			if err = d.LoadResources(); err != nil {
--- a/hugolib/testhelpers_test.go
+++ b/hugolib/testhelpers_test.go
@@ -74,7 +74,8 @@
 
 func newTestPathSpec(fs *hugofs.Fs, v *viper.Viper) *helpers.PathSpec {
 	l := helpers.NewDefaultLanguage(v)
-	return helpers.NewPathSpec(fs, l)
+	ps, _ := helpers.NewPathSpec(fs, l)
+	return ps
 }
 
 func newTestDefaultPathSpec() *helpers.PathSpec {
@@ -82,7 +83,8 @@
 	// Easier to reason about in tests.
 	v.Set("disablePathToLower", true)
 	fs := hugofs.NewDefault(v)
-	return helpers.NewPathSpec(fs, v)
+	ps, _ := helpers.NewPathSpec(fs, v)
+	return ps
 }
 
 func newTestCfg() (*viper.Viper, *hugofs.Fs) {
--- a/tpl/tplimpl/template_funcs_test.go
+++ b/tpl/tplimpl/template_funcs_test.go
@@ -289,12 +289,16 @@
 	}
 	config.Fs = fs
 
-	d := deps.New(config)
+	d, err := deps.New(config)
+	if err != nil {
+		t.Fatal(err)
+	}
+
 	if err := d.LoadResources(); err != nil {
 		t.Fatal(err)
 	}
 
-	err := d.Tmpl.Lookup("test").Execute(&b, &data)
+	err = d.Tmpl.Lookup("test").Execute(&b, &data)
 
 	if err != nil {
 		t.Fatal("Got error on execute", err)
@@ -2902,12 +2906,13 @@
 			return nil
 		}
 
-		de := deps.New(config)
+		de, err := deps.New(config)
+		require.NoError(t, err)
 		require.NoError(t, de.LoadResources())
 
 		buf := new(bytes.Buffer)
 		templ := de.Tmpl.Lookup("testroot")
-		err := templ.Execute(buf, &data)
+		err = templ.Execute(buf, &data)
 		if err != nil {
 			t.Fatalf("[%d] error executing template: %s", i, err)
 		}
@@ -2941,7 +2946,8 @@
 		return nil
 	}
 
-	de := deps.New(config)
+	de, err := deps.New(config)
+	require.NoError(b, err)
 	require.NoError(b, de.LoadResources())
 
 	buf := new(bytes.Buffer)
@@ -2972,7 +2978,8 @@
 		return nil
 	}
 
-	de := deps.New(config)
+	de, err := deps.New(config)
+	require.NoError(b, err)
 	require.NoError(b, de.LoadResources())
 
 	buf := new(bytes.Buffer)
@@ -2994,7 +3001,10 @@
 
 func newTestFuncsterWithViper(v *viper.Viper) *templateFuncster {
 	config := newDepsConfig(v)
-	d := deps.New(config)
+	d, err := deps.New(config)
+	if err != nil {
+		panic(err)
+	}
 
 	if err := d.LoadResources(); err != nil {
 		panic(err)
@@ -3013,7 +3023,8 @@
 		return nil
 	}
 
-	de := deps.New(config)
+	de, err := deps.New(config)
+	require.NoError(t, err)
 	require.NoError(t, de.LoadResources())
 
 	return de.Tmpl.Lookup(name)
--- a/tpl/tplimpl/template_test.go
+++ b/tpl/tplimpl/template_test.go
@@ -79,7 +79,8 @@
 					[]byte(this.baseContent), []byte(this.innerContent))
 			}
 
-			a := deps.New(config)
+			a, err := deps.New(config)
+			require.NoError(t, err)
 
 			if err := a.LoadResources(); err != nil {
 				t.Fatal(err)
@@ -94,7 +95,7 @@
 			}
 
 			var buff bytes.Buffer
-			err := a.Tmpl.ExecuteTemplate(&buff, "mytemplate.html", d)
+			err = a.Tmpl.ExecuteTemplate(&buff, "mytemplate.html", d)
 
 			if err != nil && this.expectErr == 0 {
 				t.Errorf("Test %d with root '%s' errored: %s", i, root, err)
@@ -288,7 +289,8 @@
 			return templ.AddTemplate("fuzz", this.data)
 		}
 
-		de := deps.New(config)
+		de, err := deps.New(config)
+		require.NoError(t, err)
 		require.NoError(t, de.LoadResources())
 
 		templ := de.Tmpl.(*GoHTMLTemplate)
@@ -299,7 +301,7 @@
 			t.Errorf("#1 Test %d should have errored", i)
 		}
 
-		err := de.Tmpl.ExecuteTemplate(ioutil.Discard, "fuzz", d)
+		err = de.Tmpl.ExecuteTemplate(ioutil.Discard, "fuzz", d)
 
 		if err != nil && this.expectErr == 0 {
 			t.Fatalf("Test %d errored: %s", i, err)