Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 07:16:58 +00:00
|
|
|
// Copyright 2019 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 htesting
|
|
|
|
|
|
|
|
import (
|
2019-08-18 09:21:27 +00:00
|
|
|
"math/rand"
|
2020-12-23 18:47:20 +00:00
|
|
|
"os"
|
2021-08-26 15:24:52 +00:00
|
|
|
"regexp"
|
Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 07:16:58 +00:00
|
|
|
"runtime"
|
2021-08-26 15:24:52 +00:00
|
|
|
"strconv"
|
Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 07:16:58 +00:00
|
|
|
"strings"
|
2019-08-18 09:21:27 +00:00
|
|
|
"time"
|
Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 07:16:58 +00:00
|
|
|
|
|
|
|
"github.com/spf13/afero"
|
|
|
|
)
|
|
|
|
|
2021-10-17 09:54:55 +00:00
|
|
|
// IsTest reports whether we're running as a test.
|
|
|
|
var IsTest bool
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
for _, arg := range os.Args {
|
|
|
|
if strings.HasPrefix(arg, "-test.") {
|
|
|
|
IsTest = true
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Add Hugo Modules
This commit implements Hugo Modules.
This is a broad subject, but some keywords include:
* A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project.
* A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects.
* Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running.
* Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions.
* A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`.
All of the above is backed by Go Modules.
Fixes #5973
Fixes #5996
Fixes #6010
Fixes #5911
Fixes #5940
Fixes #6074
Fixes #6082
Fixes #6092
2019-05-03 07:16:58 +00:00
|
|
|
// CreateTempDir creates a temp dir in the given filesystem and
|
|
|
|
// returns the dirnam and a func that removes it when done.
|
|
|
|
func CreateTempDir(fs afero.Fs, prefix string) (string, func(), error) {
|
|
|
|
tempDir, err := afero.TempDir(fs, "", prefix)
|
|
|
|
if err != nil {
|
|
|
|
return "", nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
_, isOsFs := fs.(*afero.OsFs)
|
|
|
|
|
|
|
|
if isOsFs && runtime.GOOS == "darwin" && !strings.HasPrefix(tempDir, "/private") {
|
|
|
|
// To get the entry folder in line with the rest. This its a little bit
|
|
|
|
// mysterious, but so be it.
|
|
|
|
tempDir = "/private" + tempDir
|
|
|
|
}
|
|
|
|
return tempDir, func() { fs.RemoveAll(tempDir) }, nil
|
|
|
|
}
|
2019-08-18 09:21:27 +00:00
|
|
|
|
|
|
|
// BailOut panics with a stack trace after the given duration. Useful for
|
|
|
|
// hanging tests.
|
|
|
|
func BailOut(after time.Duration) {
|
|
|
|
time.AfterFunc(after, func() {
|
|
|
|
buf := make([]byte, 1<<16)
|
|
|
|
runtime.Stack(buf, true)
|
|
|
|
panic(string(buf))
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2020-10-09 08:00:50 +00:00
|
|
|
// Rnd is used only for testing.
|
|
|
|
var Rnd = rand.New(rand.NewSource(time.Now().UnixNano()))
|
2019-08-18 09:21:27 +00:00
|
|
|
|
2020-10-09 08:00:50 +00:00
|
|
|
func RandBool() bool {
|
|
|
|
return Rnd.Intn(2) != 0
|
2019-08-18 09:21:27 +00:00
|
|
|
}
|
2019-09-10 09:26:34 +00:00
|
|
|
|
|
|
|
// DiffStringSlices returns the difference between two string slices.
|
|
|
|
// Useful in tests.
|
|
|
|
// See:
|
|
|
|
// http://stackoverflow.com/questions/19374219/how-to-find-the-difference-between-two-slices-of-strings-in-golang
|
|
|
|
func DiffStringSlices(slice1 []string, slice2 []string) []string {
|
|
|
|
diffStr := []string{}
|
|
|
|
m := map[string]int{}
|
|
|
|
|
|
|
|
for _, s1Val := range slice1 {
|
|
|
|
m[s1Val] = 1
|
|
|
|
}
|
|
|
|
for _, s2Val := range slice2 {
|
|
|
|
m[s2Val] = m[s2Val] + 1
|
|
|
|
}
|
|
|
|
|
|
|
|
for mKey, mVal := range m {
|
|
|
|
if mVal == 1 {
|
|
|
|
diffStr = append(diffStr, mKey)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return diffStr
|
|
|
|
}
|
|
|
|
|
|
|
|
// DiffStrings splits the strings into fields and runs it into DiffStringSlices.
|
|
|
|
// Useful for tests.
|
|
|
|
func DiffStrings(s1, s2 string) []string {
|
|
|
|
return DiffStringSlices(strings.Fields(s1), strings.Fields(s2))
|
|
|
|
}
|
2020-12-23 18:47:20 +00:00
|
|
|
|
2020-12-23 08:26:23 +00:00
|
|
|
// IsCI reports whether we're running in a CI server.
|
2020-12-23 18:47:20 +00:00
|
|
|
func IsCI() bool {
|
|
|
|
return (os.Getenv("CI") != "" || os.Getenv("CI_LOCAL") != "") && os.Getenv("CIRCLE_BRANCH") == ""
|
|
|
|
}
|
2020-12-23 08:26:23 +00:00
|
|
|
|
|
|
|
// IsGitHubAction reports whether we're running in a GitHub Action.
|
|
|
|
func IsGitHubAction() bool {
|
|
|
|
return os.Getenv("GITHUB_ACTION") != ""
|
|
|
|
}
|
|
|
|
|
|
|
|
// SupportsAll reports whether the running system supports all Hugo features,
|
|
|
|
// e.g. Asciidoc, Pandoc etc.
|
|
|
|
func SupportsAll() bool {
|
2021-12-12 11:11:11 +00:00
|
|
|
return IsGitHubAction() || os.Getenv("CI_LOCAL") != ""
|
2020-12-23 08:26:23 +00:00
|
|
|
}
|
2021-08-26 15:24:52 +00:00
|
|
|
|
|
|
|
// GoMinorVersion returns the minor version of the current Go version,
|
|
|
|
// e.g. 16 for Go 1.16.
|
|
|
|
func GoMinorVersion() int {
|
|
|
|
return extractMinorVersionFromGoTag(runtime.Version())
|
|
|
|
}
|
|
|
|
|
|
|
|
var goMinorVersionRe = regexp.MustCompile(`go1.(\d*)`)
|
|
|
|
|
|
|
|
func extractMinorVersionFromGoTag(tag string) int {
|
|
|
|
// The tag may be on the form go1.17, go1.17.5 go1.17rc2 -- or just a commit hash.
|
|
|
|
match := goMinorVersionRe.FindStringSubmatch(tag)
|
|
|
|
|
|
|
|
if len(match) == 2 {
|
|
|
|
i, err := strconv.Atoi(match[1])
|
|
|
|
if err != nil {
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
return i
|
|
|
|
}
|
|
|
|
|
|
|
|
// a commit hash, not useful.
|
|
|
|
return -1
|
|
|
|
|
|
|
|
}
|