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/ArtifactSetVersionTest.groovy

312 lines
14 KiB
Groovy
Raw Normal View History

import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.rules.ExpectedException
import org.junit.rules.RuleChain
import com.sap.piper.GitUtils
import hudson.AbortException
import util.BasePiperTest
2019-07-12 17:01:33 +02:00
import util.JenkinsCredentialsRule
import util.JenkinsDockerExecuteRule
import util.JenkinsEnvironmentRule
import util.JenkinsLoggingRule
import util.JenkinsReadMavenPomRule
import util.JenkinsReadYamlRule
import util.JenkinsShellCallRule
import util.JenkinsStepRule
import util.JenkinsWriteFileRule
import util.Rules
import static org.hamcrest.Matchers.hasItem
import static org.hamcrest.Matchers.hasItems
import static org.hamcrest.Matchers.not
import static org.hamcrest.Matchers.notNullValue
import static org.hamcrest.Matchers.stringContainsInOrder
2019-07-16 14:52:45 +02:00
import static org.hamcrest.Matchers.allOf
import static org.hamcrest.Matchers.containsString
2019-07-16 15:33:57 +02:00
import static org.hamcrest.Matchers.emptyIterable
import static org.junit.Assert.assertThat
2019-07-16 14:52:45 +02:00
import org.hamcrest.Matchers
import static org.junit.Assert.assertEquals
class ArtifactSetVersionTest extends BasePiperTest {
Map dockerParameters
def GitUtils gitUtils = new GitUtils() {
boolean isWorkTreeDirty() {
return false
}
String getGitCommitIdOrNull() {
return 'testCommitId'
}
}
2018-03-02 11:53:09 +02:00
def sshAgentList = []
2018-02-28 14:11:09 +02:00
private ExpectedException thrown = ExpectedException.none()
private JenkinsDockerExecuteRule dockerExecuteRule = new JenkinsDockerExecuteRule(this)
private JenkinsLoggingRule loggingRule = new JenkinsLoggingRule(this)
2019-01-22 10:19:28 +02:00
private JenkinsShellCallRule shellRule = new JenkinsShellCallRule(this)
private JenkinsWriteFileRule writeFileRule = new JenkinsWriteFileRule(this)
2019-01-22 10:25:42 +02:00
private JenkinsStepRule stepRule = new JenkinsStepRule(this)
2019-01-22 10:27:45 +02:00
private JenkinsEnvironmentRule environmentRule = new JenkinsEnvironmentRule(this)
2019-07-12 17:01:33 +02:00
private JenkinsCredentialsRule jenkinsCredentialsRule = new JenkinsCredentialsRule(this)
@Rule
public RuleChain ruleChain = Rules
.getCommonRules(this)
.around(new JenkinsReadYamlRule(this))
.around(thrown)
.around(loggingRule)
2019-01-22 10:19:28 +02:00
.around(shellRule)
.around(new JenkinsReadMavenPomRule(this, 'test/resources/versioning/MavenArtifactVersioning'))
.around(writeFileRule)
.around(dockerExecuteRule)
2019-01-22 10:25:42 +02:00
.around(stepRule)
2019-07-12 17:01:33 +02:00
.around(jenkinsCredentialsRule)
2019-01-22 10:27:45 +02:00
.around(environmentRule)
@Before
void init() throws Throwable {
dockerParameters = [:]
String version = '1.2.3'
nullScript.commonPipelineEnvironment.setArtifactVersion(null)
nullScript.commonPipelineEnvironment.setGitSshUrl('git@test.url')
helper.registerAllowedMethod("sshagent", [List.class, Closure.class], { list, closure ->
sshAgentList = list
return closure()
})
shellRule.setReturnValue("mvn --file 'pom.xml' --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn org.apache.maven.plugins:maven-help-plugin:3.1.0:evaluate -Dexpression=project.version -DforceStdout -q", version)
shellRule.setReturnValue("mvn --file 'snapshot/pom.xml' --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn org.apache.maven.plugins:maven-help-plugin:3.1.0:evaluate -Dexpression=project.version", version)
shellRule.setReturnValue("date --utc +'%Y%m%d%H%M%S'", '20180101010203')
2019-01-22 10:19:28 +02:00
shellRule.setReturnValue('git diff --quiet HEAD', 0)
helper.registerAllowedMethod('fileExists', [String.class], {true})
}
@Test
2019-07-12 17:01:33 +02:00
void testVersioningPushViaSSH() {
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils, buildTool: 'maven', gitSshUrl: 'myGitSshUrl')
2019-01-22 10:27:45 +02:00
assertEquals('1.2.3-20180101010203_testCommitId', environmentRule.env.getArtifactVersion())
assertEquals('testCommitId', environmentRule.env.getGitCommitId())
assertThat(shellRule.shell, hasItem("mvn --file 'pom.xml' --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn org.codehaus.mojo:versions-maven-plugin:2.7:set -DnewVersion=1.2.3-20180101010203_testCommitId -DgenerateBackupPoms=false"))
2019-01-22 10:19:28 +02:00
assertThat(shellRule.shell.join(), stringContainsInOrder([
"git add .",
"git commit -m 'update version 1.2.3-20180101010203_testCommitId'",
'git tag build_1.2.3-20180101010203_testCommitId',
'git push myGitSshUrl build_1.2.3-20180101010203_testCommitId',
]
))
}
2019-07-16 15:33:57 +02:00
@Test
void testVersioningNoPush() {
stepRule.step.artifactSetVersion(
script: stepRule.step,
juStabGitUtils: gitUtils,
buildTool: 'maven',
gitPushMode: 'NONE')
assertThat(loggingRule.log, containsString('Git push to remote has been skipped.'))
assertThat(((Iterable)shellRule.shell).join(), not(containsString('push')))
}
2019-07-12 17:01:33 +02:00
@Test
void testVersioningPushViaHTTPS() {
jenkinsCredentialsRule.withCredentials('myGitRepoCredentials', 'me', 'topSecret')
stepRule.step.artifactSetVersion(
script: stepRule.step,
juStabGitUtils: gitUtils,
buildTool: 'maven',
2019-07-16 16:01:43 +02:00
gitHttpsCredentialsId: 'myGitRepoCredentials',
2019-07-12 17:01:33 +02:00
gitHttpsUrl: 'https://example.org/myGitRepo',
gitPushMode: 'HTTPS')
// closer version checks already performed in test 'testVersioningPushViaSSH', focusing on
// GIT related assertions here
assertThat(shellRule.shell, hasItem("mvn --file 'pom.xml' --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn org.codehaus.mojo:versions-maven-plugin:2.7:set -DnewVersion=1.2.3-20180101010203_testCommitId -DgenerateBackupPoms=false"))
2019-07-12 17:01:33 +02:00
assertThat(((Iterable)shellRule.shell).join(), stringContainsInOrder([
"git add .",
"git commit -m 'update version 1.2.3-20180101010203_testCommitId'",
'git tag build_1.2.3-20180101010203_testCommitId',
'git push https://me:topSecret@example.org/myGitRepo build_1.2.3-20180101010203_testCommitId',
]
))
}
2019-07-16 14:52:45 +02:00
@Test
void testVersioningPushViaHTTPDisableSSLCheck() {
jenkinsCredentialsRule.withCredentials('myGitRepoCredentials', 'me', 'topSecret')
stepRule.step.artifactSetVersion(
script: stepRule.step,
juStabGitUtils: gitUtils,
buildTool: 'maven',
2019-07-16 16:01:43 +02:00
gitHttpsCredentialsId: 'myGitRepoCredentials',
2019-07-16 14:52:45 +02:00
gitHttpsUrl: 'https://example.org/myGitRepo',
gitPushMode: 'HTTPS',
2019-07-16 16:01:43 +02:00
gitDisableSslVerification: true)
2019-07-16 14:52:45 +02:00
// closer version checks already performed in test 'testVersioningPushViaSSH', focusing on
// GIT related assertions here
assertThat(((Iterable)shellRule.shell).join(), containsString('-c http.sslVerify=false'))
}
@Test
2019-07-16 16:01:43 +02:00
void testVersioningPushViaHTTPVerboseMode() {
2019-07-16 14:52:45 +02:00
jenkinsCredentialsRule.withCredentials('myGitRepoCredentials', 'me', 'topSecret')
stepRule.step.artifactSetVersion(
script: stepRule.step,
juStabGitUtils: gitUtils,
buildTool: 'maven',
2019-07-16 16:01:43 +02:00
gitHttpsCredentialsId: 'myGitRepoCredentials',
2019-07-16 14:52:45 +02:00
gitHttpsUrl: 'https://example.org/myGitRepo',
gitPushMode: 'HTTPS',
2019-07-16 16:01:43 +02:00
verbose: true)
2019-07-16 14:52:45 +02:00
// closer version checks already performed in test 'testVersioningPushViaSSH', focusing on
// GIT related assertions here
assertThat(((Iterable)shellRule.shell).join(), allOf(
containsString('GIT_CURL_VERBOSE=1'),
containsString('GIT_TRACE=1'),
containsString('--verbose'),
not(containsString('&>/dev/null'))))
}
2019-07-16 15:33:57 +02:00
@Test
void testVersioningPushViaHTTPSInDebugModeEncodingDoesNotRevealSecrets() {
2019-07-16 16:01:43 +02:00
loggingRule.expect('Verbose flag set, but encoded username/password differs from unencoded version. Cannot provide verbose output in this case.')
2019-07-16 15:33:57 +02:00
loggingRule.expect('Performing git push in quiet mode')
jenkinsCredentialsRule.withCredentials('myGitRepoCredentials', 'me', 'top@Secret')
stepRule.step.artifactSetVersion(
script: stepRule.step,
juStabGitUtils: gitUtils,
buildTool: 'maven',
2019-07-16 16:01:43 +02:00
gitHttpsCredentialsId: 'myGitRepoCredentials',
2019-07-16 15:33:57 +02:00
gitHttpsUrl: 'https://example.org/myGitRepo',
gitPushMode: 'HTTPS',
2019-07-16 16:01:43 +02:00
verbose: true)
2019-07-16 15:33:57 +02:00
// closer version checks already performed in test 'testVersioningPushViaSSH', focusing on
// GIT related assertions here
assertThat(((Iterable)shellRule.shell).join(), stringContainsInOrder([
"git add .",
"git commit -m 'update version 1.2.3-20180101010203_testCommitId'",
'git tag build_1.2.3-20180101010203_testCommitId',
'#!/bin/bash -e git push --quiet https://me:top%40Secret@example.org/myGitRepo build_1.2.3-20180101010203_testCommitId &>/dev/null',
]
))
}
2019-07-12 17:01:33 +02:00
@Test
void testVersioningPushViaHTTPSEncodingDoesNotRevealSecrets() {
// Credentials needs to be url encoded. In case that changes the secrets the credentials plugin
// doesn't hide the secrets anymore in the log. Hence we have to take care that the command is silent.
// Check for more details how that is handled in the step.
loggingRule.expect('Performing git push in quiet mode')
jenkinsCredentialsRule.withCredentials('myGitRepoCredentials', 'me', 'top@Secret')
stepRule.step.artifactSetVersion(
script: stepRule.step,
juStabGitUtils: gitUtils,
buildTool: 'maven',
2019-07-16 16:01:43 +02:00
gitHttpsCredentialsId: 'myGitRepoCredentials',
2019-07-12 17:01:33 +02:00
gitHttpsUrl: 'https://example.org/myGitRepo',
gitPushMode: 'HTTPS')
// closer version checks already performed in test 'testVersioningPushViaSSH', focusing on
// GIT related assertions here
assertThat(((Iterable)shellRule.shell).join(), stringContainsInOrder([
"git add .",
"git commit -m 'update version 1.2.3-20180101010203_testCommitId'",
'git tag build_1.2.3-20180101010203_testCommitId',
'#!/bin/bash -e git push --quiet https://me:top%40Secret@example.org/myGitRepo build_1.2.3-20180101010203_testCommitId &>/dev/null',
]
))
}
@Test
void testVersioningWithoutCommit() {
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils, buildTool: 'maven', commitVersion: false)
2019-01-22 10:27:45 +02:00
assertEquals('1.2.3-20180101010203_testCommitId', environmentRule.env.getArtifactVersion())
assertThat(shellRule.shell, hasItem("mvn --file 'pom.xml' --batch-mode -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn org.codehaus.mojo:versions-maven-plugin:2.7:set -DnewVersion=1.2.3-20180101010203_testCommitId -DgenerateBackupPoms=false"))
2019-01-22 10:19:28 +02:00
assertThat(shellRule.shell, not(hasItem(containsString('commit'))))
}
@Test
void testVersioningCustomGitUserAndEMail() {
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils, buildTool: 'maven', gitSshUrl: 'myGitSshUrl', gitUserEMail: 'test@test.com', gitUserName: 'test')
2019-01-22 10:19:28 +02:00
assertThat(shellRule.shell, hasItem(containsString("git -c user.email=\"test@test.com\" -c user.name=\"test\" commit -m 'update version 1.2.3-20180101010203_testCommitId'")))
}
@Test
void testVersioningWithTimestamp() {
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils, buildTool: 'maven', timestamp: '2018')
2019-01-22 10:27:45 +02:00
assertEquals('1.2.3-2018_testCommitId', environmentRule.env.getArtifactVersion())
}
@Test
void testVersioningNoBuildTool() {
thrown.expect(Exception)
thrown.expectMessage('ERROR - NO VALUE AVAILABLE FOR buildTool')
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils)
}
@Test
void testVersioningWithCustomTemplate() {
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils, buildTool: 'maven', versioningTemplate: '${version}-xyz')
2019-01-22 10:27:45 +02:00
assertEquals('1.2.3-xyz', environmentRule.env.getArtifactVersion())
}
@Test
void testVersioningWithTypeAppContainer() {
nullScript.commonPipelineEnvironment.setAppContainerProperty('gitSshUrl', 'git@test.url')
2019-01-22 10:27:45 +02:00
environmentRule.env.setArtifactVersion('1.2.3-xyz')
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion(script: stepRule.step, juStabGitUtils: gitUtils, buildTool: 'docker', artifactType: 'appContainer', dockerVersionSource: 'appVersion')
2019-01-22 10:27:45 +02:00
assertEquals('1.2.3-xyz', environmentRule.env.getArtifactVersion())
assertEquals('1.2.3-xyz', writeFileRule.files['VERSION'])
}
@Test
void testCredentialCompatibility() {
2019-01-22 10:25:42 +02:00
stepRule.step.artifactSetVersion (
script: nullScript,
buildTool: 'maven',
gitCredentialsId: 'testCredentials',
juStabGitUtils: gitUtils
)
assertThat(sshAgentList, hasItem('testCredentials'))
}
}