XEN-3141: Support Elastic

.github/workflows/ci.yml

@@ -3,15 +3,21 @@ name: CI
 on:
   push:
   pull_request:
+env:
+  GRADLE_OPTS: >-
+    -Dorg.gradle.project.org.alfresco.maven.nexus.username=${{ secrets.ALFRESCO_NEXUS_USERNAME }} 
+    -Dorg.gradle.project.org.alfresco.maven.nexus.password=${{ secrets.ALFRESCO_NEXUS_PASSWORD }}
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-java@v4
+      - name: Setup Java
+        uses: actions/setup-java@v4
         with:
           java-version: 17
           distribution: temurin
@@ -27,41 +33,48 @@ jobs:
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
           GITHUB_TOKEN: ${{ github.token }}
-        run: ./gradlew aggregateJacocoReport sonarqube
-      - name: Javadoc
-        run: ./gradlew javadoc
+        run: ./gradlew aggregateJacocoReport sonar --stacktrace
   integration-test:
     runs-on: ubuntu-latest
     if: ${{ github.ref == 'refs/heads/master' || github.base_ref == 'master' || startsWith(github.ref, 'refs/tags/') }}
     strategy:
       matrix:
-        flavour: [ "community" ]
-        version: [ "231" ]
+        edition: [ "community-231", "enterprise-251" ]
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-java@v4
+      - name: Setup Java
+        uses: actions/setup-java@v4
         with:
           java-version: 17
           distribution: temurin
+      - name: Login to quay.io
+        uses: docker/login-action@v3
+        with:
+          registry: quay.io
+          username: ${{ secrets.QUAY_IO_USERNAME }}
+          password: ${{ secrets.QUAY_IO_PASSWORD }}
       - name: Test
-        run: ./gradlew :integration-tests:alfresco-${{ matrix.flavour }}-${{ matrix.version }}:integrationTest -Prandom_ports=true
+        run: ./gradlew :integration-tests:alfresco-${{ matrix.edition }}:integrationTest -Prandom_ports=true
       - name: Upload reports
         if: ${{ failure() }}
         uses: actions/upload-artifact@v4
         with:
-          name: reports-integration-test-${{ matrix.flavour }}-${{ matrix.version }}
-          path: integration-tests/alfresco-${{ matrix.flavour }}-${{ matrix.version }}/build/reports
+          name: reports-integration-test-${{ matrix.edition }}
+          path: integration-tests/alfresco-${{ matrix.edition }}/build/reports
   publish:
     needs: [test, integration-test]
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/') }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-java@v4
+      - name: Setup Java
+        uses: actions/setup-java@v4
         with:
           java-version: 17
           distribution: temurin

.github/workflows/common-setup.yml

@@ -0,0 +1,19 @@
+name: Common Setup
+
+on:
+  workflow_call:
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: temurin

.gitignore

@@ -11,6 +11,7 @@
 .classpath
 .project
 .settings/
+bin/
 
 ### Gradle ###
 

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/plugins/api/HealthProcessorPlugin.java → alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/checker/api/HealthProcessorPlugin.java

@@ -1,4 +1,4 @@
-package eu.xenit.alfresco.healthprocessor.plugins.api;
+package eu.xenit.alfresco.healthprocessor.checker.api;
 
 import eu.xenit.alfresco.healthprocessor.extensibility.BaseExtension;
 import eu.xenit.alfresco.healthprocessor.reporter.api.NodeHealthReport;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/plugins/api/SingleNodeHealthProcessorPlugin.java → alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/checker/api/SingleNodeHealthProcessorPlugin.java

@@ -1,4 +1,4 @@
-package eu.xenit.alfresco.healthprocessor.plugins.api;
+package eu.xenit.alfresco.healthprocessor.checker.api;
 
 import eu.xenit.alfresco.healthprocessor.reporter.api.NodeHealthReport;
 import java.util.HashSet;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/plugins/api/ToggleableHealthProcessorPlugin.java → alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/checker/api/ToggleableHealthProcessorPlugin.java

@@ -1,4 +1,4 @@
-package eu.xenit.alfresco.healthprocessor.plugins.api;
+package eu.xenit.alfresco.healthprocessor.checker.api;
 
 import eu.xenit.alfresco.healthprocessor.fixer.api.HealthFixerPlugin;
 import eu.xenit.alfresco.healthprocessor.reporter.api.NodeHealthReport;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/plugins/api/package-info.java → alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/checker/api/package-info.java

@@ -1,4 +1,4 @@
 /**
  * API for the Health-Processor health checker extensions
  */
-package eu.xenit.alfresco.healthprocessor.plugins.api;
+package eu.xenit.alfresco.healthprocessor.checker.api;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/extensibility/annotations/ExtensionType.java

@@ -1,8 +1,8 @@
 package eu.xenit.alfresco.healthprocessor.extensibility.annotations;
 
+import eu.xenit.alfresco.healthprocessor.checker.api.HealthProcessorPlugin;
 import eu.xenit.alfresco.healthprocessor.extensibility.BaseExtension;
 import eu.xenit.alfresco.healthprocessor.fixer.api.HealthFixerPlugin;
-import eu.xenit.alfresco.healthprocessor.plugins.api.HealthProcessorPlugin;
 import eu.xenit.alfresco.healthprocessor.reporter.api.HealthReporter;
 import lombok.AllArgsConstructor;
 import lombok.Getter;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/extensibility/annotations/InternalUseOnly.java

@@ -2,8 +2,6 @@
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/extensibility/annotations/NotForUseIn.java

@@ -2,8 +2,6 @@
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/extensibility/annotations/OnlyForUseIn.java

@@ -2,8 +2,6 @@
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/fixer/api/HealthFixerPlugin.java

@@ -1,7 +1,7 @@
 package eu.xenit.alfresco.healthprocessor.fixer.api;
 
+import eu.xenit.alfresco.healthprocessor.checker.api.HealthProcessorPlugin;
 import eu.xenit.alfresco.healthprocessor.extensibility.BaseExtension;
-import eu.xenit.alfresco.healthprocessor.plugins.api.HealthProcessorPlugin;
 import eu.xenit.alfresco.healthprocessor.reporter.api.NodeHealthReport;
 import java.util.Set;
 import javax.annotation.Nonnull;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/reporter/api/DisabledHealthReporter.java

@@ -1,9 +1,10 @@
 package eu.xenit.alfresco.healthprocessor.reporter.api;
 
-import eu.xenit.alfresco.healthprocessor.plugins.api.HealthProcessorPlugin;
 import java.util.Set;
 import javax.annotation.Nonnull;
 
+import eu.xenit.alfresco.healthprocessor.checker.api.HealthProcessorPlugin;
+
 final class DisabledHealthReporter implements HealthReporter {
 
     private static class DisabledHealthReporterHolder {

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/reporter/api/HealthReporter.java

@@ -1,7 +1,8 @@
 package eu.xenit.alfresco.healthprocessor.reporter.api;
 
+import eu.xenit.alfresco.healthprocessor.checker.api.HealthProcessorPlugin;
 import eu.xenit.alfresco.healthprocessor.extensibility.BaseExtension;
-import eu.xenit.alfresco.healthprocessor.plugins.api.HealthProcessorPlugin;
+
 import java.util.List;
 import java.util.Set;
 import javax.annotation.Nonnull;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/reporter/api/NodeHealthReport.java

@@ -42,6 +42,8 @@
 @AllArgsConstructor(access = AccessLevel.PRIVATE)
 public class NodeHealthReport implements Serializable {
 
+    private static final long serialVersionUID = -939101152283421058L;
+
     NodeHealthStatus status;
     NodeRef nodeRef;
     Set<String> messages;

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/reporter/api/ProcessorPluginOverview.java

@@ -1,9 +1,10 @@
 package eu.xenit.alfresco.healthprocessor.reporter.api;
 
-import eu.xenit.alfresco.healthprocessor.plugins.api.HealthProcessorPlugin;
 import java.util.List;
 import java.util.Map;
 import javax.annotation.Nonnull;
+
+import eu.xenit.alfresco.healthprocessor.checker.api.HealthProcessorPlugin;
 import lombok.Value;
 
 /**

alfresco-health-processor-api/src/main/java/eu/xenit/alfresco/healthprocessor/reporter/api/SingleReportHealthReporter.java

@@ -1,11 +1,12 @@
 package eu.xenit.alfresco.healthprocessor.reporter.api;
 
-import eu.xenit.alfresco.healthprocessor.plugins.api.HealthProcessorPlugin;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Set;
 import javax.annotation.Nonnull;
 
+import eu.xenit.alfresco.healthprocessor.checker.api.HealthProcessorPlugin;
+
 /**
  * Health reporter that divides a batch into individual calls.
  *

alfresco-health-processor-platform/build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'eu.xenit.amp'
 }
 
-description = "Alfresco Repository module for ${rootProject.description}"
+description = "Alfresco Health Processor (Repository module)"
 
 java {
     withJavadocJar()
@@ -50,6 +50,8 @@ amp {
     libs = jar.outputs.files + configurations.runtimeClasspath - configurations.alfrescoProvided
 }
 
+testAmp { enabled = false }
+
 apply from: "${rootDir}/gradle/publish.gradle"
 
 publishing {

alfresco-health-processor-platform/src/main/amp/config/alfresco/module/alfresco-health-processor/alfresco-global.properties

@@ -6,5 +6,6 @@ cache.healthProcessorSharedCache.maxIdleSeconds=0
 cache.healthProcessorSharedCache.eviction-policy=NONE
 cache.healthProcessorSharedCache.cluster.type=fully-distributed
 cache.healthProcessorSharedCache.backup-count=1
-cache.healthProcessorSharedCache.merge-policy=com.hazelcast.map.merge.LatestUpdateMapMergePolicy
+# Alfresco supports policy names with "hz." prefix to bridge API/version differences
+cache.healthProcessorSharedCache.merge-policy=hz.LATEST_UPDATE
 cache.healthProcessorSharedCache.readBackupData=false

alfresco-health-processor-platform/src/main/amp/config/alfresco/module/alfresco-health-processor/log4j.properties

@@ -1,6 +1,6 @@
 log4j.logger.eu.xenit.alfresco.healthprocessor=INFO
 log4j.logger.eu.xenit.alfresco.healthprocessor.indexing=INHERITED
 log4j.logger.eu.xenit.alfresco.healthprocessor.fixer=INHERITED
-log4j.logger.eu.xenit.alfresco.healthprocessor.plugins=INHERITED
+log4j.logger.eu.xenit.alfresco.healthprocessor.checker=INHERITED
 log4j.logger.eu.xenit.alfresco.healthprocessor.processing=INHERITED
 log4j.logger.eu.xenit.alfresco.healthprocessor.reporter=INHERITED

alfresco-health-processor-platform/src/main/amp/config/alfresco/module/alfresco-health-processor/log4j2.properties

@@ -2,6 +2,6 @@ logger.eu_xenit_alfresco_healthprocessor.name=eu.xenit.alfresco.healthprocessor
 logger.eu_xenit_alfresco_healthprocessor.level=info
 logger.eu_xenit_alfresco_healthprocessor_indexing.name=eu.xenit.alfresco.healthprocessor.indexing
 logger.eu_xenit_alfresco_healthprocessor_fixer.name=eu.xenit.alfresco.healthprocessor.fixer
-logger.eu_xenit_alfresco_healthprocessor_plugins.name=eu.xenit.alfresco.healthprocessor.plugins
+logger.eu_xenit_alfresco_healthprocessor_checker.name=eu.xenit.alfresco.healthprocessor.checker
 logger.eu_xenit_alfresco_healthprocessor_processing.name=eu.xenit.alfresco.healthprocessor.processing
 logger.eu_xenit_alfresco_healthprocessor_reporter.name=eu.xenit.alfresco.healthprocessor.reporter

alfresco-health-processor-platform/src/main/amp/config/alfresco/subsystems/HealthProcessor/default/healthprocessor.properties

@@ -16,20 +16,36 @@ eu.xenit.alfresco.healthprocessor.indexing.txn-id.txn-batch-size=5000
 eu.xenit.alfresco.healthprocessor.indexing.last-txns.lookback-transactions=10000
 eu.xenit.alfresco.healthprocessor.indexing.last-txns.txn-batch-size=5000
 
-eu.xenit.alfresco.healthprocessor.plugin.noop.enabled=false
-eu.xenit.alfresco.healthprocessor.plugin.content-validation.enabled=false
-eu.xenit.alfresco.healthprocessor.plugin.content-validation.properties=
+eu.xenit.alfresco.healthprocessor.checker.noop.enabled=false
+eu.xenit.alfresco.healthprocessor.checker.content-validation.enabled=false
+eu.xenit.alfresco.healthprocessor.checker.content-validation.properties=
 
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.enabled=false
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.check-transaction=false
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints=default,archive
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints.default.type=Always
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints.default.base-uri=https://${solr.host}:${solr.port.ssl}/solr/alfresco
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints.default.indexed-store=workspace://SpacesStore
+eu.xenit.alfresco.healthprocessor.checker.solr-index.enabled=false
+eu.xenit.alfresco.healthprocessor.checker.solr-index.check-transaction=false
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints=default,archive
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints.default.type=Always
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints.default.base-uri=https://${solr.host}:${solr.port.ssl}/solr/alfresco
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints.default.indexed-store=workspace://SpacesStore
 
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints.archive.type=Always
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints.archive.base-uri=https://${solr.host}:${solr.port.ssl}/solr/archive
-eu.xenit.alfresco.healthprocessor.plugin.solr-index.endpoints.archive.indexed-store=archive://SpacesStore
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints.archive.type=Always
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints.archive.base-uri=https://${solr.host}:${solr.port.ssl}/solr/archive
+eu.xenit.alfresco.healthprocessor.checker.solr-index.endpoints.archive.indexed-store=archive://SpacesStore
+
+# not defined in base repository.properties or Enterprise one
+elasticsearch.host=localhost
+elasticsearch.port=9200
+elasticsearch.baseUrl=/
+elasticsearch.secureComms=none
+
+# no (default) setup for the archive here
+# indexing is dependent on events, events on behaviours, which are disabled for archive store
+elasticsearch.indexName=alfresco
+
+eu.xenit.alfresco.healthprocessor.checker.elastic-index.enabled=false
+eu.xenit.alfresco.healthprocessor.checker.elastic-index.endpoints=default
+eu.xenit.alfresco.healthprocessor.checker.elastic-index.endpoints.default.base-uri=${elasticsearch.host}:${elasticsearch.port}${elasticsearch.baseUrl}${elasticsearch.indexName}
+eu.xenit.alfresco.healthprocessor.checker.elastic-index.endpoints.default.secureComms=${elasticsearch.secureComms}
+eu.xenit.alfresco.healthprocessor.checker.elastic-index.endpoints.default.expect-paths-indexed=false
 
 eu.xenit.alfresco.healthprocessor.reporter.store.max-stored-reports=3000
 eu.xenit.alfresco.healthprocessor.reporter.alfred-telemetry.enabled=false
@@ -39,3 +55,12 @@ eu.xenit.alfresco.healthprocessor.reporter.log.streaming.enabled=false
 
 eu.xenit.alfresco.healthprocessor.fixer.solr-missing-node.enabled=false
 eu.xenit.alfresco.healthprocessor.fixer.solr-duplicate-node.enabled=false
+
+eu.xenit.alfresco.healthprocessor.fixer.elastic-undeleted-node.enabled=false
+eu.xenit.alfresco.healthprocessor.fixer.elastic-missing-or-outdated-node.enabled=false
+eu.xenit.alfresco.healthprocessor.fixer.elastic-missing-or-outdated-node.waitForIndex=true
+eu.xenit.alfresco.healthprocessor.fixer.elastic-missing-or-outdated-node.waitIntervalMillis=1000
+eu.xenit.alfresco.healthprocessor.fixer.elastic-missing-or-outdated-node.waitIntervalCount=2
+
+search.solrTrackingSupport.ignorePathsForSpecificTypes=false
+search.solrTrackingSupport.ignorePathsForSpecificAspects=false

alfresco-health-processor-platform/src/main/amp/config/alfresco/subsystems/HealthProcessor/default/indexing-context.xml

@@ -38,9 +38,49 @@
         </constructor-arg>
     </bean>
 
+    <!-- need to duplicate search tracking component - elastic does not expose any if active -->
+    <bean id="search.trackingComponent" class="org.alfresco.repo.solr.SOLRTrackingComponentImpl" init-method="init">
+        <property name="permissionService" ref="permissionService"/>
+        <property name="dictionaryService" ref="dictionaryService"/>
+        <property name="ownableService" ref="ownableService"/>
+        <property name="tenantService" ref="tenantService"/>
+        <property name="nodeDAO" ref="nodeDAO"/>
+        <property name="qnameDAO" ref="qnameDAO"/>
+        <property name="searchDAO" ref="searchDAO" />
+        <property name="dictionaryDAO" ref="dictionaryDAO" />
+        <property name="aclDAO" ref="aclDAO" />
+        <property name="enabled" value="true" />
+        <property name="typeIndexFilter" ref="search.TypeIndexFilter" />
+        <property name="aspectIndexFilter" ref="search.AspectIndexFilter" />
+        <property name="namespaceService" ref="namespaceService" />
+    </bean>
+
+    <bean id="search.abstractIndexFilter" abstract="true" init-method="init" >
+        <property name="namespaceService" ref="namespaceService"/>
+        <property name="dictionaryService" ref="dictionaryService"/>
+    </bean>
+
+    <bean id="search.TypeIndexFilter" class="org.alfresco.repo.search.TypeIndexFilter" parent="search.abstractIndexFilter">
+        <property name="ignorePathsForSpecificTypes" value="${search.solrTrackingSupport.ignorePathsForSpecificTypes}" />
+        <property name="typesForIgnoringPaths">
+            <list>
+                <value>{http://www.alfresco.org/model/content/1.0}person</value>
+                <value>{http://www.alfresco.org/model/application/1.0}configurations</value>
+                <value>{http://www.alfresco.org/model/content/1.0}authorityContainer</value>
+            </list>
+        </property>
+    </bean>
+
+    <bean id="search.AspectIndexFilter" class="org.alfresco.repo.search.AspectIndexFilter" parent="search.abstractIndexFilter">
+        <property name="ignorePathsForSpecificAspects" value="${search.solrTrackingSupport.ignorePathsForSpecificAspects}" />
+        <property name="aspectsForIgnoringPaths">
+            <list></list>
+        </property>
+    </bean>
+
     <bean id="eu.xenit.alfresco.healthprocessor.indexing.TrackingComponent"
           class="eu.xenit.alfresco.healthprocessor.indexing.Alfresco7TrackingComponent">
-        <constructor-arg name="trackingComponent" ref="searchTrackingComponent" />
+        <constructor-arg name="trackingComponent" ref="search.trackingComponent" />
     </bean>
 
     <bean id="eu.xenit.alfresco.healthprocessor.util.AlfrescoAttributeStore"