Files
airshipctl/pkg/config/utils.go
Matthew Fuller 585af5a516 Remove defaults from Config object at runtime
This change fixes a bug where the default values that are
populated during an `airshipctl config init` were getting
mixed in with user specified values at runtime. For example,
a user with two contexts defined in their airship config
file would actually see a third phantom context with default
values in the output of `airshipctl config get-context`.

Also fixes a number of the config cmd and pkg unit tests that
were affected by this bug.

Change-Id: Iac591d4c2a616090028eb730576478edefb82544
Closes: #447
2021-03-19 17:31:02 +00:00

100 lines
3.0 KiB
Go

/*
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
import (
"encoding/base64"
"opendev.org/airship/airshipctl/pkg/fs"
)
// NewConfig returns a newly initialized Config object
func NewConfig() *Config {
return &Config{
Kind: AirshipConfigKind,
APIVersion: AirshipConfigAPIVersion,
Permissions: Permissions{
DirectoryPermission: AirshipDefaultDirectoryPermission,
FilePermission: AirshipDefaultFilePermission,
},
Contexts: map[string]*Context{
AirshipDefaultContext: {
Manifest: AirshipDefaultManifest,
ManagementConfiguration: AirshipDefaultManagementConfiguration,
},
},
CurrentContext: AirshipDefaultContext,
ManagementConfiguration: map[string]*ManagementConfiguration{
AirshipDefaultManagementConfiguration: NewManagementConfiguration(),
},
Manifests: map[string]*Manifest{
AirshipDefaultManifest: {
Repositories: map[string]*Repository{
DefaultTestPhaseRepo: {
URLString: AirshipDefaultManifestRepoLocation,
CheckoutOptions: &RepoCheckout{
Branch: "master",
},
},
},
TargetPath: "/tmp/" + AirshipDefaultManifest,
PhaseRepositoryName: DefaultTestPhaseRepo,
InventoryRepositoryName: DefaultTestPhaseRepo,
MetadataPath: DefaultManifestMetadataFile,
},
},
fileSystem: fs.NewDocumentFs(),
}
}
// NewEmptyConfig returns an initialized Config object with no default values
func NewEmptyConfig() *Config {
return &Config{
ManagementConfiguration: map[string]*ManagementConfiguration{},
Manifests: map[string]*Manifest{},
Contexts: map[string]*Context{},
fileSystem: fs.NewDocumentFs(),
}
}
// NewContext is a convenience function that returns a new Context
func NewContext() *Context {
return &Context{}
}
// NewManifest is a convenience function that returns a new Manifest
// object with non-nil maps
func NewManifest() *Manifest {
return &Manifest{
InventoryRepositoryName: DefaultTestPhaseRepo,
PhaseRepositoryName: DefaultTestPhaseRepo,
TargetPath: DefaultTargetPath,
Repositories: map[string]*Repository{DefaultTestPhaseRepo: NewRepository()},
MetadataPath: DefaultManifestMetadataFile,
}
}
// NewRepository is a convenience function that returns a new Repository
func NewRepository() *Repository {
return &Repository{
CheckoutOptions: &RepoCheckout{},
}
}
// EncodeString returns the base64 encoding of given string
func EncodeString(given string) string {
return base64.StdEncoding.EncodeToString([]byte(given))
}