#!groovy import groovy.json.JsonSlurperClassic import org.junit.Before import org.junit.Rule import org.junit.Test import org.junit.rules.ExpectedException import org.junit.rules.RuleChain import util.BasePiperTest import util.JenkinsCredentialsRule import util.JenkinsLoggingRule import util.JenkinsReadJsonRule import util.JenkinsReadYamlRule import util.JenkinsStepRule import util.Rules import static org.hamcrest.Matchers.* import static org.junit.Assert.assertThat class GithubPublishReleaseTest extends BasePiperTest { private JenkinsStepRule stepRule = new JenkinsStepRule(this) private JenkinsLoggingRule loggingRule = new JenkinsLoggingRule(this) private JenkinsReadJsonRule readJsonRule = new JenkinsReadJsonRule(this) private ExpectedException thrown = ExpectedException.none() @Rule public RuleChain rules = Rules .getCommonRules(this) .around(new JenkinsReadYamlRule(this)) .around(loggingRule) .around(readJsonRule) .around(stepRule) .around(thrown) def data def requestList = [] @Before void init() throws Exception { // register Jenkins commands with mock values helper.registerAllowedMethod( "deleteDir", [], null ) helper.registerAllowedMethod("httpRequest", [], null) helper.registerAllowedMethod('string', [Map], { m -> return m }) helper.registerAllowedMethod('withCredentials', [List, Closure], { l, c -> try { l.each {Map settings -> binding.setProperty(settings.variable, '********') } c() }finally { l.each {Map settings -> binding.setProperty(settings.variable, null) } } }) def responseLatestRelease = '{"url":"https://api.github.com/SAP/jenkins-library/releases/26581","assets_url":"https://api.github.com/SAP/jenkins-library/releases/26581/assets","upload_url":"https://github.com/api/uploads/repos/ContinuousDelivery/piper-library/releases/26581/assets{?name,label}","html_url":"https://github.com/ContinuousDelivery/piper-library/releases/tag/1.11.0-20180409-074550","id":26581,"tag_name":"1.11.0-20180409-074550","target_commitish":"master","name":"1.11.0-20180409-074550","draft":false,"author":{"login":"XTEST1","id":1809,"avatar_url":"https://github.com/avatars/u/1809?","gravatar_id":"","url":"https://api.github.com/users/XTEST1","html_url":"https://github.com/XTEST1","followers_url":"https://api.github.com/users/XTEST1/followers","following_url":"https://api.github.com/users/XTEST1/following{/other_user}","gists_url":"https://api.github.com/users/XTEST1/gists{/gist_id}","starred_url":"https://api.github.com/users/XTEST1/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/XTEST1/subscriptions","organizations_url":"https://api.github.com/users/XTEST1/orgs","repos_url":"https://api.github.com/users/XTEST1/repos","events_url":"https://api.github.com/users/XTEST1/events{/privacy}","received_events_url":"https://api.github.com/users/XTEST1/received_events","type":"User","site_admin":false},"prerelease":false,"created_at":"2018-04-09T07:45:38Z","published_at":"2018-04-09T07:52:49Z","assets":[],"tarball_url":"https://api.github.com/SAP/jenkins-library/tarball/1.11.0-20180409-074550","zipball_url":"https://api.github.com/SAP/jenkins-library/zipball/1.11.0-20180409-074550","body":"

**List of closed pull-requests since last release**
[# 887](https://github.com/ContinuousDelivery/piper-library/pull/887): Add tests for checkmarx step
[# 907](https://github.com/ContinuousDelivery/piper-library/pull/907): Enable triaging
[# 908](https://github.com/ContinuousDelivery/piper-library/pull/908): SourceClear support reporting into fixed version
[# 909](https://github.com/ContinuousDelivery/piper-library/pull/909): add UserTriggerCause
[# 910](https://github.com/ContinuousDelivery/piper-library/pull/910): deployToKubernetes support of kubectl based deployment
[# 912](https://github.com/ContinuousDelivery/piper-library/pull/912): Speed up tests
[# 914](https://github.com/ContinuousDelivery/piper-library/pull/914): update config usage in writeInflux
[# 915](https://github.com/ContinuousDelivery/piper-library/pull/915): update config usage in executeVulasScan
[# 918](https://github.com/ContinuousDelivery/piper-library/pull/918): switch to new slack channel name
[# 921](https://github.com/ContinuousDelivery/piper-library/pull/921): correct utils object for restartableSteps step
[# 922](https://github.com/ContinuousDelivery/piper-library/pull/922): add default influx server
[# 924](https://github.com/ContinuousDelivery/piper-library/pull/924): update config usage in setupPipelineEnvironment
[# 925](https://github.com/ContinuousDelivery/piper-library/pull/925): Unstash content earlier to avoid FileNotFoundException
[# 927](https://github.com/ContinuousDelivery/piper-library/pull/927): Revert SourceClear support reporting into fixed version
[# 928](https://github.com/ContinuousDelivery/piper-library/pull/928): Fix rolling back mock behavior
[# 929](https://github.com/ContinuousDelivery/piper-library/pull/929): Add post-deploy actions via body
[# 930](https://github.com/ContinuousDelivery/piper-library/pull/930): parameters passed to resolveFortifyCredentialsID
[# 931](https://github.com/ContinuousDelivery/piper-library/pull/931): simplify bower installation for source clear
[# 932](https://github.com/ContinuousDelivery/piper-library/pull/932): use descriptive message for nodeAvailable
[# 934](https://github.com/ContinuousDelivery/piper-library/pull/934): Cease support for fortify technical user
[# 937](https://github.com/ContinuousDelivery/piper-library/pull/937): setVersion - allow extension of maven parameters
[# 938](https://github.com/ContinuousDelivery/piper-library/pull/938): Improve Protecode vulnerability processing
[# 939](https://github.com/ContinuousDelivery/piper-library/pull/939): xMake Docker metadata available in global pipeline environment
[# 940](https://github.com/ContinuousDelivery/piper-library/pull/940): Add missing hand-over of globalPipelineEnvironment
[# 944](https://github.com/ContinuousDelivery/piper-library/pull/944): fix: translate gh issues in traceability reports to proper urls
[# 945](https://github.com/ContinuousDelivery/piper-library/pull/945): Bump Version

**List of closed issues since last release**
[# 382](https://github.com/ContinuousDelivery/piper-library/issues/382): Snyk for security testing
[# 579](https://github.com/ContinuousDelivery/piper-library/issues/579): Evaluate required enhancements for Kubernetes
[# 638](https://github.com/ContinuousDelivery/piper-library/issues/638): Integrate Protecode for Docker scanning
[# 878](https://github.com/ContinuousDelivery/piper-library/issues/878): setVersion - allow parametrization of Maven call
[# 920](https://github.com/ContinuousDelivery/piper-library/issues/920): restartableSteps refers to wrong utils object
[# 941](https://github.com/ContinuousDelivery/piper-library/issues/941): issue in deep config merge

**Changes**
[1.10.0-20180326-070201...1.11.0-20180409-074550](https://github.com/ContinuousDelivery/piper-library/compare/1.10.0-20180326-070201...1.11.0-20180409-074550)
"}' def responseIssues = '[{"url":"https://api.github.com/SAP/jenkins-library/issues/13","repository_url":"https://api.github.com/SAP/jenkins-library","labels_url":"https://api.github.com/SAP/jenkins-library/issues/13/labels{/name}","comments_url":"https://api.github.com/SAP/jenkins-library/issues/13/comments","events_url":"https://api.github.com/SAP/jenkins-library/issues/13/events","html_url":"https://github.com/ContinuousDelivery/piper-library/issues/13","id":422536,"number":13,"title":"influx: add function to include performance result file (CSV)","user":{"login":"XTEST2","id":6991,"avatar_url":"https://github.com/avatars/u/6991?","gravatar_id":"","url":"https://api.github.com/users/XTEST2","html_url":"https://github.com/XTEST2","followers_url":"https://api.github.com/users/XTEST2/followers","following_url":"https://api.github.com/users/XTEST2/following{/other_user}","gists_url":"https://api.github.com/users/XTEST2/gists{/gist_id}","starred_url":"https://api.github.com/users/XTEST2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/XTEST2/subscriptions","organizations_url":"https://api.github.com/users/XTEST2/orgs","repos_url":"https://api.github.com/users/XTEST2/repos","events_url":"https://api.github.com/users/XTEST2/events{/privacy}","received_events_url":"https://api.github.com/users/XTEST2/received_events","type":"User","site_admin":false},"labels":[{"id":541874,"url":"https://api.github.com/SAP/jenkins-library/labels/enhancement","name":"enhancement","color":"84b6eb","default":true}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2017-03-17T10:23:08Z","updated_at":"2017-08-02T08:39:37Z","closed_at":"2017-08-02T08:39:37Z","author_association":"OWNER","body":""},{"url":"https://api.github.com/SAP/jenkins-library/issues/21","repository_url":"https://api.github.com/SAP/jenkins-library","labels_url":"https://api.github.com/SAP/jenkins-library/issues/21/labels{/name}","comments_url":"https://api.github.com/SAP/jenkins-library/issues/21/comments","events_url":"https://api.github.com/SAP/jenkins-library/issues/21/events","html_url":"https://github.com/ContinuousDelivery/piper-library/issues/21","id":422768,"number":21,"title":"environment: provide convenient method to get property as boolean","user":{"login":"XTEST2","id":6991,"avatar_url":"https://github.com/avatars/u/6991?","gravatar_id":"","url":"https://api.github.com/users/XTEST2","html_url":"https://github.com/XTEST2","followers_url":"https://api.github.com/users/XTEST2/followers","following_url":"https://api.github.com/users/XTEST2/following{/other_user}","gists_url":"https://api.github.com/users/XTEST2/gists{/gist_id}","starred_url":"https://api.github.com/users/XTEST2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/XTEST2/subscriptions","organizations_url":"https://api.github.com/users/XTEST2/orgs","repos_url":"https://api.github.com/users/XTEST2/repos","events_url":"https://api.github.com/users/XTEST2/events{/privacy}","received_events_url":"https://api.github.com/users/XTEST2/received_events","type":"User","site_admin":false},"labels":[{"id":541874,"url":"https://api.github.com/SAP/jenkins-library/labels/enhancement","name":"enhancement","color":"84b6eb","default":true}],"state":"closed","locked":false,"assignee":{"login":"XTEST2","id":6991,"avatar_url":"https://github.com/avatars/u/6991?","gravatar_id":"","url":"https://api.github.com/users/XTEST2","html_url":"https://github.com/XTEST2","followers_url":"https://api.github.com/users/XTEST2/followers","following_url":"https://api.github.com/users/XTEST2/following{/other_user}","gists_url":"https://api.github.com/users/XTEST2/gists{/gist_id}","starred_url":"https://api.github.com/users/XTEST2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/XTEST2/subscriptions","organizations_url":"https://api.github.com/users/XTEST2/orgs","repos_url":"https://api.github.com/users/XTEST2/repos","events_url":"https://api.github.com/users/XTEST2/events{/privacy}","received_events_url":"https://api.github.com/users/XTEST2/received_events","type":"User","site_admin":false},"assignees":[{"login":"XTEST2","id":6991,"avatar_url":"https://github.com/avatars/u/6991?","gravatar_id":"","url":"https://api.github.com/users/XTEST2","html_url":"https://github.com/XTEST2","followers_url":"https://api.github.com/users/XTEST2/followers","following_url":"https://api.github.com/users/XTEST2/following{/other_user}","gists_url":"https://api.github.com/users/XTEST2/gists{/gist_id}","starred_url":"https://api.github.com/users/XTEST2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/XTEST2/subscriptions","organizations_url":"https://api.github.com/users/XTEST2/orgs","repos_url":"https://api.github.com/users/XTEST2/repos","events_url":"https://api.github.com/users/XTEST2/events{/privacy}","received_events_url":"https://api.github.com/users/XTEST2/received_events","type":"User","site_admin":false}],"milestone":null,"comments":1,"created_at":"2017-03-17T13:24:21Z","updated_at":"2017-08-03T09:32:45Z","closed_at":"2017-08-03T09:32:45Z","author_association":"OWNER","body":""}]' def responseRelease = '{"url":"https://api.github.com/SAP/jenkins-library/releases/27149","assets_url":"https://api.github.com/SAP/jenkins-library/releases/27149/assets","upload_url":"https://github.com/api/uploads/repos/ContinuousDelivery/piper-library/releases/27149/assets{?name,label}","html_url":"https://github.com/ContinuousDelivery/piper-library/releases/tag/test","id":27149,"tag_name":"test","target_commitish":"master","name":"v1.0.0","draft":false,"author":{"login":"XTEST2","id":6991,"avatar_url":"https://github.com/avatars/u/6991?","gravatar_id":"","url":"https://api.github.com/users/XTEST2","html_url":"https://github.com/XTEST2","followers_url":"https://api.github.com/users/XTEST2/followers","following_url":"https://api.github.com/users/XTEST2/following{/other_user}","gists_url":"https://api.github.com/users/XTEST2/gists{/gist_id}","starred_url":"https://api.github.com/users/XTEST2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/XTEST2/subscriptions","organizations_url":"https://api.github.com/users/XTEST2/orgs","repos_url":"https://api.github.com/users/XTEST2/repos","events_url":"https://api.github.com/users/XTEST2/events{/privacy}","received_events_url":"https://api.github.com/users/XTEST2/received_events","type":"User","site_admin":false},"prerelease":false,"created_at":"2018-04-18T11:00:17Z","published_at":"2018-04-18T11:32:34Z","assets":[],"tarball_url":"https://api.github.com/SAP/jenkins-library/tarball/test","zipball_url":"https://api.github.com/SAP/jenkins-library/zipball/test","body":"Description of the release"}' helper.registerAllowedMethod("httpRequest", [String.class], { s -> def result = [status: 404] requestList.push(s.toString()) if(s.contains('/releases/latest?')) { result.content = responseLatestRelease result.status = 200 } else if(s.contains('/issues?')) { result.content = responseIssues result.status = 200 } return result }) helper.registerAllowedMethod("httpRequest", [Map.class], { m -> def result = '' requestList.push(m?.url?.toString()) if(m?.url?.contains('/releases?')){ data = new JsonSlurperClassic().parseText(m?.requestBody?.toString()) result = responseRelease } return [content: result] }) } @Test void testPublishGithubReleaseWithDefaults() throws Exception { stepRule.step.githubPublishRelease( script: nullScript, githubOrg: 'TestOrg', githubRepo: 'TestRepo', githubTokenCredentialsId: 'TestCredentials', version: '1.2.3' ) // asserts assertThat('this is not handled as a first release', loggingRule.log, not(containsString('[githubPublishRelease] This is the first release - no previous releases available'))) assertThat('every request starts with the github api url', requestList, everyItem(startsWith('https://api.github.com'))) assertThat('every request contains the github org & repo', requestList, everyItem(containsString('/TestOrg/TestRepo/'))) // test githubTokenCredentialsId assertThat('every request has an access token', requestList, everyItem(containsString('access_token=********'))) // test releaseBodyHeader assertThat('the header is not set', data.body, startsWith('')) // test addClosedIssues assertThat('the list of closed PR is not present', data.body, not(containsString('**List of closed pull-requests since last release**'))) assertThat('the list of closed issues is not present', data.body, not(containsString('**List of closed issues since last release**'))) // test addDeltaToLastRelease assertThat('the compare link is not present', data.body, not(containsString('[1.11.0-20180409-074550...1.2.3]'))) assertThat(data.name, is('1.2.3')) assertThat(data.tag_name, is('1.2.3')) assertThat(data.draft, is(false)) assertThat(data.prerelease, is(false)) assertJobStatusSuccess() } @Test void testPublishGithubRelease() throws Exception { stepRule.step.githubPublishRelease( script: nullScript, githubOrg: 'TestOrg', githubRepo: 'TestRepo', githubTokenCredentialsId: 'TestCredentials', version: '1.2.3', releaseBodyHeader: '**TestHeader**', addClosedIssues: true, addDeltaToLastRelease: true ) // asserts assertThat('this is not handled as a first release', loggingRule.log, not(containsString('[githubPublishRelease] This is the first release - no previous releases available'))) assertThat('every request starts with the github api url', requestList, everyItem(startsWith('https://api.github.com'))) assertThat('every request contains the github org & repo', requestList, everyItem(containsString('/TestOrg/TestRepo/'))) // test githubTokenCredentialsId assertThat('every request has an access token', requestList, everyItem(containsString('access_token=********'))) // test releaseBodyHeader assertThat('the header is set', data.body, startsWith('**TestHeader**')) // test addClosedIssues assertThat('the list of closed PR is present', data.body, containsString('**List of closed pull-requests since last release**')) assertThat('the list of closed issues is present', data.body, containsString('**List of closed issues since last release**')) // test addDeltaToLastRelease assertThat('the compare link is present', data.body, containsString('[1.11.0-20180409-074550...1.2.3]')) assertThat('the default github url is used', data.body, containsString('https://github.com')) //test fix for https://github.com/ContinuousDelivery/piper-library/issues/1047 assertThat(requestList[1].toString(), is('https://api.github.com/repos/TestOrg/TestRepo/issues?access_token=********&per_page=100&state=closed&direction=asc&since=2018-04-09T07:52:49Z')) assertThat(data.name, is('1.2.3')) assertThat(data.tag_name, is('1.2.3')) assertThat(data.draft, is(false)) assertThat(data.prerelease, is(false)) assertJobStatusSuccess() } @Test void testExcludeLabels() throws Exception { stepRule.step.githubPublishRelease( script: nullScript, githubOrg: 'TestOrg', githubRepo: 'TestRepo', githubTokenCredentialsId: 'TestCredentials', version: '1.2.3', releaseBodyHeader: '**TestHeader**', addClosedIssues: true, addDeltaToLastRelease: true, excludeLabels: ['enhancement'] ) // asserts assertThat('issues with excluded labels are not listed', data.body, not(containsString('influx: add function to include performance result file (CSV)'))) assertJobStatusSuccess() } @Test void testIsExcluded() throws Exception { def item = new JsonSlurperClassic().parseText('''{ "id": 422536, "number": 13, "title": "influx: add function to include performance result file (CSV)", "user": { "login": "XTEST2", "id": 6991, "type": "User", "site_admin": false }, "labels": [{ "id": 541874, "url": "https://api.github.com/SAP/jenkins-library/labels/enhancement", "name": "enhancement", "color": "84b6eb", "default": true }], "state": "closed", "locked": false, "body": "" }''') // asserts assertThat(stepRule.step.isExcluded(item, ['enhancement', 'won\'t fix']), is(true)) assertThat(stepRule.step.isExcluded(item, ['won\'t fix']), is(false)) assertJobStatusSuccess() } }