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

bryanl's avatar
bryanl committed
131 132 133
const (
	// OutputWide is wide output
	OutputWide = "wide"
bryanl's avatar
bryanl committed
134 135
	// OutputJSON is JSON output
	OutputJSON = "json"
bryanl's avatar
bryanl committed
136 137
)

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

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)
}

172 173 174
// 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
175
type optionLoader struct {
176 177
	// 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
178 179 180 181 182 183 184 185 186 187
	err error
	m   map[string]interface{}
}

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

bryanl's avatar
bryanl committed
188
func (o *optionLoader) LoadFs(name string) afero.Fs {
bryanl's avatar
bryanl committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202
	i := o.load(name)
	if i == nil {
		return nil
	}

	a, ok := i.(afero.Fs)
	if !ok {
		o.err = newInvalidOptionError(name)
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
203
func (o *optionLoader) LoadBool(name string) bool {
bryanl's avatar
bryanl committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217
	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
218
func (o *optionLoader) LoadOptionalBool(name string) bool {
bryanl's avatar
bryanl committed
219 220 221 222 223 224 225 226 227 228 229 230 231
	i := o.loadOptional(name)
	if i == nil {
		return false
	}

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

	return a
}

bryanl's avatar
bryanl committed
232
func (o *optionLoader) LoadInt(name string) int {
bryanl's avatar
bryanl committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246
	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
247
func (o *optionLoader) LoadInt64(name string) int64 {
bryanl's avatar
bryanl committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261
	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
262
func (o *optionLoader) LoadOptionalInt(name string) int {
bryanl's avatar
bryanl committed
263 264 265 266 267 268 269 270 271 272 273 274 275
	i := o.loadOptional(name)
	if i == nil {
		return 0
	}

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

	return a
}

bryanl's avatar
bryanl committed
276
func (o *optionLoader) LoadString(name string) string {
bryanl's avatar
bryanl committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290
	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
291
func (o *optionLoader) LoadOptionalString(name string) string {
bryanl's avatar
bryanl committed
292
	i := o.loadOptional(name)
bryanl's avatar
bryanl committed
293
	if i == nil {
bryanl's avatar
bryanl committed
294
		return ""
bryanl's avatar
bryanl committed
295 296
	}

bryanl's avatar
bryanl committed
297
	a, ok := i.(string)
bryanl's avatar
bryanl committed
298
	if !ok {
bryanl's avatar
bryanl committed
299
		return ""
bryanl's avatar
bryanl committed
300 301 302 303 304
	}

	return a
}

bryanl's avatar
bryanl committed
305
func (o *optionLoader) LoadStringSlice(name string) []string {
bryanl's avatar
bryanl committed
306
	i := o.load(name)
bryanl's avatar
bryanl committed
307 308 309 310
	if i == nil {
		return nil
	}

bryanl's avatar
bryanl committed
311
	a, ok := i.([]string)
bryanl's avatar
bryanl committed
312
	if !ok {
bryanl's avatar
bryanl committed
313
		o.err = newInvalidOptionError(name)
bryanl's avatar
bryanl committed
314 315 316 317 318 319
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
320
func (o *optionLoader) LoadClientConfig() *client.Config {
bryanl's avatar
bryanl committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334
	i := o.load(OptionClientConfig)
	if i == nil {
		return nil
	}

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

	return a
}

bryanl's avatar
bryanl committed
335
func (o *optionLoader) LoadApp() app.App {
bryanl's avatar
bryanl committed
336 337
	i := o.load(OptionApp)
	if i == nil {
bryanl's avatar
bryanl committed
338
		o.err = ErrNotInApp
bryanl's avatar
bryanl committed
339 340 341 342 343 344 345 346 347 348 349 350
		return nil
	}

	a, ok := i.(app.App)
	if !ok {
		o.err = newInvalidOptionError(OptionApp)
		return nil
	}

	return a
}

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
// LoadHTTPClient loads an HTTP client based on common configuration for certificates, tls verification, timeouts, etc.
func (o *optionLoader) LoadHTTPClient() *http.Client {
	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
383 384
func (o *optionLoader) load(key string) interface{} {
	if o.err != nil {
bryanl's avatar
bryanl committed
385 386 387
		return nil
	}

bryanl's avatar
bryanl committed
388
	i, ok := o.m[key]
bryanl's avatar
bryanl committed
389
	if !ok {
bryanl's avatar
bryanl committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403
		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
404 405 406 407
	}

	return i
}