package com.sap.piper.cm import static org.hamcrest.Matchers.allOf import static org.hamcrest.Matchers.containsString import static org.hamcrest.Matchers.equalTo import static org.hamcrest.Matchers.hasItem import static org.hamcrest.Matchers.is import static org.hamcrest.Matchers.not import static org.junit.Assert.assertThat import org.hamcrest.Matchers import org.junit.Assert import org.junit.Rule import org.junit.Test import org.junit.rules.ExpectedException import org.junit.rules.RuleChain import com.sap.piper.GitUtils import util.BasePiperTest import util.JenkinsLoggingRule import util.JenkinsScriptLoaderRule import util.JenkinsShellCallRule import util.Rules import hudson.AbortException public class ChangeManagementTest extends BasePiperTest { private ExpectedException thrown = ExpectedException.none() private JenkinsShellCallRule script = new JenkinsShellCallRule(this) private JenkinsLoggingRule logging = new JenkinsLoggingRule(this) @Rule public RuleChain rules = Rules.getCommonRules(this) .around(thrown) .around(script) .around(logging) @Test public void testRetrieveChangeDocumentIdOutsideGitWorkTreeTest() { thrown.expect(ChangeManagementException) thrown.expectMessage('Cannot retrieve change document id. ' + 'Not in a git work tree. ' + 'Change document id is extracted from git commit messages.') new ChangeManagement(nullScript, gitUtilsMock(false, new String[0])).getChangeDocumentId() } @Test public void testRetrieveChangeDocumentIdNothingFound() { thrown.expect(ChangeManagementException) thrown.expectMessage('Cannot retrieve changeId from git commits.') new ChangeManagement(nullScript, gitUtilsMock(true, new String[0])).getChangeDocumentId() } @Test public void testRetrieveChangeDocumentIdReturnsArrayWithNullValue() { thrown.expect(ChangeManagementException) thrown.expectMessage('Cannot retrieve changeId from git commits.') new ChangeManagement(nullScript, gitUtilsMock(true, (String[])[ null ])).getChangeDocumentId() } @Test public void testRetrieveChangeDocumentNotUnique() { thrown.expect(ChangeManagementException) thrown.expectMessage('Multiple ChangeIds found') String[] changeIds = [ 'a', 'b' ] new ChangeManagement(nullScript, gitUtilsMock(true, changeIds)).getChangeDocumentId() } @Test public void testRetrieveChangeDocumentSameChangeIdFoundTwice() { String[] changeIds = [ 'a', 'a' ] def changeID = new ChangeManagement(nullScript, gitUtilsMock(true, changeIds)).getChangeDocumentId() assert changeID == 'a' } @Test public void testIsChangeInDevelopmentReturnsTrueWhenChangeIsInDevelopent() { script.setReturnValue(JenkinsShellCallRule.Type.REGEX, "cmclient.*is-change-in-development -cID '001'", 0) boolean inDevelopment = new ChangeManagement(nullScript, null).isChangeInDevelopment('001', 'endpoint', 'user', 'password') assertThat(inDevelopment, is(equalTo(true))) assertThat(script.shell[0], allOf(containsString("cmclient"), containsString("-u 'user'"), containsString("-p 'password'"), containsString("-e 'endpoint'"), containsString('is-change-in-development'), containsString("-cID '001'"), containsString("-t SOLMAN"))) } @Test public void testIsChangeInDevelopmentReturnsFalseWhenChangeIsNotInDevelopent() { script.setReturnValue(JenkinsShellCallRule.Type.REGEX, "cmclient.*is-change-in-development -cID '001'", 3) boolean inDevelopment = new ChangeManagement(nullScript, null) .isChangeInDevelopment('001', 'endpoint', 'user', 'password') assertThat(inDevelopment, is(equalTo(false))) } @Test public void testIsChangeInDevelopmentThrowsExceptionWhenCMClientReturnsUnexpectedExitCode() { thrown.expect(ChangeManagementException) thrown.expectMessage('Cannot retrieve status for change document \'001\'. Does this change exist? Return code from cmclient: 1.') script.setReturnValue(JenkinsShellCallRule.Type.REGEX, "cmclient.*is-change-in-development -cID '001'", 1) new ChangeManagement(nullScript, null).isChangeInDevelopment('001', 'endpoint', 'user', 'password') } @Test public void testGetCommandLineWithoutCMClientOpts() { String commandLine = new ChangeManagement(nullScript, null) .getCMCommandLine('https://example.org/cm', "me", "topSecret", "the-command", ["-key1", "val1", "-key2", "val2"]) commandLine = commandLine.replaceAll(' +', " ") assertThat(commandLine, not(containsString("CMCLIENT_OPTS"))) assertThat(commandLine, containsString("cmclient -e 'https://example.org/cm' -u 'me' -p 'topSecret' -t SOLMAN the-command -key1 val1 -key2 val2")) } @Test public void testGetCommandLineWithCMClientOpts() { String commandLine = new ChangeManagement(nullScript, null) .getCMCommandLine('https://example.org/cm', "me", "topSecret", "the-command", ["-key1", "val1", "-key2", "val2"], '-Djavax.net.debug=all') commandLine = commandLine.replaceAll(' +', " ") assertThat(commandLine, containsString('export CMCLIENT_OPTS="-Djavax.net.debug=all"')) } @Test public void testCreateTransportRequestSucceeds() { script.setReturnValue(JenkinsShellCallRule.Type.REGEX, ".*cmclient.*create-transport -cID 001 -dID 002.*", '004') def transportRequestId = new ChangeManagement(nullScript).createTransportRequest('001', '002', '003', 'me', 'openSesame') // the check for the transportRequestID is sufficient. This checks implicit the command line since that value is // returned only in case the shell call matches. assert transportRequestId == '004' } @Test public void testCreateTransportRequestFails() { script.setReturnValue(JenkinsShellCallRule.Type.REGEX, '.*upload-file-to-transport.*', 1) thrown.expect(ChangeManagementException) thrown.expectMessage('Cannot upload file \'/path\' for change document \'001\''+ ' with transport request \'002\'. Return code from cmclient: 1.') new ChangeManagement(nullScript).uploadFileToTransportRequest('001', '002', 'XXX', '/path', 'https://example.org/cm', 'me', 'openSesame') } @Test public void testUploadFileToTransportSucceeds() { // the regex provided below is an implicit check that the command line is fine. script.setReturnValue(JenkinsShellCallRule.Type.REGEX,, 'upload-file-to-transport.*-cID 001 -tID 002 XXX /path', 0) new ChangeManagement(nullScript).uploadFileToTransportRequest('001', '002', 'XXX', '/path', 'https://example.org/cm', 'me', 'openSesame') // no assert required here, since the regex registered above to the script rule is an implicit check for // the command line. } private GitUtils gitUtilsMock(boolean insideWorkTree, String[] changeIds) { return new GitUtils() { public boolean insideWorkTree() { return insideWorkTree } public String[] extractLogLines( String filter = '', String from = 'origin/master', String to = 'HEAD', String format = '%b') { return changeIds } } } }