Merge pull request #347 from ysb33r/restructure-build

Restructure build

Author: rtyler

.gitignore

@@ -3,6 +3,9 @@ build/
 .ruby-*
 .gradle/
 *.iml
+*.ipr
+*.iws
 .idea
 .awestruct/
 out/
+.testconfig

HACKING.md

@@ -12,9 +12,11 @@ Please do not commit the config file back with DEBUG turned on.
 
 === Running single test suites
 
-If you only want to run the unittests in say `JRubyPlugin` then you can do `./gradlew test -Dtest.single=JRubyPlugin`.
-In a similar manner for integration tests one can do `./gradlew integrationTest -Dtest.single=JRubyIntegrationSpec`.
+If you only want to run the unittests in say `JRubyPlugin` then you can do `./gradlew test --tests JRubyPlugin`.
+In a similar manner for integration tests one can do `./gradlew integrationTest --tests JRubyIntegrationSpec`.
 
-== Release HOWTO
+=== Running tests in IntelliJ
 
-*TBC*
+Go to `File` -> `Settings` -> `Build, Execution, Deployment` -> `Gradle` -> `Runner`, then check `Delete build/run actions to Gradle` and select `Platform Test Runner`.
+
+On a Mac use `IntelliJ IDEA` -> `Preferences` instead of `File/Settings`.

jruby-gradle-base-plugin/README.adoc renamed to base-plugin/README.adoc

@@ -0,0 +1,149 @@
+
+// --- Could be in a separate gradle file
+configurations {
+    testJRubyPrepare
+}
+
+ext {
+    flatRepoDir = file("${buildDir}/tmp/integrationTest/flatRepo")
+
+    jrubyClassPathFromConfiguration = { Configuration cfg ->
+        def f = cfg.files.find { it.name.startsWith('jruby-complete-') }
+        return f?.absolutePath
+    }
+}
+
+project.afterEvaluate {
+    test {
+        systemProperties TEST_JRUBY_CLASSPATH: "${jrubyClassPathFromConfiguration(configurations.testJRubyPrepare)}"
+    }
+}
+
+// --- up to here
+
+ext {
+    olderJRubyVersion = '9.0.1.0'
+    slimVersion = '2.0.2'
+    leafyVersion = '0.4.0'
+}
+
+dependencies {
+
+    compile "org.eclipse.jetty:jetty-server:${jettyVersion}"
+    compile "org.eclipse.jetty:jetty-webapp:${jettyVersion}"
+    runtime('de.saumya.mojo:rubygems:0.2.3@war') {
+        // we just want the war file on the classloader for the application
+        // to find it and use the war-file from filesystem
+        exclude group: 'org.sonatype.nexus.plugins', module: 'nexus-ruby-tools'
+    }
+
+    testJRubyPrepare "org.jruby:jruby-complete:${jrubyVersion}"
+
+    testCompile(spockVersion) {
+        exclude module: 'groovy-all'
+    }
+
+    integrationTestCompile(spockVersion) {
+        exclude module: 'groovy-all'
+    }
+
+    // NOTE: This is used by JRubyPrepareGemsIntegrationSpec
+    integrationTestGems "rubygems:slim:${slimVersion}"
+
+    // NOTE: This is used by JRubyPrepareJarsIntegrationSpec
+    integrationTestGems "rubygems:leafy-complete:${leafyVersion}"
+
+    // NOTE: If you change this, you will also need to update JRubyExecIntegrationSpec & JRubyExecExtensionIntegrationSpec
+    integrationTestGems 'rubygems:credit_card_validator:1.1.0'
+
+    // NOTE: If you change this, you will also need to update JRubyExecIntegrationSpec
+    integrationTestGems 'rubygems:rspec:3.1.0'
+
+    // NOTE: This should always be an older older version. 
+    // It is used by JRubyExecIntegrationSpec
+    integrationTestGems "org.jruby:jruby-complete:${olderJRubyVersion}"
+
+    // NOTE: older jruby versions needs this for exec to work properly
+    integrationTestGems "rubygems:jar-dependencies:0.1.15"
+
+    // This is used by JRubyExecExtensionIntegrationSpec
+    integrationTestGems "org.bouncycastle:bcprov-jdk15on:${bcprovVersion}"
+
+    gradleTest "org.jruby:jruby-complete:${jrubyVersion}"
+    gradleTest 'rubygems:credit_card_validator:1.1.0'
+    gradleTest 'org.bouncycastle:bcprov-jdk15on:1.50'
+}
+
+generateTestConfig {
+    testProperties mavenrepo: file('src/integTest/mavenrepo').absolutePath,
+            flatrepo: flatRepoDir.absolutePath,
+            bcprovVersion: bcprovVersion,
+            olderJRubyVersion: olderJRubyVersion,
+            slimVersion: slimVersion,
+            leafyVersion: leafyVersion
+}
+
+task copyIntegrationTestJRuby(type: Copy) {
+    from({ configurations.testJRubyPrepare.files })
+    into new File(buildDir, 'tmp/integrationTest/flatRepo')
+}
+
+integrationTest {
+    if (gradle.startParameter.isOffline()) {
+        systemProperties 'TESTS_ARE_OFFLINE': '1'
+    }
+    dependsOn copyIntegrationTestJRuby
+}
+
+task installGroovyDoc(type: Copy) {
+    from({ new File(buildDir, 'docs/groovydoc') }) {
+        include '**'
+    }
+    into { new File(project.properties.jrubyGradleWebsiteInstallDir, "docs/api/${archivesBaseName}/${version}") }
+    onlyIf { project.hasProperty('jrubyGradleWebsiteInstallDir') }
+}
+
+
+publishing {
+    publications {
+        maven(MavenPublication) {
+//            groupId project.group
+//            artifactId project.archivesBaseName
+//            version project.version
+
+            artifact sourcesJar {
+                classifier "sources"
+            }
+
+            from components.java
+        }
+    }
+}
+
+bintray {
+    user = project.bintrayUser
+    key = project.bintrayKey
+    publish = true
+    dryRun = false
+    publications = ['maven']
+
+    pkg {
+        userOrg = 'jruby-gradle'
+        repo = 'plugins'
+        name = 'jruby-gradle-plugin'
+        labels = ['jruby']
+
+        version {
+            name = project.version
+            vcsTag = "v${project.version}"
+            attributes = ['gradle-plugin': 'com.github.jruby-gradle.base:com.github.jruby-gradle:jruby-gradle-plugin']
+            desc = 'The purpose of plugin is to encapsulate useful Gradle functionality for JRuby projects.'
+
+        }
+    }
+}
+bintrayUpload.dependsOn assemble
+
+gradleTest.mustRunAfter integrationTest
+// vim: ft=groovy
+

base-plugin/build.gradle

@@ -0,0 +1,176 @@
+package com.github.jrubygradle
+
+import com.github.jrubygradle.testhelper.IntegrationSpecification
+import org.gradle.testkit.runner.BuildResult
+import spock.lang.Shared
+
+/**
+ * @author Schalk W. Cronjé
+ */
+class JRubyExecExtensionIntegrationSpec extends IntegrationSpecification {
+
+    static final String DEFAULT_TASK_NAME = 'inlineJRubyExec'
+    static final String BCPROV_NAME = 'bcprov-jdk15on'
+
+    void "Run a script with minimum parameters"() {
+        setup:
+        useScript(HELLO_WORLD, 'src')
+        createJRubyExecProject """
+            script 'src/${HELLO_WORLD}'
+        """
+
+
+        when: "I call jrubyexec with only a script name"
+        BuildResult result = build()
+
+        then: "I expect the Ruby script to be executed"
+        result.output =~ /Hello, World/
+    }
+
+    void "Run an inline script"() {
+        setup:
+        createJRubyExecProject """
+            jrubyArgs '-e', "puts 'Hello, World'"
+        """
+
+        when: "I call jrubyexec with only script text"
+        BuildResult result = build()
+
+        then: "I expect the Ruby script to be executed"
+        result.output =~ /Hello, World/
+    }
+
+    void "Run a script with no subpath and arguments"() {
+        useScript(HELLO_NAME)
+        createJRubyExecProject """
+            script '${HELLO_NAME}'
+            scriptArgs 'Stan'
+        """
+
+        when:
+        BuildResult result = build()
+
+        then: "only the appropriate parameters should be passed"
+        result.output =~ /Hello, Stan/
+    }
+
+    void "Running a script that requires a jar"() {
+        setup:
+        def leadingDir = 'jrubyExec/jars/org/bouncycastle/'
+        def artifactPath = "${BCPROV_NAME}/${bcprovVer}/${BCPROV_NAME}-${bcprovVer}"
+        def withPattern = ~/.*\["file:.+${leadingDir}${artifactPath}\.jar"\].*/
+
+        def jarToUse = findDependency('org.bouncycastle', BCPROV_NAME, 'jar')
+        createJRubyExecProject withJarToUse(jarToUse), '''
+            jrubyArgs '-e'
+            jrubyArgs 'print $CLASSPATH'
+        '''
+
+        when:
+        BuildResult result = build()
+
+        then:
+        result.output.readLines().any { it.matches withPattern }
+    }
+
+    void "Running a script that requires a gem, a separate jRuby and a separate configuration"() {
+        setup:
+        useScript(REQUIRES_GEM)
+        createJRubyExecProject withCreditCardValidator(), """
+            script '${REQUIRES_GEM}'
+            jrubyArgs '-T1'
+        """
+
+        when:
+        BuildResult result = build()
+
+        then:
+        result.output =~ /Not valid/
+    }
+
+    void "Running a script that requires a gem, a separate jRuby, a separate configuration and a custom gemWorkDir"() {
+        setup:
+        final String customGemDir = 'customGemDir'
+        useScript(REQUIRES_GEM)
+        createJRubyExecProject withCreditCardValidator(), """
+            script '${REQUIRES_GEM}'
+            jrubyArgs '-T1'
+            gemWorkDir { new File(project.buildDir, '${customGemDir}' ) }
+        """
+
+        when:
+        BuildResult result = build()
+
+        then:
+        result.output =~ /Not valid/
+        new File(projectDir, "build/${customGemDir}").exists()
+    }
+
+    void "Running a script that requires environment variables"() {
+        // This tests that the passthrough invocation
+        // happens for overloaded versions of environment
+        // and that the environment variables are passed
+        // on to the script
+        setup:
+        final String envVarName = 'TEST_ENV_VAR'
+        final String envVarValue = 'Test Value'
+
+        useScript(ENV_VARS)
+        createJRubyExecProject """
+            environment    '${envVarName}', '${envVarValue}'
+            environment    TEST_A: 'A123', TEST_B: 'B123'
+            script         '${ENV_VARS}'
+        """
+
+        when:
+        BuildResult result = build()
+        String outputBuffer = result.output
+
+        then:
+        outputBuffer =~ /TEST_ENV_VAR=Test Value/
+        outputBuffer =~ /TEST_A=A123/
+        outputBuffer =~ /TEST_B=B123/
+    }
+
+    private BuildResult build() {
+        gradleRunner(DEFAULT_TASK_NAME, '-i').build()
+    }
+
+    private void createJRubyExecProject(String jrubyexecConfig) {
+        createJRubyExecProject('', jrubyexecConfig)
+    }
+
+    private void createJRubyExecProject(String preamble, String jrubyexecConfig) {
+        buildFile.text = """
+        ${projectWithLocalRepo}
+
+        ${preamble}
+
+        task ${DEFAULT_TASK_NAME} {
+            doLast {
+                jrubyexec {
+                    ${jrubyexecConfig}
+                }
+            }
+        }
+        """
+    }
+
+    private String withJarToUse(String jarFormat) {
+        String dependencies = """
+            dependencies {
+                jrubyExec ${jarFormat}
+            }
+        """
+    }
+
+    private String withCreditCardValidator() {
+        withJarToUse(findDependency('', 'credit_card_validator', 'gem'))
+    }
+
+    private String getBcprovVer() {
+        testProperties.bcprovVersion
+    }
+
+
+}