1 /*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "ecmascript/builtins/builtins_map.h"
17
18 #include "ecmascript/base/builtins_base.h"
19 #include "ecmascript/ecma_runtime_call_info.h"
20 #include "ecmascript/ecma_string.h"
21 #include "ecmascript/ecma_vm.h"
22 #include "ecmascript/global_env.h"
23 #include "ecmascript/js_array.h"
24 #include "ecmascript/js_handle.h"
25 #include "ecmascript/js_hclass.h"
26 #include "ecmascript/js_map.h"
27 #include "ecmascript/js_map_iterator.h"
28 #include "ecmascript/js_object-inl.h"
29 #include "ecmascript/js_tagged_value.h"
30 #include "ecmascript/js_thread.h"
31 #include "ecmascript/object_factory.h"
32 #include "ecmascript/tagged_array-inl.h"
33 #include "ecmascript/tests/test_helper.h"
34
35 using namespace panda::ecmascript;
36 using namespace panda::ecmascript::builtins;
37
38 namespace panda::test {
39 using BuiltinsMap = ecmascript::builtins::BuiltinsMap;
40 using JSMap = ecmascript::JSMap;
41
42 class BuiltinsMapTest : public testing::Test {
43 public:
SetUpTestCase()44 static void SetUpTestCase()
45 {
46 GTEST_LOG_(INFO) << "SetUpTestCase";
47 }
48
TearDownTestCase()49 static void TearDownTestCase()
50 {
51 GTEST_LOG_(INFO) << "TearDownCase";
52 }
53
SetUp()54 void SetUp() override
55 {
56 TestHelper::CreateEcmaVMWithScope(instance, thread, scope);
57 }
58
TearDown()59 void TearDown() override
60 {
61 TestHelper::DestroyEcmaVMWithScope(instance, scope);
62 }
63
64 EcmaVM *instance {nullptr};
65 EcmaHandleScope *scope {nullptr};
66 JSThread *thread {nullptr};
67
68 class TestClass : public base::BuiltinsBase {
69 public:
TestFunc(EcmaRuntimeCallInfo * argv)70 static JSTaggedValue TestFunc(EcmaRuntimeCallInfo *argv)
71 {
72 int num = GetCallArg(argv, 0)->GetInt();
73 JSArray *jsArray = JSArray::Cast(GetThis(argv)->GetTaggedObject());
74 int length = jsArray->GetArrayLength() + num;
75 jsArray->SetArrayLength(argv->GetThread(), length);
76 return JSTaggedValue::Undefined();
77 }
78 };
79 };
80
CreateBuiltinsMap(JSThread * thread)81 JSMap *CreateBuiltinsMap(JSThread *thread)
82 {
83 JSHandle<GlobalEnv> env = thread->GetEcmaVM()->GetGlobalEnv();
84 JSHandle<JSFunction> newTarget(env->GetBuiltinsMapFunction());
85 // 4 : test case
86 auto ecmaRuntimeCallInfo = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue(*newTarget), 4);
87 ecmaRuntimeCallInfo->SetFunction(newTarget.GetTaggedValue());
88 ecmaRuntimeCallInfo->SetThis(JSTaggedValue::Undefined());
89
90 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo);
91 JSTaggedValue result = BuiltinsMap::MapConstructor(ecmaRuntimeCallInfo);
92 TestHelper::TearDownFrame(thread, prev);
93
94 EXPECT_TRUE(result.IsECMAObject());
95 JSMap *jsMap = JSMap::Cast(reinterpret_cast<TaggedObject *>(result.GetRawData()));
96 return jsMap;
97 }
98 // new Map("abrupt").toString()
HWTEST_F_L0(BuiltinsMapTest,CreateAndGetSize)99 HWTEST_F_L0(BuiltinsMapTest, CreateAndGetSize)
100 {
101 ObjectFactory *factory = thread->GetEcmaVM()->GetFactory();
102 JSHandle<GlobalEnv> env = thread->GetEcmaVM()->GetGlobalEnv();
103 JSHandle<JSFunction> newTarget(env->GetBuiltinsMapFunction());
104 JSHandle<JSMap> map(thread, CreateBuiltinsMap(thread));
105
106 auto ecmaRuntimeCallInfo = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 6);
107 ecmaRuntimeCallInfo->SetFunction(JSTaggedValue::Undefined());
108 ecmaRuntimeCallInfo->SetThis(map.GetTaggedValue());
109 ecmaRuntimeCallInfo->SetCallArg(0, JSTaggedValue::Undefined());
110
111 {
112 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo);
113 JSTaggedValue result = BuiltinsMap::GetSize(ecmaRuntimeCallInfo);
114 TestHelper::TearDownFrame(thread, prev);
115
116 EXPECT_EQ(result.GetRawData(), JSTaggedValue(0).GetRawData());
117 }
118 JSHandle<TaggedArray> array(factory->NewTaggedArray(5));
119 for (int i = 0; i < 5; i++) {
120 JSHandle<TaggedArray> internalArray(factory->NewTaggedArray(2));
121 internalArray->Set(thread, 0, JSTaggedValue(i));
122 internalArray->Set(thread, 1, JSTaggedValue(i));
123 auto arr = JSArray::CreateArrayFromList(thread, internalArray);
124 array->Set(thread, i, arr);
125 }
126 JSHandle<JSArray> values = JSArray::CreateArrayFromList(thread, array);
127 auto ecmaRuntimeCallInfo1 = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 6);
128 ecmaRuntimeCallInfo1->SetFunction(newTarget.GetTaggedValue());
129 ecmaRuntimeCallInfo1->SetThis(map.GetTaggedValue());
130 ecmaRuntimeCallInfo1->SetCallArg(0, values.GetTaggedValue());
131 ecmaRuntimeCallInfo1->SetNewTarget(newTarget.GetTaggedValue());
132 {
133 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
134 JSTaggedValue result1 = BuiltinsMap::MapConstructor(ecmaRuntimeCallInfo1);
135 TestHelper::TearDownFrame(thread, prev);
136
137 EXPECT_EQ(JSMap::Cast(reinterpret_cast<TaggedObject *>(result1.GetRawData()))->GetSize(), 5);
138 }
139 }
140
HWTEST_F_L0(BuiltinsMapTest,SetAndHas)141 HWTEST_F_L0(BuiltinsMapTest, SetAndHas)
142 {
143 ObjectFactory *factory = thread->GetEcmaVM()->GetFactory();
144 // create jsMap
145 JSHandle<JSMap> map(thread, CreateBuiltinsMap(thread));
146 JSHandle<JSTaggedValue> key(factory->NewFromASCII("key"));
147
148 auto ecmaRuntimeCallInfo = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 8);
149 ecmaRuntimeCallInfo->SetFunction(JSTaggedValue::Undefined());
150 ecmaRuntimeCallInfo->SetThis(map.GetTaggedValue());
151 ecmaRuntimeCallInfo->SetCallArg(0, key.GetTaggedValue());
152 ecmaRuntimeCallInfo->SetCallArg(1, JSTaggedValue(static_cast<int32_t>(1)));
153
154 JSMap *jsMap;
155 {
156 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo);
157 JSTaggedValue result1 = BuiltinsMap::Has(ecmaRuntimeCallInfo);
158
159 EXPECT_EQ(result1.GetRawData(), JSTaggedValue::False().GetRawData());
160
161 // test Set()
162 JSTaggedValue result2 = BuiltinsMap::Set(ecmaRuntimeCallInfo);
163
164 EXPECT_TRUE(result2.IsECMAObject());
165 jsMap = JSMap::Cast(reinterpret_cast<TaggedObject *>(result2.GetRawData()));
166 EXPECT_EQ(jsMap->GetSize(), 1);
167 }
168
169 // test Has()
170 auto ecmaRuntimeCallInfo1 = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 8);
171 ecmaRuntimeCallInfo1->SetFunction(JSTaggedValue::Undefined());
172 ecmaRuntimeCallInfo1->SetThis(JSTaggedValue(jsMap));
173 ecmaRuntimeCallInfo1->SetCallArg(0, key.GetTaggedValue());
174 ecmaRuntimeCallInfo1->SetCallArg(1, JSTaggedValue(static_cast<int32_t>(1)));
175 {
176 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
177 JSTaggedValue result3 = BuiltinsMap::Has(ecmaRuntimeCallInfo1);
178
179 EXPECT_EQ(result3.GetRawData(), JSTaggedValue::True().GetRawData());
180 }
181 }
182
HWTEST_F_L0(BuiltinsMapTest,ForEach)183 HWTEST_F_L0(BuiltinsMapTest, ForEach)
184 {
185 // generate a map has 5 entries{key1:0,key2:1,key3:2,key4:3,key5:4}
186 ObjectFactory *factory = thread->GetEcmaVM()->GetFactory();
187 JSHandle<GlobalEnv> env = thread->GetEcmaVM()->GetGlobalEnv();
188 JSHandle<JSMap> map(thread, CreateBuiltinsMap(thread));
189 char keyArray[] = "key0";
190 for (uint32_t i = 0; i < 5; i++) {
191 keyArray[3] = '1' + i;
192 JSHandle<JSTaggedValue> key(factory->NewFromASCII(keyArray));
193 auto ecmaRuntimeCallInfo = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 8);
194 ecmaRuntimeCallInfo->SetFunction(JSTaggedValue::Undefined());
195 ecmaRuntimeCallInfo->SetThis(map.GetTaggedValue());
196 ecmaRuntimeCallInfo->SetCallArg(0, key.GetTaggedValue());
197 ecmaRuntimeCallInfo->SetCallArg(1, JSTaggedValue(static_cast<int32_t>(i)));
198
199 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo);
200 JSTaggedValue result1 = BuiltinsMap::Set(ecmaRuntimeCallInfo);
201 TestHelper::TearDownFrame(thread, prev);
202 EXPECT_TRUE(result1.IsECMAObject());
203 JSMap *jsMap = JSMap::Cast(reinterpret_cast<TaggedObject *>(result1.GetRawData()));
204 EXPECT_EQ(jsMap->GetSize(), static_cast<int>(i) + 1);
205 }
206 JSHandle<JSArray> jsArray(JSArray::ArrayCreate(thread, JSTaggedNumber(0)));
207 JSHandle<JSFunction> func = factory->NewJSFunction(env, reinterpret_cast<void *>(TestClass::TestFunc));
208
209 auto ecmaRuntimeCallInfo1 = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 8);
210 ecmaRuntimeCallInfo1->SetFunction(JSTaggedValue::Undefined());
211 ecmaRuntimeCallInfo1->SetThis(map.GetTaggedValue());
212 ecmaRuntimeCallInfo1->SetCallArg(0, func.GetTaggedValue());
213 ecmaRuntimeCallInfo1->SetCallArg(1, jsArray.GetTaggedValue());
214
215 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
216 JSTaggedValue result2 = BuiltinsMap::ForEach(ecmaRuntimeCallInfo1);
217 TestHelper::TearDownFrame(thread, prev);
218
219 EXPECT_EQ(result2.GetRawData(), JSTaggedValue::VALUE_UNDEFINED);
220 EXPECT_EQ(jsArray->GetArrayLength(), 10U);
221 }
222
HWTEST_F_L0(BuiltinsMapTest,DeleteAndRemove)223 HWTEST_F_L0(BuiltinsMapTest, DeleteAndRemove)
224 {
225 ObjectFactory *factory = thread->GetEcmaVM()->GetFactory();
226 // create jsMap
227 JSHandle<JSMap> map(thread, CreateBuiltinsMap(thread));
228
229 // add 40 keys
230 char keyArray[] = "key0";
231 for (uint32_t i = 0; i < 40; i++) {
232 keyArray[3] = '1' + i;
233 JSHandle<JSTaggedValue> key(thread, factory->NewFromASCII(keyArray).GetTaggedValue());
234 auto ecmaRuntimeCallInfo = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 8);
235 ecmaRuntimeCallInfo->SetFunction(JSTaggedValue::Undefined());
236 ecmaRuntimeCallInfo->SetThis(map.GetTaggedValue());
237 ecmaRuntimeCallInfo->SetCallArg(0, key.GetTaggedValue());
238 ecmaRuntimeCallInfo->SetCallArg(1, JSTaggedValue(static_cast<int32_t>(i)));
239
240 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo);
241 JSTaggedValue result1 = BuiltinsMap::Set(ecmaRuntimeCallInfo);
242 TestHelper::TearDownFrame(thread, prev);
243
244 EXPECT_TRUE(result1.IsECMAObject());
245 JSMap *jsMap = JSMap::Cast(reinterpret_cast<TaggedObject *>(result1.GetRawData()));
246 EXPECT_EQ(jsMap->GetSize(), static_cast<int>(i) + 1);
247 }
248 // whether jsMap has delete key
249 keyArray[3] = '1' + 8;
250 JSHandle<JSTaggedValue> deleteKey(factory->NewFromASCII(keyArray));
251
252 auto ecmaRuntimeCallInfo1 = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 6);
253 ecmaRuntimeCallInfo1->SetFunction(JSTaggedValue::Undefined());
254 ecmaRuntimeCallInfo1->SetThis(map.GetTaggedValue());
255 ecmaRuntimeCallInfo1->SetCallArg(0, deleteKey.GetTaggedValue());
256
257 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
258 JSTaggedValue result2 = BuiltinsMap::Has(ecmaRuntimeCallInfo1);
259 TestHelper::TearDownFrame(thread, prev);
260
261 EXPECT_EQ(result2.GetRawData(), JSTaggedValue::True().GetRawData());
262
263 // delete
264 [[maybe_unused]] auto prev1 = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
265 JSTaggedValue result3 = BuiltinsMap::Delete(ecmaRuntimeCallInfo1);
266 TestHelper::TearDownFrame(thread, prev1);
267 EXPECT_EQ(result3.GetRawData(), JSTaggedValue::True().GetRawData());
268
269 // check deleteKey is deleted
270 [[maybe_unused]] auto prev2 = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
271 JSTaggedValue result4 = BuiltinsMap::Has(ecmaRuntimeCallInfo1);
272 TestHelper::TearDownFrame(thread, prev2);
273 EXPECT_EQ(result4.GetRawData(), JSTaggedValue::False().GetRawData());
274 [[maybe_unused]] auto prev3 = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
275 JSTaggedValue result5 = BuiltinsMap::GetSize(ecmaRuntimeCallInfo1);
276 TestHelper::TearDownFrame(thread, prev3);
277 EXPECT_EQ(result5.GetRawData(), JSTaggedValue(39).GetRawData());
278
279 // clear
280 [[maybe_unused]] auto prev4 = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo1);
281 JSTaggedValue result6 = BuiltinsMap::Clear(ecmaRuntimeCallInfo1);
282 TestHelper::TearDownFrame(thread, prev4);
283 EXPECT_EQ(result6.GetRawData(), JSTaggedValue::VALUE_UNDEFINED);
284 EXPECT_EQ(map->GetSize(), 0);
285 }
286
HWTEST_F_L0(BuiltinsMapTest,Species)287 HWTEST_F_L0(BuiltinsMapTest, Species)
288 {
289 ObjectFactory *factory = thread->GetEcmaVM()->GetFactory();
290 JSHandle<GlobalEnv> env = thread->GetEcmaVM()->GetGlobalEnv();
291 JSHandle<JSTaggedValue> map(thread, CreateBuiltinsMap(thread));
292
293 // test species
294 JSHandle<JSTaggedValue> speciesSymbol = env->GetSpeciesSymbol();
295 EXPECT_TRUE(!speciesSymbol.GetTaggedValue().IsUndefined());
296
297 JSHandle<JSFunction> newTarget(env->GetBuiltinsMapFunction());
298
299 JSTaggedValue value =
300 JSObject::GetProperty(thread, JSHandle<JSTaggedValue>(newTarget), speciesSymbol).GetValue().GetTaggedValue();
301 JSHandle<JSTaggedValue> valueHandle(thread, value);
302 EXPECT_EQ(value, newTarget.GetTaggedValue());
303
304 // to string tag
305 JSHandle<JSTaggedValue> toStringTagSymbol = env->GetToStringTagSymbol();
306 JSHandle<EcmaString> stringTag(JSObject::GetProperty(thread, map, toStringTagSymbol).GetValue());
307 JSHandle<EcmaString> str = factory->NewFromASCII("Map");
308 EXPECT_TRUE(!stringTag.GetTaggedValue().IsUndefined());
309 EXPECT_TRUE(EcmaStringAccessor::StringsAreEqual(*str, *stringTag));
310
311 JSHandle<JSFunction> constructor = JSHandle<JSFunction>::Cast(JSTaggedValue::ToObject(thread, valueHandle));
312 EXPECT_EQ(JSTaggedValue::GetPrototype(thread, map), constructor->GetFunctionPrototype());
313
314 JSHandle<JSTaggedValue> key1(factory->NewFromASCII("set"));
315 JSTaggedValue value1 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
316 EXPECT_FALSE(value1.IsUndefined());
317
318 JSHandle<JSTaggedValue> key2(factory->NewFromASCII("has"));
319 JSTaggedValue value2 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
320 EXPECT_FALSE(value2.IsUndefined());
321
322 JSHandle<JSTaggedValue> key3(factory->NewFromASCII("clear"));
323 JSTaggedValue value3 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
324 EXPECT_FALSE(value3.IsUndefined());
325
326 JSHandle<JSTaggedValue> key4(factory->NewFromASCII("size"));
327 JSTaggedValue value4 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
328 EXPECT_FALSE(value4.IsUndefined());
329
330 JSHandle<JSTaggedValue> key5(factory->NewFromASCII("delete"));
331 JSTaggedValue value5 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
332 EXPECT_FALSE(value5.IsUndefined());
333
334 JSHandle<JSTaggedValue> key6(factory->NewFromASCII("forEach"));
335 JSTaggedValue value6 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
336 EXPECT_FALSE(value6.IsUndefined());
337
338 JSHandle<JSTaggedValue> key7(factory->NewFromASCII("get"));
339 JSTaggedValue value7 = JSObject::GetProperty(thread, map, key1).GetValue().GetTaggedValue();
340 EXPECT_FALSE(value7.IsUndefined());
341 }
342
HWTEST_F_L0(BuiltinsMapTest,GetIterator)343 HWTEST_F_L0(BuiltinsMapTest, GetIterator)
344 {
345 JSHandle<JSTaggedValue> map(thread, CreateBuiltinsMap(thread));
346 auto ecmaRuntimeCallInfo = TestHelper::CreateEcmaRuntimeCallInfo(thread, JSTaggedValue::Undefined(), 4);
347 ecmaRuntimeCallInfo->SetFunction(JSTaggedValue::Undefined());
348 ecmaRuntimeCallInfo->SetThis(map.GetTaggedValue());
349 [[maybe_unused]] auto prev = TestHelper::SetupFrame(thread, ecmaRuntimeCallInfo);
350
351 // test Values()
352 JSTaggedValue result = BuiltinsMap::Values(ecmaRuntimeCallInfo);
353 JSHandle<JSMapIterator> iter(thread, result);
354 EXPECT_TRUE(iter->IsJSMapIterator());
355 EXPECT_EQ(IterationKind::VALUE, iter->GetIterationKind());
356 EXPECT_EQ(JSMap::Cast(map.GetTaggedValue().GetTaggedObject())->GetLinkedMap(), iter->GetIteratedMap());
357
358 // test Keys()
359 JSTaggedValue result1 = BuiltinsMap::Keys(ecmaRuntimeCallInfo);
360 JSHandle<JSMapIterator> iter1(thread, result1);
361 EXPECT_TRUE(iter1->IsJSMapIterator());
362 EXPECT_EQ(IterationKind::KEY, iter1->GetIterationKind());
363
364 // test entries()
365 JSTaggedValue result2 = BuiltinsMap::Entries(ecmaRuntimeCallInfo);
366 JSHandle<JSMapIterator> iter2(thread, result2);
367 EXPECT_TRUE(iter2->IsJSMapIterator());
368 EXPECT_EQ(IterationKind::KEY_AND_VALUE, iter2->GetIterationKind());
369 TestHelper::TearDownFrame(thread, prev);
370 }
371 } // namespace panda::test
372