Add credential arg for pypi (#43) (#44)

* Add credential arg for pypi Signed-off-by: Sayali Gaikawad <[email protected]> (cherry picked from commit 5fe49fb) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Sayali Gaikawad <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Nov 18, 2022 · 8511dad · 8511dad
1 parent f5d4d2c
commit 8511dad
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 15 deletions.
diff --git a/tests/jenkins/TestPublishToPyPi.groovy b/tests/jenkins/TestPublishToPyPi.groovy
@@ -20,7 +20,7 @@ class TestPublishToPyPi extends BuildPipelineTest {
 
     @Test
     void testWithDefaults() {
-        this.registerLibTester(new PublishToPyPiLibTester())
+        this.registerLibTester(new PublishToPyPiLibTester('pypi-token'))
         super.setUp()
         super.testPipeline('tests/jenkins/jobs/PublishToPyPi_Jenkinsfile')
         def twineCommands = getCommands('sh', 'twine')
@@ -36,7 +36,7 @@ class TestPublishToPyPi extends BuildPipelineTest {
 
     @Test
     void testWithCustomDir() {
-        this.registerLibTester(new PublishToPyPiLibTester('test'))
+        this.registerLibTester(new PublishToPyPiLibTester('pypi-token', 'test'))
         super.setUp()
         super.testPipeline('tests/jenkins/jobs/PublishToPyPiWithDir_Jenkinsfile')
 

diff --git a/tests/jenkins/jobs/PublishToPyPiWithDir_Jenkinsfile b/tests/jenkins/jobs/PublishToPyPiWithDir_Jenkinsfile
@@ -13,7 +13,7 @@ pipeline {
         stage('publishToPyPi') {
             steps {
                 script {
-                    publishToPyPi(artifactsPath: 'test')
+                    publishToPyPi(credentialId: 'pypi-token', artifactsPath: 'test')
                 }
             }
         }

diff --git a/tests/jenkins/jobs/PublishToPyPiWithDir_Jenkinsfile.txt b/tests/jenkins/jobs/PublishToPyPiWithDir_Jenkinsfile.txt
@@ -3,7 +3,7 @@
          PublishToPyPiWithDir_Jenkinsfile.echo(Executing on agent [label:none])
          PublishToPyPiWithDir_Jenkinsfile.stage(publishToPyPi, groovy.lang.Closure)
             PublishToPyPiWithDir_Jenkinsfile.script(groovy.lang.Closure)
-               PublishToPyPiWithDir_Jenkinsfile.publishToPyPi({artifactsPath=test})
+               PublishToPyPiWithDir_Jenkinsfile.publishToPyPi({credentialId=pypi-token, artifactsPath=test})
                   publishToPyPi.legacySCM(groovy.lang.Closure)
                   publishToPyPi.library({[email protected], retriever=null})
                   publishToPyPi.signArtifacts({artifactPath=test, sigtype=.asc, platform=linux})
@@ -27,6 +27,6 @@
 
                    /tmp/workspace/sign.sh test --sigtype=.asc --platform=linux
                )
-                  publishToPyPi.usernamePassword({credentialsId=jenkins-opensearch-pypi-credentials, usernameVariable=TWINE_USERNAME, passwordVariable=TWINE_PASSWORD})
+                  publishToPyPi.usernamePassword({credentialsId=pypi-token, usernameVariable=TWINE_USERNAME, passwordVariable=TWINE_PASSWORD})
                   publishToPyPi.withCredentials([[TWINE_USERNAME, TWINE_PASSWORD]], groovy.lang.Closure)
                      publishToPyPi.sh(twine upload -r pypi test/*)
diff --git a/tests/jenkins/jobs/PublishToPyPi_Jenkinsfile b/tests/jenkins/jobs/PublishToPyPi_Jenkinsfile
@@ -13,7 +13,7 @@ pipeline {
         stage('publishToPyPi') {
             steps {
                 script {
-                    publishToPyPi()
+                    publishToPyPi(credentialId: 'pypi-token')
                 }
             }
         }

diff --git a/tests/jenkins/jobs/PublishToPyPi_Jenkinsfile.txt b/tests/jenkins/jobs/PublishToPyPi_Jenkinsfile.txt
@@ -3,7 +3,7 @@
          PublishToPyPi_Jenkinsfile.echo(Executing on agent [label:none])
          PublishToPyPi_Jenkinsfile.stage(publishToPyPi, groovy.lang.Closure)
             PublishToPyPi_Jenkinsfile.script(groovy.lang.Closure)
-               PublishToPyPi_Jenkinsfile.publishToPyPi()
+               PublishToPyPi_Jenkinsfile.publishToPyPi({credentialId=pypi-token})
                   publishToPyPi.legacySCM(groovy.lang.Closure)
                   publishToPyPi.library({[email protected], retriever=null})
                   publishToPyPi.signArtifacts({artifactPath=dist, sigtype=.asc, platform=linux})
@@ -27,6 +27,6 @@
 
                    /tmp/workspace/sign.sh dist --sigtype=.asc --platform=linux
                )
-                  publishToPyPi.usernamePassword({credentialsId=jenkins-opensearch-pypi-credentials, usernameVariable=TWINE_USERNAME, passwordVariable=TWINE_PASSWORD})
+                  publishToPyPi.usernamePassword({credentialsId=pypi-token, usernameVariable=TWINE_USERNAME, passwordVariable=TWINE_PASSWORD})
                   publishToPyPi.withCredentials([[TWINE_USERNAME, TWINE_PASSWORD]], groovy.lang.Closure)
                      publishToPyPi.sh(twine upload -r pypi dist/*)
diff --git a/tests/jenkins/lib-testers/PublishToPyPiLibTester.groovy b/tests/jenkins/lib-testers/PublishToPyPiLibTester.groovy
@@ -13,25 +13,31 @@ import static org.hamcrest.CoreMatchers.NullValue
 class PublishToPyPiLibTester extends LibFunctionTester {
 
     private String artifactsPath = 'dist'
+    private String credentialId
 
-    public PublishToPyPiLibTester(){}
-    public PublishToPyPiLibTester(String artifactsPath){
+    public PublishToPyPiLibTester(String credentialId) {
+        this.credentialId = credentialId
+    }
+    public PublishToPyPiLibTester(String credentialId, String artifactsPath) {
+        this.credentialId = credentialId
         this.artifactsPath = artifactsPath
     }
 
     void configure(helper, binding){
         binding.setVariable('GITHUB_BOT_TOKEN_NAME', 'github_bot_token_name')
         helper.registerAllowedMethod("git", [Map])
-        helper.registerAllowedMethod("withCredentials", [Map, Closure], { args, closure ->
-            closure.delegate = delegate
-            return helper.callClosure(closure)
-        })
+        helper.registerAllowedMethod("withCredentials", [Map])
     }
     void parameterInvariantsAssertions(call){
         assertThat(call.args.artifactsPath.toString(), notNullValue())
+        assertThat(call.args.credentialId.toString(), notNullValue())
     }
 
     boolean expectedParametersMatcher(call) {
+        return call.args.credentialId.first().toString().equals(this.credentialId)
+    }
+
+    boolean expectedParametersMatcherArtifact(call){
         if (call.args.artifactsPath.isEmpty()) {
             return (this.artifactsPath.equals('dist'))
         }

diff --git a/vars/publishToPyPi.groovy b/vars/publishToPyPi.groovy
@@ -9,6 +9,7 @@
 
 /** Library to publish artifacts to PyPi registry with OpenSearch as maintainer
 @param Map args = [:] args A map of the following parameters
+@param args.credentialId <required> - Credential id consisting token for publishing the package
 @param args.artifactsPath <optional> - The directory containing distribution files to upload to the repository. Defaults to 'dist/*'
 */
 void call(Map args = [:]) {
@@ -21,7 +22,7 @@ void call(Map args = [:]) {
         platform: 'linux'
     )
 
-    withCredentials([usernamePassword(credentialsId: 'jenkins-opensearch-pypi-credentials', usernameVariable: 'TWINE_USERNAME', passwordVariable: 'TWINE_PASSWORD')]) {
+    withCredentials([usernamePassword(credentialsId: args.credentialId, usernameVariable: 'TWINE_USERNAME', passwordVariable: 'TWINE_PASSWORD')]) {
             sh """twine upload -r pypi ${releaseArtifactsDir}/*"""
     }
 }