-
Notifications
You must be signed in to change notification settings - Fork 809
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(manifest): fixes deploy manifest SpEL evaluation toggle (#4128)
* fix(manifest): fixes deploy manifest SpEL evaluation toggle * add more tests
- Loading branch information
1 parent
d9423bc
commit a2acb5c
Showing
4 changed files
with
172 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
151 changes: 151 additions & 0 deletions
151
...ix/spinnaker/orca/clouddriver/pipeline/manifest/DeployManifestExpressionEvaluationTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /* | ||
| * Copyright 2021 Armory, Inc. | ||
| * | ||
| * 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 com.netflix.spinnaker.orca.clouddriver.pipeline.manifest | ||
|
|
||
| import com.netflix.spinnaker.orca.pipeline.expressions.PipelineExpressionEvaluator.SpelEvaluatorVersion | ||
| import com.netflix.spinnaker.orca.api.test.pipeline | ||
| import com.netflix.spinnaker.orca.api.test.stage | ||
| import com.netflix.spinnaker.orca.pipeline.StageDefinitionBuilderFactory | ||
| import com.netflix.spinnaker.orca.pipeline.util.ContextParameterProcessor | ||
| import com.netflix.spinnaker.orca.q.handler.ExpressionAware | ||
| import dev.minutest.junit.JUnit5Minutests | ||
| import dev.minutest.rootContext | ||
| import io.mockk.mockk | ||
| import strikt.api.expectThat | ||
| import strikt.assertions.isEqualTo | ||
|
|
||
| class DeployManifestExpressionEvaluationTest : JUnit5Minutests { | ||
| private val defaultSpelVersion = SpelEvaluatorVersion.Default().key | ||
|
|
||
| fun tests() = rootContext<Fixture> { | ||
| fixture { Fixture() } | ||
|
|
||
| listOf(defaultSpelVersion, "v4").forEach { spelVersion -> | ||
| test("should evaluate expression in manifest by default when SpEL $spelVersion is enabled") { | ||
| val pipeline = pipeline { | ||
| if (spelVersion != "") spelEvaluator = spelVersion | ||
| stage { | ||
| refId = "1" | ||
| type = "deployManifest" | ||
| context["manifests"] = listOf( | ||
| mapOf( | ||
| "metadata" to mapOf( | ||
| "name" to "my-k8s-manifest", | ||
| "should-evaluate-to-literal-true" to "\${#toBoolean('true')}" | ||
| ) | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
| val deployStage = pipeline.stageByRef("1") | ||
|
|
||
| expectThat(deployStage.withMergedContext().context["manifests"]).isEqualTo(listOf(mapOf( | ||
| "metadata" to mapOf( | ||
| "name" to "my-k8s-manifest", | ||
| "should-evaluate-to-literal-true" to true, | ||
| ) | ||
| ))) | ||
| } | ||
| } | ||
|
|
||
| // When the default SpEL version is bumped from v3 -> v4 this test will fail. | ||
| // At that point we should remove this test and add a test to verify that the | ||
| // default SpEL version handles the 'skipExpressionEvaluation' flag to protect against regressions in SpEL v5+. | ||
| test("should evaluate expressions even when 'skipExpressionEvaluation' context flag is enabled for default SpEL evaluator") { | ||
| val pipeline = pipeline { | ||
| spelEvaluator = defaultSpelVersion | ||
| stage { | ||
| refId = "1" | ||
| type = "deployManifest" | ||
| context["skipExpressionEvaluation"] = true | ||
| context["manifests"] = listOf( | ||
| mapOf( | ||
| "metadata" to mapOf( | ||
| "name" to "my-k8s-manifest", | ||
| "should-evaluate-to-literal-true" to "\${#toBoolean('true')}" | ||
| ) | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
| val deployStage = pipeline.stageByRef("1") | ||
|
|
||
| expectThat(deployStage.withMergedContext().context["manifests"]).isEqualTo(listOf(mapOf( | ||
| "metadata" to mapOf( | ||
| "name" to "my-k8s-manifest", | ||
| "should-evaluate-to-literal-true" to true | ||
| ) | ||
| ))) | ||
| } | ||
|
|
||
| test("should not evaluate expressions in manifests when 'skipExpressionEvaluation' context flag is enabled and SpEL evaluator is v4") { | ||
| val pipeline = pipeline { | ||
| spelEvaluator = "v4" | ||
| stage { | ||
| refId = "1" | ||
| type = "deployManifest" | ||
| context["skipExpressionEvaluation"] = true | ||
| context["manifests"] = listOf( | ||
| mapOf( | ||
| "metadata" to mapOf( | ||
| "name" to "my-k8s-manifest", | ||
| "should-not-evaluate-to-literal-true" to "\${#toBoolean('true')}" | ||
| ) | ||
| ) | ||
| ) | ||
| } | ||
| } | ||
| val deployStage = pipeline.stageByRef("1") | ||
|
|
||
| expectThat(deployStage.withMergedContext().context["manifests"]).isEqualTo(listOf(mapOf( | ||
| "metadata" to mapOf( | ||
| "name" to "my-k8s-manifest", | ||
| "should-not-evaluate-to-literal-true" to "\${#toBoolean('true')}" | ||
| ) | ||
| ))) | ||
| } | ||
|
|
||
| listOf(defaultSpelVersion, "v4").forEach { spelVersion -> | ||
| listOf(true, false).forEach { skipExpressionEvaluation -> | ||
| test("non-manifest context values should be evaluated when SpEL $spelVersion is enabled and skipExpressionEvaluation=$skipExpressionEvaluation") { | ||
| val pipeline = pipeline { | ||
| if (spelVersion != "") spelEvaluator = spelVersion | ||
| stage { | ||
| refId = "1" | ||
| type = "deployManifest" | ||
| context["skipExpressionEvaluation"] = skipExpressionEvaluation | ||
| context["should-evaluate-to-literal-true"] = "\${#toBoolean('true')}" | ||
| } | ||
| } | ||
| val deployStage = pipeline.stageByRef("1") | ||
|
|
||
| expectThat(deployStage.withMergedContext().context["should-evaluate-to-literal-true"]).isEqualTo(true) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class Fixture : ExpressionAware { | ||
| override val contextParameterProcessor = ContextParameterProcessor() | ||
| override val stageDefinitionBuilderFactory = StageDefinitionBuilderFactory { execution -> | ||
| when (execution.type) { | ||
| "deployManifest" -> DeployManifestStage(mockk()) | ||
| else -> throw IllegalArgumentException("Test factory can't make \"${execution.type}\" stages.") | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters