summaryrefslogtreecommitdiff
path: root/vendor/github.com/pborman/getopt/v2/set.go
diff options
context:
space:
mode:
authorDan Duvall <dduvall@wikimedia.org>2018-03-06 20:31:58 -0800
committerDan Duvall <dduvall@wikimedia.org>2018-03-19 15:55:16 -0700
commiteb9b69dd3d710cb7afa1dfb6e23a5987842b21cc (patch)
tree049b11cc885e4e9f54aac8981c91a1bf3620e7af /vendor/github.com/pborman/getopt/v2/set.go
parent6896e655eb5cc88b90e66979bc2d862eb92cbb9f (diff)
downloadblubber-eb9b69dd3d710cb7afa1dfb6e23a5987842b21cc.tar.gz
Allow for configuration policies
Summary: Implements a rough interface for validating configuration against arbitrary policy rules. Policies are provided as YAML and passed via the command line as file paths or remote URIs. The format of policies is: enforcements: - path: <path> rule: <rule> Where `<path>` is a YAML-ish path to a config field and `<rule>` is any expression our config validator understands (expressions built in by the validator library and custom tags defined in `config.validation.go`). Example policy: enforcements: - path: variants.production.base rule: oneof=debian:jessie debian:stretch - path: variants.production.runs.as rule: ne=foo - path: variants.production.node.dependencies rule: isfalse Command flag parsing was implemented in `main.go` to support the new `--policy=uri` flag and improve existing handling of `--version` and the usage statement. Test Plan: Run `go test ./...`. Reviewers: thcipriani, demon, hashar, mmodell, #release-engineering-team Reviewed By: thcipriani, #release-engineering-team Tags: #release-engineering-team Differential Revision: https://phabricator.wikimedia.org/D999
Diffstat (limited to 'vendor/github.com/pborman/getopt/v2/set.go')
-rw-r--r--vendor/github.com/pborman/getopt/v2/set.go284
1 files changed, 284 insertions, 0 deletions
diff --git a/vendor/github.com/pborman/getopt/v2/set.go b/vendor/github.com/pborman/getopt/v2/set.go
new file mode 100644
index 0000000..ce546ed
--- /dev/null
+++ b/vendor/github.com/pborman/getopt/v2/set.go
@@ -0,0 +1,284 @@
+// Copyright 2017 Google Inc. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package getopt
+
+import (
+ "io"
+ "os"
+ "sort"
+ "sync"
+)
+
+// A State is why the Getopt returned.
+type State int
+
+const (
+ InProgress = State(iota) // Getopt is still running
+ Dash // Returned on "-"
+ DashDash // Returned on "--"
+ EndOfOptions // End of options reached
+ EndOfArguments // No more arguments
+ Terminated // Terminated by callback function
+ Failure // Terminated due to error
+ Unknown // Indicates internal error
+)
+
+type Set struct {
+ stateMu sync.Mutex
+ state State
+
+ // args are the parameters remaining after parsing the optoins.
+ args []string
+
+ // program is the name of the program for usage and error messages.
+ // If not set it will automatically be set to the base name of the
+ // first argument passed to parse.
+ program string
+
+ // parameters is what is displayed on the usage line after displaying
+ // the various options.
+ parameters string
+
+ usage func() // usage should print the programs usage and exit.
+
+ shortOptions map[rune]*option
+ longOptions map[string]*option
+ options optionList
+}
+
+// New returns a newly created option set.
+func New() *Set {
+ s := &Set{
+ shortOptions: make(map[rune]*option),
+ longOptions: make(map[string]*option),
+ parameters: "[parameters ...]",
+ }
+
+ s.usage = func() {
+ s.PrintUsage(stderr)
+ }
+ return s
+}
+
+func (s *Set) setState(state State) {
+ s.stateMu.Lock()
+ s.state = state
+ s.stateMu.Unlock()
+}
+
+// State returns the current state of the Set s. The state is normally the
+// reason the most recent call to Getopt returned.
+func (s *Set) State() State {
+ s.stateMu.Lock()
+ defer s.stateMu.Unlock()
+ return s.state
+}
+
+// The default set of command-line options.
+var CommandLine = New()
+
+// PrintUsage calls PrintUsage in the default option set.
+func PrintUsage(w io.Writer) { CommandLine.PrintUsage(w) }
+
+// Usage calls the usage function in the default option set.
+func Usage() { CommandLine.usage() }
+
+// Parse calls Parse in the default option set with the command line arguments
+// found in os.Args.
+func Parse() { CommandLine.Parse(os.Args) }
+
+// Getops returns the result of calling Getop in the default option set with the
+// command line arguments found in os.Args. The fn function, which may be nil,
+// is passed to Getopt.
+func Getopt(fn func(Option) bool) error { return CommandLine.Getopt(os.Args, fn) }
+
+// Arg returns the n'th command-line argument. Arg(0) is the first remaining
+// argument after options have been processed.
+func Arg(n int) string {
+ if n >= 0 && n < len(CommandLine.args) {
+ return CommandLine.args[n]
+ }
+ return ""
+}
+
+// Arg returns the n'th argument. Arg(0) is the first remaining
+// argument after options have been processed.
+func (s *Set) Arg(n int) string {
+ if n >= 0 && n < len(s.args) {
+ return s.args[n]
+ }
+ return ""
+}
+
+// Args returns the non-option command line arguments.
+func Args() []string {
+ return CommandLine.args
+}
+
+// Args returns the non-option arguments.
+func (s *Set) Args() []string {
+ return s.args
+}
+
+// NArgs returns the number of non-option command line arguments.
+func NArgs() int {
+ return len(CommandLine.args)
+}
+
+// NArgs returns the number of non-option arguments.
+func (s *Set) NArgs() int {
+ return len(s.args)
+}
+
+// SetParameters sets the parameters string for printing the command line
+// usage. It defaults to "[parameters ...]"
+func SetParameters(parameters string) {
+ CommandLine.parameters = parameters
+}
+
+// SetParameters sets the parameters string for printing the s's usage.
+// It defaults to "[parameters ...]"
+func (s *Set) SetParameters(parameters string) {
+ s.parameters = parameters
+}
+
+// SetProgram sets the program name to program. Normally it is determined
+// from the zeroth command line argument (see os.Args).
+func SetProgram(program string) {
+ CommandLine.program = program
+}
+
+// SetProgram sets s's program name to program. Normally it is determined
+// from the zeroth argument passed to Getopt or Parse.
+func (s *Set) SetProgram(program string) {
+ s.program = program
+}
+
+// SetUsage sets the function used by Parse to display the commands usage
+// on error. It defaults to calling PrintUsage(os.Stderr).
+func SetUsage(usage func()) {
+ CommandLine.usage = usage
+}
+
+// SetUsage sets the function used by Parse to display usage on error. It
+// defaults to calling f.PrintUsage(os.Stderr).
+func (s *Set) SetUsage(usage func()) {
+ s.usage = usage
+}
+
+// Lookup returns the Option associated with name. Name should either be
+// a rune (the short name) or a string (the long name).
+func Lookup(name interface{}) Option {
+ return CommandLine.Lookup(name)
+}
+
+// Lookup returns the Option associated with name in s. Name should either be
+// a rune (the short name) or a string (the long name).
+func (s *Set) Lookup(name interface{}) Option {
+ switch v := name.(type) {
+ case rune:
+ return s.shortOptions[v]
+ case int:
+ return s.shortOptions[rune(v)]
+ case string:
+ return s.longOptions[v]
+ }
+ return nil
+}
+
+// IsSet returns true if the Option associated with name was seen while
+// parsing the command line arguments. Name should either be a rune (the
+// short name) or a string (the long name).
+func IsSet(name interface{}) bool {
+ return CommandLine.IsSet(name)
+}
+
+// IsSet returns true if the Option associated with name was seen while
+// parsing s. Name should either be a rune (the short name) or a string (the
+// long name).
+func (s *Set) IsSet(name interface{}) bool {
+ if opt := s.Lookup(name); opt != nil {
+ return opt.Seen()
+ }
+ return false
+}
+
+// GetCount returns the number of times the Option associated with name has been
+// seen while parsing the command line arguments. Name should either be a rune
+// (the short name) or a string (the long name).
+func GetCount(name interface{}) int {
+ return CommandLine.GetCount(name)
+}
+
+// GetCount returns the number of times the Option associated with name has been
+// seen while parsing s's arguments. Name should either be a rune (the short
+// name) or a string (the long name).
+func (s *Set) GetCount(name interface{}) int {
+ if opt := s.Lookup(name); opt != nil {
+ return opt.Count()
+ }
+ return 0
+}
+
+// GetValue returns the final value set to the command-line Option with name.
+// If the option has not been seen while parsing s then the default value is
+// returned. Name should either be a rune (the short name) or a string (the
+// long name).
+func GetValue(name interface{}) string {
+ return CommandLine.GetValue(name)
+}
+
+// GetValue returns the final value set to the Option in s associated with name.
+// If the option has not been seen while parsing s then the default value is
+// returned. Name should either be a rune (the short name) or a string (the
+// long name).
+func (s *Set) GetValue(name interface{}) string {
+ if opt := s.Lookup(name); opt != nil {
+ return opt.String()
+ }
+ return ""
+}
+
+// Visit visits the command-line options in lexicographical order, calling fn
+// for each. It visits only those options that have been set.
+func Visit(fn func(Option)) { CommandLine.Visit(fn) }
+
+// Visit visits the options in s in lexicographical order, calling fn
+// for each. It visits only those options that have been set.
+func (s *Set) Visit(fn func(Option)) {
+ sort.Sort(s.options)
+ for _, opt := range s.options {
+ if opt.count > 0 {
+ fn(opt)
+ }
+ }
+}
+
+// VisitAll visits the options in s in lexicographical order, calling fn
+// for each. It visits all options, even those not set.
+func VisitAll(fn func(Option)) { CommandLine.VisitAll(fn) }
+
+// VisitAll visits the command-line flags in lexicographical order, calling fn
+// for each. It visits all flags, even those not set.
+func (s *Set) VisitAll(fn func(Option)) {
+ sort.Sort(s.options)
+ for _, opt := range s.options {
+ fn(opt)
+ }
+}
+
+// Reset resets all the command line options to the initial state so it
+// appears none of them have been seen.
+func Reset() {
+ CommandLine.Reset()
+}
+
+// Reset resets all the options in s to the initial state so it
+// appears none of them have been seen.
+func (s *Set) Reset() {
+ for _, opt := range s.options {
+ opt.Reset()
+ }
+}