File: annotations_manager_unittest.cc

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (245 lines) | stat: -rw-r--r-- 9,384 bytes parent folder | download | duplicates (6)
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/fuchsia_component_support/annotations_manager.h"

#include "base/fuchsia/mem_buffer_util.h"
#include "base/test/gtest_util.h"
#include "base/test/task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace fuchsia_component_support {

namespace {

class AnnotationsManagerTest : public testing::Test {
 protected:
  AnnotationsManagerTest() = default;

  base::test::SingleThreadTaskEnvironment task_environment_{
      base::test::SingleThreadTaskEnvironment::MainThreadType::IO};
};

constexpr char kGlobalNamespace[] = "global";

constexpr char kAnnotationName1[] = "annotation1";
constexpr char kAnnotationName2[] = "annotation2";

constexpr char kAnnotationValue1[] = "annotation_value1";
constexpr char kAnnotationValue2[] = "annotation_value2";

TEST(MakeAnnotationTest, KeyNamespaceAndName) {
  auto annotation = MakeAnnotation(kAnnotationName1, "ignored");
  EXPECT_EQ(annotation.key.namespace_, kGlobalNamespace);
  EXPECT_EQ(annotation.key.value, kAnnotationName1);
}

TEST(MakeAnnotationTest, BooleanValue) {
  auto annotation = MakeBoolAnnotation(kAnnotationName1, true);
  ASSERT_TRUE(annotation.value.is_text());
  EXPECT_EQ(annotation.value.text(), "true");
}

TEST(MakeAnnotationTest, IntegerValue) {
  auto annotation = MakeIntAnnotation(kAnnotationName1, 12345678);
  ASSERT_TRUE(annotation.value.is_text());
  EXPECT_EQ(annotation.value.text(), "12345678");
}

TEST(MakeAnnotationTest, TextValue) {
  constexpr char kSmallText[] = "This is a short text annotation";
  auto annotation = MakeAnnotation(kAnnotationName1, kSmallText);
  ASSERT_TRUE(annotation.value.is_text());
  EXPECT_EQ(annotation.value.text(), kSmallText);
}

TEST(MakeAnnotationTest, LargeTextValue) {
  const std::string large_text(1024, 'a');
  auto annotation = MakeAnnotation(kAnnotationName1, large_text);
  ASSERT_TRUE(annotation.value.is_buffer());
  auto value = base::StringFromMemBuffer(annotation.value.buffer());
  EXPECT_EQ(value, large_text);
}

// Basic verification that a single client can connect.
TEST_F(AnnotationsManagerTest, SingleClient) {
  AnnotationsManager annotations;

  fuchsia::element::AnnotationControllerPtr ptr;
  annotations.Connect(ptr.NewRequest());
}

// Verifies that multiple clients can connect.
TEST_F(AnnotationsManagerTest, MultipleClients) {
  AnnotationsManager annotations;

  fuchsia::element::AnnotationControllerPtr ptr1;
  annotations.Connect(ptr1.NewRequest());
  fuchsia::element::AnnotationControllerPtr ptr2;
  annotations.Connect(ptr2.NewRequest());
}

// Verifies that WatchAnnotations() hanging-get behaviour:
// - first call returns all annotations.
// - watch when nothing has changed "hangs" until the next change.
// - watch after a change returns immediately.
TEST_F(AnnotationsManagerTest, WatchAnnotationsHangingGet) {
  AnnotationsManager annotations;

  fuchsia::element::AnnotationControllerPtr controller;
  annotations.Connect(controller.NewRequest());

  // Dispatch an initial watch, that will return immediately.
  bool received_annotations = false;
  controller->WatchAnnotations([&received_annotations](auto annotations) {
    EXPECT_EQ(annotations.response().annotations.size(), 0u);
    received_annotations = true;
  });
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(received_annotations);

  // Set a new watch, which should not return immediately, since nothing has
  // changed.
  received_annotations = false;
  controller->WatchAnnotations([&received_annotations](auto annotations) {
    EXPECT_EQ(annotations.response().annotations.size(), 1u);
    received_annotations = true;
  });
  base::RunLoop().RunUntilIdle();
  EXPECT_FALSE(received_annotations);

  // Set an annotation and spin the loop, to verify that the update is reported.
  std::vector<fuchsia::element::Annotation> to_set;
  to_set.push_back(MakeAnnotation(kAnnotationName1, kAnnotationValue1));
  annotations.UpdateAnnotations(std::move(to_set));
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(received_annotations);

  // Change the annotation and spin the loop, then call WatchAnnotations() to
  // verify that it returns immediately.
  to_set.clear();
  to_set.push_back(MakeAnnotation(kAnnotationName1, kAnnotationValue2));
  annotations.UpdateAnnotations(std::move(to_set));
  received_annotations = false;
  controller->WatchAnnotations([&received_annotations](auto annotations) {
    EXPECT_EQ(annotations.response().annotations.size(), 1u);
    received_annotations = true;
  });
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(received_annotations);
}

// Verifies that WatchAnnotations() returns all annotations when any annotation
// is updated, not just the changed one.
TEST_F(AnnotationsManagerTest, WatchAnnotationsReturnsAllAnnotations) {
  AnnotationsManager annotations;

  fuchsia::element::AnnotationControllerPtr controller;
  annotations.Connect(controller.NewRequest());

  // Set multiple annotations.
  std::vector<fuchsia::element::Annotation> annotations_to_set;
  annotations_to_set.push_back(
      MakeAnnotation(kAnnotationName1, kAnnotationValue1));
  annotations_to_set.push_back(
      MakeAnnotation(kAnnotationName2, kAnnotationValue2));
  annotations.UpdateAnnotations(std::move(annotations_to_set));

  // Dispatch an initial watch, that will return immediately.
  bool received_annotations = false;
  controller->WatchAnnotations([&received_annotations](auto annotations) {
    EXPECT_EQ(annotations.response().annotations.size(), 2u);
    received_annotations = true;
  });
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(received_annotations);

  // Update a single annotation, then call WatchAnnotations() again to verify
  // that all annotations including unchanged ones are returned.
  std::vector<fuchsia::element::Annotation> to_set;
  to_set.push_back(MakeAnnotation(kAnnotationName1, kAnnotationValue2));
  annotations.UpdateAnnotations(std::move(to_set));
  received_annotations = false;
  controller->WatchAnnotations([&received_annotations](auto annotations) {
    EXPECT_EQ(annotations.response().annotations.size(), 2u);
    received_annotations = true;
  });
  base::RunLoop().RunUntilIdle();
  EXPECT_TRUE(received_annotations);
}

// Verifies insertion of a new annotation via UpdateAnnotations().
TEST_F(AnnotationsManagerTest, UpdateAnnotationsSetsAnnotations) {
  AnnotationsManager annotations;

  auto all_annotations = annotations.GetAnnotations();
  ASSERT_EQ(all_annotations.size(), 0u);

  std::vector<fuchsia::element::Annotation> to_set;
  to_set.push_back(MakeAnnotation(kAnnotationName1, kAnnotationValue1));
  annotations.UpdateAnnotations(std::move(to_set));

  all_annotations = annotations.GetAnnotations();
  ASSERT_EQ(all_annotations.size(), 1u);
  EXPECT_EQ(all_annotations[0].key.value, kAnnotationName1);
  ASSERT_TRUE(all_annotations[0].value.is_text());
  EXPECT_EQ(all_annotations[0].value.text(), kAnnotationValue1);
}

// Verifies update of existing annotation via UpdateAnnotations().
TEST_F(AnnotationsManagerTest, UpdateAnnotationsUpdatesAnnotations) {
  AnnotationsManager annotations;

  std::vector<fuchsia::element::Annotation> to_set;
  to_set.push_back(MakeAnnotation(kAnnotationName1, kAnnotationValue1));
  annotations.UpdateAnnotations(std::move(to_set));
  to_set.push_back(MakeAnnotation(kAnnotationName1, kAnnotationValue2));
  annotations.UpdateAnnotations(std::move(to_set));

  auto all_annotations = annotations.GetAnnotations();
  ASSERT_EQ(all_annotations.size(), 1u);
  EXPECT_EQ(all_annotations[0].key.value, kAnnotationName1);
  ASSERT_TRUE(all_annotations[0].value.is_text());
  EXPECT_EQ(all_annotations[0].value.text(), kAnnotationValue2);
}

// Verifies that multiple annotations can be updated or insert in a single call.
TEST_F(AnnotationsManagerTest, UpdateAnnotationsMultipleAnnotations) {
  AnnotationsManager annotations;

  std::vector<fuchsia::element::Annotation> annotations_to_set;
  annotations_to_set.push_back(
      MakeAnnotation(kAnnotationName1, kAnnotationValue1));
  annotations_to_set.push_back(
      MakeAnnotation(kAnnotationName2, kAnnotationValue2));
  annotations.UpdateAnnotations(std::move(annotations_to_set));

  auto all_annotations = annotations.GetAnnotations();
  ASSERT_EQ(all_annotations.size(), 2u);
  EXPECT_EQ(all_annotations[0].key.value, kAnnotationName1);
  ASSERT_TRUE(all_annotations[0].value.is_text());
  EXPECT_EQ(all_annotations[0].value.text(), kAnnotationValue1);
  EXPECT_EQ(all_annotations[1].key.value, kAnnotationName2);
  ASSERT_TRUE(all_annotations[1].value.is_text());
  EXPECT_EQ(all_annotations[1].value.text(), kAnnotationValue2);
}

// Verifies that the controller fails the operation if duplicate annotations
// appear in the same bulk-UpdateAnnotations operation.
TEST_F(AnnotationsManagerTest,
       UpdateAnnotationsMultipleAnnotations_WithDuplicate) {
  AnnotationsManager annotations;

  std::vector<fuchsia::element::Annotation> annotations_to_set;
  annotations_to_set.push_back(
      MakeAnnotation(kAnnotationName1, kAnnotationValue1));
  annotations_to_set.push_back(
      MakeAnnotation(kAnnotationName1, kAnnotationValue2));

  EXPECT_FALSE(annotations.UpdateAnnotations(std::move(annotations_to_set)));
}

}  // namespace

}  // namespace fuchsia_component_support