blob: c13b049eadfe64cc3fe77e159ea8bb7ab610e255 [file] [log] [blame]
Mårten Kongstad02751232018-04-27 13:16:32 +02001/*
2 * Copyright (C) 2018 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 <cstdio> // fclose
Mårten Kongstad02751232018-04-27 13:16:32 +020018#include <fstream>
19#include <memory>
20#include <sstream>
21#include <string>
Mårten Kongstadce424902019-03-01 08:35:37 +010022#include <utility>
Mårten Kongstad02751232018-04-27 13:16:32 +020023#include <vector>
24
Winson62ac8b52019-12-04 08:36:48 -080025#include "R.h"
26#include "TestConstants.h"
Ryan Mitchell52e1f7a2019-04-12 12:31:42 -070027#include "TestHelpers.h"
Mårten Kongstad02751232018-04-27 13:16:32 +020028#include "android-base/macros.h"
29#include "androidfw/ApkAssets.h"
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080030#include "androidfw/ResourceUtils.h"
Ryan Mitchell52e1f7a2019-04-12 12:31:42 -070031#include "gmock/gmock.h"
32#include "gtest/gtest.h"
Mårten Kongstad02751232018-04-27 13:16:32 +020033#include "idmap2/BinaryStreamVisitor.h"
34#include "idmap2/CommandLineOptions.h"
35#include "idmap2/Idmap.h"
Mårten Kongstadd7e8a532019-10-11 08:32:04 +020036#include "idmap2/LogInfo.h"
Mårten Kongstad02751232018-04-27 13:16:32 +020037
Ryan Mitchelle753ffe2019-09-23 09:47:02 -070038using android::Res_value;
Mårten Kongstad02751232018-04-27 13:16:32 +020039using ::testing::NotNull;
40
Winson62ac8b52019-12-04 08:36:48 -080041using PolicyFlags = android::ResTable_overlayable_policy_header::PolicyFlags;
42
Mårten Kongstad0eba72a2018-11-29 08:23:14 +010043namespace android::idmap2 {
Mårten Kongstad02751232018-04-27 13:16:32 +020044
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -070045#define ASSERT_TARGET_ENTRY(entry, target_resid, overlay_resid) \
46 ASSERT_EQ((entry).target_id, (target_resid)); \
47 ASSERT_EQ((entry).overlay_id, (overlay_resid))
48
49#define ASSERT_TARGET_INLINE_ENTRY(entry, target_resid, expected_type, expected_value) \
50 ASSERT_EQ((entry).target_id, target_resid); \
51 ASSERT_EQ((entry).value.data_type, (expected_type)); \
52 ASSERT_EQ((entry).value.data_value, (expected_value))
Ryan Mitchelle753ffe2019-09-23 09:47:02 -070053
54#define ASSERT_OVERLAY_ENTRY(entry, overlay_resid, target_resid) \
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -070055 ASSERT_EQ((entry).overlay_id, (overlay_resid)); \
56 ASSERT_EQ((entry).target_id, (target_resid))
Ryan Mitchelle753ffe2019-09-23 09:47:02 -070057
Mårten Kongstad02751232018-04-27 13:16:32 +020058TEST(IdmapTests, TestCanonicalIdmapPathFor) {
59 ASSERT_EQ(Idmap::CanonicalIdmapPathFor("/foo", "/vendor/overlay/bar.apk"),
60 "/foo/vendor@overlay@bar.apk@idmap");
61}
62
63TEST(IdmapTests, CreateIdmapHeaderFromBinaryStream) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080064 std::string raw(reinterpret_cast<const char*>(idmap_raw_data), kIdmapRawDataLen);
Mårten Kongstad02751232018-04-27 13:16:32 +020065 std::istringstream stream(raw);
66 std::unique_ptr<const IdmapHeader> header = IdmapHeader::FromBinaryStream(stream);
67 ASSERT_THAT(header, NotNull());
Mårten Kongstadb8779022018-11-29 09:53:17 +010068 ASSERT_EQ(header->GetMagic(), 0x504d4449U);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080069 ASSERT_EQ(header->GetVersion(), 0x07U);
Mårten Kongstadb8779022018-11-29 09:53:17 +010070 ASSERT_EQ(header->GetTargetCrc(), 0x1234U);
71 ASSERT_EQ(header->GetOverlayCrc(), 0x5678U);
Ryan Mitchella7070132020-05-13 14:17:52 -070072 ASSERT_EQ(header->GetFulfilledPolicies(), 0x11);
73 ASSERT_EQ(header->GetEnforceOverlayable(), true);
Ryan Mitchell0699f1d2020-12-03 15:41:42 -080074 ASSERT_EQ(header->GetTargetPath(), "targetX.apk");
75 ASSERT_EQ(header->GetOverlayPath(), "overlayX.apk");
Mårten Kongstadd7e8a532019-10-11 08:32:04 +020076 ASSERT_EQ(header->GetDebugInfo(), "debug");
Mårten Kongstad02751232018-04-27 13:16:32 +020077}
78
Mårten Kongstad02751232018-04-27 13:16:32 +020079TEST(IdmapTests, CreateIdmapDataHeaderFromBinaryStream) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080080 const size_t offset = kIdmapRawDataOffset;
Mårten Kongstad02751232018-04-27 13:16:32 +020081 std::string raw(reinterpret_cast<const char*>(idmap_raw_data + offset),
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080082 kIdmapRawDataLen - offset);
Mårten Kongstad02751232018-04-27 13:16:32 +020083 std::istringstream stream(raw);
84
85 std::unique_ptr<const IdmapData::Header> header = IdmapData::Header::FromBinaryStream(stream);
86 ASSERT_THAT(header, NotNull());
Ryan Mitchelle753ffe2019-09-23 09:47:02 -070087 ASSERT_EQ(header->GetTargetEntryCount(), 0x03);
88 ASSERT_EQ(header->GetOverlayEntryCount(), 0x03);
Mårten Kongstad02751232018-04-27 13:16:32 +020089}
90
91TEST(IdmapTests, CreateIdmapDataFromBinaryStream) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080092 const size_t offset = kIdmapRawDataOffset;
Mårten Kongstad02751232018-04-27 13:16:32 +020093 std::string raw(reinterpret_cast<const char*>(idmap_raw_data + offset),
Ryan Mitchell30dc2e02020-12-02 11:43:18 -080094 kIdmapRawDataLen - offset);
Mårten Kongstad02751232018-04-27 13:16:32 +020095 std::istringstream stream(raw);
96
97 std::unique_ptr<const IdmapData> data = IdmapData::FromBinaryStream(stream);
98 ASSERT_THAT(data, NotNull());
Mårten Kongstad02751232018-04-27 13:16:32 +020099
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700100 const auto& target_entries = data->GetTargetEntries();
101 ASSERT_EQ(target_entries.size(), 3U);
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700102 ASSERT_TARGET_ENTRY(target_entries[0], 0x7f020000, 0x7f020000);
103 ASSERT_TARGET_ENTRY(target_entries[1], 0x7f030000, 0x7f030000);
104 ASSERT_TARGET_ENTRY(target_entries[2], 0x7f030002, 0x7f030001);
105
106 const auto& target_inline_entries = data->GetTargetInlineEntries();
107 ASSERT_EQ(target_inline_entries.size(), 1U);
108 ASSERT_TARGET_INLINE_ENTRY(target_inline_entries[0], 0x7f040000, Res_value::TYPE_INT_HEX,
109 0x12345678);
Mårten Kongstad02751232018-04-27 13:16:32 +0200110
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700111 const auto& overlay_entries = data->GetOverlayEntries();
112 ASSERT_EQ(target_entries.size(), 3U);
113 ASSERT_OVERLAY_ENTRY(overlay_entries[0], 0x7f020000, 0x7f020000);
114 ASSERT_OVERLAY_ENTRY(overlay_entries[1], 0x7f030000, 0x7f030000);
115 ASSERT_OVERLAY_ENTRY(overlay_entries[2], 0x7f030001, 0x7f030002);
Mårten Kongstad02751232018-04-27 13:16:32 +0200116}
117
118TEST(IdmapTests, CreateIdmapFromBinaryStream) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800119 std::string raw(reinterpret_cast<const char*>(idmap_raw_data), kIdmapRawDataLen);
Mårten Kongstad02751232018-04-27 13:16:32 +0200120 std::istringstream stream(raw);
121
Mårten Kongstadce424902019-03-01 08:35:37 +0100122 auto result = Idmap::FromBinaryStream(stream);
123 ASSERT_TRUE(result);
124 const auto idmap = std::move(*result);
Mårten Kongstad02751232018-04-27 13:16:32 +0200125
126 ASSERT_THAT(idmap->GetHeader(), NotNull());
Mårten Kongstadb8779022018-11-29 09:53:17 +0100127 ASSERT_EQ(idmap->GetHeader()->GetMagic(), 0x504d4449U);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800128 ASSERT_EQ(idmap->GetHeader()->GetVersion(), 0x07U);
Mårten Kongstadb8779022018-11-29 09:53:17 +0100129 ASSERT_EQ(idmap->GetHeader()->GetTargetCrc(), 0x1234U);
130 ASSERT_EQ(idmap->GetHeader()->GetOverlayCrc(), 0x5678U);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800131 ASSERT_EQ(idmap->GetHeader()->GetFulfilledPolicies(), kIdmapRawDataPolicies);
Ryan Mitchella7070132020-05-13 14:17:52 -0700132 ASSERT_EQ(idmap->GetHeader()->GetEnforceOverlayable(), true);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800133 ASSERT_EQ(idmap->GetHeader()->GetTargetPath(), kIdmapRawTargetPath);
134 ASSERT_EQ(idmap->GetHeader()->GetOverlayPath(), kIdmapRawOverlayPath);
135 ASSERT_EQ(idmap->GetHeader()->GetOverlayName(), kIdmapRawOverlayName);
Mårten Kongstad02751232018-04-27 13:16:32 +0200136
137 const std::vector<std::unique_ptr<const IdmapData>>& dataBlocks = idmap->GetData();
Mårten Kongstadb8779022018-11-29 09:53:17 +0100138 ASSERT_EQ(dataBlocks.size(), 1U);
Mårten Kongstad02751232018-04-27 13:16:32 +0200139
140 const std::unique_ptr<const IdmapData>& data = dataBlocks[0];
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700141 ASSERT_THAT(data, NotNull());
Mårten Kongstad02751232018-04-27 13:16:32 +0200142
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700143 const auto& target_entries = data->GetTargetEntries();
144 ASSERT_EQ(target_entries.size(), 3U);
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700145 ASSERT_TARGET_ENTRY(target_entries[0], 0x7f020000, 0x7f020000);
146 ASSERT_TARGET_ENTRY(target_entries[1], 0x7f030000, 0x7f030000);
147 ASSERT_TARGET_ENTRY(target_entries[2], 0x7f030002, 0x7f030001);
148
149 const auto& target_inline_entries = data->GetTargetInlineEntries();
150 ASSERT_EQ(target_inline_entries.size(), 1U);
151 ASSERT_TARGET_INLINE_ENTRY(target_inline_entries[0], 0x7f040000, Res_value::TYPE_INT_HEX,
152 0x12345678);
Mårten Kongstad02751232018-04-27 13:16:32 +0200153
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700154 const auto& overlay_entries = data->GetOverlayEntries();
155 ASSERT_EQ(target_entries.size(), 3U);
156 ASSERT_OVERLAY_ENTRY(overlay_entries[0], 0x7f020000, 0x7f020000);
157 ASSERT_OVERLAY_ENTRY(overlay_entries[1], 0x7f030000, 0x7f030000);
158 ASSERT_OVERLAY_ENTRY(overlay_entries[2], 0x7f030001, 0x7f030002);
Mårten Kongstad02751232018-04-27 13:16:32 +0200159}
160
161TEST(IdmapTests, GracefullyFailToCreateIdmapFromCorruptBinaryStream) {
162 std::string raw(reinterpret_cast<const char*>(idmap_raw_data),
163 10); // data too small
164 std::istringstream stream(raw);
165
Mårten Kongstadce424902019-03-01 08:35:37 +0100166 const auto result = Idmap::FromBinaryStream(stream);
167 ASSERT_FALSE(result);
Mårten Kongstad02751232018-04-27 13:16:32 +0200168}
169
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700170TEST(IdmapTests, CreateIdmapHeaderFromApkAssets) {
Ryan Mitchellb863ca32019-03-07 14:31:54 -0800171 std::string target_apk_path = GetTestDataPath() + "/target/target.apk";
172 std::string overlay_apk_path = GetTestDataPath() + "/overlay/overlay.apk";
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700173
174 std::unique_ptr<const ApkAssets> target_apk = ApkAssets::Load(target_apk_path);
175 ASSERT_THAT(target_apk, NotNull());
176
177 std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
178 ASSERT_THAT(overlay_apk, NotNull());
179
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800180 auto idmap_result = Idmap::FromApkAssets(
181 *target_apk, *overlay_apk, TestConstants::OVERLAY_NAME_ALL_POLICIES, PolicyFlags::PUBLIC,
182 /* enforce_overlayable */ true);
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700183 ASSERT_TRUE(idmap_result) << idmap_result.GetErrorMessage();
184 auto& idmap = *idmap_result;
185 ASSERT_THAT(idmap, NotNull());
Mårten Kongstad02751232018-04-27 13:16:32 +0200186
187 ASSERT_THAT(idmap->GetHeader(), NotNull());
Mårten Kongstadb8779022018-11-29 09:53:17 +0100188 ASSERT_EQ(idmap->GetHeader()->GetMagic(), 0x504d4449U);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800189 ASSERT_EQ(idmap->GetHeader()->GetVersion(), 0x07U);
Winson62ac8b52019-12-04 08:36:48 -0800190 ASSERT_EQ(idmap->GetHeader()->GetTargetCrc(), android::idmap2::TestConstants::TARGET_CRC);
191 ASSERT_EQ(idmap->GetHeader()->GetOverlayCrc(), android::idmap2::TestConstants::OVERLAY_CRC);
Ryan Mitchella7070132020-05-13 14:17:52 -0700192 ASSERT_EQ(idmap->GetHeader()->GetFulfilledPolicies(), PolicyFlags::PUBLIC);
193 ASSERT_EQ(idmap->GetHeader()->GetEnforceOverlayable(), true);
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800194 ASSERT_EQ(idmap->GetHeader()->GetTargetPath(), target_apk_path);
Mårten Kongstad02751232018-04-27 13:16:32 +0200195 ASSERT_EQ(idmap->GetHeader()->GetOverlayPath(), overlay_apk_path);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800196 ASSERT_EQ(idmap->GetHeader()->GetOverlayName(), TestConstants::OVERLAY_NAME_ALL_POLICIES);
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700197}
198
199TEST(IdmapTests, CreateIdmapDataFromApkAssets) {
Ryan Mitchellb863ca32019-03-07 14:31:54 -0800200 std::string target_apk_path = GetTestDataPath() + "/target/target.apk";
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700201 std::string overlay_apk_path = GetTestDataPath() + "/overlay/overlay.apk";
202
203 std::unique_ptr<const ApkAssets> target_apk = ApkAssets::Load(target_apk_path);
204 ASSERT_THAT(target_apk, NotNull());
205
206 std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
207 ASSERT_THAT(overlay_apk, NotNull());
208
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800209 auto idmap_result = Idmap::FromApkAssets(*target_apk, *overlay_apk,
210 TestConstants::OVERLAY_NAME_DEFAULT, PolicyFlags::PUBLIC,
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700211 /* enforce_overlayable */ true);
212 ASSERT_TRUE(idmap_result) << idmap_result.GetErrorMessage();
213 auto& idmap = *idmap_result;
Mårten Kongstadd10d06d2019-01-07 17:26:25 -0800214 ASSERT_THAT(idmap, NotNull());
215
216 const std::vector<std::unique_ptr<const IdmapData>>& dataBlocks = idmap->GetData();
217 ASSERT_EQ(dataBlocks.size(), 1U);
218
219 const std::unique_ptr<const IdmapData>& data = dataBlocks[0];
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700220 ASSERT_THAT(data, NotNull());
Mårten Kongstadd10d06d2019-01-07 17:26:25 -0800221
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700222 const auto& target_entries = data->GetTargetEntries();
223 ASSERT_EQ(target_entries.size(), 4U);
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700224 ASSERT_TARGET_ENTRY(target_entries[0], R::target::integer::int1, R::overlay::integer::int1);
225 ASSERT_TARGET_ENTRY(target_entries[1], R::target::string::str1, R::overlay::string::str1);
226 ASSERT_TARGET_ENTRY(target_entries[2], R::target::string::str3, R::overlay::string::str3);
227 ASSERT_TARGET_ENTRY(target_entries[3], R::target::string::str4, R::overlay::string::str4);
228
229 const auto& target_inline_entries = data->GetTargetInlineEntries();
230 ASSERT_EQ(target_inline_entries.size(), 0U);
Mårten Kongstadd10d06d2019-01-07 17:26:25 -0800231
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700232 const auto& overlay_entries = data->GetOverlayEntries();
233 ASSERT_EQ(target_entries.size(), 4U);
Winson62ac8b52019-12-04 08:36:48 -0800234 ASSERT_OVERLAY_ENTRY(overlay_entries[0], R::overlay::integer::int1, R::target::integer::int1);
235 ASSERT_OVERLAY_ENTRY(overlay_entries[1], R::overlay::string::str1, R::target::string::str1);
236 ASSERT_OVERLAY_ENTRY(overlay_entries[2], R::overlay::string::str3, R::target::string::str3);
237 ASSERT_OVERLAY_ENTRY(overlay_entries[3], R::overlay::string::str4, R::target::string::str4);
Winsonb4100202019-02-06 12:05:32 -0800238}
239
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800240TEST(IdmapTests, FailCreateIdmapInvalidName) {
241 std::string target_apk_path = GetTestDataPath() + "/target/target.apk";
242 std::string overlay_apk_path = GetTestDataPath() + "/overlay/overlay.apk";
243
244 std::unique_ptr<const ApkAssets> target_apk = ApkAssets::Load(target_apk_path);
245 ASSERT_THAT(target_apk, NotNull());
246
247 std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
248 ASSERT_THAT(overlay_apk, NotNull());
249
250 {
251 auto idmap_result = Idmap::FromApkAssets(*target_apk, *overlay_apk, "", PolicyFlags::PUBLIC,
252 /* enforce_overlayable */ true);
253 ASSERT_FALSE(idmap_result);
254 }
255 {
256 auto idmap_result =
257 Idmap::FromApkAssets(*target_apk, *overlay_apk, "unknown", PolicyFlags::PUBLIC,
258 /* enforce_overlayable */ true);
259 ASSERT_FALSE(idmap_result);
260 }
261}
262
Ryan Mitchell5035d662020-01-22 13:19:41 -0800263TEST(IdmapTests, CreateIdmapDataFromApkAssetsSharedLibOverlay) {
264 std::string target_apk_path = GetTestDataPath() + "/target/target.apk";
265 std::string overlay_apk_path = GetTestDataPath() + "/overlay/overlay-shared.apk";
266
267 std::unique_ptr<const ApkAssets> target_apk = ApkAssets::Load(target_apk_path);
268 ASSERT_THAT(target_apk, NotNull());
269
270 std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
271 ASSERT_THAT(overlay_apk, NotNull());
272
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800273 auto idmap_result = Idmap::FromApkAssets(*target_apk, *overlay_apk,
274 TestConstants::OVERLAY_NAME_DEFAULT, PolicyFlags::PUBLIC,
Ryan Mitchell5035d662020-01-22 13:19:41 -0800275 /* enforce_overlayable */ true);
276 ASSERT_TRUE(idmap_result) << idmap_result.GetErrorMessage();
277 auto& idmap = *idmap_result;
278 ASSERT_THAT(idmap, NotNull());
279
280 const std::vector<std::unique_ptr<const IdmapData>>& dataBlocks = idmap->GetData();
281 ASSERT_EQ(dataBlocks.size(), 1U);
282
283 const std::unique_ptr<const IdmapData>& data = dataBlocks[0];
284 ASSERT_THAT(data, NotNull());
285
286 const auto& target_entries = data->GetTargetEntries();
287 ASSERT_EQ(target_entries.size(), 4U);
Winsonf56ade32019-12-04 11:32:41 -0800288 ASSERT_TARGET_ENTRY(target_entries[0], R::target::integer::int1,
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800289 fix_package_id(R::overlay::integer::int1, 0));
290 ASSERT_TARGET_ENTRY(target_entries[1], R::target::string::str1,
291 fix_package_id(R::overlay::string::str1, 0));
292 ASSERT_TARGET_ENTRY(target_entries[2], R::target::string::str3,
293 fix_package_id(R::overlay::string::str3, 0));
294 ASSERT_TARGET_ENTRY(target_entries[3], R::target::string::str4,
295 fix_package_id(R::overlay::string::str4, 0));
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700296
297 const auto& target_inline_entries = data->GetTargetInlineEntries();
298 ASSERT_EQ(target_inline_entries.size(), 0U);
Ryan Mitchell5035d662020-01-22 13:19:41 -0800299
300 const auto& overlay_entries = data->GetOverlayEntries();
301 ASSERT_EQ(target_entries.size(), 4U);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800302 ASSERT_OVERLAY_ENTRY(overlay_entries[0], fix_package_id(R::overlay::integer::int1, 0),
Winsonf56ade32019-12-04 11:32:41 -0800303 R::target::integer::int1);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800304 ASSERT_OVERLAY_ENTRY(overlay_entries[1], fix_package_id(R::overlay::string::str1, 0),
Winsonf56ade32019-12-04 11:32:41 -0800305 R::target::string::str1);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800306 ASSERT_OVERLAY_ENTRY(overlay_entries[2], fix_package_id(R::overlay::string::str3, 0),
Winsonf56ade32019-12-04 11:32:41 -0800307 R::target::string::str3);
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800308 ASSERT_OVERLAY_ENTRY(overlay_entries[3], fix_package_id(R::overlay::string::str4, 0),
Winsonf56ade32019-12-04 11:32:41 -0800309 R::target::string::str4);
Ryan Mitchell5035d662020-01-22 13:19:41 -0800310}
311
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800312Result<std::unique_ptr<const IdmapData>> TestIdmapDataFromApkAssets(
313 const std::string& local_target_apk_path, const std::string& local_overlay_apk_path,
314 const std::string& overlay_name, const PolicyBitmask& fulfilled_policies,
315 bool enforce_overlayable) {
316 auto overlay_info =
317 utils::ExtractOverlayManifestInfo(GetTestDataPath() + local_overlay_apk_path, overlay_name);
318 if (!overlay_info) {
319 return overlay_info.GetError();
320 }
321
322 const std::string target_apk_path(GetTestDataPath() + local_target_apk_path);
323 std::unique_ptr<const ApkAssets> target_apk = ApkAssets::Load(target_apk_path);
324 if (!target_apk) {
325 return Error(R"(Failed to load target apk "%s")", target_apk_path.data());
326 }
327
328 const std::string overlay_apk_path(GetTestDataPath() + local_overlay_apk_path);
329 std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
330 if (!overlay_apk) {
331 return Error(R"(Failed to load overlay apk "%s")", overlay_apk_path.data());
332 }
333
334 LogInfo log_info;
335 auto mapping = ResourceMapping::FromApkAssets(*target_apk, *overlay_apk, *overlay_info,
336 fulfilled_policies, enforce_overlayable, log_info);
337 if (!mapping) {
338 return mapping.GetError();
339 }
340
341 return IdmapData::FromResourceMapping(*mapping);
342}
343
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700344TEST(IdmapTests, CreateIdmapDataDoNotRewriteNonOverlayResourceId) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800345 auto idmap_data =
346 TestIdmapDataFromApkAssets("/target/target.apk", "/overlay/overlay.apk", "DifferentPackages",
347
348 PolicyFlags::PUBLIC,
349 /* enforce_overlayable */ false);
Winsonb4100202019-02-06 12:05:32 -0800350
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700351 ASSERT_TRUE(idmap_data) << idmap_data.GetErrorMessage();
352 auto& data = *idmap_data;
Winsonb4100202019-02-06 12:05:32 -0800353
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700354 const auto& target_entries = data->GetTargetEntries();
355 ASSERT_EQ(target_entries.size(), 2U);
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700356 ASSERT_TARGET_ENTRY(target_entries[0], R::target::string::str1,
Winson62ac8b52019-12-04 08:36:48 -0800357 0x0104000a); // -> android:string/ok
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700358 ASSERT_TARGET_ENTRY(target_entries[1], R::target::string::str3, R::overlay::string::str3);
359
360 const auto& target_inline_entries = data->GetTargetInlineEntries();
361 ASSERT_EQ(target_inline_entries.size(), 0U);
Winsonb4100202019-02-06 12:05:32 -0800362
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700363 const auto& overlay_entries = data->GetOverlayEntries();
364 ASSERT_EQ(overlay_entries.size(), 1U);
Winson62ac8b52019-12-04 08:36:48 -0800365 ASSERT_OVERLAY_ENTRY(overlay_entries[0], R::overlay::string::str3, R::target::string::str3);
Winsonb4100202019-02-06 12:05:32 -0800366}
367
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700368TEST(IdmapTests, CreateIdmapDataInlineResources) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800369 auto idmap_data = TestIdmapDataFromApkAssets("/target/target.apk", "/overlay/overlay.apk",
370 "Inline", PolicyFlags::PUBLIC,
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700371 /* enforce_overlayable */ false);
Mårten Kongstadd10d06d2019-01-07 17:26:25 -0800372
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700373 ASSERT_TRUE(idmap_data) << idmap_data.GetErrorMessage();
374 auto& data = *idmap_data;
Mårten Kongstadd10d06d2019-01-07 17:26:25 -0800375
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700376 const auto& target_entries = data->GetTargetEntries();
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700377 ASSERT_EQ(target_entries.size(), 0U);
378
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800379 constexpr size_t overlay_string_pool_size = 10U;
Ryan Mitchellbf1f45b2020-09-29 17:22:52 -0700380 const auto& target_inline_entries = data->GetTargetInlineEntries();
381 ASSERT_EQ(target_inline_entries.size(), 2U);
382 ASSERT_TARGET_INLINE_ENTRY(target_inline_entries[0], R::target::integer::int1,
383 Res_value::TYPE_INT_DEC, 73U); // -> 73
384 ASSERT_TARGET_INLINE_ENTRY(target_inline_entries[1], R::target::string::str1,
385 Res_value::TYPE_STRING,
386 overlay_string_pool_size + 0U); // -> "Hello World"
Mårten Kongstadd10d06d2019-01-07 17:26:25 -0800387
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700388 const auto& overlay_entries = data->GetOverlayEntries();
389 ASSERT_EQ(overlay_entries.size(), 0U);
Ryan Mitchell19823452019-01-29 12:01:24 -0800390}
391
Mårten Kongstad02751232018-04-27 13:16:32 +0200392TEST(IdmapTests, IdmapHeaderIsUpToDate) {
393 fclose(stderr); // silence expected warnings from libandroidfw
394
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800395 const std::string target_apk_path = kIdmapRawTargetPath;
396 const std::string overlay_apk_path = kIdmapRawOverlayPath;
397 const std::string overlay_name = kIdmapRawOverlayName;
398 const PolicyBitmask policies = kIdmapRawDataPolicies;
399 const uint32_t target_crc = kIdmapRawDataTargetCrc;
400 const uint32_t overlay_crc = kIdmapRawOverlayCrc;
Mårten Kongstad02751232018-04-27 13:16:32 +0200401
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800402 std::string raw(reinterpret_cast<const char*>(idmap_raw_data), kIdmapRawDataLen);
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800403 std::istringstream raw_stream(raw);
Mårten Kongstad02751232018-04-27 13:16:32 +0200404
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800405 auto result = Idmap::FromBinaryStream(raw_stream);
Mårten Kongstadce424902019-03-01 08:35:37 +0100406 ASSERT_TRUE(result);
407 const auto idmap = std::move(*result);
Mårten Kongstad02751232018-04-27 13:16:32 +0200408
409 std::stringstream stream;
410 BinaryStreamVisitor visitor(stream);
411 idmap->accept(&visitor);
412
413 std::unique_ptr<const IdmapHeader> header = IdmapHeader::FromBinaryStream(stream);
414 ASSERT_THAT(header, NotNull());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800415 ASSERT_TRUE(header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
416 kIdmapRawDataTargetCrc, overlay_crc, policies,
417 /* enforce_overlayable */ true));
Mårten Kongstad02751232018-04-27 13:16:32 +0200418
419 // magic: bytes (0x0, 0x03)
420 std::string bad_magic_string(stream.str());
421 bad_magic_string[0x0] = '.';
422 bad_magic_string[0x1] = '.';
423 bad_magic_string[0x2] = '.';
424 bad_magic_string[0x3] = '.';
425 std::stringstream bad_magic_stream(bad_magic_string);
426 std::unique_ptr<const IdmapHeader> bad_magic_header =
427 IdmapHeader::FromBinaryStream(bad_magic_stream);
428 ASSERT_THAT(bad_magic_header, NotNull());
429 ASSERT_NE(header->GetMagic(), bad_magic_header->GetMagic());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800430 ASSERT_FALSE(bad_magic_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
431 target_crc, overlay_crc, policies,
432 /* enforce_overlayable */ true));
Mårten Kongstad02751232018-04-27 13:16:32 +0200433
434 // version: bytes (0x4, 0x07)
435 std::string bad_version_string(stream.str());
436 bad_version_string[0x4] = '.';
437 bad_version_string[0x5] = '.';
438 bad_version_string[0x6] = '.';
439 bad_version_string[0x7] = '.';
440 std::stringstream bad_version_stream(bad_version_string);
441 std::unique_ptr<const IdmapHeader> bad_version_header =
442 IdmapHeader::FromBinaryStream(bad_version_stream);
443 ASSERT_THAT(bad_version_header, NotNull());
444 ASSERT_NE(header->GetVersion(), bad_version_header->GetVersion());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800445 ASSERT_FALSE(bad_magic_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
446 target_crc, overlay_crc, policies,
447 /* enforce_overlayable */ true));
Mårten Kongstad02751232018-04-27 13:16:32 +0200448
449 // target crc: bytes (0x8, 0xb)
450 std::string bad_target_crc_string(stream.str());
451 bad_target_crc_string[0x8] = '.';
452 bad_target_crc_string[0x9] = '.';
453 bad_target_crc_string[0xa] = '.';
454 bad_target_crc_string[0xb] = '.';
455 std::stringstream bad_target_crc_stream(bad_target_crc_string);
456 std::unique_ptr<const IdmapHeader> bad_target_crc_header =
457 IdmapHeader::FromBinaryStream(bad_target_crc_stream);
458 ASSERT_THAT(bad_target_crc_header, NotNull());
459 ASSERT_NE(header->GetTargetCrc(), bad_target_crc_header->GetTargetCrc());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800460 ASSERT_FALSE(bad_magic_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
461 target_crc, overlay_crc, policies,
462 /* enforce_overlayable */ true));
Mårten Kongstad02751232018-04-27 13:16:32 +0200463
464 // overlay crc: bytes (0xc, 0xf)
465 std::string bad_overlay_crc_string(stream.str());
466 bad_overlay_crc_string[0xc] = '.';
467 bad_overlay_crc_string[0xd] = '.';
468 bad_overlay_crc_string[0xe] = '.';
469 bad_overlay_crc_string[0xf] = '.';
470 std::stringstream bad_overlay_crc_stream(bad_overlay_crc_string);
471 std::unique_ptr<const IdmapHeader> bad_overlay_crc_header =
472 IdmapHeader::FromBinaryStream(bad_overlay_crc_stream);
473 ASSERT_THAT(bad_overlay_crc_header, NotNull());
474 ASSERT_NE(header->GetOverlayCrc(), bad_overlay_crc_header->GetOverlayCrc());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800475 ASSERT_FALSE(bad_magic_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
476 target_crc, overlay_crc, policies,
477 /* enforce_overlayable */ true));
Mårten Kongstad02751232018-04-27 13:16:32 +0200478
Ryan Mitchella7070132020-05-13 14:17:52 -0700479 // fulfilled policy: bytes (0x10, 0x13)
480 std::string bad_policy_string(stream.str());
481 bad_policy_string[0x10] = '.';
482 bad_policy_string[0x11] = '.';
483 bad_policy_string[0x12] = '.';
484 bad_policy_string[0x13] = '.';
485 std::stringstream bad_policy_stream(bad_policy_string);
486 std::unique_ptr<const IdmapHeader> bad_policy_header =
487 IdmapHeader::FromBinaryStream(bad_policy_stream);
488 ASSERT_THAT(bad_policy_header, NotNull());
489 ASSERT_NE(header->GetFulfilledPolicies(), bad_policy_header->GetFulfilledPolicies());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800490 ASSERT_FALSE(bad_policy_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
491 target_crc, overlay_crc, policies,
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800492 /* enforce_overlayable */ true));
Ryan Mitchella7070132020-05-13 14:17:52 -0700493
494 // enforce overlayable: bytes (0x14)
495 std::string bad_enforce_string(stream.str());
496 bad_enforce_string[0x14] = '\0';
497 std::stringstream bad_enforce_stream(bad_enforce_string);
498 std::unique_ptr<const IdmapHeader> bad_enforce_header =
499 IdmapHeader::FromBinaryStream(bad_enforce_stream);
500 ASSERT_THAT(bad_enforce_header, NotNull());
501 ASSERT_NE(header->GetEnforceOverlayable(), bad_enforce_header->GetEnforceOverlayable());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800502 ASSERT_FALSE(bad_enforce_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
503 target_crc, overlay_crc, policies,
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800504 /* enforce_overlayable */ true));
Ryan Mitchella7070132020-05-13 14:17:52 -0700505
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800506 // target path: bytes (0x1c, 0x27)
Mårten Kongstad02751232018-04-27 13:16:32 +0200507 std::string bad_target_path_string(stream.str());
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800508 bad_target_path_string[0x1c] = '\0';
Mårten Kongstad02751232018-04-27 13:16:32 +0200509 std::stringstream bad_target_path_stream(bad_target_path_string);
510 std::unique_ptr<const IdmapHeader> bad_target_path_header =
511 IdmapHeader::FromBinaryStream(bad_target_path_stream);
512 ASSERT_THAT(bad_target_path_header, NotNull());
513 ASSERT_NE(header->GetTargetPath(), bad_target_path_header->GetTargetPath());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800514 ASSERT_FALSE(bad_magic_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
515 target_crc, overlay_crc, policies,
516 /* enforce_overlayable */ true));
Mårten Kongstad02751232018-04-27 13:16:32 +0200517
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800518 // overlay path: bytes (0x2c, 0x37)
Mårten Kongstad02751232018-04-27 13:16:32 +0200519 std::string bad_overlay_path_string(stream.str());
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800520 bad_overlay_path_string[0x33] = '\0';
Mårten Kongstad02751232018-04-27 13:16:32 +0200521 std::stringstream bad_overlay_path_stream(bad_overlay_path_string);
522 std::unique_ptr<const IdmapHeader> bad_overlay_path_header =
523 IdmapHeader::FromBinaryStream(bad_overlay_path_stream);
524 ASSERT_THAT(bad_overlay_path_header, NotNull());
525 ASSERT_NE(header->GetOverlayPath(), bad_overlay_path_header->GetOverlayPath());
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800526 ASSERT_FALSE(bad_overlay_path_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
527 target_crc, overlay_crc, policies,
Ryan Mitchell0699f1d2020-12-03 15:41:42 -0800528 /* enforce_overlayable */ true));
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800529
530 // overlay path: bytes (0x3c, 0x47)
531 std::string bad_overlay_name_string(stream.str());
532 bad_overlay_name_string[0x3c] = '\0';
533 std::stringstream bad_overlay_name_stream(bad_overlay_name_string);
534 std::unique_ptr<const IdmapHeader> bad_overlay_name_header =
535 IdmapHeader::FromBinaryStream(bad_overlay_name_stream);
536 ASSERT_THAT(bad_overlay_name_header, NotNull());
537 ASSERT_NE(header->GetOverlayName(), bad_overlay_name_header->GetOverlayName());
538 ASSERT_FALSE(bad_overlay_name_header->IsUpToDate(target_apk_path, overlay_apk_path, overlay_name,
539 target_crc, overlay_crc, policies,
540 /* enforce_overlayable */ true));
541
542 // overlay name: bytes (0x2c, 0x37)
Mårten Kongstad02751232018-04-27 13:16:32 +0200543}
544
545class TestVisitor : public Visitor {
546 public:
547 explicit TestVisitor(std::ostream& stream) : stream_(stream) {
548 }
549
Mårten Kongstad0eba72a2018-11-29 08:23:14 +0100550 void visit(const Idmap& idmap ATTRIBUTE_UNUSED) override {
Mårten Kongstad02751232018-04-27 13:16:32 +0200551 stream_ << "TestVisitor::visit(Idmap)" << std::endl;
552 }
553
Mårten Kongstad0eba72a2018-11-29 08:23:14 +0100554 void visit(const IdmapHeader& idmap ATTRIBUTE_UNUSED) override {
Mårten Kongstad02751232018-04-27 13:16:32 +0200555 stream_ << "TestVisitor::visit(IdmapHeader)" << std::endl;
556 }
557
Mårten Kongstad0eba72a2018-11-29 08:23:14 +0100558 void visit(const IdmapData& idmap ATTRIBUTE_UNUSED) override {
Mårten Kongstad02751232018-04-27 13:16:32 +0200559 stream_ << "TestVisitor::visit(IdmapData)" << std::endl;
560 }
561
Mårten Kongstad0eba72a2018-11-29 08:23:14 +0100562 void visit(const IdmapData::Header& idmap ATTRIBUTE_UNUSED) override {
Mårten Kongstad02751232018-04-27 13:16:32 +0200563 stream_ << "TestVisitor::visit(IdmapData::Header)" << std::endl;
564 }
565
Mårten Kongstad02751232018-04-27 13:16:32 +0200566 private:
567 std::ostream& stream_;
568};
569
570TEST(IdmapTests, TestVisitor) {
Ryan Mitchell30dc2e02020-12-02 11:43:18 -0800571 std::string raw(reinterpret_cast<const char*>(idmap_raw_data), kIdmapRawDataLen);
Mårten Kongstad02751232018-04-27 13:16:32 +0200572 std::istringstream stream(raw);
573
Mårten Kongstadce424902019-03-01 08:35:37 +0100574 const auto idmap = Idmap::FromBinaryStream(stream);
575 ASSERT_TRUE(idmap);
Mårten Kongstad02751232018-04-27 13:16:32 +0200576
577 std::stringstream test_stream;
578 TestVisitor visitor(test_stream);
Mårten Kongstadce424902019-03-01 08:35:37 +0100579 (*idmap)->accept(&visitor);
Mårten Kongstad02751232018-04-27 13:16:32 +0200580
581 ASSERT_EQ(test_stream.str(),
Mårten Kongstad02751232018-04-27 13:16:32 +0200582 "TestVisitor::visit(IdmapHeader)\n"
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700583 "TestVisitor::visit(Idmap)\n"
Mårten Kongstad02751232018-04-27 13:16:32 +0200584 "TestVisitor::visit(IdmapData::Header)\n"
Ryan Mitchelle753ffe2019-09-23 09:47:02 -0700585 "TestVisitor::visit(IdmapData)\n");
Mårten Kongstad02751232018-04-27 13:16:32 +0200586}
587
Mårten Kongstad0eba72a2018-11-29 08:23:14 +0100588} // namespace android::idmap2