HomeMesosphereNo notifications. 4 unresolved issues.
  • Search
Differential D29

Dramatically improve pod validation
AbandonedAll Users
Actions

Authored by • jasongilanfarr on Sep 28 2016, 1:56 AM.

Details

Reviewers
aquamatthias
jdef
unterstein
Commits
rMARATHON35478b0416cb: Dramatically improve pod validation (#4501)
rMARATHON216cce70a186: Merge fd1748f46a38e47fcc5dc7c658c3ab41394db89b into…
rMARATHONfd1748f46a38: Dramatically improve pod validation
rMARATHONdd16df4ac824: Merge 35478b0416cbffebe60ef95467e7a5c5da8aae48 into…
Summary
  • pods validation was missing a ton of stuff
Test Plan

sbt test

Used example from Greg in DCOS-10021

Diff Detail

Repository
rMARATHON marathon
Branch
jason/pod-validation
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 46
Build 46: arc lint + arc unit
• jasongilanfarr retitled this revision from to Dramatically improve pod validation.Sep 28 2016, 1:56 AM
• jasongilanfarr updated this object.
• jasongilanfarr edited the test plan for this revision. (Show Details)
• jasongilanfarr added reviewers: jdef, aquamatthias, unterstein.
• jasongilanfarr added a subscriber: marathon-team.
• jasongilanfarr abandoned this revision.Sep 28 2016, 5:11 PM

Already merged into feature/pods

Revision Contents

Diff 50

View Options

src/main/scala/mesosphere/marathon/api/v2/validation/PodsValidation.scala

11package mesosphere.marathon.api.v2.validation
22
33// scalastyle:off
44import java.util.regex.Pattern
55
66import com.wix.accord.dsl._
77import com.wix.accord.{ Failure, Result, RuleViolation, Success, Validator }
88import mesosphere.marathon.Features
99import mesosphere.marathon.api.v2.Validation
10import mesosphere.marathon.raml.{ Constraint, EnvVars, FixedPodScalingPolicy, PodContainer, Network, NetworkMode, Pod, PodPlacementPolicy, PodScalingPolicy, PodSchedulingBackoffStrategy, PodSchedulingPolicy, PodUpgradeStrategy, Resources, Secrets, Volume }
10import mesosphere.marathon.raml.{ ArgvCommand, Artifact, CommandHealthCheck, Constraint, Endpoint, EnvVars, FixedPodScalingPolicy, HealthCheck, HttpHealthCheck, Image, ImageType, Lifecycle, Network, NetworkMode, Pod, PodContainer, PodPlacementPolicy, PodScalingPolicy, PodSchedulingBackoffStrategy, PodSchedulingPolicy, PodUpgradeStrategy, Resources, Secrets, ShellCommand, TcpHealthCheck, Volume, VolumeMount }
1111import mesosphere.marathon.state.{ PathId, ResourceRole }
1212
1313import scala.collection.immutable.Seq
1414import scala.util.Try
1515// scalastyle:on
1616
1717/**
1818 * Defines implicit validation for pods
1919 */
20@SuppressWarnings(Array("all")) // wix breaks stuff
2021trait PodsValidation {
2122 import Validation._
2223
2324 val NamePattern = """^[a-z0-9]([-a-z0-9]*[a-z0-9])?$""".r
2425 val validName: Validator[String] = validator[String] { name =>
2526 name should matchRegexWithFailureMessage(
2627 NamePattern,
2728 "must contain only alphanumeric chars or hyphens, and must begin with a letter")
Show All 16 Lines
4445 // unnamed CT nets pick up the default virtual net name
4546 val unnamedAtMostOnce = nets.count { n => n.name.isEmpty && n.mode == NetworkMode.Container } < 2
4647 val realNamesAtMostOnce: Boolean = !nets.flatMap(_.name).groupBy(name => name).exists(_._2.size > 1)
4748 unnamedAtMostOnce && realNamesAtMostOnce
4849 } and
4950 isTrue[Seq[Network]]("Must specify either a single host network, or else 1-to-n container networks") { nets =>
5051 val countsByMode = nets.groupBy { net => net.mode }.mapValues(_.size)
5152 val hostNetworks = countsByMode.getOrElse(NetworkMode.Host, 0)
52 val containerNetworks = countsByMode.get(NetworkMode.Container).getOrElse(0)
53 val containerNetworks = countsByMode.getOrElse(NetworkMode.Container, 0)
5354 (hostNetworks == 1 && containerNetworks == 0) || (hostNetworks == 0 && containerNetworks > 0)
5455 }
5556
5657 val envValidator = validator[EnvVars] { env =>
5758 env.values.keys is every(validName)
5859 }
5960
6061 val resourceValidator = validator[Resources] { resource =>
6162 resource.cpus should be >= 0.0
6263 resource.mem should be >= 0.0
6364 resource.disk should be >= 0.0
6465 resource.gpus should be >= 0
6566 }
6667
67 val containerValidator: Validator[PodContainer] = validator[PodContainer] { container =>
68 def httpHealthCheckValidator(endpoints: Seq[Endpoint]) = validator[HttpHealthCheck] { hc =>
69 hc.endpoint.length is between(1, 63)
70 hc.endpoint should matchRegexFully(NamePattern)
71 hc.endpoint is isTrue("contained in the container endpoints") { endpoint =>
72 endpoints.exists(_.name == endpoint)
73 }
74 hc.path.map(_.length).getOrElse(1) is between(1, 1024)
75 }
76
77 def tcpHealthCheckValidator(endpoints: Seq[Endpoint]) = validator[TcpHealthCheck] { hc =>
78 hc.endpoint.length is between(1, 63)
79 hc.endpoint should matchRegexFully(NamePattern)
80 hc.endpoint is isTrue("contained in the container endpoints") { endpoint =>
81 endpoints.exists(_.name == endpoint)
82 }
83 }
84
85 val commandCheckValidator = new Validator[CommandHealthCheck] {
86 override def apply(v1: CommandHealthCheck): Result = v1.command match {
87 case ShellCommand(shell) =>
88 (shell.length should be > 0)(shell.length)
89 case ArgvCommand(argv) =>
90 (argv.size should be >0)(argv.size)
91 }
92 }
93
94 def healthCheckValidator(endpoints: Seq[Endpoint]) = validator[HealthCheck] { hc =>
95 hc.gracePeriodSeconds should be >= 0L
96 hc.intervalSeconds should be >= 0
97 hc.maxConsecutiveFailures should be >= 0
98 hc.timeoutSeconds should be >= 0
99 hc.delaySeconds should be >= 0
100 hc.http is optional(httpHealthCheckValidator(endpoints))
101 hc.tcp is optional(tcpHealthCheckValidator(endpoints))
102 hc.command is optional(commandCheckValidator)
103 hc is isTrue("Only one of http, tcp, or command may be specified") { hc =>
104 hc.http.isDefined ^ hc.tcp.isDefined ^ hc.command.isDefined
105 }
106 }
107
108 val endpointValidator = validator[Endpoint] { endpoint =>
109 endpoint.name.length is between(1, 63)
110 endpoint.name should matchRegexFully(NamePattern)
111 endpoint.containerPort.getOrElse(1) is between(1, 65535)
112 endpoint.hostPort.getOrElse(0) is between(0, 65535)
113 endpoint.protocol.size should be > 0
114 }
115
116 val imageValidator = validator[Image] { image =>
117 image.id.length is between(1, 1024)
118 }
119
120 // TODO(PODS): don't we need to know what path we're mounting, not just where it is in the container?
121 // kind of confused by this one.
122 @SuppressWarnings(Array("UnusedParameter"))
123 def volumeMountValidator(volumes: Seq[Volume]): Validator[VolumeMount] = validator[VolumeMount] { volumeMount => // linter:ignore:UnusedParameter
124 volumeMount.name.length is between(1, 63)
125 volumeMount.name should matchRegexFully(NamePattern)
126 volumeMount.mountPath.length is between(1, 1024)
127 }
128
129 val artifactValidator = validator[Artifact] { artifact =>
130 artifact.uri.length is between(1, 1024)
131 artifact.destPath.map(_.length).getOrElse(1) is between(1, 1024)
132 }
133
134 val lifeCycleValidator = validator[Lifecycle] { lc =>
135 lc.killGracePeriodSeconds.getOrElse(0.0) should be > 0.0
136 }
137
138 def containerValidator(volumes: Seq[Volume]): Validator[PodContainer] = validator[PodContainer] { container =>
68139 container.resources is valid(resourceValidator)
140 container.endpoints is empty or every(endpointValidator)
141 container.image.getOrElse(Image(ImageType.Docker, "abc")) is valid(imageValidator)
69142 container.environment is optional(envValidator)
143 container.healthCheck is optional(healthCheckValidator(container.endpoints))
144 container.volumeMounts is empty or every(volumeMountValidator(volumes))
145 container.artifacts is empty or every(artifactValidator)
70146 }
71147
72148 val volumeValidator: Validator[Volume] = validator[Volume] { volume =>
73149 volume.name is valid(validName)
74150 volume.host is optional(notEmpty)
75151 }
76152
77153 val backoffStrategyValidator = validator[PodSchedulingBackoffStrategy] { bs =>
▲ Show 20 Lines • Show All 79 Lines • ▼ Show 20 Line(s)
157233 case _ => Failure(Set(RuleViolation(v1, "Not a fixed scaling policy", None)))
158234 }
159235 }
160236
161237 def podDefValidator(enabledFeatures: Set[String]): Validator[Pod] = validator[Pod] { pod =>
162238 PathId(pod.id) as "id" is valid and valid(PathId.absolutePathValidator)
163239 pod.user is optional(notEmpty)
164240 pod.environment is optional(envValidator)
165 pod.containers is notEmpty and every(containerValidator)
241 pod.volumes is every(volumeValidator)
242 pod.containers is notEmpty and every(containerValidator(pod.volumes))
166243 pod.secrets is optional(secretValidator)
167244 pod.secrets is empty or featureEnabled(enabledFeatures, Features.SECRETS)
168 pod.volumes is every(volumeValidator)
169245 pod.networks is valid(networksValidator)
170246 pod.networks is every(networkValidator)
171247 pod.scheduling is optional(schedulingValidator)
172248 pod.scaling is optional(scalingValidator)
173249 }
174250}
175251
176252object PodsValidation extends PodsValidation