aboutsummaryrefslogtreecommitdiff
path: root/icing/index/iterator/doc-hit-info-iterator-not_test.cc
blob: 5a8ce2cacbd80cfc7edbc4c7965e6ca09375e1a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
// Copyright (C) 2019 Google LLC
//
// Licensed 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.

#include "icing/index/iterator/doc-hit-info-iterator-not.h"

#include <string>
#include <vector>

#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include "icing/index/hit/doc-hit-info.h"
#include "icing/index/iterator/doc-hit-info-iterator-test-util.h"
#include "icing/index/iterator/doc-hit-info-iterator.h"
#include "icing/schema/section.h"
#include "icing/store/document-id.h"
#include "icing/testing/common-matchers.h"

namespace icing {
namespace lib {

namespace {

using ::testing::ElementsAre;
using ::testing::Eq;
using ::testing::IsEmpty;

TEST(DocHitInfoIteratorNotTest, InvalidDocumentIdLimit) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {DocHitInfo(5),
                                                   DocHitInfo(4)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/-1);
  EXPECT_THAT(not_iterator.Advance(),
              StatusIs(libtextclassifier3::StatusCode::RESOURCE_EXHAUSTED));
}

TEST(DocHitInfoIteratorNotTest, NotFirstFewDocumentIdsOk) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {DocHitInfo(5),
                                                   DocHitInfo(4)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);
  EXPECT_THAT(GetDocumentIds(&not_iterator), ElementsAre(3, 2, 1, 0));
}

TEST(DocHitInfoIteratorNotTest, NotLastFewDocumentIdsOk) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {DocHitInfo(1),
                                                   DocHitInfo(0)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);
  EXPECT_THAT(GetDocumentIds(&not_iterator), ElementsAre(5, 4, 3, 2));
}

TEST(DocHitInfoIteratorNotTest, IntermittentDocumentIdOverlapOk) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {
      DocHitInfo(8), DocHitInfo(6), DocHitInfo(4), DocHitInfo(2)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/10);
  EXPECT_THAT(GetDocumentIds(&not_iterator), ElementsAre(10, 9, 7, 5, 3, 1, 0));
}

TEST(DocHitInfoIteratorNotTest, NoDocumentIdOverlapOk) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);
  EXPECT_THAT(GetDocumentIds(&not_iterator), ElementsAre(5, 4, 3, 2, 1, 0));
}

TEST(DocHitInfoIteratorNotTest, AllDocumentIdOverlapOk) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {
      DocHitInfo(5), DocHitInfo(4), DocHitInfo(3),
      DocHitInfo(2), DocHitInfo(1), DocHitInfo(0)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);
  EXPECT_THAT(GetDocumentIds(&not_iterator), IsEmpty());
}

TEST(DocHitInfoIteratorNotTest, GetNumBlocksInspected) {
  int to_be_excluded_iterator_blocks = 4;  // arbitrary value
  auto to_be_excluded_iterator = std::make_unique<DocHitInfoIteratorDummy>();
  to_be_excluded_iterator->SetNumBlocksInspected(
      to_be_excluded_iterator_blocks);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);

  // The AllDocumentId iterator doesn't count any blocks as being inspected
  // since it's just decrementing 1 from the document_id_limit.
  EXPECT_THAT(not_iterator.GetNumBlocksInspected(),
              Eq(to_be_excluded_iterator_blocks));
}

TEST(DocHitInfoIteratorNotTest, GetNumLeafAdvanceCalls) {
  int to_be_excluded_iterator_leaves = 4;  // arbitrary value
  auto to_be_excluded_iterator = std::make_unique<DocHitInfoIteratorDummy>();
  to_be_excluded_iterator->SetNumLeafAdvanceCalls(
      to_be_excluded_iterator_leaves);

  int all_document_id_limit = 5;
  // Since we iterate from [limit, 0] inclusive, add 1 for the 0th advance call
  int all_leaf_advance_calls = all_document_id_limit + 1;
  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     all_document_id_limit);

  while (not_iterator.Advance().ok()) {
    // Advance through the whole not iterator
  }

  // The AllDocumentId iterator counts each DocumentId as a leaf advance call
  EXPECT_THAT(not_iterator.GetNumLeafAdvanceCalls(),
              Eq(to_be_excluded_iterator_leaves + all_leaf_advance_calls));
}

TEST(DocHitInfoIteratorNotTest, SectionIdsAlwaysNone) {
  SectionIdMask section_id_mask5 = 1U << 5;  // arbitrary non-zero value
  SectionIdMask section_id_mask4 = 1U << 4;  // arbitrary non-zero value
  std::vector<DocHitInfo> exclude_doc_hit_infos = {
      DocHitInfo(5, section_id_mask5), DocHitInfo(4, section_id_mask4)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);
  EXPECT_THAT(GetDocHitInfos(&not_iterator),
              ElementsAre(DocHitInfo(3, kSectionIdMaskNone),
                          DocHitInfo(2, kSectionIdMaskNone),
                          DocHitInfo(1, kSectionIdMaskNone),
                          DocHitInfo(0, kSectionIdMaskNone)));
}

TEST(DocHitInfoIteratorNotTest, TrimNotIterator) {
  std::vector<DocHitInfo> exclude_doc_hit_infos = {DocHitInfo(0)};
  std::unique_ptr<DocHitInfoIterator> to_be_excluded_iterator =
      std::make_unique<DocHitInfoIteratorDummy>(exclude_doc_hit_infos);

  DocHitInfoIteratorNot not_iterator(std::move(to_be_excluded_iterator),
                                     /*document_id_limit=*/5);
  EXPECT_THAT(std::move(not_iterator).TrimRightMostNode(),
              StatusIs(libtextclassifier3::StatusCode::INVALID_ARGUMENT));
}

}  // namespace

}  // namespace lib
}  // namespace icing