selector.go

/*
Copyright 2014 Google Inc. All rights reserved.

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 labels

import (
	"bytes"
	"fmt"
	"regexp"
	"sort"
	"strings"

	"github.com/GoogleCloudPlatform/kubernetes/pkg/api/errors"
	"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
)

// Selector represents a label selector.
type Selector interface {
	// Matches returns true if this selector matches the given set of labels.
	Matches(Labels) bool

	// Empty returns true if this selector does not restrict the selection space.
	Empty() bool

	// RequiresExactMatch allows a caller to introspect whether a given selector
	// requires a single specific label to be set, and if so returns the value it
	// requires.
	// TODO: expand this to be more general
	RequiresExactMatch(label string) (value string, found bool)

	// String returns a human readable string that represents this selector.
	String() string
}

// Everything returns a selector that matches all labels.
func Everything() Selector {
	return andTerm{}
}

type hasTerm struct {
	label, value string
}

func (t *hasTerm) Matches(ls Labels) bool {
	return ls.Get(t.label) == t.value
}

func (t *hasTerm) Empty() bool {
	return false
}

func (t *hasTerm) RequiresExactMatch(label string) (value string, found bool) {
	if t.label == label {
		return t.value, true
	}
	return "", false
}

func (t *hasTerm) String() string {
	return fmt.Sprintf("%v=%v", t.label, t.value)
}

type notHasTerm struct {
	label, value string
}

func (t *notHasTerm) Matches(ls Labels) bool {
	return ls.Get(t.label) != t.value
}

func (t *notHasTerm) Empty() bool {
	return false
}

func (t *notHasTerm) RequiresExactMatch(label string) (value string, found bool) {
	return "", false
}

func (t *notHasTerm) String() string {
	return fmt.Sprintf("%v!=%v", t.label, t.value)
}

type andTerm []Selector

func (t andTerm) Matches(ls Labels) bool {
	for _, q := range t {
		if !q.Matches(ls) {
			return false
		}
	}
	return true
}

func (t andTerm) Empty() bool {
	if t == nil {
		return true
	}
	if len([]Selector(t)) == 0 {
		return true
	}
	for i := range t {
		if !t[i].Empty() {
			return false
		}
	}
	return true
}

func (t andTerm) RequiresExactMatch(label string) (string, bool) {
	if t == nil || len([]Selector(t)) == 0 {
		return "", false
	}
	for i := range t {
		if value, found := t[i].RequiresExactMatch(label); found {
			return value, found
		}
	}
	return "", false
}

func (t andTerm) String() string {
	var terms []string
	for _, q := range t {
		terms = append(terms, q.String())
	}
	return strings.Join(terms, ",")
}

// TODO Support forward and reverse indexing (#1183, #1348). Eliminate uses of Selector.RequiresExactMatch.
// TODO rename to Selector after Selector interface above removed
type SetBasedSelector interface {
	// Matches returns true if this selector matches the given set of labels.
	Matches(Labels) (bool, error)

	// String returns a human-readable string that represents this selector.
	String() (string, error)
}

// Operator represents a key's relationship
// to a set of values in a Requirement.
type Operator int

const (
	In Operator = iota + 1
	NotIn
	Exists
)

// LabelSelector contains a list of Requirements.
// LabelSelector is set-based and is distinguished from exact
// match-based selectors composed of key=value matching conjunctions.
// TODO: Remove previous sentence when exact match-based
// selectors are removed.
type LabelSelector struct {
	Requirements []Requirement
}

// Requirement is a selector that contains values, a key
// and an operator that relates the key and values. The zero
// value of Requirement is invalid. See the NewRequirement
// constructor for creating a valid Requirement.
// Requirement is set-based and is distinguished from exact
// match-based selectors composed of key=value matching.
// TODO: Remove previous sentence when exact match-based
// selectors are removed.
type Requirement struct {
	key       string
	operator  Operator
	strValues util.StringSet
}

// NewRequirement is the constructor for a Requirement.
// If any of these rules is violated, an error is returned:
// (1) The operator can only be In, NotIn or Exists.
// (2) If the operator is In or NotIn, the values set must
//     be non-empty.
// (3) The key is invalid due to its length, or sequence
//     of characters. See validateLabelKey for more details.
//
// The empty string is a valid value in the input values set.
func NewRequirement(key string, op Operator, vals util.StringSet) (*Requirement, error) {
	if err := validateLabelKey(key); err != nil {
		return nil, err
	}
	switch op {
	case In, NotIn:
		if len(vals) == 0 {
			return nil, fmt.Errorf("for In,NotIn operators, values set can't be empty")
		}
	case Exists:
	default:
		return nil, fmt.Errorf("operator '%v' is not recognized", op)
	}
	return &Requirement{key: key, operator: op, strValues: vals}, nil
}

// Matches returns true if the Requirement matches the input Labels.
// There is a match in the following cases:
// (1) The operator is Exists and Labels has the Requirement's key.
// (2) The operator is In, Labels has the Requirement's key and Labels'
//     value for that key is in Requirement's value set.
// (3) The operator is NotIn, Labels has the Requirement's key and
//     Labels' value for that key is not in Requirement's value set.
// (4) The operator is NotIn and Labels does not have the
//     Requirement's key.
//
// If called on an invalid Requirement, an error is returned. See
// NewRequirement for creating a valid Requirement.
func (r *Requirement) Matches(ls Labels) (bool, error) {
	switch r.operator {
	case In:
		if !ls.Has(r.key) {
			return false, nil
		}
		return r.strValues.Has(ls.Get(r.key)), nil
	case NotIn:
		if !ls.Has(r.key) {
			return true, nil
		}
		return !r.strValues.Has(ls.Get(r.key)), nil
	case Exists:
		return ls.Has(r.key), nil
	default:
		return false, fmt.Errorf("requirement is not set: %+v", r)
	}
}

// String returns a human-readable string that represents this
// Requirement. If called on an invalid Requirement, an error is
// returned. See NewRequirement for creating a valid Requirement.
func (r *Requirement) String() (string, error) {
	var buffer bytes.Buffer
	buffer.WriteString(r.key)

	switch r.operator {
	case In:
		buffer.WriteString(" in ")
	case NotIn:
		buffer.WriteString(" not in ")
	case Exists:
		return buffer.String(), nil
	default:
		return "", fmt.Errorf("requirement is not set: %+v", r)
	}

	buffer.WriteString("(")
	if len(r.strValues) == 1 {
		buffer.WriteString(r.strValues.List()[0])
	} else { // only > 1 since == 0 prohibited by NewRequirement
		buffer.WriteString(strings.Join(r.strValues.List(), ","))
	}
	buffer.WriteString(")")
	return buffer.String(), nil
}

// Matches for a LabelSelector returns true if all
// its Requirements match the input Labels. If any
// Requirement does not match, false is returned.
// An error is returned if any match attempt between
// a Requirement and the input Labels returns an error.
func (lsel *LabelSelector) Matches(l Labels) (bool, error) {
	for _, req := range lsel.Requirements {
		if matches, err := req.Matches(l); err != nil {
			return false, err
		} else if !matches {
			return false, nil
		}
	}
	return true, nil
}

// String returns a comma-separated string of all
// the LabelSelector Requirements' human-readable strings.
// An error is returned if any attempt to get a
// Requirement's  human-readable string returns an error.
func (lsel *LabelSelector) String() (string, error) {
	var reqs []string
	for _, req := range lsel.Requirements {
		if str, err := req.String(); err != nil {
			return "", err
		} else {
			reqs = append(reqs, str)
		}
	}
	return strings.Join(reqs, ","), nil
}

// Parse takes a string representing a selector and returns a selector
// object, or an error. This parsing function differs from ParseSelector
// as they parse different selectors with different syntaxes.
// The input will cause an error if it does not follow this form:
//
//     <selector-syntax> ::= <requirement> | <requirement> "," <selector-syntax>
//         <requirement> ::= WHITESPACE_OPT KEY <set-restriction>
//     <set-restriction> ::= "" | <inclusion-exclusion> <value-set>
// <inclusion-exclusion> ::= <inclusion> | <exclusion>
//           <exclusion> ::= WHITESPACE "not" <inclusion>
//           <inclusion> ::= WHITESPACE "in" WHITESPACE
//           <value-set> ::= "(" <values> ")"
//              <values> ::= VALUE | VALUE "," <values>
//
// KEY is a sequence of one or more characters that does not contain ',' or ' '
//      [^, ]+
// VALUE is a sequence of zero or more characters that does not contain ',', ' ' or ')'
//      [^, )]*
// WHITESPACE_OPT is a sequence of zero or more whitespace characters
//      \s*
// WHITESPACE is a sequence of one or more whitespace characters
//      \s+
//
// Example of valid syntax:
//  "x in (foo,,baz),y,z not in ()"
//
// Note:
//  (1) Inclusion - " in " - denotes that the KEY is equal to any of the
//      VALUEs in its requirement
//  (2) Exclusion - " not in " - denotes that the KEY is not equal to any
//      of the VALUEs in its requirement
//  (3) The empty string is a valid VALUE
//  (4) A requirement with just a KEY - as in "y" above - denotes that
//      the KEY exists and can be any VALUE.
//
// TODO: value validation possibly including duplicate value check, restricting certain characters
func Parse(selector string) (SetBasedSelector, error) {
	var items []Requirement
	var key string
	var op Operator
	var vals util.StringSet
	const (
		startReq int = iota
		inKey
		waitOp
		inVals
	)
	const pos = "position %d:%s"
	inRegex, errIn := regexp.Compile("^\\s*in\\s+\\(")
	if errIn != nil {
		return nil, errIn
	}
	notInRegex, errNotIn := regexp.Compile("^\\s*not\\s+in\\s+\\(")
	if errNotIn != nil {
		return nil, errNotIn
	}

	state := startReq
	strStart := 0
	for i := 0; i < len(selector); i++ {
		switch state {
		case startReq:
			switch selector[i] {
			case ',':
				return nil, fmt.Errorf("a requirement can't be empty. "+pos, i, selector)
			case ' ', '\t', '\n', '\f', '\r':
			default:
				state = inKey
				strStart = i
			}
		case inKey:
			switch selector[i] {
			case ',':
				state = startReq
				if req, err := NewRequirement(selector[strStart:i], Exists, nil); err != nil {
					return nil, err
				} else {
					items = append(items, *req)
				}
			case ' ', '\t', '\n', '\f', '\r':
				state = waitOp
				key = selector[strStart:i]
			}
		case waitOp:
			if loc := inRegex.FindStringIndex(selector[i:]); loc != nil {
				op = In
				i += loc[1] - loc[0] - 1
			} else if loc = notInRegex.FindStringIndex(selector[i:]); loc != nil {
				op = NotIn
				i += loc[1] - loc[0] - 1
			} else {
				return nil, fmt.Errorf("expected \" in (\"/\" not in (\" after key. "+pos, i, selector)
			}
			state = inVals
			vals = util.NewStringSet()
			strStart = i + 1
		case inVals:
			switch selector[i] {
			case ',':
				vals.Insert(selector[strStart:i])
				strStart = i + 1
			case ' ':
				return nil, fmt.Errorf("white space not allowed in set strings. "+pos, i, selector)
			case ')':
				if i+1 == len(selector)-1 && selector[i+1] == ',' {
					return nil, fmt.Errorf("expected requirement after comma. "+pos, i+1, selector)
				}
				if i+1 < len(selector) && selector[i+1] != ',' {
					return nil, fmt.Errorf("requirements must be comma-separated. "+pos, i+1, selector)
				}
				state = startReq
				vals.Insert(selector[strStart:i])
				if req, err := NewRequirement(key, op, vals); err != nil {
					return nil, err
				} else {
					items = append(items, *req)
				}
				if i+1 < len(selector) {
					i += 1 //advance past comma
				}
			}
		}
	}

	switch state {
	case inKey:
		if req, err := NewRequirement(selector[strStart:], Exists, nil); err != nil {
			return nil, err
		} else {
			items = append(items, *req)
		}
	case waitOp:
		return nil, fmt.Errorf("input terminated while waiting for operator \"in \"/\"not in \":%s", selector)
	case inVals:
		return nil, fmt.Errorf("input terminated while waiting for value set:%s", selector)
	}

	return &LabelSelector{Requirements: items}, nil
}

// TODO: unify with validation.validateLabels
func validateLabelKey(k string) error {
	if !util.IsDNSLabel(k) {
		return errors.NewFieldNotSupported("key", k)
	}
	return nil
}

func try(selectorPiece, op string) (lhs, rhs string, ok bool) {
	pieces := strings.Split(selectorPiece, op)
	if len(pieces) == 2 {
		return pieces[0], pieces[1], true
	}
	return "", "", false
}

// SelectorFromSet returns a Selector which will match exactly the given Set. A
// nil Set is considered equivalent to Everything().
func SelectorFromSet(ls Set) Selector {
	if ls == nil {
		return Everything()
	}
	items := make([]Selector, 0, len(ls))
	for label, value := range ls {
		items = append(items, &hasTerm{label: label, value: value})
	}
	if len(items) == 1 {
		return items[0]
	}
	return andTerm(items)
}

// ParseSelector takes a string representing a selector and returns an
// object suitable for matching, or an error.
func ParseSelector(selector string) (Selector, error) {
	parts := strings.Split(selector, ",")
	sort.StringSlice(parts).Sort()
	var items []Selector
	for _, part := range parts {
		if part == "" {
			continue
		}
		if lhs, rhs, ok := try(part, "!="); ok {
			items = append(items, &notHasTerm{label: lhs, value: rhs})
		} else if lhs, rhs, ok := try(part, "=="); ok {
			items = append(items, &hasTerm{label: lhs, value: rhs})
		} else if lhs, rhs, ok := try(part, "="); ok {
			items = append(items, &hasTerm{label: lhs, value: rhs})
		} else {
			return nil, fmt.Errorf("invalid selector: '%s'; can't understand '%s'", selector, part)
		}
	}
	if len(items) == 1 {
		return items[0], nil
	}
	return andTerm(items), nil
}

// OneTermEqualSelector returns an object that matches objects where one label/field equals one value.
// Cannot return an error.
func OneTermEqualSelector(k, v string) Selector {
	return &hasTerm{label: k, value: v}
}