base_app.go 10.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// Copyright 2018 The ksonnet authors
//
//
//    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 app

import (
	"path/filepath"
bryanl's avatar
bryanl committed
20
	"sync"
21

bryanl's avatar
bryanl committed
22
	"github.com/ghodss/yaml"
23
	stringutils "github.com/ksonnet/ksonnet/pkg/util/strings"
bryanl's avatar
bryanl committed
24
	"github.com/pkg/errors"
25
	log "github.com/sirupsen/logrus"
26 27 28 29 30 31
	"github.com/spf13/afero"
)

type baseApp struct {
	root string
	fs   afero.Fs
bryanl's avatar
bryanl committed
32 33 34 35 36

	config    *Spec
	overrides *Override

	mu sync.Mutex
37 38

	load func() error
39 40 41
}

func newBaseApp(fs afero.Fs, root string) *baseApp {
42
	ba := &baseApp{
bryanl's avatar
bryanl committed
43 44 45 46
		fs:     fs,
		root:   root,
		config: &Spec{},
		overrides: &Override{
47
			Environments: EnvironmentConfigs{},
48
			Registries:   RegistryConfigs{},
bryanl's avatar
bryanl committed
49
		},
50
	}
51 52
	ba.load = ba.doLoad
	return ba
53 54
}

bryanl's avatar
bryanl committed
55 56 57 58 59 60 61 62 63 64 65
func (ba *baseApp) CurrentEnvironment() string {
	currentPath := filepath.Join(ba.root, currentEnvName)
	data, err := afero.ReadFile(ba.fs, currentPath)
	if err != nil {
		return ""
	}

	return string(data)
}

func (ba *baseApp) SetCurrentEnvironment(name string) error {
66 67 68 69 70 71 72 73 74 75 76 77 78 79
	envs, err := ba.Environments()
	if err != nil {
		return errors.Wrap(err, "loading environments")
	}

	var envNames []string
	for _, env := range envs {
		envNames = append(envNames, env.Name)
	}

	if !stringutils.InSlice(name, envNames) {
		return errors.Errorf("environment %q does not exist", name)
	}

bryanl's avatar
bryanl committed
80 81 82 83
	currentPath := filepath.Join(ba.root, currentEnvName)
	return afero.WriteFile(ba.fs, currentPath, []byte(name), DefaultFilePermissions)
}

bryanl's avatar
bryanl committed
84 85 86 87 88 89
func (ba *baseApp) configPath() string {
	return filepath.Join(ba.root, "app.yaml")
}

func (ba *baseApp) overridePath() string {
	return filepath.Join(ba.root, "app.override.yaml")
90 91
}

bryanl's avatar
bryanl committed
92
func (ba *baseApp) save() error {
93 94
	log := log.WithField("action", "baseApp.save")

bryanl's avatar
bryanl committed
95 96 97
	ba.mu.Lock()
	defer ba.mu.Unlock()

98 99 100 101 102 103 104 105
	if ba.config == nil {
		return errors.Errorf("cannot save nil app configuration")
	}

	// Signal we have converted to new app version
	ba.config.APIVersion = DefaultAPIVersion
	log.Debugf("saving app version %v", ba.config.APIVersion)

bryanl's avatar
bryanl committed
106
	configData, err := yaml.Marshal(ba.config)
107
	if err != nil {
bryanl's avatar
bryanl committed
108 109 110 111 112
		return errors.Wrap(err, "convert application configuration to YAML")
	}

	if err = afero.WriteFile(ba.fs, ba.configPath(), configData, DefaultFilePermissions); err != nil {
		return errors.Wrapf(err, "write %s", ba.configPath())
113 114
	}

115
	if err = removeOverride(ba.fs, ba.root); err != nil {
bryanl's avatar
bryanl committed
116 117 118
		return errors.Wrap(err, "clean overrides")
	}

119 120
	if ba.overrides.IsDefined() {
		return SaveOverride(defaultYAMLEncoder, ba.fs, ba.root, ba.overrides)
bryanl's avatar
bryanl committed
121 122 123 124 125
	}

	return nil
}

126
func (ba *baseApp) doLoad() error {
bryanl's avatar
bryanl committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140
	ba.mu.Lock()
	defer ba.mu.Unlock()

	configData, err := afero.ReadFile(ba.fs, ba.configPath())
	if err != nil {
		return errors.Wrapf(err, "read %s", ba.configPath())
	}

	var config Spec
	if err = yaml.Unmarshal(configData, &config); err != nil {
		return errors.Wrapf(err, "unmarshal application YAML config")
	}

	exists, err := afero.Exists(ba.fs, ba.overridePath())
141 142 143 144
	if err != nil {
		return err
	}

bryanl's avatar
bryanl committed
145
	if len(config.Environments) == 0 {
146
		config.Environments = EnvironmentConfigs{}
bryanl's avatar
bryanl committed
147 148 149
	}

	if len(config.Registries) == 0 {
150
		config.Registries = RegistryConfigs{}
bryanl's avatar
bryanl committed
151 152 153
	}

	override := Override{
154
		Environments: EnvironmentConfigs{},
155
		Registries:   RegistryConfigs{},
bryanl's avatar
bryanl committed
156 157 158 159 160 161 162 163 164 165
	}
	if exists {
		overrideData, err := afero.ReadFile(ba.fs, ba.overridePath())
		if err != nil {
			return errors.Wrapf(err, "read %s", ba.overridePath())
		}
		if err = yaml.Unmarshal(overrideData, &override); err != nil {
			return errors.Wrapf(err, "unmarshal override YAML config")
		}

166 167
		if err = override.Validate(); err != nil {
			return errors.Wrap(err, "validating override")
bryanl's avatar
bryanl committed
168 169 170
		}

		if len(override.Environments) == 0 {
171
			override.Environments = EnvironmentConfigs{}
bryanl's avatar
bryanl committed
172 173 174
		}

		if len(override.Registries) == 0 {
175
			override.Registries = RegistryConfigs{}
bryanl's avatar
bryanl committed
176 177
		}

178 179 180 181 182 183 184 185
		for k := range override.Registries {
			override.Registries[k].isOverride = true
		}

		for k := range override.Environments {
			override.Environments[k].isOverride = true
		}

bryanl's avatar
bryanl committed
186 187 188 189 190 191 192 193
	}

	ba.overrides = &override
	ba.config = &config

	return ba.config.validate()
}

194
func (ba *baseApp) AddRegistry(newReg *RegistryConfig, isOverride bool) error {
bryanl's avatar
bryanl committed
195 196 197 198
	if err := ba.load(); err != nil {
		return errors.Wrap(err, "load configuration")
	}

199 200 201 202
	if newReg.Name == "" {
		return ErrRegistryNameInvalid
	}

bryanl's avatar
bryanl committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216
	if isOverride {
		_, exists := ba.overrides.Registries[newReg.Name]
		if exists {
			return ErrRegistryExists
		}

		newReg.isOverride = true

		ba.overrides.Registries[newReg.Name] = newReg
		return ba.save()
	}

	_, exists := ba.config.Registries[newReg.Name]
	if exists {
217 218 219
		return ErrRegistryExists
	}

bryanl's avatar
bryanl committed
220 221
	newReg.isOverride = false
	ba.config.Registries[newReg.Name] = newReg
222

bryanl's avatar
bryanl committed
223
	return ba.save()
224 225
}

226 227 228 229
// UpdateLib adds or updates a library reference.
// env is optional - if provided the reference is scoped under the environment,
// otherwise it is globally scoped.
func (ba *baseApp) UpdateLib(name string, env string, libSpec *LibraryConfig) error {
bryanl's avatar
bryanl committed
230 231
	if err := ba.load(); err != nil {
		return errors.Wrap(err, "load configuration")
232 233
	}

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
	if ba.config == nil {
		return errors.Errorf("invalid app - configuration is nil")
	}

	if libSpec.Name != name {
		return errors.Errorf("library name mismatch: %v vs %v", libSpec.Name, name)
	}

	// TODO support app overrides

	switch env {
	case "":
		// Globally scoped
		ba.config.Libraries[name] = libSpec
	default:
		// Scoped by environment
		e, ok := ba.config.GetEnvironmentConfig(env)
		if !ok {
			return errors.Errorf("invalid environment: %v", env)
		}

		if e.Libraries == nil {
			// We may want to move this into EnvrionmentConfig unmarshaling code.
			e.Libraries = LibraryConfigs{}
		}
		e.Libraries[name] = libSpec

		if err := ba.config.UpdateEnvironmentConfig(env, e); err != nil {
			return errors.Wrapf(err, "updating environment %v", env)
		}
	}

bryanl's avatar
bryanl committed
266
	return ba.save()
267 268
}

269
// UpdateRegistry updates a registry spec and persists in app[.override].yaml
270
func (ba *baseApp) UpdateRegistry(spec *RegistryConfig) error {
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	if err := ba.load(); err != nil {
		return errors.Wrap(err, "load configuration")
	}

	if spec.Name == "" {
		return ErrRegistryNameInvalid
	}

	// Figure out where the registry is defined (app or override)
	var ok, okOverride bool
	if ba.config != nil {
		_, ok = ba.config.Registries[spec.Name]
	}
	if ba.overrides != nil {
		_, okOverride = ba.overrides.Registries[spec.Name]
	}

	if !ok && !okOverride {
		return errors.Errorf("registry not found: %v", spec.Name)
	}

	if ok && okOverride {
		return errors.Errorf("registry %v found in both app.yaml and app.override.yaml", spec.Name)
	}

	if ok {
		ba.config.Registries[spec.Name] = spec
	} else {
		ba.overrides.Registries[spec.Name] = spec
	}

	return ba.save()
}

305 306 307 308 309 310 311 312 313
func (ba *baseApp) Fs() afero.Fs {
	return ba.fs
}

func (ba *baseApp) Root() string {
	return ba.root
}

func (ba *baseApp) EnvironmentParams(envName string) (string, error) {
bryanl's avatar
bryanl committed
314 315 316
	if envName == "" {
		return "", errors.New("environment name is blank")
	}
317 318 319
	envParamsPath := filepath.Join(ba.Root(), EnvironmentDirName, envName, "params.libsonnet")
	b, err := afero.ReadFile(ba.Fs(), envParamsPath)
	if err != nil {
bryanl's avatar
bryanl committed
320
		return "", errors.Wrapf(err, "unable to read params for environment %s", envName)
321 322 323 324
	}

	return string(b), nil
}
bryanl's avatar
bryanl committed
325 326 327 328

func (ba *baseApp) VendorPath() string {
	return filepath.Join(ba.Root(), "vendor")
}
329 330 331 332 333 334 335

// Environment returns the spec for an environment.
func (ba *baseApp) Environment(name string) (*EnvironmentConfig, error) {
	if err := ba.load(); err != nil {
		return nil, errors.Wrap(err, "load configuration")
	}

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
	e := ba.mergedEnvironment(name)
	if e == nil {
		return nil, errors.Errorf("environment %q was not found", name)
	}
	return e, nil
}

func deepCopyLibraries(src LibraryConfigs) LibraryConfigs {
	if src == nil {
		return LibraryConfigs(nil)
	}

	lc := LibraryConfigs{}
	for k, v := range src {
		c := *v
		lc[k] = &c
	}
	return lc
}

func deepCopyEnvironmentConfig(src EnvironmentConfig) *EnvironmentConfig {
	e := src

	if src.Destination != nil {
		d := *src.Destination
		e.Destination = &d
	}
	if src.Targets != nil {
		t := make([]string, len(src.Targets))
		copy(t, src.Targets)
		e.Targets = t
367
	}
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
	if src.Libraries != nil {
		e.Libraries = deepCopyLibraries(src.Libraries)
	}

	return &e
}

// mergedEnvrionment returns a fresh copy of the named environment, merged with
// optional overrides if present. Note overrides cannot override environment-scoped library
// references.
// Returns nil if the envrionment is not present and non-nil in either primary configuration
// or overrides.
func (ba *baseApp) mergedEnvironment(name string) *EnvironmentConfig {
	var hasPrimary, hasOverride bool
	var primary, override *EnvironmentConfig
383

384 385 386 387 388 389 390 391 392 393
	if ba.config != nil {
		primary, hasPrimary = ba.config.Environments[name]
		if primary == nil {
			hasPrimary = false
		}
	}
	if ba.overrides != nil {
		override, hasOverride = ba.overrides.Environments[name]
		if override == nil {
			hasOverride = false
394 395 396
		}
	}

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
	switch {
	case hasPrimary && !hasOverride:
		e := deepCopyEnvironmentConfig(*primary)
		e.isOverride = false
		return e
	case hasPrimary && hasOverride:
		combined := deepCopyEnvironmentConfig(*primary)
		combined.Name = override.Name
		combined.KubernetesVersion = override.KubernetesVersion
		combined.Path = override.Path
		if override.Destination != nil {
			d := *override.Destination
			combined.Destination = &d
		}
		if override.Targets != nil {
			t := make([]string, len(override.Targets))
			copy(t, override.Targets)
			combined.Targets = t
		}
		combined.isOverride = true
		return combined
	case hasOverride:
		e := deepCopyEnvironmentConfig(*override)
		e.isOverride = true
		return e
	default:
		return nil
	}
425 426
}

427 428
// Environments returns all environment specs, merged with any corresponding overrides.
// Note overrides cannot override environment libraries.
429 430 431 432 433
func (ba *baseApp) Environments() (EnvironmentConfigs, error) {
	if err := ba.load(); err != nil {
		return nil, errors.Wrap(err, "load configuration")
	}

434
	// Build merged list of keys
435
	environments := EnvironmentConfigs{}
436 437 438 439
	if ba.config != nil {
		for k := range ba.config.Environments {
			environments[k] = nil
		}
440
	}
441 442 443 444 445 446 447 448 449 450 451 452
	if ba.overrides != nil {
		for k := range ba.overrides.Environments {
			environments[k] = nil
		}
	}

	for k := range environments {
		e := ba.mergedEnvironment(k)
		if e == nil {
			delete(environments, k)
			continue
		}
453

454
		environments[k] = e
455 456 457 458
	}

	return environments, nil
}