Merge pull request #65 from allegro/development

basic auth/github token support

Author: adamdubiel

docs/changelog.rst

@@ -1,6 +1,8 @@
 Changelog
 =========
 
+* **1.2.3** (29.03.2015)
+    * support for Basic Auth username and password (GitHub tokens!)
 * **1.2.2** (21.03.2015)
     * use newer GrGit (and JGit) version with some bugfixes
     * start using Coveralls

docs/configuration/authorization.rst

@@ -8,6 +8,8 @@ All interactive authorization mechanisms are provided by `grgit <https://github.
 see `authorization docs <http://ajoberstar.org/grgit/docs/groovydoc/org/ajoberstar/grgit/auth/AuthConfig.html>`_
 for more information.
 
+Interactive mode is default option, switched off by using any special properties described below.
+
 SSH Key/password
 ----------------
 
@@ -51,3 +53,27 @@ dynamically using custom Gradle tasks right before release. To change credential
     task release {
         dependsOn loadKeyPassword
     }
+
+
+HTTP Basic Auth/GitHub tokens
+-----------------------------
+
+Same as with SSH keys, ``axion-release-plugin``gives option to set basic auth data when connecting to repository via
+HTTP. This is especially useful when using `GitHub OAuth tokens <https://help.github.com/articles/git-automation-with-oauth-tokens/>`_.
+
+Command line
+^^^^^^^^^^^^
+
+Use ``release.customUsername`` and ``release.customPassword`` properties to set username and password that will be provided
+when using Basic Auth. If password is not set, it defaults to empty string.
+
+Dynamic
+^^^^^^^
+
+Username and password can be provided in runtime, just before push is made via ``scmVersion.repository.customUsername``
+and ``scmVersion.repository.customPassword`` properties::
+
+
+    task loadGitHubToken << {
+        scmVersion.repository.customUsername = loadGitHubTokenFromSomewhere()
+    }

src/main/groovy/pl/allegro/tech/build/axion/release/domain/RepositoryConfig.groovy

@@ -11,4 +11,8 @@ class RepositoryConfig {
     def customKey
 
     String customKeyPassword
+    
+    String customUsername
+    
+    String customPassword = ''
 }

src/main/groovy/pl/allegro/tech/build/axion/release/domain/RepositoryConfigFactory.groovy

@@ -10,6 +10,10 @@ class RepositoryConfigFactory {
     private static final String CUSTOM_KEY_FILE_PROPERTY = 'release.customKeyFile'
 
     private static final String CUSTOM_KEY_PASSWORD_PROPERTY = 'release.customKeyPassword'
+    
+    private static final String USERNAME_PROPERTY = 'release.customUsername'
+    
+    private static final String PASSWORD_PROPERTY = 'release.customPassword'
 
 
     static RepositoryConfig create(Project project) {
@@ -25,6 +29,14 @@ class RepositoryConfigFactory {
         } else if (project.hasProperty(CUSTOM_KEY_FILE_PROPERTY)) {
             config.customKey = FileLoader.readFrom(project.property(CUSTOM_KEY_FILE_PROPERTY))
         }
+        
+        if(project.hasProperty(USERNAME_PROPERTY)) {
+            config.customUsername = project.property(USERNAME_PROPERTY)
+        }
+        if(project.hasProperty(PASSWORD_PROPERTY)) {
+            config.customPassword = project.property(PASSWORD_PROPERTY)
+        }
+        
         return config
     }
 }

src/main/groovy/pl/allegro/tech/build/axion/release/domain/scm/ScmIdentity.groovy

@@ -7,15 +7,27 @@ public class ScmIdentity {
 
     final boolean useDefault
 
+    final boolean privateKeyBased
+    
+    final boolean usernameBased
+    
     final String privateKey
 
     final String passPhrase
+    
+    final String username
+    
+    final String password
 
     static ScmIdentity defaultIdentity() {
         return new ScmIdentity(useDefault: true)
     }
 
-    static ScmIdentity customIdentity(String privateKey, String passPhrase) {
-        return new ScmIdentity(privateKey: privateKey, passPhrase: passPhrase, useDefault: false)
+    static ScmIdentity keyIdentity(String privateKey, String passPhrase) {
+        return new ScmIdentity(privateKey: privateKey, passPhrase: passPhrase, privateKeyBased: true, useDefault: false)
+    }
+
+    static ScmIdentity usernameIdentity(String username, String password) {
+        return new ScmIdentity(username: username, password: password, usernameBased: true, useDefault: false)
     }
 }

src/main/groovy/pl/allegro/tech/build/axion/release/domain/scm/ScmIdentityResolver.groovy

@@ -8,7 +8,9 @@ class ScmIdentityResolver {
     static ScmIdentity resolve(RepositoryConfig config) {
         ScmIdentity identity
         if (config.customKey) {
-            identity = ScmIdentity.customIdentity(FileLoader.readIfFile(config.customKey), config.customKeyPassword)
+            identity = ScmIdentity.keyIdentity(FileLoader.readIfFile(config.customKey), config.customKeyPassword)
+        } else if (config.customUsername) {
+            identity = ScmIdentity.usernameIdentity(config.customUsername, config.customPassword)
         } else {
             identity = ScmIdentity.defaultIdentity()
         }

src/main/groovy/pl/allegro/tech/build/axion/release/infrastructure/git/GitRepository.groovy

@@ -22,6 +22,8 @@ class GitRepository implements ScmRepository {
 
     private static final String GIT_TAG_PREFIX = 'refs/tags/'
 
+    private final TransportConfigFactory transportConfigFactory = new TransportConfigFactory()
+    
     private final File repositoryDir
 
     private final Grgit repository
@@ -100,13 +102,7 @@ class GitRepository implements ScmRepository {
     }
 
     private void setTransportOptions(ScmIdentity identity, TransportCommand command) {
-        command.transportConfigCallback = new TransportConfigCallback() {
-            @Override
-            void configure(Transport transport) {
-                SshTransport sshTransport = (SshTransport) transport
-                sshTransport.setSshSessionFactory(new SshConnector(identity))
-            }
-        }
+        command.transportConfigCallback = transportConfigFactory.create(identity)
     }
 
     @Override

src/main/groovy/pl/allegro/tech/build/axion/release/infrastructure/git/SimpleCredentialsProvider.groovy

@@ -0,0 +1,40 @@
+package pl.allegro.tech.build.axion.release.infrastructure.git
+
+import org.eclipse.jgit.errors.UnsupportedCredentialItem
+import org.eclipse.jgit.transport.CredentialItem
+import org.eclipse.jgit.transport.CredentialsProvider
+import org.eclipse.jgit.transport.URIish
+
+class SimpleCredentialsProvider extends CredentialsProvider {
+    
+    private final String username
+    
+    private final String password
+
+    SimpleCredentialsProvider(String username, String password) {
+        this.username = username
+        this.password = password
+    }
+
+    @Override
+    boolean isInteractive() {
+        return false
+    }
+
+    @Override
+    boolean supports(CredentialItem... items) {
+        items.every { it instanceof CredentialItem.Username || it instanceof CredentialItem.Password }
+    }
+
+    @Override
+    boolean get(URIish uri, CredentialItem... items) throws UnsupportedCredentialItem {
+        items.each {
+            if(it instanceof CredentialItem.Username) {
+                it.setValue(username)
+            }
+            else if (it instanceof CredentialItem.Password) {
+                it.setValue(password.toCharArray())
+            }
+        }
+    }
+}

src/main/groovy/pl/allegro/tech/build/axion/release/infrastructure/git/TransportConfigFactory.groovy

@@ -0,0 +1,37 @@
+package pl.allegro.tech.build.axion.release.infrastructure.git
+
+import org.eclipse.jgit.api.TransportConfigCallback
+import org.eclipse.jgit.transport.SshTransport
+import org.eclipse.jgit.transport.Transport
+import pl.allegro.tech.build.axion.release.domain.scm.ScmIdentity
+
+class TransportConfigFactory {
+
+    TransportConfigCallback create(ScmIdentity identity) {
+        if (identity.privateKeyBased) {
+            return createForSsh(identity)
+        } else if (identity.usernameBased) {
+            return createForUsername(identity)
+        }
+        throw new IllegalArgumentException("Transport callback can be created only for private key or username based identity")
+    }
+
+    private TransportConfigCallback createForSsh(ScmIdentity identity) {
+        return new TransportConfigCallback() {
+            @Override
+            void configure(Transport transport) {
+                SshTransport sshTransport = (SshTransport) transport
+                sshTransport.setSshSessionFactory(new SshConnector(identity))
+            }
+        }
+    }
+
+    private TransportConfigCallback createForUsername(ScmIdentity identity) {
+        return new TransportConfigCallback() {
+            @Override
+            void configure(Transport transport) {
+                transport.setCredentialsProvider(new SimpleCredentialsProvider(identity.username, identity.password))
+            }
+        }
+    }
+}

src/test/groovy/pl/allegro/tech/build/axion/release/domain/RepositoryConfigFactoryTest.groovy

@@ -27,6 +27,8 @@ class RepositoryConfigFactoryTest extends Specification {
         then:
         !config.customKeyPassword
         !config.customKey
+        !config.customUsername
+        config.customPassword == ''
     }
 
     def "should set authorization options when custom key and password provided"() {
@@ -80,5 +82,19 @@ class RepositoryConfigFactoryTest extends Specification {
         then:
         config.customKey == 'key'
     }
+    
+    def "should set username and password when provided via 'release.customUsername' and 'release.customPassword'"() {
+        given:
+        Project project = ProjectBuilder.builder().build()
+        project.extensions.extraProperties.set('release.customUsername', 'username')
+        project.extensions.extraProperties.set('release.customPassword', 'password')
+
+        when:
+        RepositoryConfig config = RepositoryConfigFactory.create(project)
+
+        then:
+        config.customUsername == 'username'
+        config.customPassword == 'password'
+    }
 
 }

src/test/groovy/pl/allegro/tech/build/axion/release/infrastructure/git/SimpleCredentialsProviderTest.groovy

@@ -0,0 +1,22 @@
+package pl.allegro.tech.build.axion.release.infrastructure.git
+
+import org.eclipse.jgit.transport.CredentialItem
+import spock.lang.Specification
+
+class SimpleCredentialsProviderTest extends Specification {
+    
+    def "should provide username and password"() {
+        given:
+        SimpleCredentialsProvider provider = new SimpleCredentialsProvider('username', 'password')
+        CredentialItem.Password passwordItem = new CredentialItem.Password('whatever')
+        CredentialItem.Username usernameItem = new CredentialItem.Username()
+        
+        when:
+        provider.get(null, passwordItem, usernameItem)
+
+        then:
+        usernameItem.value == 'username'
+        passwordItem.value == 'password'.toCharArray()
+    }
+    
+}