/
config.go
96 lines (79 loc) · 2.6 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
//
// Copyright 2023 Stacklok, Inc.
//
// 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 config provides the frizbee configuration.
package config
import (
"context"
"errors"
"fmt"
"os"
"path/filepath"
"github.com/go-git/go-billy/v5"
"github.com/go-git/go-billy/v5/osfs"
"gopkg.in/yaml.v3"
)
type contextConfigKey struct{}
// ContextConfigKey is the context key for the configuration.
// nolint:gochecknoglobals // this is a context key
var ContextConfigKey = contextConfigKey{}
var (
// ErrNoConfigInContext is returned when no configuration is found in the context.
ErrNoConfigInContext = errors.New("no configuration found in context")
)
// FromContext returns the configuration from the context.
func FromContext(ctx context.Context) (*Config, error) {
cfg, ok := ctx.Value(ContextConfigKey).(*Config)
if !ok {
return nil, ErrNoConfigInContext
}
return cfg, nil
}
// Config is the frizbee configuration.
type Config struct {
GHActions GHActions `yaml:"ghactions" mapstructure:"ghactions"`
}
// GHActions is the GitHub Actions configuration.
type GHActions struct {
Filter `yaml:",inline" mapstructure:",inline"`
}
// Filter is a common configuration for filtering out patterns.
type Filter struct {
// Exclude is a list of patterns to exclude.
Exclude []string `yaml:"exclude" mapstructure:"exclude"`
}
// ParseConfigFile parses a configuration file.
func ParseConfigFile(configfile string) (*Config, error) {
bfs := osfs.New(".")
return ParseConfigFileFromFS(bfs, configfile)
}
// ParseConfigFileFromFS parses a configuration file from a filesystem.
func ParseConfigFileFromFS(fs billy.Filesystem, configfile string) (*Config, error) {
cfg := &Config{}
cleancfgfile := filepath.Clean(configfile)
cfgF, err := fs.Open(cleancfgfile)
if err != nil {
if os.IsNotExist(err) {
return cfg, nil
}
return nil, fmt.Errorf("failed to open config file: %w", err)
}
// nolint:errcheck // we don't care about the error here
defer cfgF.Close()
dec := yaml.NewDecoder(cfgF)
if err := dec.Decode(cfg); err != nil {
return nil, fmt.Errorf("failed to decode config file: %w", err)
}
return cfg, nil
}