mirror of
https://github.com/gohugoio/hugo.git
synced 2025-01-01 17:13:00 +00:00
f7aeaa6129
This commits reworks how file caching is performed in Hugo. Now there is only one way, and it can be configured.
This is the default configuration:
```toml
[caches]
[caches.getjson]
dir = ":cacheDir"
maxAge = -1
[caches.getcsv]
dir = ":cacheDir"
maxAge = -1
[caches.images]
dir = ":resourceDir/_gen"
maxAge = -1
[caches.assets]
dir = ":resourceDir/_gen"
maxAge = -1
```
You can override any of these cache setting in your own `config.toml`.
The placeholders explained:
`:cacheDir`: This is the value of the `cacheDir` config option if set (can also be set via OS env variable `HUGO_CACHEDIR`). It will fall back to `/opt/build/cache/hugo_cache/` on Netlify, or a `hugo_cache` directory below the OS temp dir for the others.
`:resourceDir`: This is the value of the `resourceDir` config option.
`maxAge` is the time in seconds before a cache entry will be evicted, -1 means forever and 0 effectively turns that particular cache off.
This means that if you run your builds on Netlify, all caches configured with `:cacheDir` will be saved and restored on the next build. For other CI vendors, please read their documentation. For an CircleCI example, see 6c3960a8f4/.circleci/config.yml
Fixes #5404
210 lines
5.2 KiB
Go
210 lines
5.2 KiB
Go
// Copyright 2016 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 (
|
|
"bytes"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/gohugoio/hugo/hugolib/paths"
|
|
|
|
"github.com/gohugoio/hugo/cache/filecache"
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/deps"
|
|
"github.com/gohugoio/hugo/helpers"
|
|
"github.com/gohugoio/hugo/hugofs"
|
|
"github.com/gohugoio/hugo/langs"
|
|
"github.com/spf13/afero"
|
|
"github.com/spf13/viper"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestScpGetLocal(t *testing.T) {
|
|
t.Parallel()
|
|
v := viper.New()
|
|
fs := hugofs.NewMem(v)
|
|
ps := helpers.FilePathSeparator
|
|
|
|
tests := []struct {
|
|
path string
|
|
content []byte
|
|
}{
|
|
{"testpath" + ps + "test.txt", []byte(`T€st Content 123 fOO,bar:foo%bAR`)},
|
|
{"FOo" + ps + "BaR.html", []byte(`FOo/BaR.html T€st Content 123`)},
|
|
{"трям" + ps + "трям", []byte(`T€st трям/трям Content 123`)},
|
|
{"은행", []byte(`T€st C은행ontent 123`)},
|
|
{"Банковский кассир", []byte(`Банковский кассир T€st Content 123`)},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
r := bytes.NewReader(test.content)
|
|
err := helpers.WriteToDisk(test.path, r, fs.Source)
|
|
if err != nil {
|
|
t.Error(err)
|
|
}
|
|
|
|
c, err := getLocal(test.path, fs.Source, v)
|
|
if err != nil {
|
|
t.Errorf("Error getting resource content: %s", err)
|
|
}
|
|
if !bytes.Equal(c, test.content) {
|
|
t.Errorf("\nExpected: %s\nActual: %s\n", string(test.content), string(c))
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
func getTestServer(handler func(w http.ResponseWriter, r *http.Request)) (*httptest.Server, *http.Client) {
|
|
testServer := httptest.NewServer(http.HandlerFunc(handler))
|
|
client := &http.Client{
|
|
Transport: &http.Transport{Proxy: func(r *http.Request) (*url.URL, error) {
|
|
// Remove when https://github.com/golang/go/issues/13686 is fixed
|
|
r.Host = "gohugo.io"
|
|
return url.Parse(testServer.URL)
|
|
}},
|
|
}
|
|
return testServer, client
|
|
}
|
|
|
|
func TestScpGetRemote(t *testing.T) {
|
|
t.Parallel()
|
|
fs := new(afero.MemMapFs)
|
|
cache := filecache.NewCache(fs, 100)
|
|
|
|
tests := []struct {
|
|
path string
|
|
content []byte
|
|
}{
|
|
{"http://Foo.Bar/foo_Bar-Foo", []byte(`T€st Content 123`)},
|
|
{"http://Doppel.Gänger/foo_Bar-Foo", []byte(`T€st Cont€nt 123`)},
|
|
{"http://Doppel.Gänger/Fizz_Bazz-Foo", []byte(`T€st Банковский кассир Cont€nt 123`)},
|
|
{"http://Doppel.Gänger/Fizz_Bazz-Bar", []byte(`T€st Банковский кассир Cont€nt 456`)},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
msg := fmt.Sprintf("%v", test)
|
|
|
|
req, err := http.NewRequest("GET", test.path, nil)
|
|
require.NoError(t, err, msg)
|
|
|
|
srv, cl := getTestServer(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Write(test.content)
|
|
})
|
|
defer func() { srv.Close() }()
|
|
|
|
ns := newTestNs()
|
|
ns.client = cl
|
|
|
|
var c []byte
|
|
f := func(b []byte) (error, bool) {
|
|
c = b
|
|
return nil, false
|
|
}
|
|
|
|
err = ns.getRemote(cache, f, req)
|
|
require.NoError(t, err, msg)
|
|
assert.Equal(t, string(test.content), string(c))
|
|
|
|
assert.Equal(t, string(test.content), string(c))
|
|
|
|
}
|
|
}
|
|
|
|
func TestScpGetRemoteParallel(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
content := []byte(`T€st Content 123`)
|
|
srv, cl := getTestServer(func(w http.ResponseWriter, r *http.Request) {
|
|
w.Write(content)
|
|
})
|
|
|
|
defer func() { srv.Close() }()
|
|
|
|
url := "http://Foo.Bar/foo_Bar-Foo"
|
|
req, err := http.NewRequest("GET", url, nil)
|
|
require.NoError(t, err)
|
|
|
|
for _, ignoreCache := range []bool{false} {
|
|
cfg := viper.New()
|
|
cfg.Set("ignoreCache", ignoreCache)
|
|
cfg.Set("contentDir", "content")
|
|
|
|
ns := New(newDeps(cfg))
|
|
ns.client = cl
|
|
|
|
var wg sync.WaitGroup
|
|
|
|
for i := 0; i < 1; i++ {
|
|
wg.Add(1)
|
|
go func(gor int) {
|
|
defer wg.Done()
|
|
for j := 0; j < 10; j++ {
|
|
var c []byte
|
|
f := func(b []byte) (error, bool) {
|
|
c = b
|
|
return nil, false
|
|
}
|
|
err := ns.getRemote(ns.cacheGetJSON, f, req)
|
|
|
|
assert.NoError(t, err)
|
|
if string(content) != string(c) {
|
|
t.Fatalf("expected\n%q\ngot\n%q", content, c)
|
|
}
|
|
|
|
time.Sleep(23 * time.Millisecond)
|
|
}
|
|
}(i)
|
|
}
|
|
|
|
wg.Wait()
|
|
}
|
|
}
|
|
|
|
func newDeps(cfg config.Provider) *deps.Deps {
|
|
l := langs.NewLanguage("en", cfg)
|
|
l.Set("i18nDir", "i18n")
|
|
cs, err := helpers.NewContentSpec(l)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fs := hugofs.NewMem(l)
|
|
logger := loggers.NewErrorLogger()
|
|
p, _ := paths.New(fs, cfg)
|
|
|
|
fileCaches, _ := filecache.NewCachesFromPaths(p)
|
|
|
|
return &deps.Deps{
|
|
Cfg: cfg,
|
|
Fs: fs,
|
|
FileCaches: fileCaches,
|
|
ContentSpec: cs,
|
|
Log: logger,
|
|
DistinctErrorLog: helpers.NewDistinctLogger(logger.ERROR),
|
|
}
|
|
}
|
|
|
|
func newTestNs() *Namespace {
|
|
v := viper.New()
|
|
v.Set("contentDir", "content")
|
|
return New(newDeps(v))
|
|
}
|