Initial support for ivy-publish and feature variants (capabilities)

linkedin · Mar 23, 2021 · 95ba811 · 95ba811
1 parent 8c69f45
commit 95ba811
Show file tree

Hide file tree

Showing 5 changed files with 389 additions and 0 deletions.
diff --git a/...oovy/com/linkedin/pegasus/gradle/publishing/PegasusPluginIvyPublishIntegrationTest.groovy b/...oovy/com/linkedin/pegasus/gradle/publishing/PegasusPluginIvyPublishIntegrationTest.groovy
@@ -0,0 +1,301 @@
+package com.linkedin.pegasus.gradle.publishing
+
+import org.gradle.testkit.runner.GradleRunner
+import org.gradle.testkit.runner.TaskOutcome
+import org.junit.Rule
+import org.junit.rules.TemporaryFolder
+import spock.lang.Specification
+
+import java.util.zip.ZipFile
+
+class PegasusPluginIvyPublishIntegrationTest extends Specification {
+
+  @Rule
+  TemporaryFolder grandparentProject
+
+  @Rule
+  TemporaryFolder parentProject
+
+  @Rule
+  TemporaryFolder childProject
+
+  @Rule
+  TemporaryFolder localRepo
+
+  URL localIvyRepo
+
+  def setup() {
+    localIvyRepo = localRepo.newFolder('local-ivy-repo').toURI().toURL()
+  }
+
+  def 'publishes and consumes dataTemplate configurations'() {
+    given:
+    def gradlePropertiesFile = grandparentProject.newFile('gradle.properties')
+    gradlePropertiesFile << '''
+    |group=com.linkedin.pegasus-grandparent-demo
+    |version=1.0.0
+    |'''.stripMargin()
+
+    def settingsFile = grandparentProject.newFile('settings.gradle')
+    settingsFile << "rootProject.name = 'grandparent'"
+
+    grandparentProject.newFile('build.gradle') << """
+    |plugins {
+    |  id 'ivy-publish'
+    |  id 'pegasus'
+    |}
+    |
+    |repositories {
+    |  mavenCentral()
+    |}
+    |
+    |dependencies {
+    |  dataTemplateCompile files(${System.getProperty('integTest.dataTemplateCompileDependencies')})
+    |  pegasusPlugin files(${System.getProperty('integTest.pegasusPluginDependencies')})
+    |}
+    |
+    |//tasks.withType(GenerateModuleMetadata) { enabled=false }
+    |
+    |//modern ivy-publish configuration
+    |publishing {
+    |  publications {
+    |    ivy(IvyPublication) {
+    |      from components.java
+    |    }
+    |  }
+    |  repositories {
+    |    ivy { url '$localIvyRepo' }
+    |  }
+    |}
+    """.stripMargin()
+
+    // Create a simple pdl schema, borrowed from restli-example-api
+    def schemaFilename = 'LatLong.pdl'
+    def grandparentPegasusDir = grandparentProject.newFolder('src', 'main', 'pegasus', 'com', 'linkedin', 'grandparent')
+    def grandparentPdlFile = new File("$grandparentPegasusDir.path$File.separator$schemaFilename")
+    grandparentPdlFile << '''namespace com.linkedin.grandparent
+      |
+      |record LatLong {
+      |  latitude: optional float
+      |  longitude: optional float
+      |}'''.stripMargin()
+
+    when:
+    def grandparentRunner = GradleRunner.create()
+        .withProjectDir(grandparentProject.root)
+        .withPluginClasspath()
+        .withArguments('publish', '-is') //uploadDataTemplate
+        .forwardOutput()
+        //.withDebug(true)
+
+    def grandparentResult = grandparentRunner.build()
+
+    then:
+    grandparentResult.task(':compileMainGeneratedDataTemplateJava').outcome == TaskOutcome.SUCCESS
+    grandparentResult.task(':generateDescriptorFileForIvyPublication').outcome == TaskOutcome.SUCCESS
+
+    def grandparentProjectIvyDescriptor = new File(localIvyRepo.path, 'com.linkedin.pegasus-grandparent-demo/grandparent/1.0.0/ivy-1.0.0.xml')
+    grandparentProjectIvyDescriptor.exists()
+    def grandparentProjectIvyDescriptorContents = grandparentProjectIvyDescriptor.text
+    def expectedGrandparentContents = new File(Thread.currentThread().contextClassLoader.getResource('ivy/modern/expectedGrandparentIvyDescriptorContents.txt').toURI()).text
+    grandparentProjectIvyDescriptorContents.contains expectedGrandparentContents
+
+    def grandparentProjectPrimaryArtifact = new File(localIvyRepo.path, 'com.linkedin.pegasus-grandparent-demo/grandparent/1.0.0/grandparent-1.0.0.jar')
+    grandparentProjectPrimaryArtifact.exists()
+    //NB note naming scheme of data-template jar changes when classifier, not appendix, is used
+    def grandparentProjectDataTemplateArtifact = new File(localIvyRepo.path, 'com.linkedin.pegasus-grandparent-demo/grandparent/1.0.0/grandparent-1.0.0-data-template.jar')
+    grandparentProjectDataTemplateArtifact.exists()
+
+    assertZipContains(grandparentProjectDataTemplateArtifact, 'com/linkedin/grandparent/LatLong.class')
+    assertZipContains(grandparentProjectDataTemplateArtifact, 'pegasus/com/linkedin/grandparent/LatLong.pdl')
+
+    when: 'a parent project consumes the grandparent project data-template jar'
+
+    gradlePropertiesFile = parentProject.newFile('gradle.properties')
+    gradlePropertiesFile << '''
+    |group=com.linkedin.pegasus-parent-demo
+    |version=1.0.0
+    |'''.stripMargin()
+
+    settingsFile = parentProject.newFile('settings.gradle')
+    settingsFile << "rootProject.name = 'parent'"
+
+    parentProject.newFile('build.gradle') << """
+    |plugins {
+    |  id 'ivy-publish'
+    |  id 'pegasus'
+    |}
+    |
+    |repositories {
+    |  ivy { url '$localIvyRepo' }
+    |  mavenCentral()
+    |}
+    |
+    |dependencies {
+    |  dataTemplateCompile files(${System.getProperty('integTest.dataTemplateCompileDependencies')})
+    |  pegasusPlugin files(${System.getProperty('integTest.pegasusPluginDependencies')})
+    |
+    |  //dataModel group: 'com.linkedin.pegasus-grandparent-demo', name: 'grandparent', version: '1.0.0', configuration: 'dataTemplate'
+    |  dataModel ('com.linkedin.pegasus-grandparent-demo:grandparent:1.0.0') {
+    |    capabilities {
+    |      requireCapability('com.linkedin.pegasus-grandparent-demo:grandparent-data-template:1.0.0') // TODO Gradle 6.0 requires an explicit version, 6.? does not
+    |    }
+    |  }
+    |}
+    |
+    |//tasks.withType(GenerateModuleMetadata) { enabled=false }
+    |
+    |//modern ivy-publish configuration
+    |publishing {
+    |  publications {
+    |    ivy(IvyPublication) {
+    |      from components.java
+    |    }
+    |  }
+    |  repositories {
+    |    ivy { url '$localIvyRepo' }
+    |  }
+    |}
+    """.stripMargin()
+
+    // Create a simple pdl schema which references a grandparent type
+    schemaFilename = 'EXIF.pdl'
+    def parentPegasusDir = parentProject.newFolder('src', 'main', 'pegasus', 'com', 'linkedin', 'parent')
+    def parentPdlFile = new File("$parentPegasusDir.path$File.separator$schemaFilename")
+    parentPdlFile << '''namespace com.linkedin.parent
+      |
+      |import com.linkedin.grandparent.LatLong
+      |
+      |record EXIF {
+      |  isFlash: optional boolean = true
+      |  location: optional LatLong
+      |}'''.stripMargin()
+
+    def parentRunner = GradleRunner.create()
+        .withProjectDir(parentProject.root)
+        .withPluginClasspath()
+        .withArguments('publish', '-is')
+        .forwardOutput()
+        //.withDebug(true)
+
+    def parentResult = parentRunner.build()
+
+    then:
+    parentResult.task(':compileMainGeneratedDataTemplateJava').outcome == TaskOutcome.SUCCESS
+    parentResult.task(':generateDescriptorFileForIvyPublication').outcome == TaskOutcome.SUCCESS
+
+    def parentProjectIvyDescriptor = new File(localIvyRepo.path, 'com.linkedin.pegasus-parent-demo/parent/1.0.0/ivy-1.0.0.xml')
+    parentProjectIvyDescriptor.exists()
+    def parentProjectIvyDescriptorContents = parentProjectIvyDescriptor.text
+    def expectedParentContents = new File(Thread.currentThread().contextClassLoader.getResource('ivy/modern/expectedParentIvyDescriptorContents.txt').toURI()).text
+    parentProjectIvyDescriptorContents.contains expectedParentContents
+
+    def parentProjectPrimaryArtifact = new File(localIvyRepo.path, 'com.linkedin.pegasus-parent-demo/parent/1.0.0/parent-1.0.0.jar')
+    parentProjectPrimaryArtifact.exists()
+    //NB note naming scheme of data-template jar changes when classifier, not appendix, is used
+    def parentProjectDataTemplateArtifact = new File(localIvyRepo.path, 'com.linkedin.pegasus-parent-demo/parent/1.0.0/parent-1.0.0-data-template.jar')
+    parentProjectDataTemplateArtifact.exists()
+
+    assertZipContains(parentProjectDataTemplateArtifact, 'com/linkedin/parent/EXIF.class')
+    assertZipContains(parentProjectDataTemplateArtifact, 'pegasus/com/linkedin/parent/EXIF.pdl')
+
+    when: 'a child project transitively consumes the grandparent project data-template jar'
+
+    gradlePropertiesFile = childProject.newFile('gradle.properties')
+    gradlePropertiesFile << '''
+    |group=com.linkedin.pegasus-child-demo
+    |version=1.0.0
+    |'''.stripMargin()
+
+    settingsFile = childProject.newFile('settings.gradle')
+    settingsFile << "rootProject.name = 'child'"
+
+    childProject.newFile('build.gradle') << """
+    |plugins {
+    |  id 'ivy-publish'
+    |  id 'pegasus'
+    |}
+    |
+    |repositories {
+    |  ivy { url '$localIvyRepo' }
+    |  mavenCentral()
+    |}
+    |
+    |dependencies {
+    |  dataTemplateCompile files(${System.getProperty('integTest.dataTemplateCompileDependencies')})
+    |  pegasusPlugin files(${System.getProperty('integTest.pegasusPluginDependencies')})
+    |
+    |  //dataModel group: 'com.linkedin.pegasus-parent-demo', name: 'parent', version: '1.0.0', configuration: 'dataTemplate'
+    |  dataModel ('com.linkedin.pegasus-parent-demo:parent:1.0.0') {
+    |    capabilities {
+    |      requireCapability('com.linkedin.pegasus-parent-demo:parent-data-template:1.0.0') // TODO Gradle 6.0 requires an explicit version, 6.? does not
+    |    }
+    |  }    
+    |}
+    |
+    |//tasks.withType(GenerateModuleMetadata) { enabled=false }
+    |
+    |//modern ivy-publish configuration
+    |publishing {
+    |  publications {
+    |    ivy(IvyPublication) {
+    |      from components.java
+    |    }
+    |  }
+    |  repositories {
+    |    ivy { url '$localIvyRepo' }
+    |  }
+    |}
+    """.stripMargin()
+
+    // Create a simple pdl schema which references parent and grandparent types
+    schemaFilename = 'Photo.pdl'
+    def childPegasusDir = childProject.newFolder('src', 'main', 'pegasus', 'com', 'linkedin', 'child')
+    def childPdlFile = new File("$childPegasusDir.path$File.separator$schemaFilename")
+    childPdlFile << '''namespace com.linkedin.child
+      |
+      |import com.linkedin.grandparent.LatLong
+      |import com.linkedin.parent.EXIF
+      |
+      |record Photo {
+      |  id: long
+      |  urn: string
+      |  title: string
+      |  exif: EXIF
+      |  backupLocation: optional LatLong
+      |}'''.stripMargin()
+
+    def childRunner = GradleRunner.create()
+        .withProjectDir(childProject.root)
+        .withPluginClasspath()
+        .withArguments('publish', '-is') //uploadDataTemplate
+        .forwardOutput()
+        .withDebug(true)
+
+    def childResult = childRunner.build()
+
+    then:
+    childResult.task(':compileMainGeneratedDataTemplateJava').outcome == TaskOutcome.SUCCESS
+    childResult.task(':generateDescriptorFileForIvyPublication').outcome == TaskOutcome.SUCCESS
+
+    def childProjectIvyDescriptor = new File(localIvyRepo.path, 'com.linkedin.pegasus-child-demo/child/1.0.0/ivy-1.0.0.xml')
+    childProjectIvyDescriptor.exists()
+    def childProjectIvyDescriptorContents = childProjectIvyDescriptor.text
+    def expectedChildContents = new File(Thread.currentThread().contextClassLoader.getResource('ivy/modern/expectedChildIvyDescriptorContents.txt').toURI()).text
+    childProjectIvyDescriptorContents.contains expectedChildContents
+
+    def childProjectPrimaryArtifact = new File(localIvyRepo.path, 'com.linkedin.pegasus-child-demo/child/1.0.0/child-1.0.0.jar')
+    childProjectPrimaryArtifact.exists()
+    //NB note naming scheme of data-template jar changes when classifier, not appendix, is used
+    def childProjectDataTemplateArtifact = new File(localIvyRepo.path, 'com.linkedin.pegasus-child-demo/child/1.0.0/child-1.0.0-data-template.jar')
+    childProjectDataTemplateArtifact.exists()
+
+    assertZipContains(childProjectDataTemplateArtifact, 'com/linkedin/child/Photo.class')
+    assertZipContains(childProjectDataTemplateArtifact, 'pegasus/com/linkedin/child/Photo.pdl')
+  }
+
+  private static boolean assertZipContains(File zip, String path) {
+    return new ZipFile(zip).getEntry(path)
+  }
+
+}
diff --git a/gradle-plugins/src/integTest/resources/ivy/modern/expectedChildIvyDescriptorContents.txt b/gradle-plugins/src/integTest/resources/ivy/modern/expectedChildIvyDescriptorContents.txt
@@ -0,0 +1,21 @@
+  <configurations>
+    <conf name="compile" visibility="public"/>
+    <conf name="default" visibility="public" extends="runtime"/>
+    <conf name="mainGeneratedDataTemplateApiElements" visibility="public"/>
+    <conf name="mainGeneratedDataTemplateRuntimeElements" visibility="public"/>
+    <conf name="runtime" visibility="public"/>
+  </configurations>
+  <publications>
+    <artifact name="child" type="jar" ext="jar" conf="compile,runtime"/>
+    <artifact name="child" type="jar" ext="jar" conf="mainGeneratedDataTemplateApiElements,mainGeneratedDataTemplateRuntimeElements" m:classifier="data-template"/>
+  </publications>
+  <dependencies>
+    <dependency org="com.linkedin.pegasus-parent-demo" name="parent" rev="1.0.0" conf="compile-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="compile-&gt;default"/>
+    <dependency org="com.linkedin.pegasus-parent-demo" name="parent" rev="1.0.0" conf="runtime-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="runtime-&gt;default"/>
+    <dependency org="com.linkedin.pegasus-parent-demo" name="parent" rev="1.0.0" conf="mainGeneratedDataTemplateApiElements-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="mainGeneratedDataTemplateApiElements-&gt;default"/>
+    <dependency org="com.linkedin.pegasus-parent-demo" name="parent" rev="1.0.0" conf="mainGeneratedDataTemplateRuntimeElements-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="mainGeneratedDataTemplateRuntimeElements-&gt;default"/>
+  </dependencies>
diff --git a/...e-plugins/src/integTest/resources/ivy/modern/expectedGrandparentIvyDescriptorContents.txt b/...e-plugins/src/integTest/resources/ivy/modern/expectedGrandparentIvyDescriptorContents.txt
@@ -0,0 +1,17 @@
+  <configurations>
+    <conf name="compile" visibility="public"/>
+    <conf name="default" visibility="public" extends="runtime"/>
+    <conf name="mainGeneratedDataTemplateApiElements" visibility="public"/>
+    <conf name="mainGeneratedDataTemplateRuntimeElements" visibility="public"/>
+    <conf name="runtime" visibility="public"/>
+  </configurations>
+  <publications>
+    <artifact name="grandparent" type="jar" ext="jar" conf="compile,runtime"/>
+    <artifact name="grandparent" type="jar" ext="jar" conf="mainGeneratedDataTemplateApiElements,mainGeneratedDataTemplateRuntimeElements" m:classifier="data-template"/>
+  </publications>
+  <dependencies>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="compile-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="runtime-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="mainGeneratedDataTemplateApiElements-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="mainGeneratedDataTemplateRuntimeElements-&gt;default"/>
+  </dependencies>
diff --git a/gradle-plugins/src/integTest/resources/ivy/modern/expectedParentIvyDescriptorContents.txt b/gradle-plugins/src/integTest/resources/ivy/modern/expectedParentIvyDescriptorContents.txt
@@ -0,0 +1,21 @@
+  <configurations>
+    <conf name="compile" visibility="public"/>
+    <conf name="default" visibility="public" extends="runtime"/>
+    <conf name="mainGeneratedDataTemplateApiElements" visibility="public"/>
+    <conf name="mainGeneratedDataTemplateRuntimeElements" visibility="public"/>
+    <conf name="runtime" visibility="public"/>
+  </configurations>
+  <publications>
+    <artifact name="parent" type="jar" ext="jar" conf="compile,runtime"/>
+    <artifact name="parent" type="jar" ext="jar" conf="mainGeneratedDataTemplateApiElements,mainGeneratedDataTemplateRuntimeElements" m:classifier="data-template"/>
+  </publications>
+  <dependencies>
+    <dependency org="com.linkedin.pegasus-grandparent-demo" name="grandparent" rev="1.0.0" conf="compile-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="compile-&gt;default"/>
+    <dependency org="com.linkedin.pegasus-grandparent-demo" name="grandparent" rev="1.0.0" conf="runtime-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="runtime-&gt;default"/>
+    <dependency org="com.linkedin.pegasus-grandparent-demo" name="grandparent" rev="1.0.0" conf="mainGeneratedDataTemplateApiElements-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="mainGeneratedDataTemplateApiElements-&gt;default"/>
+    <dependency org="com.linkedin.pegasus-grandparent-demo" name="grandparent" rev="1.0.0" conf="mainGeneratedDataTemplateRuntimeElements-&gt;default"/>
+    <dependency org="com.google.code.findbugs" name="jsr305" rev="3.0.2" conf="mainGeneratedDataTemplateRuntimeElements-&gt;default"/>
+  </dependencies>