actions.go 6.71 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
	// OptionFormat is format option.
	OptionFormat = "format"
bryanl's avatar
bryanl committed
50 51 52 53 54 55
	// OptionFs is fs option.
	OptionFs = "fs"
	// OptionGcTag is gcTag option.
	OptionGcTag = "gc-tag"
	// OptionGlobal is global option.
	OptionGlobal = "global"
bryanl's avatar
bryanl committed
56 57
	// OptionGracePeriod is gracePeriod option.
	OptionGracePeriod = "grace-period"
bryanl's avatar
bryanl committed
58 59 60 61
	// OptionLibName is libName.
	OptionLibName = "lib-name"
	// OptionName is name option.
	OptionName = "name"
62 63 64 65
	// OptionModule is component module option.
	OptionModule = "module"
	// OptionNamespace is a cluster namespace option
	OptionNamespace = "namespace"
bryanl's avatar
bryanl committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
	// 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"
84 85
	// OptionSkipDefaultRegistries is skipDefaultRegistries option. Used by init.
	OptionSkipDefaultRegistries = "skip-default-registries"
bryanl's avatar
bryanl committed
86 87 88 89
	// OptionSkipGc is skipGc option.
	OptionSkipGc = "skip-gc"
	// OptionSpecFlag is specFlag option. Used for setting k8s spec.
	OptionSpecFlag = "spec-flag"
bryanl's avatar
bryanl committed
90 91
	// OptionUnset is unset option.
	OptionUnset = "unset"
bryanl's avatar
bryanl committed
92 93 94 95 96 97 98 99
	// 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
100 101 102
const (
	// OutputWide is wide output
	OutputWide = "wide"
bryanl's avatar
bryanl committed
103 104
	// OutputJSON is JSON output
	OutputJSON = "json"
bryanl's avatar
bryanl committed
105 106
)

bryanl's avatar
bryanl committed
107 108 109 110
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
111 112 113 114 115 116 117 118 119 120 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
)

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
152
func (o *optionLoader) LoadFs(name string) afero.Fs {
bryanl's avatar
bryanl committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166
	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
167
func (o *optionLoader) LoadBool(name string) bool {
bryanl's avatar
bryanl committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181
	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
182
func (o *optionLoader) LoadOptionalBool(name string) bool {
bryanl's avatar
bryanl committed
183 184 185 186 187 188 189 190 191 192 193 194 195
	i := o.loadOptional(name)
	if i == nil {
		return false
	}

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

	return a
}

bryanl's avatar
bryanl committed
196
func (o *optionLoader) LoadInt(name string) int {
bryanl's avatar
bryanl committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210
	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
211
func (o *optionLoader) LoadInt64(name string) int64 {
bryanl's avatar
bryanl committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225
	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
226
func (o *optionLoader) LoadOptionalInt(name string) int {
bryanl's avatar
bryanl committed
227 228 229 230 231 232 233 234 235 236 237 238 239
	i := o.loadOptional(name)
	if i == nil {
		return 0
	}

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

	return a
}

bryanl's avatar
bryanl committed
240
func (o *optionLoader) LoadString(name string) string {
bryanl's avatar
bryanl committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254
	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
255
func (o *optionLoader) LoadOptionalString(name string) string {
bryanl's avatar
bryanl committed
256
	i := o.loadOptional(name)
bryanl's avatar
bryanl committed
257
	if i == nil {
bryanl's avatar
bryanl committed
258
		return ""
bryanl's avatar
bryanl committed
259 260
	}

bryanl's avatar
bryanl committed
261
	a, ok := i.(string)
bryanl's avatar
bryanl committed
262
	if !ok {
bryanl's avatar
bryanl committed
263
		return ""
bryanl's avatar
bryanl committed
264 265 266 267 268
	}

	return a
}

bryanl's avatar
bryanl committed
269
func (o *optionLoader) LoadStringSlice(name string) []string {
bryanl's avatar
bryanl committed
270
	i := o.load(name)
bryanl's avatar
bryanl committed
271 272 273 274
	if i == nil {
		return nil
	}

bryanl's avatar
bryanl committed
275
	a, ok := i.([]string)
bryanl's avatar
bryanl committed
276
	if !ok {
bryanl's avatar
bryanl committed
277
		o.err = newInvalidOptionError(name)
bryanl's avatar
bryanl committed
278 279 280 281 282 283
		return nil
	}

	return a
}

bryanl's avatar
bryanl committed
284
func (o *optionLoader) LoadClientConfig() *client.Config {
bryanl's avatar
bryanl committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298
	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
299
func (o *optionLoader) LoadApp() app.App {
bryanl's avatar
bryanl committed
300 301
	i := o.load(OptionApp)
	if i == nil {
bryanl's avatar
bryanl committed
302
		o.err = ErrNotInApp
bryanl's avatar
bryanl committed
303 304 305 306 307 308 309 310 311 312 313 314
		return nil
	}

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

	return a
}

bryanl's avatar
bryanl committed
315 316
func (o *optionLoader) load(key string) interface{} {
	if o.err != nil {
bryanl's avatar
bryanl committed
317 318 319
		return nil
	}

bryanl's avatar
bryanl committed
320
	i, ok := o.m[key]
bryanl's avatar
bryanl committed
321
	if !ok {
bryanl's avatar
bryanl committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335
		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
336 337 338 339
	}

	return i
}