TableFlattener_test.cpp revision 1ab598f46c3ff520a67f9d80194847741f3467ab 
1/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "flatten/TableFlattener.h"
18#include "unflatten/BinaryResourceParser.h"
19#include "util/Util.h"
20
21#include "test/Builders.h"
22#include "test/Context.h"
23
24#include <gtest/gtest.h>
25
26using namespace android;
27
28namespace aapt {
29
30class TableFlattenerTest : public ::testing::Test {
31public:
32    void SetUp() override {
33        mContext = test::ContextBuilder()
34                .setCompilationPackage(u"com.app.test")
35                .setPackageId(0x7f)
36                .build();
37    }
38
39    ::testing::AssertionResult flatten(ResourceTable* table, ResTable* outTable) {
40        BigBuffer buffer(1024);
41        TableFlattenerOptions options = {};
42        options.useExtendedChunks = true;
43        TableFlattener flattener(&buffer, options);
44        if (!flattener.consume(mContext.get(), table)) {
45            return ::testing::AssertionFailure() << "failed to flatten ResourceTable";
46        }
47
48        std::unique_ptr<uint8_t[]> data = util::copy(buffer);
49        if (outTable->add(data.get(), buffer.size(), -1, true) != NO_ERROR) {
50            return ::testing::AssertionFailure() << "flattened ResTable is corrupt";
51        }
52        return ::testing::AssertionSuccess();
53    }
54
55    ::testing::AssertionResult flatten(ResourceTable* table, ResourceTable* outTable) {
56        BigBuffer buffer(1024);
57        TableFlattenerOptions options = {};
58        options.useExtendedChunks = true;
59        TableFlattener flattener(&buffer, options);
60        if (!flattener.consume(mContext.get(), table)) {
61            return ::testing::AssertionFailure() << "failed to flatten ResourceTable";
62        }
63
64        std::unique_ptr<uint8_t[]> data = util::copy(buffer);
65        BinaryResourceParser parser(mContext.get(), outTable, {}, data.get(), buffer.size());
66        if (!parser.parse()) {
67            return ::testing::AssertionFailure() << "flattened ResTable is corrupt";
68        }
69        return ::testing::AssertionSuccess();
70    }
71
72    ::testing::AssertionResult exists(ResTable* table,
73                                      const StringPiece16& expectedName,
74                                      const ResourceId expectedId,
75                                      const ConfigDescription& expectedConfig,
76                                      const uint8_t expectedDataType, const uint32_t expectedData,
77                                      const uint32_t expectedSpecFlags) {
78        const ResourceName expectedResName = test::parseNameOrDie(expectedName);
79
80        table->setParameters(&expectedConfig);
81
82        ResTable_config config;
83        Res_value val;
84        uint32_t specFlags;
85        if (table->getResource(expectedId.id, &val, false, 0, &specFlags, &config) < 0) {
86            return ::testing::AssertionFailure() << "could not find resource with";
87        }
88
89        if (expectedDataType != val.dataType) {
90            return ::testing::AssertionFailure()
91                    << "expected data type "
92                    << std::hex << (int) expectedDataType << " but got data type "
93                    << (int) val.dataType << std::dec << " instead";
94        }
95
96        if (expectedData != val.data) {
97            return ::testing::AssertionFailure()
98                    << "expected data "
99                    << std::hex << expectedData << " but got data "
100                    << val.data << std::dec << " instead";
101        }
102
103        if (expectedSpecFlags != specFlags) {
104            return ::testing::AssertionFailure()
105                    << "expected specFlags "
106                    << std::hex << expectedSpecFlags << " but got specFlags "
107                    << specFlags << std::dec << " instead";
108        }
109
110        ResTable::resource_name actualName;
111        if (!table->getResourceName(expectedId.id, false, &actualName)) {
112            return ::testing::AssertionFailure() << "failed to find resource name";
113        }
114
115        StringPiece16 package16(actualName.package, actualName.packageLen);
116        if (package16 != expectedResName.package) {
117            return ::testing::AssertionFailure()
118                    << "expected package '" << expectedResName.package << "' but got '"
119                    << package16 << "'";
120        }
121
122        StringPiece16 type16(actualName.type, actualName.typeLen);
123        if (type16 != toString(expectedResName.type)) {
124            return ::testing::AssertionFailure()
125                    << "expected type '" << expectedResName.type
126                    << "' but got '" << type16 << "'";
127        }
128
129        StringPiece16 name16(actualName.name, actualName.nameLen);
130        if (name16 != expectedResName.entry) {
131            return ::testing::AssertionFailure()
132                    << "expected name '" << expectedResName.entry
133                    << "' but got '" << name16 << "'";
134        }
135
136        if (expectedConfig != config) {
137            return ::testing::AssertionFailure()
138                    << "expected config '" << expectedConfig << "' but got '"
139                    << ConfigDescription(config) << "'";
140        }
141        return ::testing::AssertionSuccess();
142    }
143
144private:
145    std::unique_ptr<IAaptContext> mContext;
146};
147
148TEST_F(TableFlattenerTest, FlattenFullyLinkedTable) {
149    std::unique_ptr<ResourceTable> table = test::ResourceTableBuilder()
150            .setPackageId(u"com.app.test", 0x7f)
151            .addSimple(u"@com.app.test:id/one", ResourceId(0x7f020000))
152            .addSimple(u"@com.app.test:id/two", ResourceId(0x7f020001))
153            .addValue(u"@com.app.test:id/three", ResourceId(0x7f020002),
154                      test::buildReference(u"@com.app.test:id/one", ResourceId(0x7f020000)))
155            .addValue(u"@com.app.test:integer/one", ResourceId(0x7f030000),
156                      util::make_unique<BinaryPrimitive>(uint8_t(Res_value::TYPE_INT_DEC), 1u))
157            .addValue(u"@com.app.test:integer/one", ResourceId(0x7f030000),
158                      test::parseConfigOrDie("v1"),
159                      util::make_unique<BinaryPrimitive>(uint8_t(Res_value::TYPE_INT_DEC), 2u))
160            .addString(u"@com.app.test:string/test", ResourceId(0x7f040000), u"foo")
161            .addString(u"@com.app.test:layout/bar", ResourceId(0x7f050000), u"res/layout/bar.xml")
162            .build();
163
164    ResTable resTable;
165    ASSERT_TRUE(flatten(table.get(), &resTable));
166
167    EXPECT_TRUE(exists(&resTable, u"@com.app.test:id/one", ResourceId(0x7f020000), {},
168                       Res_value::TYPE_INT_BOOLEAN, 0u, 0u));
169
170    EXPECT_TRUE(exists(&resTable, u"@com.app.test:id/two", ResourceId(0x7f020001), {},
171                       Res_value::TYPE_INT_BOOLEAN, 0u, 0u));
172
173    EXPECT_TRUE(exists(&resTable, u"@com.app.test:id/three", ResourceId(0x7f020002), {},
174                       Res_value::TYPE_REFERENCE, 0x7f020000u, 0u));
175
176    EXPECT_TRUE(exists(&resTable, u"@com.app.test:integer/one", ResourceId(0x7f030000),
177                       {}, Res_value::TYPE_INT_DEC, 1u,
178                       ResTable_config::CONFIG_VERSION));
179
180    EXPECT_TRUE(exists(&resTable, u"@com.app.test:integer/one", ResourceId(0x7f030000),
181                       test::parseConfigOrDie("v1"), Res_value::TYPE_INT_DEC, 2u,
182                       ResTable_config::CONFIG_VERSION));
183
184    StringPiece16 fooStr = u"foo";
185    ssize_t idx = resTable.getTableStringBlock(0)->indexOfString(fooStr.data(), fooStr.size());
186    ASSERT_GE(idx, 0);
187    EXPECT_TRUE(exists(&resTable, u"@com.app.test:string/test", ResourceId(0x7f040000),
188                       {}, Res_value::TYPE_STRING, (uint32_t) idx, 0u));
189
190    StringPiece16 barPath = u"res/layout/bar.xml";
191    idx = resTable.getTableStringBlock(0)->indexOfString(barPath.data(), barPath.size());
192    ASSERT_GE(idx, 0);
193    EXPECT_TRUE(exists(&resTable, u"@com.app.test:layout/bar", ResourceId(0x7f050000), {},
194                       Res_value::TYPE_STRING, (uint32_t) idx, 0u));
195}
196
197TEST_F(TableFlattenerTest, FlattenEntriesWithGapsInIds) {
198    std::unique_ptr<ResourceTable> table = test::ResourceTableBuilder()
199            .setPackageId(u"com.app.test", 0x7f)
200            .addSimple(u"@com.app.test:id/one", ResourceId(0x7f020001))
201            .addSimple(u"@com.app.test:id/three", ResourceId(0x7f020003))
202            .build();
203
204    ResTable resTable;
205    ASSERT_TRUE(flatten(table.get(), &resTable));
206
207    EXPECT_TRUE(exists(&resTable, u"@com.app.test:id/one", ResourceId(0x7f020001), {},
208                       Res_value::TYPE_INT_BOOLEAN, 0u, 0u));
209    EXPECT_TRUE(exists(&resTable, u"@com.app.test:id/three", ResourceId(0x7f020003), {},
210                           Res_value::TYPE_INT_BOOLEAN, 0u, 0u));
211}
212
213TEST_F(TableFlattenerTest, FlattenUnlinkedTable) {
214    std::unique_ptr<ResourceTable> table = test::ResourceTableBuilder()
215            .setPackageId(u"com.app.test", 0x7f)
216            .addValue(u"@com.app.test:integer/one", ResourceId(0x7f020000),
217                      test::buildReference(u"@android:integer/foo"))
218            .addValue(u"@com.app.test:style/Theme", ResourceId(0x7f030000), test::StyleBuilder()
219                    .setParent(u"@android:style/Theme.Material")
220                    .addItem(u"@android:attr/background", {})
221                    .addItem(u"@android:attr/colorAccent",
222                             test::buildReference(u"@com.app.test:color/green"))
223                    .build())
224            .build();
225
226    {
227        // Need access to stringPool to make RawString.
228        Style* style = test::getValue<Style>(table.get(), u"@com.app.test:style/Theme");
229        style->entries[0].value = util::make_unique<RawString>(table->stringPool.makeRef(u"foo"));
230    }
231
232    ResourceTable finalTable;
233    ASSERT_TRUE(flatten(table.get(), &finalTable));
234
235    Reference* ref = test::getValue<Reference>(&finalTable, u"@com.app.test:integer/one");
236    ASSERT_NE(ref, nullptr);
237    AAPT_ASSERT_TRUE(ref->name);
238    EXPECT_EQ(ref->name.value(), test::parseNameOrDie(u"@android:integer/foo"));
239
240    Style* style = test::getValue<Style>(&finalTable, u"@com.app.test:style/Theme");
241    ASSERT_NE(style, nullptr);
242    AAPT_ASSERT_TRUE(style->parent);
243    AAPT_ASSERT_TRUE(style->parent.value().name);
244    EXPECT_EQ(style->parent.value().name.value(),
245              test::parseNameOrDie(u"@android:style/Theme.Material"));
246
247    ASSERT_EQ(2u, style->entries.size());
248
249    AAPT_ASSERT_TRUE(style->entries[0].key.name);
250    EXPECT_EQ(style->entries[0].key.name.value(),
251              test::parseNameOrDie(u"@android:attr/background"));
252    RawString* raw = valueCast<RawString>(style->entries[0].value.get());
253    ASSERT_NE(raw, nullptr);
254    EXPECT_EQ(*raw->value, u"foo");
255
256    AAPT_ASSERT_TRUE(style->entries[1].key.name);
257    EXPECT_EQ(style->entries[1].key.name.value(),
258              test::parseNameOrDie(u"@android:attr/colorAccent"));
259    ref = valueCast<Reference>(style->entries[1].value.get());
260    ASSERT_NE(ref, nullptr);
261    AAPT_ASSERT_TRUE(ref->name);
262    EXPECT_EQ(ref->name.value(), test::parseNameOrDie(u"@com.app.test:color/green"));
263}
264
265} // namespace aapt
266