actions.go 10.4 KB
Newer Older
bryanl's avatar
bryanl committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
// 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 actions

import (
19
	"crypto/tls"
bryanl's avatar
bryanl committed
20
	"fmt"
21 22 23
	"net"
	"net/http"
	"time"
bryanl's avatar
bryanl committed
24

bryanl's avatar
bryanl committed
25
	"github.com/ksonnet/ksonnet/pkg/app"
bryanl's avatar
bryanl committed
26
	"github.com/ksonnet/ksonnet/pkg/client"
bryanl's avatar
bryanl committed
27 28
	"github.com/pkg/errors"
	"github.com/spf13/afero"
bryanl's avatar
bryanl committed
29 30 31
)

const (
bryanl's avatar
bryanl committed
32 33
	// OptionApp is app option.
	OptionApp = "app"
34 35
	// OptionAppRoot is the root directory of the application.
	OptionAppRoot = "app-root"
bryanl's avatar
bryanl committed
36 37
	// OptionArguments is arguments option. Used for passing arguments to prototypes.
	OptionArguments = "arguments"
38 39
	// OptionAsString is asString. Used for setting values as strings.
	OptionAsString = "as-string"
bryanl's avatar
bryanl committed
40 41 42 43 44
	// OptionClientConfig is clientConfig option.
	OptionClientConfig = "client-config"
	// OptionComponentName is a componentName option.
	OptionComponentName = "component-name"
	// OptionComponentNames is componentNames option.
bryanl's avatar
bryanl committed
45
	OptionComponentNames = "component-names"
bryanl's avatar
bryanl committed
46 47 48 49 50 51
	// OptionCreate is create option.
	OptionCreate = "create"
	// OptionDryRun is dryRun option.
	OptionDryRun = "dry-run"
	// OptionEnvName is envName option.
	OptionEnvName = "env-name"
52 53 54 55
	// OptionEnvName1 is envName1. Used for param diff.
	OptionEnvName1 = "env-name-1"
	// OptionEnvName2 is envName1. Used for param diff.
	OptionEnvName2 = "env-name-2"
bryanl's avatar
bryanl committed
56 57 58 59
	// OptionExtVarFiles is jsonnet ext var files.
	OptionExtVarFiles = "ext-vars-files"
	// OptionExtVars is jsonnet ext vars.
	OptionExtVars = "ext-vars"
60 61
	// OptionForce is force option.
	OptionForce = "force"
bryanl's avatar
bryanl committed
62 63
	// OptionFormat is format option.
	OptionFormat = "format"
bryanl's avatar
bryanl committed
64 65 66 67 68 69
	// OptionFs is fs option.
	OptionFs = "fs"
	// OptionGcTag is gcTag option.
	OptionGcTag = "gc-tag"
	// OptionGlobal is global option.
	OptionGlobal = "global"
bryanl's avatar
bryanl committed
70 71
	// OptionGracePeriod is gracePeriod option.
	OptionGracePeriod = "grace-period"
72 73
	// OptionHTTPClient is the http.Client for outbound network requests.
	OptionHTTPClient = "http-client"
bryanl's avatar
bryanl committed
74 75
	// OptionInstalled is for listing installed packages.
	OptionInstalled = "only-installed"
bryanl's avatar
bryanl committed
76 77
	// OptionJPaths is jsonnet paths.
	OptionJPaths = "jpaths"
Oren Shomron's avatar
Oren Shomron committed
78 79
	// OptionPkgName is (an optionally qualified) name of a package.
	OptionPkgName = "pkg-name"
bryanl's avatar
bryanl committed
80 81
	// OptionName is name option.
	OptionName = "name"
82 83 84 85
	// OptionModule is component module option.
	OptionModule = "module"
	// OptionNamespace is a cluster namespace option
	OptionNamespace = "namespace"
86 87
	// OptionNewRoot is init new root path option.
	OptionNewRoot = "root-path"
bryanl's avatar
bryanl committed
88 89 90 91 92 93 94 95 96 97 98 99
	// OptionNewEnvName is newEnvName option. Used for renaming environments.
	OptionNewEnvName = "new-env-name"
	// OptionOutput is output option.
	OptionOutput = "output"
	// OptionOverride is override option.
	OptionOverride = "override"
	// OptionPackageName is packageName option.
	OptionPackageName = "package-name"
	// OptionPath is path option.
	OptionPath = "path"
	// OptionQuery is query option.
	OptionQuery = "query"
100 101 102
	// OptionResolveImage is resolve image option. It is used to resolve docker image references
	// when setting parameters.
	OptionResolveImage = "resolve-image"
bryanl's avatar
bryanl committed
103 104 105 106
	// OptionServer is server option.
	OptionServer = "server"
	// OptionServerURI is serverURI option.
	OptionServerURI = "server-uri"
107 108
	// OptionSkipCheckUpgrade tells app not to emit upgrade warnings, probably because the user is already upgrading.
	OptionSkipCheckUpgrade = "skip-check-upgrade"
109 110
	// OptionSkipDefaultRegistries is skipDefaultRegistries option. Used by init.
	OptionSkipDefaultRegistries = "skip-default-registries"
bryanl's avatar
bryanl committed
111 112 113 114
	// OptionSkipGc is skipGc option.
	OptionSkipGc = "skip-gc"
	// OptionSpecFlag is specFlag option. Used for setting k8s spec.
	OptionSpecFlag = "spec-flag"
bryanl's avatar
bryanl committed
115 116 117 118
	// OptionSrc1 is src1 option.
	OptionSrc1 = "src-1"
	// OptionSrc2 is src2 option.
	OptionSrc2 = "src-2"
bryanl's avatar
bryanl committed
119 120 121 122
	// OptionTlaVarFiles is jsonnet tla var files.
	OptionTlaVarFiles = "tla-var-files"
	// OptionTlaVars is jsonnet tla vars.
	OptionTlaVars = "tla-vars"
123 124
	// OptionTLSSkipVerify specifies that tls server certifactes should not be verified.
	OptionTLSSkipVerify = "tls-skip-verify"
bryanl's avatar
bryanl committed
125 126
	// OptionUnset is unset option.
	OptionUnset = "unset"
bryanl's avatar
bryanl committed
127 128
	// OptionURI is uri option. Used for setting registry URI.
	OptionURI = "URI"
bryanl's avatar
bryanl committed
129 130
	// OptionWithoutModules is without modules option.
	OptionWithoutModules = "without-modules"
bryanl's avatar
bryanl committed
131 132 133 134 135 136
	// OptionValue is value option.
	OptionValue = "value"
	// OptionVersion is version option.
	OptionVersion = "version"
)

bryanl's avatar
bryanl committed
137 138 139
const (
	// OutputWide is wide output
	OutputWide = "wide"
bryanl's avatar
bryanl committed
140 141
	// OutputJSON is JSON output
	OutputJSON = "json"
bryanl's avatar
bryanl committed
142 143
)

bryanl's avatar
bryanl committed
144 145 146
var (
	// ErrNotInApp is an error stating the user is not in a ksonnet application directory
	// hierarchy.
147
	ErrNotInApp = errors.Errorf("this command has to be run within a ksonnet application")
bryanl's avatar
bryanl committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
)

type missingOptionError struct {
	name string
}

func newMissingOptionError(name string) *missingOptionError {
	return &missingOptionError{
		name: name,
	}
}

func (e *missingOptionError) Error() string {
	return fmt.Sprintf("missing required %s option", e.name)
}

type invalidOptionError struct {
	name string
}

func newInvalidOptionError(name string) *invalidOptionError {
	return &invalidOptionError{
		name: name,
	}
}

func (e *invalidOptionError) Error() string {
	return fmt.Sprintf("invalid type for option %s", e.name)
}

178 179 180
// optionLoader loads typed option from a configuration map. If an error
// occurs in any of the load processes, the loader will return default
// values for type.
bryanl's avatar
bryanl committed
181
type optionLoader struct {
182 183
	// err is the error state for the optionLoader. If this is not nil, all
	// subsequent calls to load will return nil.
bryanl's avatar
bryanl committed
184 185 186 187 188 189 190 191 192 193
	err error
	m   map[string]interface{}
}

func newOptionLoader(m map[string]interface{}) *optionLoader {
	return &optionLoader{
		m: m,
	}
}

194 195
func (o *optionLoader) LoadFs() afero.Fs {
	i := o.loadOptional(OptionFs)
bryanl's avatar
bryanl committed
196
	if i == nil {
197
		return afero.NewOsFs()
bryanl's avatar
bryanl committed
198 199 200 201
	}

	a, ok := i.(afero.Fs)
	if !ok {
202
		o.err = newInvalidOptionError(OptionFs)
bryanl's avatar
bryanl committed
203 204 205 206 207 208
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
209
func (o *optionLoader) LoadBool(name string) bool {
bryanl's avatar
bryanl committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223
	i := o.load(name)
	if i == nil {
		return false
	}

	a, ok := i.(bool)
	if !ok {
		o.err = newInvalidOptionError(name)
		return false
	}

	return a
}

bryanl's avatar
bryanl committed
224
func (o *optionLoader) LoadOptionalBool(name string) bool {
bryanl's avatar
bryanl committed
225 226 227 228 229 230 231 232 233 234 235 236 237
	i := o.loadOptional(name)
	if i == nil {
		return false
	}

	a, ok := i.(bool)
	if !ok {
		return false
	}

	return a
}

bryanl's avatar
bryanl committed
238
func (o *optionLoader) LoadInt(name string) int {
bryanl's avatar
bryanl committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252
	i := o.load(name)
	if i == nil {
		return 0
	}

	a, ok := i.(int)
	if !ok {
		o.err = newInvalidOptionError(name)
		return 0
	}

	return a
}

bryanl's avatar
bryanl committed
253
func (o *optionLoader) LoadInt64(name string) int64 {
bryanl's avatar
bryanl committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267
	i := o.load(name)
	if i == nil {
		return 0
	}

	a, ok := i.(int64)
	if !ok {
		o.err = newInvalidOptionError(name)
		return 0
	}

	return a
}

bryanl's avatar
bryanl committed
268
func (o *optionLoader) LoadOptionalInt(name string) int {
bryanl's avatar
bryanl committed
269 270 271 272 273 274 275 276 277 278 279 280 281
	i := o.loadOptional(name)
	if i == nil {
		return 0
	}

	a, ok := i.(int)
	if !ok {
		return 0
	}

	return a
}

bryanl's avatar
bryanl committed
282
func (o *optionLoader) LoadString(name string) string {
bryanl's avatar
bryanl committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296
	i := o.load(name)
	if i == nil {
		return ""
	}

	a, ok := i.(string)
	if !ok {
		o.err = newInvalidOptionError(name)
		return ""
	}

	return a
}

bryanl's avatar
bryanl committed
297
func (o *optionLoader) LoadOptionalString(name string) string {
bryanl's avatar
bryanl committed
298
	i := o.loadOptional(name)
bryanl's avatar
bryanl committed
299
	if i == nil {
bryanl's avatar
bryanl committed
300
		return ""
bryanl's avatar
bryanl committed
301 302
	}

bryanl's avatar
bryanl committed
303
	a, ok := i.(string)
bryanl's avatar
bryanl committed
304
	if !ok {
bryanl's avatar
bryanl committed
305
		return ""
bryanl's avatar
bryanl committed
306 307 308 309 310
	}

	return a
}

bryanl's avatar
bryanl committed
311
func (o *optionLoader) LoadStringSlice(name string) []string {
bryanl's avatar
bryanl committed
312
	i := o.load(name)
bryanl's avatar
bryanl committed
313 314 315 316
	if i == nil {
		return nil
	}

bryanl's avatar
bryanl committed
317
	a, ok := i.([]string)
bryanl's avatar
bryanl committed
318
	if !ok {
bryanl's avatar
bryanl committed
319
		o.err = newInvalidOptionError(name)
bryanl's avatar
bryanl committed
320 321 322 323 324 325
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
326
func (o *optionLoader) LoadClientConfig() *client.Config {
bryanl's avatar
bryanl committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340
	i := o.load(OptionClientConfig)
	if i == nil {
		return nil
	}

	a, ok := i.(*client.Config)
	if !ok {
		o.err = newInvalidOptionError(OptionClientConfig)
		return nil
	}

	return a
}

341 342
// LoadApp returns an app.App reference - either as passed via OptionApp,
// or newly constructed.
bryanl's avatar
bryanl committed
343
func (o *optionLoader) LoadApp() app.App {
344 345 346 347 348
	i := o.loadOptional(OptionApp)
	a, ok := i.(app.App)
	if i != nil && !ok {
		// App was provided but was invalid type
		o.err = newInvalidOptionError(OptionApp)
bryanl's avatar
bryanl committed
349 350
		return nil
	}
351 352 353 354
	if a != nil {
		// Return app if a valid app.App was provided
		return a
	}
bryanl's avatar
bryanl committed
355

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
	var fs = o.LoadFs()
	if fs == nil {
		o.err = errors.New("missing required fs reference")
		return nil
	}
	var httpClient = o.LoadHTTPClient()
	if httpClient == nil {
		o.err = errors.New("initializing http client")
		return nil
	}
	var appRoot = o.LoadOptionalString(OptionAppRoot)

	appRoot, err := app.FindRoot(fs, appRoot)
	if err != nil {
		o.err = errors.Wrapf(err, "finding app root from starting path: %s", appRoot)
bryanl's avatar
bryanl committed
371 372 373
		return nil
	}

374 375 376 377 378 379 380 381 382 383 384 385 386
	a, err = app.Load(fs, httpClient, appRoot)
	if err != nil {
		o.err = errors.New("initializing app")
		return nil
	}

	if !o.LoadOptionalBool(OptionSkipCheckUpgrade) {
		if _, err := a.CheckUpgrade(); err != nil {
			o.err = errors.Wrap(err, "checking for app upgrades")
			return nil
		}
	}

bryanl's avatar
bryanl committed
387 388 389
	return a
}

390 391
// LoadHTTPClient loads an HTTP client based on common configuration for certificates, tls verification, timeouts, etc.
func (o *optionLoader) LoadHTTPClient() *http.Client {
392 393 394 395 396 397
	i := o.loadOptional(OptionHTTPClient)
	if c, ok := i.(*http.Client); ok {
		return c
	}

	// Construct a client if none was passed
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 425 426 427
	tlsSkipVerify := o.LoadOptionalBool(OptionTLSSkipVerify)

	tlsConfig := &tls.Config{
		InsecureSkipVerify: tlsSkipVerify,
	}

	timeoutSeconds := 10

	var defaultTransport http.RoundTripper = &http.Transport{
		Proxy: http.ProxyFromEnvironment,
		DialContext: (&net.Dialer{
			Timeout:   30 * time.Second,
			KeepAlive: 30 * time.Second,
			DualStack: true,
		}).DialContext,
		MaxIdleConns:          100,
		IdleConnTimeout:       90 * time.Second,
		TLSClientConfig:       tlsConfig,
		TLSHandshakeTimeout:   10 * time.Second,
		ExpectContinueTimeout: 1 * time.Second,
	}

	c := &http.Client{
		Timeout:   time.Duration(timeoutSeconds) * time.Second,
		Transport: defaultTransport,
	}

	return c
}

bryanl's avatar
bryanl committed
428 429
func (o *optionLoader) load(key string) interface{} {
	if o.err != nil {
bryanl's avatar
bryanl committed
430 431 432
		return nil
	}

bryanl's avatar
bryanl committed
433
	i, ok := o.m[key]
bryanl's avatar
bryanl committed
434
	if !ok {
bryanl's avatar
bryanl committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448
		o.err = newMissingOptionError(key)
	}

	return i
}

func (o *optionLoader) loadOptional(key string) interface{} {
	if o.err != nil {
		return nil
	}

	i, ok := o.m[key]
	if !ok {
		return nil
bryanl's avatar
bryanl committed
449 450 451 452
	}

	return i
}