Merge pull request #19 from EMCECS/ObjectScale-refactor

Modularization for ObjectScale

Author: twincitiesguy

build.gradle

@@ -24,22 +24,18 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
+import com.github.jk1.license.render.InventoryHtmlReportRenderer
+
 plugins {
     id 'idea'
     id 'eclipse'
     id 'java'
-    id 'java-library'
-    id 'net.saliman.cobertura' version '3.0.0'
-    id 'distribution'
-    id 'signing'
-    id 'maven'
+    id 'net.saliman.cobertura' version '3.0.0' apply false
+    id 'com.github.jk1.dependency-license-report' version '1.14' apply false
     id 'org.ajoberstar.git-publish' version '3.0.0'
     id 'nebula.release' version '15.2.0'
 }
 
-group 'com.emc.ecs'
-description = 'Smart REST Client - JAX-RS (Jersey) REST client that provides client-side load balancing with a pluggable host list provider'
-
 // name of the github project repository
 ext.githubProjectName = 'smart-client-java'
 // URL to github project
@@ -52,149 +48,168 @@ ext.githubRemoteUrl = "https://github.com/EMCECS/${githubProjectName}.git"
 ext.licenseName = 'The BSD 3-Clause License'
 ext.licenseUrl = 'https://opensource.org/licenses/BSD-3-Clause'
 
-defaultTasks 'distZip'
+subprojects {
+    apply plugin: 'java-library'
+    apply plugin: 'net.saliman.cobertura'
+    apply plugin: 'com.github.jk1.dependency-license-report'
+    apply plugin: 'distribution'
+    apply plugin: 'signing'
+    apply plugin: 'maven'
 
-repositories {
-    mavenCentral()
-}
+    group 'com.emc.ecs'
 
-dependencies {
-    implementation 'com.sun.jersey:jersey-client:1.19.4'
-    implementation 'com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:2.12.4'
-    implementation 'com.fasterxml.jackson.module:jackson-module-jaxb-annotations:2.12.4'
-    implementation 'org.apache.httpcomponents:httpclient:4.5.13'
-    implementation 'org.slf4j:slf4j-api:1.7.32'
-    implementation('com.sun.jersey:jersey-json:1.19.4') {
-        exclude group: 'org.codehaus.jackson'
+    defaultTasks 'distZip'
+
+    repositories {
+        mavenCentral()
+        mavenLocal()
     }
-    implementation 'com.sun.jersey.contribs:jersey-apache-client4:1.19.4'
-    testImplementation 'junit:junit:4.13.2'
-    testImplementation 'org.slf4j:slf4j-log4j12:1.7.32'
-    testRuntimeOnly 'org.slf4j:jcl-over-slf4j:1.7.32'
-}
 
-allprojects {
     configurations {
-        tools // specifies tool artifacts for the distribution (placed in the tools/ directory)
+        jars.extendsFrom(signatures)
     }
-}
-
-configurations {
-    jars.extendsFrom(signatures)
-}
 
-[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
+    [compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
 
-compileJava {
-    sourceCompatibility = 1.8
-    targetCompatibility = 1.8
-}
-
-def projectPom = {
-    project {
-        name project.name
-        description project.description
-        url githubProjectUrl
+    compileJava {
+        sourceCompatibility = 1.8
+        targetCompatibility = 1.8
+    }
 
-        scm {
+    def projectPom = {
+        project {
+            name project.name
+            description project.description
             url githubProjectUrl
-            connection githubScmUrl
-            developerConnection githubScmUrl
-        }
 
-        licenses {
-            license {
-                name licenseName
-                url licenseUrl
-                distribution 'repo'
+            scm {
+                url githubProjectUrl
+                connection githubScmUrl
+                developerConnection githubScmUrl
+            }
+
+            licenses {
+                license {
+                    name licenseName
+                    url licenseUrl
+                    distribution 'repo'
+                }
             }
-        }
 
-        developers {
-            developer {
-                id 'EMCECS'
-                name 'Dell EMC ECS'
+            developers {
+                developer {
+                    id 'EMCECS'
+                    name 'Dell EMC ECS'
+                }
             }
         }
     }
-}
 
-task writePom {
-    ext.pomFile = file("$buildDir/pom.xml")
-    outputs.file pomFile
-    doLast {
-        pom(projectPom).writeTo pomFile
+    task writePom {
+        ext.pomFile = file("$buildDir/pom.xml")
+        outputs.file pomFile
+        doLast {
+            pom(projectPom).writeTo pomFile
+        }
     }
-}
 
-jar {
-    doFirst {
-        manifest {
-            attributes 'Implementation-Version': project.version,
-                    'Class-Path': configurations.runtime.collect { it.getName() }.join(' ')
+    jar {
+        doFirst {
+            manifest {
+                attributes 'Implementation-Version': project.version,
+                        'Class-Path': configurations.runtime.collect { it.getName() }.join(' ')
+            }
+        }
+        into("META-INF/maven/$project.group/$project.name") {
+            from writePom
         }
     }
-    into("META-INF/maven/$project.group/$project.name") {
-        from writePom
+
+    javadoc {
+        options.addStringOption('Xdoclint:none', '-quiet')
     }
-}
 
-javadoc {
-    options.addStringOption('Xdoclint:none', '-quiet')
-}
+    task javadocJar(type: Jar) {
+        archiveClassifier = 'javadoc'
+        from "${docsDir}/javadoc"
+    }
+    tasks.javadocJar.dependsOn javadoc
 
-task javadocJar(type: Jar) {
-    archiveClassifier = 'javadoc'
-    from "${docsDir}/javadoc"
-}
-tasks.javadocJar.dependsOn javadoc
+    task sourcesJar(type: Jar) {
+        archiveClassifier = 'sources'
+        from sourceSets.main.allSource
+    }
 
-task sourcesJar(type: Jar) {
-    archiveClassifier = 'sources'
-    from sourceSets.main.allSource
-}
+    artifacts {
+        jars jar
+        jars javadocJar
+        jars sourcesJar
+    }
 
-artifacts {
-    jars jar
-    jars javadocJar
-    jars sourcesJar
-}
+    // remove zips and tars from "install" task
+    configurations.archives.artifacts.removeAll {it.file =~ /(zip|tar)$/}
 
-distributions {
-    main {
-        contents {
-            from configurations.jars.artifacts.files
-            into('tools') {
-                from { allprojects.configurations.tools.artifacts.files }
-            }
-            from('.') {
-                include '*.txt'
-            }
-            into('3rd-party-licenses') {
-                from '3rd-party-licenses'
-            }
-            into('lib') {
-                from configurations.runtimeClasspath
+    licenseReport {
+        renderers = [new InventoryHtmlReportRenderer()]
+    }
+
+    distributions {
+        main {
+            contents {
+                from configurations.jars.artifacts.files
+                from('.') {
+                    include '*.txt'
+                }
+                into('3rd-party-licenses') {
+                    from generateLicenseReport
+                }
+                into('lib') {
+                    from configurations.runtimeClasspath
+                }
             }
         }
     }
-}
 
-signing {
-    required { gradle.taskGraph.hasTask(':uploadJars') }
-    sign configurations.jars
-}
+    signing {
+        required { gradle.taskGraph.hasTask(uploadJars) }
+        sign configurations.jars
+    }
 
-uploadJars {
-    repositories {
-        mavenDeployer {
-            beforeDeployment { deployment -> signing.signPom(deployment) }
+    uploadJars {
+        repositories {
+            mavenDeployer {
+                beforeDeployment { deployment -> signing.signPom(deployment) }
+
+                repository(url: 'https://oss.sonatype.org/service/local/staging/deploy/maven2/') {
+                    authentication(userName: '', password: '')
+                }
 
-            repository(url: 'https://oss.sonatype.org/service/local/staging/deploy/maven2/') {
-                authentication(userName: '', password: '')
+                pom projectPom
             }
+        }
+    }
 
-            pom projectPom
+    // allow typing in credentials
+    // note: this only works when run without the Gradle daemon (--no-daemon).
+    //       if that's not possible, it's best to read passwords into env. variables and set these properties on the gradle
+    //       command line ( -PsigningPass="${SIGNING_PASS}" -PsonatypePass="${SONATYPE_PASS}" )
+    gradle.taskGraph.whenReady { taskGraph ->
+        if (taskGraph.hasTask(uploadJars)) {
+            if (!rootProject.hasProperty('signingSecretKeyRingFile'))
+                rootProject.ext.signingSecretKeyRingFile = new String(System.console().readLine('\nSecret key ring file: '))
+            if (!rootProject.hasProperty('signingKeyId'))
+                rootProject.ext.signingKeyId = new String(System.console().readLine('\nSigning key id: '))
+            if (!rootProject.hasProperty('signingPass'))
+                rootProject.ext.signingPass = new String(System.console().readPassword('\nSigning key passphrase: '))
+            if (!rootProject.hasProperty('sonatypeUser'))
+                rootProject.ext.sonatypeUser = new String(System.console().readLine('\nSonatype username: '))
+            if (!rootProject.hasProperty('sonatypePass'))
+                rootProject.ext.sonatypePass = new String(System.console().readPassword('\nSonatype password: '))
+            ext.'signing.keyId' = rootProject.ext.signingKeyId
+            ext.'signing.secretKeyRingFile' = rootProject.ext.signingSecretKeyRingFile
+            ext.'signing.password' = rootProject.ext.signingPass
+            uploadJars.repositories.mavenDeployer.repository.authentication.userName = rootProject.ext.sonatypeUser
+            uploadJars.repositories.mavenDeployer.repository.authentication.password = rootProject.ext.sonatypePass
         }
     }
 }
@@ -203,18 +218,22 @@ ext.aggregatedDocsDir = "$buildDir/aggregatedDocs"
 task aggregateDocs {
     doLast {
         if (project.hasProperty('release.stage') && project.ext['release.stage'] == 'final') {
-            copy {
-                from docsDir
-                into "${aggregatedDocsDir}/latest"
+            subprojects.each { sp ->
+                copy {
+                    from sp.docsDir
+                    into "${aggregatedDocsDir}/${sp.name}/latest"
+                }
             }
         }
-        copy {
-            from docsDir
-            into "${aggregatedDocsDir}/${project.version}"
+        subprojects.each {sp ->
+            copy {
+                from sp.docsDir
+                into "${aggregatedDocsDir}/${sp.name}/${sp.version}"
+            }
         }
     }
 }
-tasks.aggregateDocs.dependsOn javadoc
+tasks.aggregateDocs.dependsOn subprojects.javadoc
 
 gitPublish {
     repoUri = githubRemoteUrl
@@ -226,32 +245,17 @@ gitPublish {
 }
 tasks.gitPublishPush.dependsOn aggregateDocs
 
-tasks.release.dependsOn test, uploadJars, gitPublishPush, distZip
+tasks.release.dependsOn subprojects.test, subprojects.uploadJars, gitPublishPush, subprojects.distZip
 
 clean {
     delete aggregatedDocsDir
 }
 
 // allow typing in credentials
-// note: this only works when run without the Gradle daemon (--no-daemon)
+// note: this only works when run without the Gradle daemon (--no-daemon).
+//       if that's not possible, it's best to read passwords into env. variables and set these properties on the gradle
+//       command line ( -PgitPassword="${GIT_PASSWORD}" )
 gradle.taskGraph.whenReady { taskGraph ->
-    if (taskGraph.hasTask(':uploadJars')) {
-        if (!rootProject.hasProperty('signingSecretKeyRingFile'))
-            rootProject.ext.signingSecretKeyRingFile = new String(System.console().readLine('\nSecret key ring file: '))
-        if (!rootProject.hasProperty('signingKeyId'))
-            rootProject.ext.signingKeyId = new String(System.console().readLine('\nSigning key id: '))
-        if (!rootProject.hasProperty('signingPass'))
-            rootProject.ext.signingPass = new String(System.console().readPassword('\nSigning key passphrase: '))
-        if (!rootProject.hasProperty('sonatypeUser'))
-            rootProject.ext.sonatypeUser = new String(System.console().readLine('\nSonatype username: '))
-        if (!rootProject.hasProperty('sonatypePass'))
-            rootProject.ext.sonatypePass = new String(System.console().readPassword('\nSonatype password: '))
-        ext.'signing.keyId' = rootProject.ext.signingKeyId
-        ext.'signing.secretKeyRingFile' = rootProject.ext.signingSecretKeyRingFile
-        ext.'signing.password' = rootProject.ext.signingPass
-        uploadJars.repositories.mavenDeployer.repository.authentication.userName = rootProject.ext.sonatypeUser
-        uploadJars.repositories.mavenDeployer.repository.authentication.password = rootProject.ext.sonatypePass
-    }
     if (taskGraph.hasTask(':gitPublishPush') || taskGraph.hasTask(':release')) {
         if (!rootProject.hasProperty('gitUsername'))
             rootProject.ext.gitUsername = new String(System.console().readLine('\nGit username: '))

settings.gradle

@@ -1 +1,5 @@
 rootProject.name = 'smart-client'
+include 'smart-client-core'
+include 'smart-client-jersey'
+include 'smart-client-ecs'
+

smart-client-core/build.gradle

@@ -0,0 +1,12 @@
+description = 'Smart Client core components - This library has minimal dependencies and provides the core generic logic necesary for client-side intelligent load balancing'
+
+dependencies {
+    implementation 'org.slf4j:slf4j-api:1.7.32'
+
+    testImplementation 'junit:junit:4.13.2'
+    testImplementation 'log4j:log4j:1.2.17'
+}
+
+test {
+    useJUnit()
+}