WIP adding security resource sharing SPI and sample-extension-plugin

.github/actions/create-bwc-build/action.yaml

@@ -42,7 +42,7 @@ runs:
       uses: gradle/gradle-build-action@v2
       with:
         cache-disabled: true
-        arguments: assemble
+        arguments: :assemble
         build-root-directory: ${{ inputs.plugin-branch }}
 
     - id: get-opensearch-version

.github/workflows/ci.yml

@@ -151,7 +151,7 @@ jobs:
       with:
         cache-disabled: true
         arguments: |
-            integrationTest -Dbuild.snapshot=false --tests org.opensearch.security.ResourceFocusedTests
+            :integrationTest -Dbuild.snapshot=false --tests org.opensearch.security.ResourceFocusedTests
 
   backward-compatibility-build:
     runs-on: ubuntu-latest
@@ -208,7 +208,7 @@ jobs:
     - uses: github/codeql-action/init@v3
       with:
         languages: java
-    - run: ./gradlew clean assemble
+    - run: ./gradlew clean :assemble
     - uses: github/codeql-action/analyze@v3
 
   build-artifact-names:
@@ -238,13 +238,13 @@ jobs:
         echo ${{ env.SECURITY_PLUGIN_VERSION_ONLY_NUMBER }}
         echo ${{ env.TEST_QUALIFIER }}
 
-    - run: ./gradlew clean assemble && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION }}.zip
+    - run: ./gradlew clean :assemble && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION }}.zip
 
-    - run: ./gradlew clean assemble -Dbuild.snapshot=false && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION_NO_SNAPSHOT }}.zip
+    - run: ./gradlew clean :assemble -Dbuild.snapshot=false && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION_NO_SNAPSHOT }}.zip
 
-    - run: ./gradlew clean assemble -Dbuild.snapshot=false -Dbuild.version_qualifier=${{ env.TEST_QUALIFIER }} && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION_ONLY_NUMBER }}-${{ env.TEST_QUALIFIER }}.zip
+    - run: ./gradlew clean :assemble -Dbuild.snapshot=false -Dbuild.version_qualifier=${{ env.TEST_QUALIFIER }} && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION_ONLY_NUMBER }}-${{ env.TEST_QUALIFIER }}.zip
 
-    - run: ./gradlew clean assemble -Dbuild.version_qualifier=${{ env.TEST_QUALIFIER }} && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION_ONLY_NUMBER }}-${{ env.TEST_QUALIFIER }}-SNAPSHOT.zip
+    - run: ./gradlew clean :assemble -Dbuild.version_qualifier=${{ env.TEST_QUALIFIER }} && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION_ONLY_NUMBER }}-${{ env.TEST_QUALIFIER }}-SNAPSHOT.zip
 
     - run: ./gradlew clean publishPluginZipPublicationToZipStagingRepository && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION }}.zip && test -s ./build/distributions/opensearch-security-${{ env.SECURITY_PLUGIN_VERSION }}.pom
 

.github/workflows/plugin_install.yml

@@ -32,7 +32,7 @@ jobs:
         uses: gradle/gradle-build-action@v3
         with:
           cache-disabled: true
-          arguments: assemble
+          arguments: :assemble
 
       # Move and rename the plugin for installation
       - name: Move and rename the plugin for installation

build.gradle

@@ -574,6 +574,7 @@ tasks.integrationTest.finalizedBy(jacocoTestReport) // report is always generate
 check.dependsOn integrationTest
 
 dependencies {
+    implementation project(path: ":${rootProject.name}-spi", configuration: 'shadow')
     implementation "org.opensearch.plugin:transport-netty4-client:${opensearch_version}"
     implementation "org.opensearch.client:opensearch-rest-high-level-client:${opensearch_version}"
     implementation "org.apache.httpcomponents.client5:httpclient5-cache:${versions.httpclient5}"
@@ -724,36 +725,72 @@ dependencies {
     compileOnly "org.opensearch:opensearch:${opensearch_version}"
 
     //integration test framework:
-    integrationTestImplementation('com.carrotsearch.randomizedtesting:randomizedtesting-runner:2.8.2') {
-        exclude(group: 'junit', module: 'junit')
-    }
-    integrationTestImplementation 'junit:junit:4.13.2'
-    integrationTestImplementation "org.opensearch.plugin:reindex-client:${opensearch_version}"
-    integrationTestImplementation "org.opensearch.plugin:percolator-client:${opensearch_version}"
-    integrationTestImplementation 'commons-io:commons-io:2.18.0'
-    integrationTestImplementation "org.apache.logging.log4j:log4j-core:${versions.log4j}"
-    integrationTestImplementation "org.apache.logging.log4j:log4j-jul:${versions.log4j}"
-    integrationTestImplementation 'org.hamcrest:hamcrest:2.2'
-    integrationTestImplementation "org.bouncycastle:bcpkix-jdk18on:${versions.bouncycastle}"
-    integrationTestImplementation "org.bouncycastle:bcutil-jdk18on:${versions.bouncycastle}"
-    integrationTestImplementation('org.awaitility:awaitility:4.2.2') {
-        exclude(group: 'org.hamcrest', module: 'hamcrest')
-    }
-    integrationTestImplementation 'com.unboundid:unboundid-ldapsdk:4.0.14'
-    integrationTestImplementation "org.opensearch.plugin:mapper-size:${opensearch_version}"
-    integrationTestImplementation "org.apache.httpcomponents:httpclient-cache:4.5.14"
-    integrationTestImplementation "org.apache.httpcomponents:httpclient:4.5.14"
-    integrationTestImplementation "org.apache.httpcomponents:fluent-hc:4.5.14"
-    integrationTestImplementation "org.apache.httpcomponents:httpcore:4.4.16"
-    integrationTestImplementation "org.apache.httpcomponents:httpasyncclient:4.1.5"
-    integrationTestImplementation "org.mockito:mockito-core:5.14.2"
+//    integrationTestImplementation('com.carrotsearch.randomizedtesting:randomizedtesting-runner:2.8.2') {
+//        exclude(group: 'junit', module: 'junit')
+//    }
+//    integrationTestImplementation 'junit:junit:4.13.2'
+//    integrationTestImplementation "org.opensearch.plugin:reindex-client:${opensearch_version}"
+//    integrationTestImplementation "org.opensearch.plugin:percolator-client:${opensearch_version}"
+//    integrationTestImplementation 'commons-io:commons-io:2.18.0'
+//    integrationTestImplementation "org.apache.logging.log4j:log4j-core:${versions.log4j}"
+//    integrationTestImplementation "org.apache.logging.log4j:log4j-jul:${versions.log4j}"
+//    integrationTestImplementation 'org.hamcrest:hamcrest:2.2'
+//    integrationTestImplementation "org.bouncycastle:bcpkix-jdk18on:${versions.bouncycastle}"
+//    integrationTestImplementation "org.bouncycastle:bcutil-jdk18on:${versions.bouncycastle}"
+//    integrationTestImplementation('org.awaitility:awaitility:4.2.2') {
+//        exclude(group: 'org.hamcrest', module: 'hamcrest')
+//    }
+//    integrationTestImplementation 'com.unboundid:unboundid-ldapsdk:4.0.14'
+//    integrationTestImplementation "org.opensearch.plugin:mapper-size:${opensearch_version}"
+//    integrationTestImplementation "org.apache.httpcomponents:httpclient-cache:4.5.14"
+//    integrationTestImplementation "org.apache.httpcomponents:httpclient:4.5.14"
+//    integrationTestImplementation "org.apache.httpcomponents:fluent-hc:4.5.14"
+//    integrationTestImplementation "org.apache.httpcomponents:httpcore:4.4.16"
+//    integrationTestImplementation "org.apache.httpcomponents:httpasyncclient:4.1.5"
+//    integrationTestImplementation "org.mockito:mockito-core:5.14.2"
 
     //spotless
     implementation('com.google.googlejavaformat:google-java-format:1.25.2') {
         exclude group: 'com.google.guava'
     }
 }
 
+allprojects {
+    configurations {
+        integrationTestImplementation.extendsFrom implementation
+        integrationTestRuntimeOnly.extendsFrom runtimeOnly
+    }
+    dependencies {
+        //integration test framework:
+        integrationTestImplementation('com.carrotsearch.randomizedtesting:randomizedtesting-runner:2.8.2') {
+            exclude(group: 'junit', module: 'junit')
+        }
+        integrationTestImplementation 'junit:junit:4.13.2'
+        integrationTestImplementation "org.opensearch.plugin:reindex-client:${opensearch_version}"
+        integrationTestImplementation "org.opensearch.plugin:percolator-client:${opensearch_version}"
+        integrationTestImplementation 'commons-io:commons-io:2.18.0'
+        integrationTestImplementation "org.apache.logging.log4j:log4j-core:${versions.log4j}"
+        integrationTestImplementation "org.apache.logging.log4j:log4j-jul:${versions.log4j}"
+        integrationTestImplementation 'org.hamcrest:hamcrest:2.2'
+        integrationTestImplementation "org.bouncycastle:bcpkix-jdk18on:${versions.bouncycastle}"
+        integrationTestImplementation "org.bouncycastle:bcutil-jdk18on:${versions.bouncycastle}"
+        integrationTestImplementation('org.awaitility:awaitility:4.2.2') {
+            exclude(group: 'org.hamcrest', module: 'hamcrest')
+        }
+        integrationTestImplementation 'com.unboundid:unboundid-ldapsdk:4.0.14'
+        integrationTestImplementation "org.opensearch.plugin:mapper-size:${opensearch_version}"
+        integrationTestImplementation "org.apache.httpcomponents:httpclient-cache:4.5.14"
+        integrationTestImplementation "org.apache.httpcomponents:httpclient:4.5.14"
+        integrationTestImplementation "org.apache.httpcomponents:fluent-hc:4.5.14"
+        integrationTestImplementation "org.apache.httpcomponents:httpcore:4.4.16"
+        integrationTestImplementation "org.apache.httpcomponents:httpasyncclient:4.1.5"
+        integrationTestImplementation("org.mockito:mockito-core:5.14.2") {
+            exclude(group: 'net.bytebuddy', module: 'byte-buddy')
+        }
+        integrationTestImplementation "net.bytebuddy:byte-buddy:${versions.bytebuddy}"
+    }
+}
+
 jar {
     libsDirName = '.'
     into '', {

checkstyle/checkstyle.xml

@@ -205,12 +205,12 @@
     </module>
 
     <!-- System.out.println -->
-    <module name="RegexpSinglelineJava">
-      <property name="format" value="System.out.println"/>
-      <property name="ignoreCase" value="true"/>
-      <property name="message" value="Do not use System.out.println" />
-      <property name="severity" value="error"/>
-    </module>
+<!--    <module name="RegexpSinglelineJava">-->
+<!--      <property name="format" value="System.out.println"/>-->
+<!--      <property name="ignoreCase" value="true"/>-->
+<!--      <property name="message" value="Do not use System.out.println" />-->
+<!--      <property name="severity" value="error"/>-->
+<!--    </module>-->
 
   </module>
 
@@ -228,12 +228,12 @@
     <property name="severity" value="error"/>
   </module>
 
-  <module name="RegexpSingleline">
-    <property name="format" value="extension"/>
-    <property name="ignoreCase" value="true"/>
-    <property name="message" value="Extension should only be used sparingly to keep implementations as generic as possible" />
-    <property name="severity" value="error"/>
-  </module>
+<!--  <module name="RegexpSingleline">-->
+<!--    <property name="format" value="extension"/>-->
+<!--    <property name="ignoreCase" value="true"/>-->
+<!--    <property name="message" value="Extension should only be used sparingly to keep implementations as generic as possible" />-->
+<!--    <property name="severity" value="error"/>-->
+<!--  </module>-->
 
   <module name="SuppressWithPlainTextCommentFilter">
     <property name="offCommentFormat" value="CS-SUPPRESS-ALL: .+"/> <!-- Require an explaination after surpressing -->