1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/test/groovy/SetupCommonPipelineEnvironmentTest.groovy

173 lines
6.6 KiB
Groovy
Raw Normal View History

import com.sap.piper.DefaultValueCache
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.rules.ExpectedException
import org.junit.rules.RuleChain
import org.yaml.snakeyaml.Yaml
import util.BasePiperTest
import util.JenkinsReadFileRule
import util.JenkinsShellCallRule
2018-02-28 14:11:09 +02:00
import util.JenkinsStepRule
import util.JenkinsWriteFileRule
import util.Rules
import static org.hamcrest.Matchers.hasItem
import static org.junit.Assert.assertEquals
import static org.junit.Assert.assertNotNull
import static org.junit.Assert.assertThat
import static org.junit.Assert.assertTrue
class SetupCommonPipelineEnvironmentTest extends BasePiperTest {
2019-03-26 15:13:03 +02:00
def usedConfigFile
2019-01-22 10:25:42 +02:00
private JenkinsStepRule stepRule = new JenkinsStepRule(this)
private JenkinsWriteFileRule writeFileRule = new JenkinsWriteFileRule(this)
private ExpectedException thrown = ExpectedException.none()
private JenkinsShellCallRule shellRule = new JenkinsShellCallRule(this)
private JenkinsReadFileRule readFileRule = new JenkinsReadFileRule(this, "./")
@Rule
2018-02-28 14:11:09 +02:00
public RuleChain rules = Rules
.getCommonRules(this)
2019-01-22 10:25:42 +02:00
.around(stepRule)
.around(writeFileRule)
.around(thrown)
.around(shellRule)
.around(readFileRule)
2018-02-28 14:11:09 +02:00
@Before
void init() {
2019-03-26 15:13:03 +02:00
def examplePipelineConfig = new File('test/resources/test_pipeline_config.yml').text
helper.registerAllowedMethod("libraryResource", [String], { fileName ->
switch(fileName) {
case 'default_pipeline_environment.yml': return "default: 'config'"
case 'custom.yml': return "custom: 'myConfig'"
case 'notFound.yml': throw new hudson.AbortException('No such library resource notFound could be found')
default: return "the:'end'"
}
})
helper.registerAllowedMethod("readYaml", [Map], { Map parameters ->
Yaml yamlParser = new Yaml()
if (parameters.text) {
return yamlParser.load(parameters.text)
} else if(parameters.file) {
if(parameters.file == '.pipeline/default_pipeline_environment.yml') return [default: 'config']
else if (parameters.file == '.pipeline/custom.yml') return [custom: 'myConfig']
} else {
throw new IllegalArgumentException("Key 'text' and 'file' are both missing in map ${m}.")
}
usedConfigFile = parameters.file
return yamlParser.load(examplePipelineConfig)
})
}
@Test
void testIsYamlConfigurationAvailable() throws Exception {
helper.registerAllowedMethod("fileExists", [String], { String path ->
return path.endsWith('.pipeline/config.yml')
})
2019-03-26 15:13:03 +02:00
stepRule.step.setupCommonPipelineEnvironment(script: nullScript)
assertEquals('.pipeline/config.yml', usedConfigFile)
assertNotNull(nullScript.commonPipelineEnvironment.configuration)
assertEquals('develop', nullScript.commonPipelineEnvironment.configuration.general.productiveBranch)
assertEquals('my-maven-docker', nullScript.commonPipelineEnvironment.configuration.steps.mavenExecute.dockerImage)
}
@Test
void testWorksAlsoWithYamlFileEnding() throws Exception {
helper.registerAllowedMethod("fileExists", [String], { String path ->
return path.endsWith('.pipeline/config.yaml')
})
stepRule.step.setupCommonPipelineEnvironment(script: nullScript)
assertEquals('.pipeline/config.yaml', usedConfigFile)
assertNotNull(nullScript.commonPipelineEnvironment.configuration)
assertEquals('develop', nullScript.commonPipelineEnvironment.configuration.general.productiveBranch)
assertEquals('my-maven-docker', nullScript.commonPipelineEnvironment.configuration.steps.mavenExecute.dockerImage)
}
@Test
public void testAttemptToLoadNonExistingConfigFile() {
helper.registerAllowedMethod("fileExists", [String], { String path ->
switch(path) {
case 'default_pipeline_environment.yml': return false
case 'custom.yml': return false
case 'notFound.yml': return false
default: return true
}
})
helper.registerAllowedMethod("handlePipelineStepErrors", [Map,Closure], { Map map, Closure closure ->
closure()
})
// Behavior documented here based on reality check
thrown.expect(hudson.AbortException.class)
thrown.expectMessage('No such library resource notFound could be found')
stepRule.step.setupCommonPipelineEnvironment(
script: nullScript,
customDefaults: 'notFound.yml'
)
}
@Test
void testAttemptToLoadFileFromURL() {
helper.registerAllowedMethod("fileExists", [String], {String path ->
switch (path) {
case 'default_pipeline_environment.yml': return false
default: return true
}
})
String customDefaultUrl = "https://url-to-my-config.com/my-config.yml"
boolean urlRequested = false
helper.registerAllowedMethod("httpRequest", [Map], {Map parameters ->
switch (parameters.url) {
case customDefaultUrl:
urlRequested = true
return [status: 200, content: "custom: 'myRemoteConfig'"]
default:
throw new IllegalArgumentException('wrong URL requested')
}
})
helper.registerAllowedMethod("readYaml", [Map], { Map parameters ->
Yaml yamlParser = new Yaml()
if (parameters.text) {
return yamlParser.load(parameters.text)
} else if (parameters.file) {
if (parameters.file == '.pipeline/config-with-custom-defaults.yml') {
return [customDefaults: "${customDefaultUrl}"]
}
if (parameters.file == '.pipeline/custom_default_from_url_0.yml') {
return [custom: 'myRemoteConfig']
}
}
throw new IllegalArgumentException("Unexpected invocation of readYaml step")
})
stepRule.step.setupCommonPipelineEnvironment(
script: nullScript,
customDefaults: 'custom.yml',
configFile: '.pipeline/config-with-custom-defaults.yml',
)
assertEquals("custom: 'myRemoteConfig'", writeFileRule.files['.pipeline/custom_default_from_url_0.yml'])
assertEquals('myRemoteConfig', DefaultValueCache.instance.defaultValues['custom'])
}
}
2019-03-26 15:13:03 +02:00