use crate::core::index::index_reader::IndexReader;
use crate::test_framework::core::util::lucene_test_case::{
new_directory_shared, new_field, new_index_writer_config, new_log_merge_policy,
new_searcher_with_reader, new_text_field, random,
};
use std::collections::HashMap;
use std::sync::Arc;
use crate::core::document::document::Document;
use crate::core::document::field::Store;
use crate::core::document::field_type::FieldType;
use crate::core::document::text_field::TYPE_NOT_STORED;
use crate::core::index::index_options::IndexOptions;
use crate::core::index::live_index_writer_config::LiveIndexWriterConfig;
use crate::core::index::term::Term;
use crate::core::search::boolean_clause::Occur;
use crate::core::search::boolean_query::Builder;
use crate::core::search::similarities_impl::bm25_similarity::BM25Similarity;
use crate::core::search::similarities_impl::classic_similarity;
use crate::core::search::term_query::TermQuery;
use crate::core::util::error::lucene_error::Result;
use crate::test_framework::core::index::random_index_writer::RandomIndexWriter;
use rand::RngExt;
#[allow(dead_code)] pub struct TestSimilarity2;
macro_rules! for_each_similarity {
($sim:ident, $body:block) => {{
let $sim = Arc::new(classic_similarity::new());
$body
}
{
let $sim = Arc::new(BM25Similarity::new()?);
$body
}};
($sim:ident, $i:ident, $body:block) => {{
let $i = 0;
let $sim = Arc::new(classic_similarity::new());
$body
}
{
let $i = 1;
let $sim = Arc::new(BM25Similarity::new()?);
$body
}};
}
#[test]
fn test_empty_index() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let iw = RandomIndexWriter::new(&mut random, dir.clone())?;
let ir = iw.get_reader(&mut random)?;
iw.close(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
assert_eq!(
0,
searcher
.search(TermQuery::new(Term::from_text("foo", "bar")), 10)?
.total_hits
.value()
);
});
Ok(())
}
#[test]
fn test_empty_field() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let iw = RandomIndexWriter::new(&mut random, dir.clone())?;
let mut field_to_type = HashMap::new();
let mut doc = Document::new();
doc.add(new_text_field(
&mut random,
"foo",
"bar",
Store::No,
&mut field_to_type,
)?);
iw.add_document(&mut random, doc)?;
let ir = iw.get_reader(&mut random)?;
iw.close(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
let mut query = Builder::new();
query.add(TermQuery::new(Term::from_text("foo", "bar")), Occur::Should)?;
query.add(TermQuery::new(Term::from_text("bar", "baz")), Occur::Should)?;
assert_eq!(1, searcher.search(query.build(), 10)?.total_hits.value());
});
Ok(())
}
#[test]
fn test_empty_term() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let iw = RandomIndexWriter::new(&mut random, dir.clone())?;
let mut doc = Document::new();
let mut field_to_type = HashMap::new();
doc.add(new_text_field(
&mut random,
"foo",
"bar",
Store::No,
&mut field_to_type,
)?);
iw.add_document(&mut random, doc)?;
let ir = iw.get_reader(&mut random)?;
iw.close(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
let mut query = Builder::new();
query.add(TermQuery::new(Term::from_text("foo", "bar")), Occur::Should)?;
query.add(TermQuery::new(Term::from_text("foo", "baz")), Occur::Should)?;
assert_eq!(1, searcher.search(query.build(), 10)?.total_hits.value());
});
Ok(())
}
#[test]
fn test_no_norms() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let iw = RandomIndexWriter::new(&mut random, dir.clone())?;
let mut doc = Document::new();
let mut field_to_type = HashMap::new();
let mut ft = FieldType::from_ref(&*TYPE_NOT_STORED)?;
ft.set_omit_norms(true)?;
ft.freeze();
doc.add(new_field(
&mut random,
"foo",
"bar",
&ft,
&mut field_to_type,
)?);
iw.add_document(&mut random, doc)?;
let ir = iw.get_reader(&mut random)?;
iw.close(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
let mut query = Builder::new();
query.add(TermQuery::new(Term::from_text("foo", "bar")), Occur::Should)?;
assert_eq!(1, searcher.search(query.build(), 10)?.total_hits.value());
});
Ok(())
}
#[test]
fn test_no_field_skew() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let mut iw_config = new_index_writer_config(&mut random)?;
iw_config.set_merge_policy(new_log_merge_policy(&mut random)?);
let iw = RandomIndexWriter::with_config(&mut random, dir.clone(), iw_config);
let mut field_to_type = HashMap::new();
let mut doc = Document::new();
doc.add(new_text_field(
&mut random,
"foo",
"bar baz somethingelse",
Store::No,
&mut field_to_type,
)?);
iw.add_document(&mut random, doc)?;
let mut query_builder = Builder::new();
query_builder.add(TermQuery::new(Term::from_text("foo", "bar")), Occur::Should)?;
query_builder.add(TermQuery::new(Term::from_text("foo", "baz")), Occur::Should)?;
let query = query_builder.build();
let mut scores = Vec::new();
{
let ir = iw.get_reader(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
scores.push(searcher.explain(query.clone(), 0)?);
});
}
let num_extra_docs = random.random_range(1..=1000);
for _ in 0..num_extra_docs {
iw.add_document(&mut random, Document::new())?;
}
{
let ir = iw.get_reader(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, i, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
let expected = &scores[i];
let actual = searcher.explain(query.clone(), 0)?;
assert_eq!(
expected.get_value().to_f32(),
actual.get_value().to_f32(),
"{}: actual={},expected={}",
sim,
actual,
expected
);
});
}
iw.close(&mut random)?;
Ok(())
}
#[test]
fn test_omit_tf() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let iw = RandomIndexWriter::new(&mut random, dir.clone())?;
let mut doc = Document::new();
let mut field_to_type = HashMap::new();
let mut ft = FieldType::from_ref(&*TYPE_NOT_STORED)?;
ft.set_index_options(IndexOptions::Docs)?;
ft.freeze();
doc.add(new_field(
&mut random,
"foo",
"bar",
&ft,
&mut field_to_type,
)?);
iw.add_document(&mut random, doc)?;
let ir = iw.get_reader(&mut random)?;
iw.close(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
let mut query = Builder::new();
query.add(TermQuery::new(Term::from_text("foo", "bar")), Occur::Should)?;
assert_eq!(1, searcher.search(query.build(), 10)?.total_hits.value());
});
Ok(())
}
#[test]
fn test_omit_tf_and_norms() -> Result<()> {
let mut random = random();
let dir = new_directory_shared(&mut random)?;
let iw = RandomIndexWriter::new(&mut random, dir.clone())?;
let mut doc = Document::new();
let mut field_to_type = HashMap::new();
let mut ft = FieldType::from_ref(&*TYPE_NOT_STORED)?;
ft.set_index_options(IndexOptions::Docs)?;
ft.set_omit_norms(true)?;
ft.freeze();
doc.add(new_field(
&mut random,
"foo",
"bar",
&ft,
&mut field_to_type,
)?);
iw.add_document(&mut random, doc)?;
let ir = iw.get_reader(&mut random)?;
iw.close(&mut random)?;
let searcher = new_searcher_with_reader(Arc::new(ir))?;
for_each_similarity!(sim, {
let searcher = crate::core::search::index_searcher::IndexSearcher::new_with_executor(
searcher.get_index_reader().clone().get_context()?,
None,
sim.clone(),
)?;
let mut query = Builder::new();
query.add(TermQuery::new(Term::from_text("foo", "bar")), Occur::Should)?;
assert_eq!(1, searcher.search(query.build(), 10)?.total_hits.value());
});
Ok(())
}