github.com/neohugo/neohugo@v0.123.8/config/testconfig/testconfig.go (about)

     1  // Copyright 2024 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  // This package should only be used for testing.
    15  package testconfig
    16  
    17  import (
    18  	_ "unsafe"
    19  
    20  	"github.com/neohugo/neohugo/common/maps"
    21  	"github.com/neohugo/neohugo/config"
    22  	"github.com/neohugo/neohugo/config/allconfig"
    23  	"github.com/neohugo/neohugo/deps"
    24  	"github.com/neohugo/neohugo/hugofs"
    25  	toml "github.com/pelletier/go-toml/v2"
    26  	"github.com/spf13/afero"
    27  )
    28  
    29  func GetTestConfigs(fs afero.Fs, cfg config.Provider) *allconfig.Configs {
    30  	if fs == nil {
    31  		fs = afero.NewMemMapFs()
    32  	}
    33  	if cfg == nil {
    34  		cfg = config.New()
    35  	}
    36  	// Make sure that the workingDir exists.
    37  	workingDir := cfg.GetString("workingDir")
    38  	if workingDir != "" {
    39  		if err := fs.MkdirAll(workingDir, 0o777); err != nil {
    40  			panic(err)
    41  		}
    42  	}
    43  
    44  	configs, err := allconfig.LoadConfig(allconfig.ConfigSourceDescriptor{Fs: fs, Flags: cfg, Environ: []string{"EMPTY_TEST_ENVIRONMENT"}})
    45  	if err != nil {
    46  		panic(err)
    47  	}
    48  	return configs
    49  }
    50  
    51  func GetTestConfig(fs afero.Fs, cfg config.Provider) config.AllProvider {
    52  	return GetTestConfigs(fs, cfg).GetFirstLanguageConfig()
    53  }
    54  
    55  func GetTestDeps(fs afero.Fs, cfg config.Provider, beforeInit ...func(*deps.Deps)) *deps.Deps {
    56  	if fs == nil {
    57  		fs = afero.NewMemMapFs()
    58  	}
    59  	conf := GetTestConfig(fs, cfg)
    60  	d := &deps.Deps{
    61  		Conf: conf,
    62  		Fs:   hugofs.NewFrom(fs, conf.BaseConfig()),
    63  	}
    64  	for _, f := range beforeInit {
    65  		f(d)
    66  	}
    67  	if err := d.Init(); err != nil {
    68  		panic(err)
    69  	}
    70  	return d
    71  }
    72  
    73  func GetTestConfigSectionFromStruct(section string, v any) config.AllProvider {
    74  	data, err := toml.Marshal(v)
    75  	if err != nil {
    76  		panic(err)
    77  	}
    78  	p := maps.Params{
    79  		section: config.FromTOMLConfigString(string(data)).Get(""),
    80  	}
    81  	cfg := config.NewFrom(p)
    82  	return GetTestConfig(nil, cfg)
    83  }