OAK-12089: Add Lucene 9 index provider (oak-search-luceneNg)

oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexComparisonTest.java

@@ -0,0 +1,72 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jackrabbit.oak.plugins.index.lucene;
+
+import org.apache.jackrabbit.JcrConstants;
+import org.apache.jackrabbit.oak.InitialContent;
+import org.apache.jackrabbit.oak.Oak;
+import org.apache.jackrabbit.oak.api.ContentRepository;
+import org.apache.jackrabbit.oak.api.Tree;
+import org.apache.jackrabbit.oak.api.Type;
+import org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants;
+import org.apache.jackrabbit.oak.plugins.index.search.test.AbstractIndexComparisonTest;
+import org.apache.jackrabbit.oak.spi.commit.Observer;
+import org.apache.jackrabbit.oak.spi.query.QueryIndexProvider;
+import org.apache.jackrabbit.oak.spi.security.OpenSecurityProvider;
+
+import java.util.List;
+
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.INDEX_DEFINITIONS_NODE_TYPE;
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.REINDEX_PROPERTY_NAME;
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.TYPE_PROPERTY_NAME;
+import static org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants.INCLUDE_PROPERTY_NAMES;
+import static org.apache.jackrabbit.oak.plugins.memory.PropertyStates.createProperty;
+
+/**
+ * Runs the shared {@link AbstractIndexComparisonTest} scenarios against the legacy Lucene backend.
+ */
+public class LuceneIndexComparisonTest extends AbstractIndexComparisonTest {
+
+    @Override
+    protected ContentRepository createRepository() {
+        LuceneIndexProvider provider = new LuceneIndexProvider();
+        return new Oak()
+            .with(new InitialContent())
+            .with(new OpenSecurityProvider())
+            .with((QueryIndexProvider) provider)
+            .with((Observer) provider)
+            .with(new LuceneIndexEditorProvider())
+            .createContentRepository();
+    }
+
+    @Override
+    protected void createTestIndexNode() throws Exception {
+        setTraversalEnabled(false);
+    }
+
+    @Override
+    protected void createSearchIndex() throws Exception {
+        Tree def = root.getTree("/oak:index").addChild("luceneTestIndex");
+        def.setProperty(JcrConstants.JCR_PRIMARYTYPE, INDEX_DEFINITIONS_NODE_TYPE, Type.NAME);
+        def.setProperty(TYPE_PROPERTY_NAME, LuceneIndexConstants.TYPE_LUCENE);
+        def.setProperty(REINDEX_PROPERTY_NAME, true);
+        def.setProperty(FulltextIndexConstants.FULL_TEXT_ENABLED, false);
+        def.setProperty(createProperty(INCLUDE_PROPERTY_NAMES,
+                List.of("title", "description", "age", "price", "status", "category"), Type.STRINGS));
+        root.commit();
+    }
+}

oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexMinimalTest.java

@@ -0,0 +1,66 @@
+package org.apache.jackrabbit.oak.plugins.index.lucene;
+
+import org.apache.jackrabbit.oak.InitialContent;
+import org.apache.jackrabbit.oak.Oak;
+import org.apache.jackrabbit.oak.api.ContentRepository;
+import org.apache.jackrabbit.oak.api.Tree;
+import org.apache.jackrabbit.oak.api.Type;
+import org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants;
+import org.apache.jackrabbit.oak.query.AbstractQueryTest;
+import org.apache.jackrabbit.oak.spi.commit.Observer;
+import org.apache.jackrabbit.oak.spi.query.QueryIndexProvider;
+import org.apache.jackrabbit.oak.spi.security.OpenSecurityProvider;
+import org.junit.Test;
+
+import java.util.List;
+
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.*;
+import static org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants.INCLUDE_PROPERTY_NAMES;
+import static org.apache.jackrabbit.oak.plugins.memory.PropertyStates.createProperty;
+
+public class LuceneIndexMinimalTest extends AbstractQueryTest {
+    @Override protected void createTestIndexNode() throws Exception { setTraversalEnabled(false); }
+
+    @Override
+    protected ContentRepository createRepository() {
+        LuceneIndexProvider provider = new LuceneIndexProvider();
+        return new Oak().with(new InitialContent()).with(new OpenSecurityProvider())
+            .with((QueryIndexProvider) provider).with((Observer) provider)
+            .with(new LuceneIndexEditorProvider()).createContentRepository();
+    }
+
+    @Test
+    public void singleCommit() throws Exception {
+        // Index + content in ONE commit
+        Tree def = root.getTree("/oak:index").addChild("testIdx");
+        def.setProperty("jcr:primaryType", INDEX_DEFINITIONS_NODE_TYPE, Type.NAME);
+        def.setProperty(TYPE_PROPERTY_NAME, LuceneIndexConstants.TYPE_LUCENE);
+        def.setProperty(REINDEX_PROPERTY_NAME, true);
+        def.setProperty(FulltextIndexConstants.FULL_TEXT_ENABLED, false);
+        def.setProperty(createProperty(INCLUDE_PROPERTY_NAMES, List.of("title"), Type.STRINGS));
+
+        Tree page = root.getTree("/").addChild("content").addChild("page1");
+        page.setProperty("title", "Lucene Integration");
+        root.commit();
+
+        assertQuery("//element(*, nt:base)[@title = 'Lucene Integration']", "xpath", List.of("/content/page1"));
+    }
+
+    @Test
+    public void twoCommits() throws Exception {
+        // Index in first commit, content in second
+        Tree def = root.getTree("/oak:index").addChild("testIdx");
+        def.setProperty("jcr:primaryType", INDEX_DEFINITIONS_NODE_TYPE, Type.NAME);
+        def.setProperty(TYPE_PROPERTY_NAME, LuceneIndexConstants.TYPE_LUCENE);
+        def.setProperty(REINDEX_PROPERTY_NAME, true);
+        def.setProperty(FulltextIndexConstants.FULL_TEXT_ENABLED, false);
+        def.setProperty(createProperty(INCLUDE_PROPERTY_NAMES, List.of("title"), Type.STRINGS));
+        root.commit();
+
+        Tree page = root.getTree("/").addChild("content").addChild("page1");
+        page.setProperty("title", "Lucene Integration");
+        root.commit();
+
+        assertQuery("//element(*, nt:base)[@title = 'Lucene Integration']", "xpath", List.of("/content/page1"));
+    }
+}

oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneNodeNameCommonTest.java

@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.jackrabbit.oak.plugins.index.lucene;
+
+import org.apache.jackrabbit.oak.Oak;
+import org.apache.jackrabbit.oak.jcr.Jcr;
+import org.apache.jackrabbit.oak.plugins.index.LuceneIndexOptions;
+import org.apache.jackrabbit.oak.plugins.index.NodeNameCommonTest;
+import org.junit.After;
+import org.junit.Rule;
+import org.junit.rules.TemporaryFolder;
+
+import javax.jcr.Repository;
+import java.io.File;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
+/**
+ * Runs {@link NodeNameCommonTest} against the legacy Lucene index.
+ */
+public class LuceneNodeNameCommonTest extends NodeNameCommonTest {
+
+    private ExecutorService executorService = Executors.newFixedThreadPool(2);
+
+    @Rule
+    public TemporaryFolder temporaryFolder = new TemporaryFolder(new File("target"));
+
+    @Override
+    protected Repository createJcrRepository() {
+        indexOptions = new LuceneIndexOptions();
+        repositoryOptionsUtil = new LuceneTestRepositoryBuilder(executorService, temporaryFolder).build();
+        Oak oak = repositoryOptionsUtil.getOak();
+        return new Jcr(oak).createRepository();
+    }
+
+    @After
+    public void shutdownExecutor() {
+        executorService.shutdown();
+    }
+}

oak-search-lucene-ng/README.md

@@ -0,0 +1,26 @@
+# oak-search-lucene-ng
+
+Lucene 9 index provider for Oak (`type="lucene9"`).
+
+## Feature parity
+
+| Feature | Legacy Lucene | Elastic | LuceneNg |
+|---|---|---|---|
+| Property restrictions, path/type filters | ✓ | ✓ | ✓ |
+| Fulltext search | ✓ | ✓ | ✓ |
+| Facets (insecure / statistical / secure) | ✓ | ✓ | ✓ |
+| Excerpts | ✓ | ✓ | ✓ |
+| Ordering / sorting | ✓ | ✓ | ✓ |
+| Suggestions | ✓ | ✓ | ✗ |
+| Spellcheck | ✓ | ✓ | ✗ |
+| Similarity / More Like This | ✓ | ✓ (+ KNN) | ✗ |
+| Native queries | ✓ | ✓ | ✗ |
+| Index statistics / JMX | ✓ | ✓ | ✗ |
+| Index augmentors [^1] | ✓ | ✗ | ✗ |
+| NRT / hybrid indexing | ✓ | ✗ | ✗ |
+| Index copier (CopyOnRead/Write) | ✓ | ✗ | ✗ |
+| Composite node store queries [^2] | ✓ | ✗ | ✗ |
+| Inference / vector search | ✗ | ✓ | ✗ |
+
+[^1]: Index augmentors are OSGi services (`IndexFieldProvider`, `FulltextQueryTermsProvider`) that let third-party code inject additional fields into indexed documents or expand fulltext queries, without modifying the index definition.
+[^2]: When the repository is backed by a composite node store (e.g. a read-only `/apps`+`/libs` mount combined with a writeable store), the Lucene index runs one query per mount and merges the results. This feature is not required for a single-store deployment.