idmap2: add debug information to idmap file format
Add a new variable length string to the idmap file format. This string will
hold debug information like fulfilled policies and any warnings triggered while
generating the file.
Bump the idmap version to 3.
Adjust the idmap header definition in ResourceType.h to take the new string
into account.
Example debug info:
$ idmap2 create \
--target-apk-path frameworks/base/cmds/idmap2/tests/data/target/target.apk \
--overlay-apk-path frameworks/base/cmds/idmap2/tests/data/overlay/overlay.apk \
--idmap-path /tmp/a.idmap \
--policy public \
--policy oem
$ idmap2 dump --idmap-path /tmp/a.idmap
target apk path : frameworks/base/cmds/idmap2/tests/data/target/target.apk
overlay apk path : frameworks/base/cmds/idmap2/tests/data/overlay/overlay.apk
I fulfilled_policies=oem|public enforce_overlayable=true
W failed to find resource "integer/not_in_target" in target resources
0x7f010000 -> 0x7f010000 integer/int1
0x7f02000c -> 0x7f020000 string/str1
[...]
$ idmap2 dump --idmap-path /tmp/a.idmap --verbose
00000000: 504d4449 magic
00000004: 00000003 version
00000008: 76a20829 target crc
0000000c: c054fb26 overlay crc
00000010: ........ target path: frameworks/base/cmds/idmap2/tests/data/target/target.apk
00000110: ........ overlay path: frameworks/base/cmds/idmap2/tests/data/overlay/overlay.apk
00000210: ........ debug info: ...
00000294: 7f target package id
00000295: 7f overlay package id
[...]
Also, tell cpplint to accept non-const references as function parameters:
they make more sense as out-parameters than pointers that are assumed to
be non-null.
Also, switch to regular expressions in the RawPrintVisitorTests: no more
manual fixups of the stream offsets! Tell cpplint that the <regex>
header is OK to use.
Bug: 140790707
Test: idmap2_tests
Change-Id: Ib94684a3b4001240321801e21af8e132fbcf6609
diff --git a/cmds/idmap2/tests/RawPrintVisitorTests.cpp b/cmds/idmap2/tests/RawPrintVisitorTests.cpp
index d387880..b22fdaf 100644
--- a/cmds/idmap2/tests/RawPrintVisitorTests.cpp
+++ b/cmds/idmap2/tests/RawPrintVisitorTests.cpp
@@ -16,6 +16,7 @@
#include <cstdio> // fclose
#include <memory>
+#include <regex>
#include <sstream>
#include <string>
@@ -29,7 +30,16 @@
namespace android::idmap2 {
+#define ASSERT_CONTAINS_REGEX(pattern, str) \
+ do { \
+ ASSERT_TRUE(std::regex_search(str, std::regex(pattern))) \
+ << "pattern '" << pattern << "' not found in\n--------\n" \
+ << str << "--------"; \
+ } while (0)
+
TEST(RawPrintVisitorTests, CreateRawPrintVisitor) {
+ fclose(stderr); // silence expected warnings
+
const std::string target_apk_path(GetTestDataPath() + "/target/target.apk");
std::unique_ptr<const ApkAssets> target_apk = ApkAssets::Load(target_apk_path);
ASSERT_THAT(target_apk, NotNull());
@@ -46,22 +56,24 @@
RawPrintVisitor visitor(stream);
(*idmap)->accept(&visitor);
- ASSERT_NE(stream.str().find("00000000: 504d4449 magic\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000004: 00000002 version\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000008: 76a20829 target crc\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000000c: c054fb26 overlay crc\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000210: 7f target package id\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000211: 7f overlay package id\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000212: 00000004 target entry count\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000216: 00000004 overlay entry count\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000021a: 00000008 string pool index offset\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000021e: 000000b4 string pool byte length\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000222: 7f010000 target id: integer/int1\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000226: 07 type: reference (dynamic)\n"),
- std::string::npos);
- ASSERT_NE(stream.str().find("00000227: 7f010000 value: integer/int1\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000246: 7f010000 overlay id: integer/int1\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000024a: 7f010000 target id: integer/int1\n"), std::string::npos);
+#define ADDRESS "[0-9a-f]{8}: "
+ ASSERT_CONTAINS_REGEX(ADDRESS "504d4449 magic\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "00000003 version\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "76a20829 target crc\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "c054fb26 overlay crc\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS " 7f target package id\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS " 7f overlay package id\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "00000004 target entry count\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "00000004 overlay entry count\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "00000004 overlay entry count\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "00000008 string pool index offset\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "000000b4 string pool byte length\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "7f010000 target id: integer/int1\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS " 07 type: reference \\(dynamic\\)\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "7f010000 value: integer/int1\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "7f010000 overlay id: integer/int1\n", stream.str());
+ ASSERT_CONTAINS_REGEX(ADDRESS "7f010000 target id: integer/int1\n", stream.str());
+#undef ADDRESS
}
TEST(RawPrintVisitorTests, CreateRawPrintVisitorWithoutAccessToApks) {
@@ -78,21 +90,21 @@
(*idmap)->accept(&visitor);
ASSERT_NE(stream.str().find("00000000: 504d4449 magic\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000004: 00000002 version\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("00000004: 00000003 version\n"), std::string::npos);
ASSERT_NE(stream.str().find("00000008: 00001234 target crc\n"), std::string::npos);
ASSERT_NE(stream.str().find("0000000c: 00005678 overlay crc\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000210: 7f target package id\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000211: 7f overlay package id\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000212: 00000003 target entry count\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000216: 00000003 overlay entry count\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000021a: 00000000 string pool index offset\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000021e: 00000000 string pool byte length\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000222: 7f020000 target id\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000226: 01 type: reference\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000227: 7f020000 value\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("0000021c: 7f target package id\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("0000021d: 7f overlay package id\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("0000021e: 00000003 target entry count\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("00000222: 00000003 overlay entry count\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("00000226: 00000000 string pool index offset\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("0000022a: 00000000 string pool byte length\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("0000022e: 7f020000 target id\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("00000232: 01 type: reference\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("00000233: 7f020000 value\n"), std::string::npos);
- ASSERT_NE(stream.str().find("0000023d: 7f020000 overlay id\n"), std::string::npos);
- ASSERT_NE(stream.str().find("00000241: 7f020000 target id\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("00000249: 7f020000 overlay id\n"), std::string::npos);
+ ASSERT_NE(stream.str().find("0000024d: 7f020000 target id\n"), std::string::npos);
}
} // namespace android::idmap2