actions.go 7.06 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 32 33 34 35 36
	// OptionApp is app option.
	OptionApp = "app"
	// OptionArguments is arguments option. Used for passing arguments to prototypes.
	OptionArguments = "arguments"
	// OptionClientConfig is clientConfig option.
	OptionClientConfig = "client-config"
	// OptionComponentName is a componentName option.
	OptionComponentName = "component-name"
	// OptionComponentNames is componentNames option.
bryanl's avatar
bryanl committed
37
	OptionComponentNames = "component-names"
bryanl's avatar
bryanl committed
38 39 40 41 42 43
	// OptionCreate is create option.
	OptionCreate = "create"
	// OptionDryRun is dryRun option.
	OptionDryRun = "dry-run"
	// OptionEnvName is envName option.
	OptionEnvName = "env-name"
44 45 46 47
	// 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
48 49 50 51
	// OptionExtVarFiles is jsonnet ext var files.
	OptionExtVarFiles = "ext-vars-files"
	// OptionExtVars is jsonnet ext vars.
	OptionExtVars = "ext-vars"
bryanl's avatar
bryanl committed
52 53
	// OptionFormat is format option.
	OptionFormat = "format"
bryanl's avatar
bryanl committed
54 55 56 57 58 59
	// OptionFs is fs option.
	OptionFs = "fs"
	// OptionGcTag is gcTag option.
	OptionGcTag = "gc-tag"
	// OptionGlobal is global option.
	OptionGlobal = "global"
bryanl's avatar
bryanl committed
60 61
	// OptionGracePeriod is gracePeriod option.
	OptionGracePeriod = "grace-period"
bryanl's avatar
bryanl committed
62 63
	// OptionJPaths is jsonnet paths.
	OptionJPaths = "jpaths"
bryanl's avatar
bryanl committed
64 65 66 67
	// OptionLibName is libName.
	OptionLibName = "lib-name"
	// OptionName is name option.
	OptionName = "name"
68 69 70 71
	// OptionModule is component module option.
	OptionModule = "module"
	// OptionNamespace is a cluster namespace option
	OptionNamespace = "namespace"
bryanl's avatar
bryanl committed
72 73 74 75 76 77 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"
	// OptionRootPath is path option.
	OptionRootPath = "root-path"
	// OptionServer is server option.
	OptionServer = "server"
	// OptionServerURI is serverURI option.
	OptionServerURI = "server-uri"
90 91
	// OptionSkipDefaultRegistries is skipDefaultRegistries option. Used by init.
	OptionSkipDefaultRegistries = "skip-default-registries"
bryanl's avatar
bryanl committed
92 93 94 95
	// OptionSkipGc is skipGc option.
	OptionSkipGc = "skip-gc"
	// OptionSpecFlag is specFlag option. Used for setting k8s spec.
	OptionSpecFlag = "spec-flag"
bryanl's avatar
bryanl committed
96 97 98 99
	// OptionTlaVarFiles is jsonnet tla var files.
	OptionTlaVarFiles = "tla-var-files"
	// OptionTlaVars is jsonnet tla vars.
	OptionTlaVars = "tla-vars"
bryanl's avatar
bryanl committed
100 101
	// OptionUnset is unset option.
	OptionUnset = "unset"
bryanl's avatar
bryanl committed
102 103 104 105 106 107 108 109
	// 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
110 111 112
const (
	// OutputWide is wide output
	OutputWide = "wide"
bryanl's avatar
bryanl committed
113 114
	// OutputJSON is JSON output
	OutputJSON = "json"
bryanl's avatar
bryanl committed
115 116
)

bryanl's avatar
bryanl committed
117 118 119 120
var (
	// ErrNotInApp is an error stating the user is not in a ksonnet application directory
	// hierarchy.
	ErrNotInApp = errors.Errorf("could not find ksonnet app")
bryanl's avatar
bryanl committed
121 122 123 124 125 126 127 128 129 130 131 132 133 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
)

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

type optionLoader struct {
	err error
	m   map[string]interface{}
}

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

bryanl's avatar
bryanl committed
162
func (o *optionLoader) LoadFs(name string) afero.Fs {
bryanl's avatar
bryanl committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176
	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
177
func (o *optionLoader) LoadBool(name string) bool {
bryanl's avatar
bryanl committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191
	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
192
func (o *optionLoader) LoadOptionalBool(name string) bool {
bryanl's avatar
bryanl committed
193 194 195 196 197 198 199 200 201 202 203 204 205
	i := o.loadOptional(name)
	if i == nil {
		return false
	}

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

	return a
}

bryanl's avatar
bryanl committed
206
func (o *optionLoader) LoadInt(name string) int {
bryanl's avatar
bryanl committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220
	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
221
func (o *optionLoader) LoadInt64(name string) int64 {
bryanl's avatar
bryanl committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235
	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
236
func (o *optionLoader) LoadOptionalInt(name string) int {
bryanl's avatar
bryanl committed
237 238 239 240 241 242 243 244 245 246 247 248 249
	i := o.loadOptional(name)
	if i == nil {
		return 0
	}

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

	return a
}

bryanl's avatar
bryanl committed
250
func (o *optionLoader) LoadString(name string) string {
bryanl's avatar
bryanl committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264
	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
265
func (o *optionLoader) LoadOptionalString(name string) string {
bryanl's avatar
bryanl committed
266
	i := o.loadOptional(name)
bryanl's avatar
bryanl committed
267
	if i == nil {
bryanl's avatar
bryanl committed
268
		return ""
bryanl's avatar
bryanl committed
269 270
	}

bryanl's avatar
bryanl committed
271
	a, ok := i.(string)
bryanl's avatar
bryanl committed
272
	if !ok {
bryanl's avatar
bryanl committed
273
		return ""
bryanl's avatar
bryanl committed
274 275 276 277 278
	}

	return a
}

bryanl's avatar
bryanl committed
279
func (o *optionLoader) LoadStringSlice(name string) []string {
bryanl's avatar
bryanl committed
280
	i := o.load(name)
bryanl's avatar
bryanl committed
281 282 283 284
	if i == nil {
		return nil
	}

bryanl's avatar
bryanl committed
285
	a, ok := i.([]string)
bryanl's avatar
bryanl committed
286
	if !ok {
bryanl's avatar
bryanl committed
287
		o.err = newInvalidOptionError(name)
bryanl's avatar
bryanl committed
288 289 290 291 292 293
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
294
func (o *optionLoader) LoadClientConfig() *client.Config {
bryanl's avatar
bryanl committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308
	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
309
func (o *optionLoader) LoadApp() app.App {
bryanl's avatar
bryanl committed
310 311
	i := o.load(OptionApp)
	if i == nil {
bryanl's avatar
bryanl committed
312
		o.err = ErrNotInApp
bryanl's avatar
bryanl committed
313 314 315 316 317 318 319 320 321 322 323 324
		return nil
	}

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

	return a
}

bryanl's avatar
bryanl committed
325 326
func (o *optionLoader) load(key string) interface{} {
	if o.err != nil {
bryanl's avatar
bryanl committed
327 328 329
		return nil
	}

bryanl's avatar
bryanl committed
330
	i, ok := o.m[key]
bryanl's avatar
bryanl committed
331
	if !ok {
bryanl's avatar
bryanl committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345
		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
346 347 348 349
	}

	return i
}