| /* |
| Copyright 2016 The Kubernetes 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 v1 |
| |
| import ( |
| "encoding/json" |
| "fmt" |
| |
| "k8s.io/apimachinery/pkg/fields" |
| "k8s.io/apimachinery/pkg/labels" |
| "k8s.io/apimachinery/pkg/selection" |
| "k8s.io/apimachinery/pkg/types" |
| ) |
| |
| // LabelSelectorAsSelector converts the LabelSelector api type into a struct that implements |
| // labels.Selector |
| // Note: This function should be kept in sync with the selector methods in pkg/labels/selector.go |
| func LabelSelectorAsSelector(ps *LabelSelector) (labels.Selector, error) { |
| if ps == nil { |
| return labels.Nothing(), nil |
| } |
| if len(ps.MatchLabels)+len(ps.MatchExpressions) == 0 { |
| return labels.Everything(), nil |
| } |
| selector := labels.NewSelector() |
| for k, v := range ps.MatchLabels { |
| r, err := labels.NewRequirement(k, selection.Equals, []string{v}) |
| if err != nil { |
| return nil, err |
| } |
| selector = selector.Add(*r) |
| } |
| for _, expr := range ps.MatchExpressions { |
| var op selection.Operator |
| switch expr.Operator { |
| case LabelSelectorOpIn: |
| op = selection.In |
| case LabelSelectorOpNotIn: |
| op = selection.NotIn |
| case LabelSelectorOpExists: |
| op = selection.Exists |
| case LabelSelectorOpDoesNotExist: |
| op = selection.DoesNotExist |
| default: |
| return nil, fmt.Errorf("%q is not a valid pod selector operator", expr.Operator) |
| } |
| r, err := labels.NewRequirement(expr.Key, op, append([]string(nil), expr.Values...)) |
| if err != nil { |
| return nil, err |
| } |
| selector = selector.Add(*r) |
| } |
| return selector, nil |
| } |
| |
| // LabelSelectorAsMap converts the LabelSelector api type into a map of strings, ie. the |
| // original structure of a label selector. Operators that cannot be converted into plain |
| // labels (Exists, DoesNotExist, NotIn, and In with more than one value) will result in |
| // an error. |
| func LabelSelectorAsMap(ps *LabelSelector) (map[string]string, error) { |
| if ps == nil { |
| return nil, nil |
| } |
| selector := map[string]string{} |
| for k, v := range ps.MatchLabels { |
| selector[k] = v |
| } |
| for _, expr := range ps.MatchExpressions { |
| switch expr.Operator { |
| case LabelSelectorOpIn: |
| if len(expr.Values) != 1 { |
| return selector, fmt.Errorf("operator %q without a single value cannot be converted into the old label selector format", expr.Operator) |
| } |
| // Should we do anything in case this will override a previous key-value pair? |
| selector[expr.Key] = expr.Values[0] |
| case LabelSelectorOpNotIn, LabelSelectorOpExists, LabelSelectorOpDoesNotExist: |
| return selector, fmt.Errorf("operator %q cannot be converted into the old label selector format", expr.Operator) |
| default: |
| return selector, fmt.Errorf("%q is not a valid selector operator", expr.Operator) |
| } |
| } |
| return selector, nil |
| } |
| |
| // ParseToLabelSelector parses a string representing a selector into a LabelSelector object. |
| // Note: This function should be kept in sync with the parser in pkg/labels/selector.go |
| func ParseToLabelSelector(selector string) (*LabelSelector, error) { |
| reqs, err := labels.ParseToRequirements(selector) |
| if err != nil { |
| return nil, fmt.Errorf("couldn't parse the selector string \"%s\": %v", selector, err) |
| } |
| |
| labelSelector := &LabelSelector{ |
| MatchLabels: map[string]string{}, |
| MatchExpressions: []LabelSelectorRequirement{}, |
| } |
| for _, req := range reqs { |
| var op LabelSelectorOperator |
| switch req.Operator() { |
| case selection.Equals, selection.DoubleEquals: |
| vals := req.Values() |
| if vals.Len() != 1 { |
| return nil, fmt.Errorf("equals operator must have exactly one value") |
| } |
| val, ok := vals.PopAny() |
| if !ok { |
| return nil, fmt.Errorf("equals operator has exactly one value but it cannot be retrieved") |
| } |
| labelSelector.MatchLabels[req.Key()] = val |
| continue |
| case selection.In: |
| op = LabelSelectorOpIn |
| case selection.NotIn: |
| op = LabelSelectorOpNotIn |
| case selection.Exists: |
| op = LabelSelectorOpExists |
| case selection.DoesNotExist: |
| op = LabelSelectorOpDoesNotExist |
| case selection.GreaterThan, selection.LessThan: |
| // Adding a separate case for these operators to indicate that this is deliberate |
| return nil, fmt.Errorf("%q isn't supported in label selectors", req.Operator()) |
| default: |
| return nil, fmt.Errorf("%q is not a valid label selector operator", req.Operator()) |
| } |
| labelSelector.MatchExpressions = append(labelSelector.MatchExpressions, LabelSelectorRequirement{ |
| Key: req.Key(), |
| Operator: op, |
| Values: req.Values().List(), |
| }) |
| } |
| return labelSelector, nil |
| } |
| |
| // SetAsLabelSelector converts the labels.Set object into a LabelSelector api object. |
| func SetAsLabelSelector(ls labels.Set) *LabelSelector { |
| if ls == nil { |
| return nil |
| } |
| |
| selector := &LabelSelector{ |
| MatchLabels: make(map[string]string), |
| } |
| for label, value := range ls { |
| selector.MatchLabels[label] = value |
| } |
| |
| return selector |
| } |
| |
| // FormatLabelSelector convert labelSelector into plain string |
| func FormatLabelSelector(labelSelector *LabelSelector) string { |
| selector, err := LabelSelectorAsSelector(labelSelector) |
| if err != nil { |
| return "<error>" |
| } |
| |
| l := selector.String() |
| if len(l) == 0 { |
| l = "<none>" |
| } |
| return l |
| } |
| |
| func ExtractGroupVersions(l *APIGroupList) []string { |
| var groupVersions []string |
| for _, g := range l.Groups { |
| for _, gv := range g.Versions { |
| groupVersions = append(groupVersions, gv.GroupVersion) |
| } |
| } |
| return groupVersions |
| } |
| |
| // HasAnnotation returns a bool if passed in annotation exists |
| func HasAnnotation(obj ObjectMeta, ann string) bool { |
| _, found := obj.Annotations[ann] |
| return found |
| } |
| |
| // SetMetaDataAnnotation sets the annotation and value |
| func SetMetaDataAnnotation(obj *ObjectMeta, ann string, value string) { |
| if obj.Annotations == nil { |
| obj.Annotations = make(map[string]string) |
| } |
| obj.Annotations[ann] = value |
| } |
| |
| // SingleObject returns a ListOptions for watching a single object. |
| func SingleObject(meta ObjectMeta) ListOptions { |
| return ListOptions{ |
| FieldSelector: fields.OneTermEqualSelector("metadata.name", meta.Name).String(), |
| ResourceVersion: meta.ResourceVersion, |
| } |
| } |
| |
| // NewDeleteOptions returns a DeleteOptions indicating the resource should |
| // be deleted within the specified grace period. Use zero to indicate |
| // immediate deletion. If you would prefer to use the default grace period, |
| // use &metav1.DeleteOptions{} directly. |
| func NewDeleteOptions(grace int64) *DeleteOptions { |
| return &DeleteOptions{GracePeriodSeconds: &grace} |
| } |
| |
| // NewPreconditionDeleteOptions returns a DeleteOptions with a UID precondition set. |
| func NewPreconditionDeleteOptions(uid string) *DeleteOptions { |
| u := types.UID(uid) |
| p := Preconditions{UID: &u} |
| return &DeleteOptions{Preconditions: &p} |
| } |
| |
| // NewUIDPreconditions returns a Preconditions with UID set. |
| func NewUIDPreconditions(uid string) *Preconditions { |
| u := types.UID(uid) |
| return &Preconditions{UID: &u} |
| } |
| |
| // NewRVDeletionPrecondition returns a DeleteOptions with a ResourceVersion precondition set. |
| func NewRVDeletionPrecondition(rv string) *DeleteOptions { |
| p := Preconditions{ResourceVersion: &rv} |
| return &DeleteOptions{Preconditions: &p} |
| } |
| |
| // HasObjectMetaSystemFieldValues returns true if fields that are managed by the system on ObjectMeta have values. |
| func HasObjectMetaSystemFieldValues(meta Object) bool { |
| return !meta.GetCreationTimestamp().Time.IsZero() || |
| len(meta.GetUID()) != 0 |
| } |
| |
| // ResetObjectMetaForStatus forces the meta fields for a status update to match the meta fields |
| // for a pre-existing object. This is opt-in for new objects with Status subresource. |
| func ResetObjectMetaForStatus(meta, existingMeta Object) { |
| meta.SetDeletionTimestamp(existingMeta.GetDeletionTimestamp()) |
| meta.SetGeneration(existingMeta.GetGeneration()) |
| meta.SetSelfLink(existingMeta.GetSelfLink()) |
| meta.SetLabels(existingMeta.GetLabels()) |
| meta.SetAnnotations(existingMeta.GetAnnotations()) |
| meta.SetFinalizers(existingMeta.GetFinalizers()) |
| meta.SetOwnerReferences(existingMeta.GetOwnerReferences()) |
| meta.SetManagedFields(existingMeta.GetManagedFields()) |
| } |
| |
| // MarshalJSON implements json.Marshaler |
| func (f Fields) MarshalJSON() ([]byte, error) { |
| return json.Marshal(&f.Map) |
| } |
| |
| // UnmarshalJSON implements json.Unmarshaler |
| func (f *Fields) UnmarshalJSON(b []byte) error { |
| return json.Unmarshal(b, &f.Map) |
| } |
| |
| var _ json.Marshaler = Fields{} |
| var _ json.Unmarshaler = &Fields{} |