/* Copyright 2020 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 netpol import ( "fmt" "strings" v1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/kubernetes/test/e2e/framework" imageutils "k8s.io/kubernetes/test/utils/image" ) // Model defines the namespaces, deployments, services, pods, containers and associated // data for network policy test cases and provides the source of truth type Model struct { Namespaces []*Namespace PodNames []string Ports []int32 Protocols []v1.Protocol } // NewWindowsModel returns a model specific to windows testing. func NewWindowsModel(namespaceBaseNames []string, podNames []string, ports []int32) *Model { return NewModel(namespaceBaseNames, podNames, ports, []v1.Protocol{v1.ProtocolTCP, v1.ProtocolUDP}) } // NewModel instantiates a model based on: // - namespaceBaseNames // - pods // - ports to listen on // - protocols to listen on // The total number of pods is the number of namespaces x the number of pods per namespace. // The number of containers per pod is the number of ports x the number of protocols. // The *total* number of containers is namespaces x pods x ports x protocols. func NewModel(namespaceBaseNames []string, podNames []string, ports []int32, protocols []v1.Protocol) *Model { model := &Model{ PodNames: podNames, Ports: ports, Protocols: protocols, } // build the entire "model" for the overall test, which means, building // namespaces, pods, containers for each protocol. for _, ns := range namespaceBaseNames { var pods []*Pod for _, podName := range podNames { var containers []*Container for _, port := range ports { for _, protocol := range protocols { containers = append(containers, &Container{ Port: port, Protocol: protocol, }) } } pods = append(pods, &Pod{ Name: podName, Containers: containers, }) } model.Namespaces = append(model.Namespaces, &Namespace{ BaseName: ns, Pods: pods, }) } return model } // Namespace is the abstract representation of what matters to network policy // tests for a namespace; i.e. it ignores kube implementation details type Namespace struct { BaseName string Pods []*Pod } // Pod is the abstract representation of what matters to network policy tests for // a pod; i.e. it ignores kube implementation details type Pod struct { Name string Containers []*Container } // ContainerSpecs builds kubernetes container specs for the pod func (p *Pod) ContainerSpecs() []v1.Container { var containers []v1.Container for _, cont := range p.Containers { containers = append(containers, cont.Spec()) } return containers } func podNameLabelKey() string { return "pod" } // Labels returns the default labels that should be placed on a pod/deployment // in order for it to be uniquely selectable by label selectors func (p *Pod) Labels() map[string]string { return map[string]string{ podNameLabelKey(): p.Name, } } // KubePod returns the kube pod (will add label selectors for windows if needed). func (p *Pod) KubePod(namespace string) *v1.Pod { zero := int64(0) thePod := &v1.Pod{ ObjectMeta: metav1.ObjectMeta{ Name: p.Name, Labels: p.Labels(), Namespace: namespace, }, Spec: v1.PodSpec{ TerminationGracePeriodSeconds: &zero, Containers: p.ContainerSpecs(), }, } if framework.NodeOSDistroIs("windows") { thePod.Spec.NodeSelector = map[string]string{ "kubernetes.io/os": "windows", } } return thePod } // QualifiedServiceAddress returns the address that can be used to access the service func (p *Pod) QualifiedServiceAddress(namespace string, dnsDomain string) string { return fmt.Sprintf("%s.%s.svc.%s", p.ServiceName(namespace), namespace, dnsDomain) } // ServiceName returns the unqualified service name func (p *Pod) ServiceName(namespace string) string { return fmt.Sprintf("s-%s-%s", namespace, p.Name) } // Service returns a kube service spec func (p *Pod) Service(namespace string) *v1.Service { service := &v1.Service{ ObjectMeta: metav1.ObjectMeta{ Name: p.ServiceName(namespace), Namespace: namespace, }, Spec: v1.ServiceSpec{ Selector: p.Labels(), }, } for _, container := range p.Containers { service.Spec.Ports = append(service.Spec.Ports, v1.ServicePort{ Name: fmt.Sprintf("service-port-%s-%d", strings.ToLower(string(container.Protocol)), container.Port), Protocol: container.Protocol, Port: container.Port, }) } return service } // Container is the abstract representation of what matters to network policy tests for // a container; i.e. it ignores kube implementation details type Container struct { Port int32 Protocol v1.Protocol } // Name returns the container name func (c *Container) Name() string { return fmt.Sprintf("cont-%d-%s", c.Port, strings.ToLower(string(c.Protocol))) } // PortName returns the container port name func (c *Container) PortName() string { return fmt.Sprintf("serve-%d-%s", c.Port, strings.ToLower(string(c.Protocol))) } // Spec returns the kube container spec func (c *Container) Spec() v1.Container { var ( // agnHostImage is the image URI of AgnHost agnHostImage = imageutils.GetE2EImage(imageutils.Agnhost) env = []v1.EnvVar{} cmd []string ) switch c.Protocol { case v1.ProtocolTCP: cmd = []string{"/agnhost", "serve-hostname", "--tcp", "--http=false", "--port", fmt.Sprintf("%d", c.Port)} case v1.ProtocolUDP: cmd = []string{"/agnhost", "serve-hostname", "--udp", "--http=false", "--port", fmt.Sprintf("%d", c.Port)} case v1.ProtocolSCTP: env = append(env, v1.EnvVar{ Name: fmt.Sprintf("SERVE_SCTP_PORT_%d", c.Port), Value: "foo", }) cmd = []string{"/agnhost", "porter"} default: framework.Failf("invalid protocol %v", c.Protocol) } return v1.Container{ Name: c.Name(), ImagePullPolicy: v1.PullIfNotPresent, Image: agnHostImage, Command: cmd, Env: env, SecurityContext: &v1.SecurityContext{}, Ports: []v1.ContainerPort{ { ContainerPort: c.Port, Name: c.PortName(), Protocol: c.Protocol, }, }, } }