idmap2: move Idmap.h to Result
Change the signatures of Idmap::FromApkAssets and
Idmap::FromBinaryStream from
std::unique_ptr<const Idmap> func(..., std::ostream& out_error);
to
Result<std::unique_ptr<const Idmap>> func(...);
The returned pointer is still a unique pointer to ensure the dynamically
allocated memory is automatically released when no longer used. This
means that using the returned value of either function requires one of
two patterns:
const auto idmap = func(...);
if (!idmap) {
return Error(...);
}
(*idmap)->accept(...);
or
auto result = func(...);
if (!result) {
return Error(...);
}
const auto idmap = std::move(*result);
idmap->accept(...);
Note that in the second example, result must be non-const or
the call to std::move(*result) will not compile.
With this change, the entire idmap2 project has been converted to use
Result.
Test: make idmap2_tests
Change-Id: I533f4e03b99645523d94dd5f446ad76fb435f661
diff --git a/cmds/idmap2/tests/BinaryStreamVisitorTests.cpp b/cmds/idmap2/tests/BinaryStreamVisitorTests.cpp
index 9a0412e..9a5b633 100644
--- a/cmds/idmap2/tests/BinaryStreamVisitorTests.cpp
+++ b/cmds/idmap2/tests/BinaryStreamVisitorTests.cpp
@@ -17,6 +17,7 @@
#include <memory>
#include <sstream>
#include <string>
+#include <utility>
#include "gmock/gmock.h"
#include "gtest/gtest.h"
@@ -37,16 +38,17 @@
std::string raw(reinterpret_cast<const char*>(idmap_raw_data), idmap_raw_data_len);
std::istringstream raw_stream(raw);
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap1 = Idmap::FromBinaryStream(raw_stream, error);
- ASSERT_THAT(idmap1, NotNull());
+ auto result1 = Idmap::FromBinaryStream(raw_stream);
+ ASSERT_TRUE(result1);
+ const auto idmap1 = std::move(*result1);
std::stringstream stream;
BinaryStreamVisitor visitor(stream);
idmap1->accept(&visitor);
- std::unique_ptr<const Idmap> idmap2 = Idmap::FromBinaryStream(stream, error);
- ASSERT_THAT(idmap2, NotNull());
+ auto result2 = Idmap::FromBinaryStream(stream);
+ ASSERT_TRUE(result2);
+ const auto idmap2 = std::move(*result2);
ASSERT_EQ(idmap1->GetHeader()->GetTargetCrc(), idmap2->GetHeader()->GetTargetCrc());
ASSERT_EQ(idmap1->GetHeader()->GetTargetPath(), idmap2->GetHeader()->GetTargetPath());
@@ -76,15 +78,14 @@
std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
ASSERT_THAT(overlay_apk, NotNull());
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap =
+ const auto idmap =
Idmap::FromApkAssets(target_apk_path, *target_apk, overlay_apk_path, *overlay_apk,
- PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true, error);
- ASSERT_THAT(idmap, NotNull());
+ PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true);
+ ASSERT_TRUE(idmap);
std::stringstream stream;
BinaryStreamVisitor visitor(stream);
- idmap->accept(&visitor);
+ (*idmap)->accept(&visitor);
const std::string str = stream.str();
const StringPiece data(str);
std::unique_ptr<const LoadedIdmap> loaded_idmap = LoadedIdmap::Load(data);
diff --git a/cmds/idmap2/tests/Idmap2BinaryTests.cpp b/cmds/idmap2/tests/Idmap2BinaryTests.cpp
index a6a2ada..91bc4dd 100644
--- a/cmds/idmap2/tests/Idmap2BinaryTests.cpp
+++ b/cmds/idmap2/tests/Idmap2BinaryTests.cpp
@@ -100,13 +100,12 @@
struct stat st;
ASSERT_EQ(stat(GetIdmapPath().c_str(), &st), 0);
- std::stringstream error;
std::ifstream fin(GetIdmapPath());
- std::unique_ptr<const Idmap> idmap = Idmap::FromBinaryStream(fin, error);
+ const auto idmap = Idmap::FromBinaryStream(fin);
fin.close();
- ASSERT_THAT(idmap, NotNull());
- ASSERT_IDMAP(*idmap, GetTargetApkPath(), GetOverlayApkPath());
+ ASSERT_TRUE(idmap);
+ ASSERT_IDMAP(**idmap, GetTargetApkPath(), GetOverlayApkPath());
unlink(GetIdmapPath().c_str());
}
@@ -193,24 +192,23 @@
expected << idmap_static_2_path << std::endl;
ASSERT_EQ(result->stdout, expected.str());
- std::stringstream error;
auto idmap_static_no_name_raw_string = utils::ReadFile(idmap_static_no_name_path);
auto idmap_static_no_name_raw_stream = std::istringstream(*idmap_static_no_name_raw_string);
- auto idmap_static_no_name = Idmap::FromBinaryStream(idmap_static_no_name_raw_stream, error);
- ASSERT_THAT(idmap_static_no_name, NotNull());
- ASSERT_IDMAP(*idmap_static_no_name, GetTargetApkPath(), overlay_static_no_name_apk_path);
+ auto idmap_static_no_name = Idmap::FromBinaryStream(idmap_static_no_name_raw_stream);
+ ASSERT_TRUE(idmap_static_no_name);
+ ASSERT_IDMAP(**idmap_static_no_name, GetTargetApkPath(), overlay_static_no_name_apk_path);
auto idmap_static_1_raw_string = utils::ReadFile(idmap_static_1_path);
auto idmap_static_1_raw_stream = std::istringstream(*idmap_static_1_raw_string);
- auto idmap_static_1 = Idmap::FromBinaryStream(idmap_static_1_raw_stream, error);
- ASSERT_THAT(idmap_static_1, NotNull());
- ASSERT_IDMAP(*idmap_static_1, GetTargetApkPath(), overlay_static_1_apk_path);
+ auto idmap_static_1 = Idmap::FromBinaryStream(idmap_static_1_raw_stream);
+ ASSERT_TRUE(idmap_static_1);
+ ASSERT_IDMAP(**idmap_static_1, GetTargetApkPath(), overlay_static_1_apk_path);
auto idmap_static_2_raw_string = utils::ReadFile(idmap_static_2_path);
auto idmap_static_2_raw_stream = std::istringstream(*idmap_static_2_raw_string);
- auto idmap_static_2 = Idmap::FromBinaryStream(idmap_static_2_raw_stream, error);
- ASSERT_THAT(idmap_static_2, NotNull());
- ASSERT_IDMAP(*idmap_static_2, GetTargetApkPath(), overlay_static_2_apk_path);
+ auto idmap_static_2 = Idmap::FromBinaryStream(idmap_static_2_raw_stream);
+ ASSERT_TRUE(idmap_static_2);
+ ASSERT_IDMAP(**idmap_static_2, GetTargetApkPath(), overlay_static_2_apk_path);
unlink(idmap_static_no_name_path.c_str());
unlink(idmap_static_2_path.c_str());
diff --git a/cmds/idmap2/tests/IdmapTests.cpp b/cmds/idmap2/tests/IdmapTests.cpp
index c20ae7b..621f503 100644
--- a/cmds/idmap2/tests/IdmapTests.cpp
+++ b/cmds/idmap2/tests/IdmapTests.cpp
@@ -20,6 +20,7 @@
#include <memory>
#include <sstream>
#include <string>
+#include <utility>
#include <vector>
#include "gmock/gmock.h"
@@ -127,9 +128,9 @@
std::string raw(reinterpret_cast<const char*>(idmap_raw_data), idmap_raw_data_len);
std::istringstream stream(raw);
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap = Idmap::FromBinaryStream(stream, error);
- ASSERT_THAT(idmap, NotNull());
+ auto result = Idmap::FromBinaryStream(stream);
+ ASSERT_TRUE(result);
+ const auto idmap = std::move(*result);
ASSERT_THAT(idmap->GetHeader(), NotNull());
ASSERT_EQ(idmap->GetHeader()->GetMagic(), 0x504d4449U);
@@ -168,9 +169,8 @@
10); // data too small
std::istringstream stream(raw);
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap = Idmap::FromBinaryStream(stream, error);
- ASSERT_THAT(idmap, IsNull());
+ const auto result = Idmap::FromBinaryStream(stream);
+ ASSERT_FALSE(result);
}
void CreateIdmap(const StringPiece& target_apk_path, const StringPiece& overlay_apk_path,
@@ -182,10 +182,10 @@
std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path.to_string());
ASSERT_THAT(overlay_apk, NotNull());
- std::stringstream error;
- *out_idmap =
+ auto result =
Idmap::FromApkAssets(target_apk_path.to_string(), *target_apk, overlay_apk_path.to_string(),
- *overlay_apk, fulfilled_policies, enforce_overlayable, error);
+ *overlay_apk, fulfilled_policies, enforce_overlayable);
+ *out_idmap = result ? std::move(*result) : nullptr;
}
TEST(IdmapTests, CreateIdmapFromApkAssets) {
@@ -471,11 +471,10 @@
std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
ASSERT_THAT(overlay_apk, NotNull());
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap =
+ const auto result =
Idmap::FromApkAssets(target_apk_path, *target_apk, overlay_apk_path, *overlay_apk,
- PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true, error);
- ASSERT_THAT(idmap, IsNull());
+ PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true);
+ ASSERT_FALSE(result);
}
TEST(IdmapTests, IdmapHeaderIsUpToDate) {
@@ -489,11 +488,11 @@
std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
ASSERT_THAT(overlay_apk, NotNull());
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap = Idmap::FromApkAssets(
- target_apk_path, *target_apk, overlay_apk_path, *overlay_apk, PolicyFlags::POLICY_PUBLIC,
- /* enforce_overlayable */ true, error);
- ASSERT_THAT(idmap, NotNull());
+ auto result = Idmap::FromApkAssets(target_apk_path, *target_apk, overlay_apk_path, *overlay_apk,
+ PolicyFlags::POLICY_PUBLIC,
+ /* enforce_overlayable */ true);
+ ASSERT_TRUE(result);
+ const auto idmap = std::move(*result);
std::stringstream stream;
BinaryStreamVisitor visitor(stream);
@@ -609,13 +608,12 @@
std::string raw(reinterpret_cast<const char*>(idmap_raw_data), idmap_raw_data_len);
std::istringstream stream(raw);
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap = Idmap::FromBinaryStream(stream, error);
- ASSERT_THAT(idmap, NotNull());
+ const auto idmap = Idmap::FromBinaryStream(stream);
+ ASSERT_TRUE(idmap);
std::stringstream test_stream;
TestVisitor visitor(test_stream);
- idmap->accept(&visitor);
+ (*idmap)->accept(&visitor);
ASSERT_EQ(test_stream.str(),
"TestVisitor::visit(Idmap)\n"
diff --git a/cmds/idmap2/tests/PrettyPrintVisitorTests.cpp b/cmds/idmap2/tests/PrettyPrintVisitorTests.cpp
index eaa47cd..27a3880 100644
--- a/cmds/idmap2/tests/PrettyPrintVisitorTests.cpp
+++ b/cmds/idmap2/tests/PrettyPrintVisitorTests.cpp
@@ -46,15 +46,14 @@
std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
ASSERT_THAT(overlay_apk, NotNull());
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap =
+ const auto idmap =
Idmap::FromApkAssets(target_apk_path, *target_apk, overlay_apk_path, *overlay_apk,
- PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true, error);
- ASSERT_THAT(idmap, NotNull());
+ PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true);
+ ASSERT_TRUE(idmap);
std::stringstream stream;
PrettyPrintVisitor visitor(stream);
- idmap->accept(&visitor);
+ (*idmap)->accept(&visitor);
ASSERT_NE(stream.str().find("target apk path : "), std::string::npos);
ASSERT_NE(stream.str().find("overlay apk path : "), std::string::npos);
@@ -67,13 +66,12 @@
std::string raw(reinterpret_cast<const char*>(idmap_raw_data), idmap_raw_data_len);
std::istringstream raw_stream(raw);
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap = Idmap::FromBinaryStream(raw_stream, error);
- ASSERT_THAT(idmap, NotNull());
+ const auto idmap = Idmap::FromBinaryStream(raw_stream);
+ ASSERT_TRUE(idmap);
std::stringstream stream;
PrettyPrintVisitor visitor(stream);
- idmap->accept(&visitor);
+ (*idmap)->accept(&visitor);
ASSERT_NE(stream.str().find("target apk path : "), std::string::npos);
ASSERT_NE(stream.str().find("overlay apk path : "), std::string::npos);
diff --git a/cmds/idmap2/tests/RawPrintVisitorTests.cpp b/cmds/idmap2/tests/RawPrintVisitorTests.cpp
index 7ec13ed..7372148 100644
--- a/cmds/idmap2/tests/RawPrintVisitorTests.cpp
+++ b/cmds/idmap2/tests/RawPrintVisitorTests.cpp
@@ -40,15 +40,14 @@
std::unique_ptr<const ApkAssets> overlay_apk = ApkAssets::Load(overlay_apk_path);
ASSERT_THAT(overlay_apk, NotNull());
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap =
+ const auto idmap =
Idmap::FromApkAssets(target_apk_path, *target_apk, overlay_apk_path, *overlay_apk,
- PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true, error);
- ASSERT_THAT(idmap, NotNull());
+ PolicyFlags::POLICY_PUBLIC, /* enforce_overlayable */ true);
+ ASSERT_TRUE(idmap);
std::stringstream stream;
RawPrintVisitor visitor(stream);
- idmap->accept(&visitor);
+ (*idmap)->accept(&visitor);
ASSERT_NE(stream.str().find("00000000: 504d4449 magic\n"), std::string::npos);
ASSERT_NE(stream.str().find("00000004: 00000001 version\n"), std::string::npos);
@@ -64,13 +63,12 @@
std::string raw(reinterpret_cast<const char*>(idmap_raw_data), idmap_raw_data_len);
std::istringstream raw_stream(raw);
- std::stringstream error;
- std::unique_ptr<const Idmap> idmap = Idmap::FromBinaryStream(raw_stream, error);
- ASSERT_THAT(idmap, NotNull());
+ const auto idmap = Idmap::FromBinaryStream(raw_stream);
+ ASSERT_TRUE(idmap);
std::stringstream stream;
RawPrintVisitor visitor(stream);
- idmap->accept(&visitor);
+ (*idmap)->accept(&visitor);
ASSERT_NE(stream.str().find("00000000: 504d4449 magic\n"), std::string::npos);
ASSERT_NE(stream.str().find("00000004: 00000001 version\n"), std::string::npos);