docker/swarmkit

View on GitHub
manager/controlapi/common.go

Summary

Maintainability
A
0 mins
Test Coverage
package controlapi

import (
    "regexp"
    "strings"

    "github.com/moby/swarmkit/v2/api"
    "github.com/moby/swarmkit/v2/manager/state/store"
    "google.golang.org/grpc/codes"
    "google.golang.org/grpc/status"
)

var isValidDNSName = regexp.MustCompile(`^[a-zA-Z0-9](?:[-_]*[A-Za-z0-9]+)*$`)

// configs and secrets have different naming requirements from tasks and services
var isValidConfigOrSecretName = regexp.MustCompile(`^[a-zA-Z0-9]+(?:[a-zA-Z0-9-_.]*[a-zA-Z0-9])?$`)

func buildFilters(by func(string) store.By, values []string) store.By {
    filters := make([]store.By, 0, len(values))
    for _, v := range values {
        filters = append(filters, by(v))
    }
    return store.Or(filters...)
}

func filterContains(match string, candidates []string) bool {
    if len(candidates) == 0 {
        return true
    }
    for _, c := range candidates {
        if c == match {
            return true
        }
    }
    return false
}

func filterContainsPrefix(match string, candidates []string) bool {
    if len(candidates) == 0 {
        return true
    }
    for _, c := range candidates {
        if strings.HasPrefix(match, c) {
            return true
        }
    }
    return false
}

func filterMatchLabels(match map[string]string, candidates map[string]string) bool {
    if len(candidates) == 0 {
        return true
    }

    for k, v := range candidates {
        c, ok := match[k]
        if !ok {
            return false
        }
        if v != "" && v != c {
            return false
        }
    }
    return true
}

func validateAnnotations(m api.Annotations) error {
    if m.Name == "" {
        return status.Errorf(codes.InvalidArgument, "meta: name must be provided")
    }
    if !isValidDNSName.MatchString(m.Name) {
        // if the name doesn't match the regex
        return status.Errorf(codes.InvalidArgument, "name must be valid as a DNS name component")
    }
    if len(m.Name) > 63 {
        // DNS labels are limited to 63 characters
        return status.Errorf(codes.InvalidArgument, "name must be 63 characters or fewer")
    }
    return nil
}

func validateConfigOrSecretAnnotations(m api.Annotations) error {
    if m.Name == "" {
        return status.Errorf(codes.InvalidArgument, "name must be provided")
    } else if len(m.Name) > 64 || !isValidConfigOrSecretName.MatchString(m.Name) {
        // if the name doesn't match the regex
        return status.Errorf(codes.InvalidArgument,
            "invalid name, only 64 [a-zA-Z0-9-_.] characters allowed, and the start and end character must be [a-zA-Z0-9]")
    }
    return nil
}