actions.go 7.87 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 19 20
// 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 (
	"fmt"

bryanl's avatar
bryanl committed
21
	"github.com/ksonnet/ksonnet/pkg/app"
bryanl's avatar
bryanl committed
22
	"github.com/ksonnet/ksonnet/pkg/client"
bryanl's avatar
bryanl committed
23 24
	"github.com/pkg/errors"
	"github.com/spf13/afero"
bryanl's avatar
bryanl committed
25 26 27
)

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

bryanl's avatar
bryanl committed
123 124 125
const (
	// OutputWide is wide output
	OutputWide = "wide"
bryanl's avatar
bryanl committed
126 127
	// OutputJSON is JSON output
	OutputJSON = "json"
bryanl's avatar
bryanl committed
128 129
)

bryanl's avatar
bryanl committed
130 131 132
var (
	// ErrNotInApp is an error stating the user is not in a ksonnet application directory
	// hierarchy.
133
	ErrNotInApp = errors.Errorf("this command has to be run within a ksonnet application")
bryanl's avatar
bryanl committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
)

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

164 165 166
// 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
167
type optionLoader struct {
168 169
	// 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
170 171 172 173 174 175 176 177 178 179
	err error
	m   map[string]interface{}
}

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

bryanl's avatar
bryanl committed
180
func (o *optionLoader) LoadFs(name string) afero.Fs {
bryanl's avatar
bryanl committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194
	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
195
func (o *optionLoader) LoadBool(name string) bool {
bryanl's avatar
bryanl committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209
	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
210
func (o *optionLoader) LoadOptionalBool(name string) bool {
bryanl's avatar
bryanl committed
211 212 213 214 215 216 217 218 219 220 221 222 223
	i := o.loadOptional(name)
	if i == nil {
		return false
	}

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

	return a
}

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

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

	return a
}

bryanl's avatar
bryanl committed
268
func (o *optionLoader) LoadString(name string) string {
bryanl's avatar
bryanl committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282
	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
283
func (o *optionLoader) LoadOptionalString(name string) string {
bryanl's avatar
bryanl committed
284
	i := o.loadOptional(name)
bryanl's avatar
bryanl committed
285
	if i == nil {
bryanl's avatar
bryanl committed
286
		return ""
bryanl's avatar
bryanl committed
287 288
	}

bryanl's avatar
bryanl committed
289
	a, ok := i.(string)
bryanl's avatar
bryanl committed
290
	if !ok {
bryanl's avatar
bryanl committed
291
		return ""
bryanl's avatar
bryanl committed
292 293 294 295 296
	}

	return a
}

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

bryanl's avatar
bryanl committed
303
	a, ok := i.([]string)
bryanl's avatar
bryanl committed
304
	if !ok {
bryanl's avatar
bryanl committed
305
		o.err = newInvalidOptionError(name)
bryanl's avatar
bryanl committed
306 307 308 309 310 311
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
312
func (o *optionLoader) LoadClientConfig() *client.Config {
bryanl's avatar
bryanl committed
313 314 315 316 317 318 319 320 321 322 323 324 325 326
	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
327
func (o *optionLoader) LoadApp() app.App {
bryanl's avatar
bryanl committed
328 329
	i := o.load(OptionApp)
	if i == nil {
bryanl's avatar
bryanl committed
330
		o.err = ErrNotInApp
bryanl's avatar
bryanl committed
331 332 333 334 335 336 337 338 339 340 341 342
		return nil
	}

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

	return a
}

bryanl's avatar
bryanl committed
343 344
func (o *optionLoader) load(key string) interface{} {
	if o.err != nil {
bryanl's avatar
bryanl committed
345 346 347
		return nil
	}

bryanl's avatar
bryanl committed
348
	i, ok := o.m[key]
bryanl's avatar
bryanl committed
349
	if !ok {
bryanl's avatar
bryanl committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363
		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
364 365 366 367
	}

	return i
}