Add a comment to the latest

Signed-off-by: Prudhvi Godithi <[email protected]>
opensearch-project · Jul 27, 2023 · 70507a0 · 70507a0
1 parent 8776b89
commit 70507a0
Show file tree

Hide file tree

Showing 23 changed files with 438 additions and 48 deletions.
diff --git a/.github/workflows/groovy-tests.yml b/.github/workflows/groovy-tests.yml
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: Run Tests
         run: |
-          ./gradlew test --info
+          ./gradlew test --info --tests=TestCloseGithubIssue
       - name: Upload Coverage Report
         uses: codecov/[email protected]
         with:

diff --git a/build.gradle b/build.gradle
@@ -120,7 +120,7 @@ jacocoTestReport {
     }
 }
 
-String version = '5.2.0'
+String version = '5.4.0'
 
 task updateVersion {
     doLast {

diff --git a/tests/jenkins/TestBuildFailureMessage.groovy → tests/jenkins/TestBuildMessage.groovy b/tests/jenkins/TestBuildFailureMessage.groovy → tests/jenkins/TestBuildMessage.groovy
@@ -11,19 +11,19 @@ package jenkins.tests
 import jenkins.tests.BuildPipelineTest
 import org.junit.*
 
-class TestBuildFailureMessage extends BuildPipelineTest {
+class TestBuildMessage extends BuildPipelineTest {
 
 
     @Before
     void setUp() {
-        this.registerLibTester(new BuildFailureMessageLibTester())
+        this.registerLibTester(new BuildMessageLibTester('pass'))
         super.setUp()
         def currentBuild = binding.getVariable('currentBuild')
         binding.setVariable("currentBuild", currentBuild)
     }
 
     @Test
     void testBuildFailureMsg() {
-        super.testPipeline("tests/jenkins/jobs/BuildFailureMessage_Jenkinsfile")
+        super.testPipeline("tests/jenkins/jobs/BuildMessage_Jenkinsfile")
     }
 }
diff --git a/tests/jenkins/TestCloseBuildSuccessGithubIssue.groovy b/tests/jenkins/TestCloseBuildSuccessGithubIssue.groovy
@@ -0,0 +1,46 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package jenkins.tests
+
+import jenkins.tests.BuildPipelineTest
+import org.junit.Before
+import org.junit.Test
+import static com.lesfurets.jenkins.unit.MethodCall.callArgsToString
+import static org.hamcrest.CoreMatchers.hasItem
+import static org.hamcrest.MatcherAssert.assertThat
+
+class TestCloseBuildSuccessGithubIssue extends BuildPipelineTest {
+
+    @Override
+    @Before
+    void setUp() {
+        this.registerLibTester(new CloseBuildSuccessGithubIssueLibTester(['Build successful OpenSearch']))
+        super.setUp()
+    }
+
+
+    @Test
+    public void testExistingGithubIssue() {
+        super.testPipeline('tests/jenkins/jobs/CloseBuildSuccessGithubIssue_Jenkinsfile')
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue list --repo https://github.com/opensearch-project/OpenSearch.git -S \"[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0 in:title\" --label autocut,v2.0.0 --json number --jq '.[0].number', returnStdout=true}"))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue close bbb\nccc -R opensearch-project/OpenSearch --comment \"Closing the issue as the distribution build for OpenSearch has passed for version: **2.0.0**.\n                    Please see build log at www.example.com/jobs/test/123/consoleFull\", returnStdout=true}"))
+    }
+
+    def getCommands(method, text) {
+        def shCommands = helper.callStack.findAll { call ->
+            call.methodName == method
+        }.collect { call ->
+            callArgsToString(call)
+        }.findAll { command ->
+            command.contains(text)
+        }
+        return shCommands
+    }
+
+}
diff --git a/tests/jenkins/TestCloseGithubIssue.groovy b/tests/jenkins/TestCloseGithubIssue.groovy
@@ -0,0 +1,51 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package jenkins.tests
+
+import jenkins.tests.BuildPipelineTest
+import org.junit.Before
+import org.junit.Test
+import static com.lesfurets.jenkins.unit.MethodCall.callArgsToString
+import static org.hamcrest.CoreMatchers.hasItem
+import static org.hamcrest.MatcherAssert.assertThat
+
+class TestCloseGithubIssue extends BuildPipelineTest {
+
+    @Override
+    @Before
+    void setUp() {
+        super.setUp()
+    }
+
+
+    @Test
+    void testCloseExistingGithubIssue() {
+        this.registerLibTester(new CloseGithubIssueLibTester(
+            'https://github.com/opensearch-project/opensearch-build',
+            'Test GH issue title',
+            'Test GH issue close comment',
+            'label101',
+            ))
+        super.testPipeline("tests/jenkins/jobs/CloseGithubIssue_JenkinsFile")
+        // assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S \"Test GH issue title in:title\" --label label101 --json number --jq '.[0].number', returnStdout=true}"))
+        // assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue close bbb\nccc -R opensearch-project/opensearch-build --comment \"Test GH issue close comment\", returnStdout=true}"))
+    }
+
+    def getCommands(method, text) {
+        def shCommands = helper.callStack.findAll { call ->
+            call.methodName == method
+        }.collect { call ->
+            callArgsToString(call)
+        }.findAll { command ->
+            command.contains(text)
+        }
+        return shCommands
+    }
+
+}
diff --git a/tests/jenkins/TestCreateBuildFailureGithubIssue.groovy b/tests/jenkins/TestCreateBuildFailureGithubIssue.groovy
@@ -34,7 +34,10 @@ class TestCreateBuildFailureGithubIssue extends BuildPipelineTest {
     @Test
     public void testExistingGithubIssue() {
         super.testPipeline('tests/jenkins/jobs/CreateBuildFailureGithubIssue_Jenkinsfile', 'tests/jenkins/jobs/CreateBuildFailureGithubExistingIssueCheck_Jenkinsfile')
-        assertThat(getCommands('println', ''), hasItem('Issue already exists in the repository, skipping.'))
+        assertThat(getCommands('println', ''), hasItem('Issue already exists, adding a comment.'))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue list --repo https://github.com/opensearch-project/OpenSearch.git -S \"[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0 in:title\" --label autocut,v2.0.0, returnStdout=true}"))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue list --repo https://github.com/opensearch-project/OpenSearch.git -S \"[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0 in:title\" --label autocut,v2.0.0 --json number --jq '.[0].number', returnStdout=true}"))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue comment bbb\nccc --repo https://github.com/opensearch-project/OpenSearch.git --body \"***Received Error***: **Error building OpenSearch, retry with: ./build.sh manifests/2.2.0/opensearch-2.2.0.yml --component OpenSearch --snapshot**.\n                      The distribution build for OpenSearch has failed for version: 2.0.0.\n                      Please see build log at www.example.com/jobs/test/123/consoleFull\", returnStdout=true}"))
     }
 
     def getCommands(method, text) {

diff --git a/tests/jenkins/TestCreateGithubIssue.groovy b/tests/jenkins/TestCreateGithubIssue.groovy
@@ -41,11 +41,13 @@ class TestCreateGithubIssue extends BuildPipelineTest {
         this.registerLibTester(new CreateGithubIssueLibTester(
             'https://github.com/opensearch-project/opensearch-build',
             'Test GH issue title',
-            'Test GH issue body'
+            'Test GH issue body',
             ))
         super.testPipeline('tests/jenkins/jobs/CreateGithubIssueExisting_JenkinsFile')
-        assertThat(getCommands('println', ''), hasItem('Issue already exists in the repository, skipping.'))
-        assertThat(getCommands('sh', 'script'), hasItem('{script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S "Test GH issue title in:title" --label autocut, returnStdout=true}'))
+        assertThat(getCommands('println', ''), hasItem('Issue already exists, adding a comment.'))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S \"Test GH issue title in:title\" --label autocut, returnStdout=true}"))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S \"Test GH issue title in:title\" --label autocut --json number --jq '.[0].number', returnStdout=true}"))
+        assertThat(getCommands('sh', 'script'), hasItem("{script=gh issue comment bbb\nccc --repo https://github.com/opensearch-project/opensearch-build --body \"Test GH issue body\", returnStdout=true}"))
     }
 
     def getCommands(method, text) {

diff --git a/...kins/jobs/BuildFailureMessage_Jenkinsfile → tests/jenkins/jobs/BuildMessage_Jenkinsfile b/...kins/jobs/BuildFailureMessage_Jenkinsfile → tests/jenkins/jobs/BuildMessage_Jenkinsfile
@@ -14,7 +14,7 @@ pipeline {
             steps {
                 script {
                     try {
-                        buildFailureMessage()
+                        buildMessage(search: 'pass')
                         currentBuild.result = 'SUCCESS'
                     } catch (Exception err) {
 //https://github.com/jenkinsci/JenkinsPipelineUnit/issues/509

diff --git a/tests/jenkins/jobs/BuildMessage_Jenkinsfile.txt b/tests/jenkins/jobs/BuildMessage_Jenkinsfile.txt
@@ -0,0 +1,6 @@
+   BuildMessage_Jenkinsfile.run()
+      BuildMessage_Jenkinsfile.pipeline(groovy.lang.Closure)
+         BuildMessage_Jenkinsfile.echo(Executing on agent [label:none])
+         BuildMessage_Jenkinsfile.stage(notify, groovy.lang.Closure)
+            BuildMessage_Jenkinsfile.script(groovy.lang.Closure)
+               BuildMessage_Jenkinsfile.buildMessage({search=pass})
diff --git a/tests/jenkins/jobs/CloseBuildSuccessGithubIssue_Jenkinsfile b/tests/jenkins/jobs/CloseBuildSuccessGithubIssue_Jenkinsfile
@@ -0,0 +1,24 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+pipeline {
+    agent none
+    stages {
+        stage('notify') {
+            steps {
+                script {
+                    closeBuildSuccessGithubIssue(
+                        message: ["Build successful OpenSearch"],
+                        inputManifestPath: 'tests/data/opensearch-2.0.0.yml'
+                    )
+                }
+            }
+        }
+    }
+}
diff --git a/tests/jenkins/jobs/CloseBuildSuccessGithubIssue_Jenkinsfile.txt b/tests/jenkins/jobs/CloseBuildSuccessGithubIssue_Jenkinsfile.txt
@@ -0,0 +1,18 @@
+   CloseBuildSuccessGithubIssue_Jenkinsfile.run()
+      CloseBuildSuccessGithubIssue_Jenkinsfile.pipeline(groovy.lang.Closure)
+         CloseBuildSuccessGithubIssue_Jenkinsfile.echo(Executing on agent [label:none])
+         CloseBuildSuccessGithubIssue_Jenkinsfile.stage(notify, groovy.lang.Closure)
+            CloseBuildSuccessGithubIssue_Jenkinsfile.script(groovy.lang.Closure)
+               CloseBuildSuccessGithubIssue_Jenkinsfile.closeBuildSuccessGithubIssue({message=[Build successful OpenSearch], inputManifestPath=tests/data/opensearch-2.0.0.yml})
+                  closeBuildSuccessGithubIssue.legacySCM(groovy.lang.Closure)
+                  closeBuildSuccessGithubIssue.library({identifier=jenkins@main, retriever=null})
+                  closeBuildSuccessGithubIssue.readYaml({file=tests/data/opensearch-2.0.0.yml})
+                  closeBuildSuccessGithubIssue.closeGithubIssue({repoUrl=https://github.com/opensearch-project/OpenSearch.git, issueTitle=[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0, closeComment=Closing the issue as the distribution build for OpenSearch has passed for version: **2.0.0**.
+                    Please see build log at www.example.com/jobs/test/123/consoleFull, label=autocut,v2.0.0})
+                     closeGithubIssue.usernamePassword({credentialsId=jenkins-github-bot-token, passwordVariable=GITHUB_TOKEN, usernameVariable=GITHUB_USER})
+                     closeGithubIssue.withCredentials([[GITHUB_USER, GITHUB_TOKEN]], groovy.lang.Closure)
+                        closeGithubIssue.sh({script=gh issue list --repo https://github.com/opensearch-project/OpenSearch.git -S "[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0 in:title" --label autocut,v2.0.0 --json number --jq '.[0].number', returnStdout=true})
+                        closeGithubIssue.sh({script=gh issue close bbb
+ccc -R opensearch-project/OpenSearch --comment "Closing the issue as the distribution build for OpenSearch has passed for version: **2.0.0**.
+                    Please see build log at www.example.com/jobs/test/123/consoleFull", returnStdout=true})
+                  closeBuildSuccessGithubIssue.sleep({time=3, unit=SECONDS})
diff --git a/tests/jenkins/jobs/CloseGithubIssue_JenkinsFile.txt b/tests/jenkins/jobs/CloseGithubIssue_JenkinsFile.txt
@@ -0,0 +1,11 @@
+   CloseGithubIssue_JenkinsFile.run()
+      CloseGithubIssue_JenkinsFile.pipeline(groovy.lang.Closure)
+         CloseGithubIssue_JenkinsFile.echo(Executing on agent [label:none])
+         CloseGithubIssue_JenkinsFile.stage(closeGithubIssue, groovy.lang.Closure)
+            CloseGithubIssue_JenkinsFile.script(groovy.lang.Closure)
+               CloseGithubIssue_JenkinsFile.closeGithubIssue({repoUrl=https://github.com/opensearch-project/opensearch-build, issueTitle=Test GH issue title, closeComment=Test GH issue close comment, label=label101})
+                  closeGithubIssue.usernamePassword({credentialsId=jenkins-github-bot-token, passwordVariable=GITHUB_TOKEN, usernameVariable=GITHUB_USER})
+                  closeGithubIssue.withCredentials([[GITHUB_USER, GITHUB_TOKEN]], groovy.lang.Closure)
+                     closeGithubIssue.sh({script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S "Test GH issue title in:title" --label label101 --json number --jq '.[0].number', returnStdout=true})
+                     closeGithubIssue.sh({script=gh issue close bbb
+ccc -R opensearch-project/opensearch-build --comment "Test GH issue close comment", returnStdout=true})
diff --git a/tests/jenkins/jobs/CloseGithubIssue_Jenkinsfile b/tests/jenkins/jobs/CloseGithubIssue_Jenkinsfile
@@ -0,0 +1,26 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+pipeline {
+    agent none
+    stages {
+        stage('closeGithubIssue') {
+            steps {
+                script {
+                    closeGithubIssue(
+                        repoUrl: 'https://github.com/opensearch-project/opensearch-build',
+                        issueTitle: 'Test GH issue title',
+                        closeComment: 'Test GH issue close comment',
+                        label: 'label101'
+                        )
+                }
+            }
+        }
+    }
+}
diff --git a/tests/jenkins/jobs/CreateBuildFailureGithubExistingIssueCheck_Jenkinsfile.txt b/tests/jenkins/jobs/CreateBuildFailureGithubExistingIssueCheck_Jenkinsfile.txt
@@ -13,5 +13,10 @@
                      createGithubIssue.usernamePassword({credentialsId=jenkins-github-bot-token, passwordVariable=GITHUB_TOKEN, usernameVariable=GITHUB_USER})
                      createGithubIssue.withCredentials([[GITHUB_USER, GITHUB_TOKEN]], groovy.lang.Closure)
                         createGithubIssue.sh({script=gh issue list --repo https://github.com/opensearch-project/OpenSearch.git -S "[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0 in:title" --label autocut,v2.0.0, returnStdout=true})
-                        createGithubIssue.println(Issue already exists in the repository, skipping.)
+                        createGithubIssue.println(Issue already exists, adding a comment.)
+                        createGithubIssue.sh({script=gh issue list --repo https://github.com/opensearch-project/OpenSearch.git -S "[AUTOCUT] Distribution Build Failed for OpenSearch-2.0.0 in:title" --label autocut,v2.0.0 --json number --jq '.[0].number', returnStdout=true})
+                        createGithubIssue.sh({script=gh issue comment bbb
+ccc --repo https://github.com/opensearch-project/OpenSearch.git --body "***Received Error***: **Error building OpenSearch, retry with: ./build.sh manifests/2.2.0/opensearch-2.2.0.yml --component OpenSearch --snapshot**.
+                      The distribution build for OpenSearch has failed for version: 2.0.0.
+                      Please see build log at www.example.com/jobs/test/123/consoleFull", returnStdout=true})
                   createBuildFailureGithubIssue.sleep({time=3, unit=SECONDS})
diff --git a/tests/jenkins/jobs/CreateGithubIssueExisting_JenkinsFile.txt b/tests/jenkins/jobs/CreateGithubIssueExisting_JenkinsFile.txt
@@ -7,4 +7,7 @@
                   createGithubIssue.usernamePassword({credentialsId=jenkins-github-bot-token, passwordVariable=GITHUB_TOKEN, usernameVariable=GITHUB_USER})
                   createGithubIssue.withCredentials([[GITHUB_USER, GITHUB_TOKEN]], groovy.lang.Closure)
                      createGithubIssue.sh({script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S "Test GH issue title in:title" --label autocut, returnStdout=true})
-                     createGithubIssue.println(Issue already exists in the repository, skipping.)
+                     createGithubIssue.println(Issue already exists, adding a comment.)
+                     createGithubIssue.sh({script=gh issue list --repo https://github.com/opensearch-project/opensearch-build -S "Test GH issue title in:title" --label autocut --json number --jq '.[0].number', returnStdout=true})
+                     createGithubIssue.sh({script=gh issue comment bbb
+ccc --repo https://github.com/opensearch-project/opensearch-build --body "Test GH issue body", returnStdout=true})
diff --git a/tests/jenkins/lib-testers/BuildFailureMessageLibTester.groovy b/tests/jenkins/lib-testers/BuildFailureMessageLibTester.groovy
diff --git a/tests/jenkins/lib-testers/BuildMessageLibTester.groovy b/tests/jenkins/lib-testers/BuildMessageLibTester.groovy
@@ -0,0 +1,36 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+import static org.hamcrest.CoreMatchers.notNullValue
+import static org.hamcrest.CoreMatchers.nullValue
+import static org.hamcrest.MatcherAssert.assertThat
+
+class BuildMessageLibTester extends LibFunctionTester {
+
+    private String search
+
+    public BuildMessageLibTester(search) {
+        this.search = search
+    }
+
+
+     void parameterInvariantsAssertions(call) {
+        assertThat(call.args.search.first(), notNullValue())
+     }
+
+     boolean expectedParametersMatcher(call) {
+        return call.args.search.first().toString().equals(this.search)
+     }
+
+    String libFunctionName() {
+        return 'buildMessage'
+    }
+
+    void configure(helper, binding){
+    }
+}
diff --git a/tests/jenkins/lib-testers/CloseBuildSuccessGithubIssueLibTester.groovy b/tests/jenkins/lib-testers/CloseBuildSuccessGithubIssueLibTester.groovy
@@ -0,0 +1,41 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+import static org.hamcrest.CoreMatchers.notNullValue
+import static org.hamcrest.CoreMatchers.nullValue
+import static org.hamcrest.MatcherAssert.assertThat
+
+class CloseBuildSuccessGithubIssueLibTester extends LibFunctionTester{
+    private List<String> message
+
+    public CloseBuildSuccessGithubIssueLibTester(message){
+        this.message = message
+    }
+
+    @Override
+    String libFunctionName() {
+        return 'closeBuildSuccessGithubIssue'
+    }
+
+    @Override
+    void parameterInvariantsAssertions(Object call) {
+        assertThat(call.args.message.first(), notNullValue())
+    }
+
+    @Override
+    boolean expectedParametersMatcher(Object call) {
+        return call.args.message.first().equals(this.message)
+    }
+
+    @Override
+    void configure(Object helper, Object binding) {
+        helper.registerAllowedMethod('withCredentials', [Map])
+        helper.registerAllowedMethod('sleep', [Map])
+        binding.setVariable('BUILD_URL', 'www.example.com/jobs/test/123/')
+    }
+}