Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate config.yaml as valid config source; Add unit regression for correct config paths #1640

Merged
merged 9 commits into from
Mar 20, 2023
Merged

Deprecate config.yaml as valid config source; Add unit regression for correct config paths #1640

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
51398ab
Add pwd to config search path iff it contains a config
AidanDelaney Mar 2, 2023
b88f11d
refactor: update to deprecate behavior pre v1.0.0
spiffcs Mar 20, 2023
59f9061
chore: add nolint directive for SA
spiffcs Mar 20, 2023
592deff
test: add config discovery regressions
spiffcs Mar 20, 2023
2b0b596
test: add unit test cases for config coverage
spiffcs Mar 20, 2023
898fc45
chore: refactor tests to account for XDG path
spiffcs Mar 20, 2023
e9025e3
chore: update hidden to full
spiffcs Mar 20, 2023
7cf22a2
chore: update scope cli options to map cli default
spiffcs Mar 20, 2023
dc0ce0e
chore: restructure so xdg can be in same table
spiffcs Mar 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions internal/config/application.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package config
import (
"errors"
"fmt"
"os"
"path"
"reflect"
"sort"
Expand Down Expand Up @@ -208,6 +209,7 @@ func (cfg Application) String() string {
return string(appaStr)
}

// nolint:funlen
func loadConfig(v *viper.Viper, configPath string) error {
var err error
// use explicitly the given user config
Expand All @@ -223,13 +225,25 @@ func loadConfig(v *viper.Viper, configPath string) error {

// start searching for valid configs in order...
// 1. look for .<appname>.yaml (in the current directory)
confFilePath := "." + internal.ApplicationName

// TODO: Remove this before v1.0.0
// See syft #1634
v.AddConfigPath(".")
v.SetConfigName("." + internal.ApplicationName)
if err = v.ReadInConfig(); err == nil {
v.Set("config", v.ConfigFileUsed())
return nil
} else if !errors.As(err, &viper.ConfigFileNotFoundError{}) {
return fmt.Errorf("unable to parse config=%q: %w", v.ConfigFileUsed(), err)
v.SetConfigName(confFilePath)

// check if config.yaml exists in the current directory
// DEPRECATED: this will be removed in v1.0.0
if _, err := os.Stat("config.yaml"); err == nil {
log.Warn("DEPRECATED: config.yaml as a configuration file is deprecated and will be removed as an option in v1.0.0, please rename to .syft.yaml")
}
if _, err := os.Stat(confFilePath); err == nil {
if err = v.ReadInConfig(); err == nil {
v.Set("config", v.ConfigFileUsed())
return nil
} else if !errors.As(err, &viper.ConfigFileNotFoundError{}) {
return fmt.Errorf("unable to parse config=%q: %w", v.ConfigFileUsed(), err)
}
}

// 2. look for .<appname>/config.yaml (in the current directory)
Expand Down