gautamworah96 commented on code in PR #762: URL: https://github.com/apache/lucene/pull/762#discussion_r848944541
########## lucene/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestAlwaysRefreshDirectoryTaxonomyReader.java: ########## @@ -0,0 +1,195 @@ +/* + * 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.lucene.facet.taxonomy.directory; + +import static com.carrotsearch.randomizedtesting.RandomizedTest.sleep; +import static org.apache.lucene.tests.mockfile.ExtrasFS.isExtra; + +import java.io.IOException; +import java.nio.file.Path; +import java.time.Instant; +import java.util.List; +import java.util.function.Function; +import org.apache.lucene.facet.FacetTestCase; +import org.apache.lucene.facet.FacetsCollector; +import org.apache.lucene.facet.FacetsConfig; +import org.apache.lucene.facet.taxonomy.FacetLabel; +import org.apache.lucene.facet.taxonomy.SearcherTaxonomyManager; +import org.apache.lucene.index.DirectoryReader; +import org.apache.lucene.index.IndexWriterConfig; +import org.apache.lucene.store.Directory; +import org.apache.lucene.store.IOContext; +import org.apache.lucene.tests.util.TestUtil; +import org.apache.lucene.util.IOUtils; + +public class TestAlwaysRefreshDirectoryTaxonomyReader extends FacetTestCase { + + /** + * Tests the behavior of the {@link AlwaysRefreshDirectoryTaxonomyReader} by testing if the + * associated {@link SearcherTaxonomyManager} can successfully refresh and serve queries if the + * underlying taxonomy index is changed to an older checkpoint. Ideally, each checkpoint should be + * self-sufficient and should allow serving search queries when {@link + * SearcherTaxonomyManager#maybeRefresh()} is called. + * + * <p>It does not check whether the private taxoArrays were actually recreated or no. We are + * (correctly) hiding away that complexity away from the user. + */ + private <T extends Throwable> void testAlwaysRefreshDirectoryTaxonomyReader( + Function<Directory, DirectoryTaxonomyReader> dtrProducer, Class<T> exceptionType) + throws IOException { + final Path taxoPath1 = createTempDir(String.valueOf(Instant.now())); + final Directory dir1 = newFSDirectory(taxoPath1); + final DirectoryTaxonomyWriter tw1 = + new DirectoryTaxonomyWriter(dir1, IndexWriterConfig.OpenMode.CREATE); + tw1.addCategory(new FacetLabel("a")); + tw1.commit(); // commit1 + + final Path taxoPath2 = createTempDir(String.valueOf(Instant.now())); + final Directory commit1 = newFSDirectory(taxoPath2); + // copy all index files from dir1 + for (String file : dir1.listAll()) { + if (isExtra(file) == false) { + // the test framework creates these devious extra files just to chaos test the edge cases + commit1.copyFrom(dir1, file, file, IOContext.READ); + } + } + + tw1.addCategory(new FacetLabel("b")); + tw1.commit(); // commit2 + tw1.close(); + + final DirectoryReader dr1 = DirectoryReader.open(dir1); + final DirectoryTaxonomyReader dtr1 = dtrProducer.apply(dir1); + final SearcherTaxonomyManager mgr = new SearcherTaxonomyManager(dr1, dtr1, null); + + final FacetsConfig config = new FacetsConfig(); + SearcherTaxonomyManager.SearcherAndTaxonomy pair = mgr.acquire(); + final FacetsCollector sfc = new FacetsCollector(); + /** + * the call flow here initializes {@link DirectoryTaxonomyReader#taxoArrays}. These reused + * `taxoArrays` form the basis of the inconsistency * + */ + getTaxonomyFacetCounts(pair.taxonomyReader, config, sfc); + + // now try to go back to checkpoint 1 and refresh the SearcherTaxonomyManager + + // delete all files from commit2 + for (String file : dir1.listAll()) { + dir1.deleteFile(file); + } + + while (dir1.getPendingDeletions().isEmpty() == false) { + // make the test more robust to the OS taking more time to actually delete files + if (TestUtil.hasVirusChecker(dir1) || TestUtil.hasWindowsFS(dir1)) { Review Comment: Done. It does not look too neat but I think it is good enough -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
