Skip to content

Commit 68ff6c3

Browse files
committed
Rename *MiscInfo methods to refer to behavior rather than the format.
Bug: b/438847412
1 parent 0db9e9d commit 68ff6c3

8 files changed

Lines changed: 41 additions & 36 deletions

File tree

base/cvd/cuttlefish/common/libs/key_equals_value/key_equals_value.cc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@
2929

3030
namespace cuttlefish {
3131

32-
Result<MiscInfo> ParseMiscInfo(const std::string& contents) {
33-
MiscInfo misc_info;
32+
Result<std::map<std::string, std::string>> ParseKeyEqualsValue(
33+
const std::string& contents) {
34+
std::map<std::string, std::string> key_equals_value;
3435
for (std::string_view line : absl::StrSplit(contents, '\n')) {
3536
std::pair<std::string_view, std::string_view> key_value =
3637
absl::StrSplit(line, absl::MaxSplits('=', 1));
@@ -42,29 +43,32 @@ Result<MiscInfo> ParseMiscInfo(const std::string& contents) {
4243

4344
key_value.second = absl::StripAsciiWhitespace(key_value.second);
4445

45-
auto [it, inserted] = misc_info.emplace(key_value);
46+
auto [it, inserted] = key_equals_value.emplace(key_value);
4647
CF_EXPECTF(inserted || it->second == key_value.second,
4748
"Duplicate key with different value. key:\"{}\", previous "
4849
"value:\"{}\", this value:\"{}\"",
4950
key_value.first, it->second, key_value.second);
5051
}
51-
return misc_info;
52+
return key_equals_value;
5253
}
5354

54-
std::string SerializeMiscInfo(const MiscInfo& misc_info) {
55+
std::string SerializeKeyEqualsValue(
56+
const std::map<std::string, std::string>& key_equals_value) {
5557
std::stringstream file_content;
56-
for (const auto& [key, value] : misc_info) {
58+
for (const auto& [key, value] : key_equals_value) {
5759
file_content << key << "=" << value << "\n";
5860
}
5961
return file_content.str();
6062
}
6163

62-
Result<void> WriteMiscInfo(const MiscInfo& misc_info, const std::string& path) {
64+
Result<void> WriteKeyEqualsValue(
65+
const std::map<std::string, std::string>& key_equals_value,
66+
const std::string& path) {
6367
SharedFD output = SharedFD::Creat(path, 0644);
6468
CF_EXPECTF(output->IsOpen(), "Failed to open '{}': '{}'", path,
6569
output->StrError());
6670

67-
std::string serialized = SerializeMiscInfo(misc_info);
71+
std::string serialized = SerializeKeyEqualsValue(key_equals_value);
6872

6973
CF_EXPECTF(WriteAll(output, serialized) == serialized.size(),
7074
"Failed to write to '{}': '{}'", path, output->StrError());

base/cvd/cuttlefish/common/libs/key_equals_value/key_equals_value.h

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@
2222

2323
namespace cuttlefish {
2424

25-
// TODO(chadreynolds): rename MiscInfo to more generic KeyValueFile since this
26-
// logic is processing multiple filetypes now
27-
using MiscInfo = std::map<std::string, std::string>;
28-
29-
Result<MiscInfo> ParseMiscInfo(const std::string& misc_info_contents);
30-
std::string SerializeMiscInfo(const MiscInfo&);
31-
Result<void> WriteMiscInfo(const MiscInfo& misc_info, const std::string& path);
25+
Result<std::map<std::string, std::string>> ParseKeyEqualsValue(
26+
const std::string&);
27+
std::string SerializeKeyEqualsValue(const std::map<std::string, std::string>&);
28+
Result<void> WriteKeyEqualsValue(const std::map<std::string, std::string>&,
29+
const std::string& path);
3230

3331
} // namespace cuttlefish

base/cvd/cuttlefish/common/libs/key_equals_value/key_equals_value_test.cc

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,42 +29,45 @@ namespace {
2929
TEST(KeyEqualsValue, Deserialize) {
3030
std::string serialized = "key1 = value1 \n key2 = value2";
3131

32-
MiscInfo expected = {{"key1", "value1"}, {"key2", "value2"}};
33-
ASSERT_THAT(ParseMiscInfo(serialized), IsOkAndValue(expected));
32+
std::map<std::string, std::string> expected = {{"key1", "value1"},
33+
{"key2", "value2"}};
34+
ASSERT_THAT(ParseKeyEqualsValue(serialized), IsOkAndValue(expected));
3435
}
3536

3637
TEST(KeyEqualsValue, Serialize) {
37-
MiscInfo misc_info = {{"key1", "value1"}, {"key2", "value2"}};
38+
std::map<std::string, std::string> misc_info = {{"key1", "value1"},
39+
{"key2", "value2"}};
3840

39-
EXPECT_EQ(SerializeMiscInfo(misc_info), "key1=value1\nkey2=value2\n");
41+
EXPECT_EQ(SerializeKeyEqualsValue(misc_info), "key1=value1\nkey2=value2\n");
4042
}
4143

4244
TEST(KeyEqualsValue, SerializeDeserialize) {
43-
MiscInfo misc_info = {{"key1", "value1"}, {"key2", "value2"}};
45+
std::map<std::string, std::string> misc_info = {{"key1", "value1"},
46+
{"key2", "value2"}};
4447

45-
std::string serialized = SerializeMiscInfo(misc_info);
48+
std::string serialized = SerializeKeyEqualsValue(misc_info);
4649

47-
ASSERT_THAT(ParseMiscInfo(serialized), IsOkAndValue(misc_info));
50+
ASSERT_THAT(ParseKeyEqualsValue(serialized), IsOkAndValue(misc_info));
4851
}
4952

5053
TEST(KeyEqualsValue, DeserializeDuplicateKeySameValue) {
5154
std::string serialized = "key1=value1\nkey1=value1";
5255

53-
MiscInfo expected = {{"key1", "value1"}};
54-
ASSERT_THAT(ParseMiscInfo(serialized), IsOkAndValue(expected));
56+
std::map<std::string, std::string> expected = {{"key1", "value1"}};
57+
ASSERT_THAT(ParseKeyEqualsValue(serialized), IsOkAndValue(expected));
5558
}
5659

5760
TEST(KeyEqualsValue, DeserializeDuplicateKeyDifferentValue) {
5861
std::string serialized = "key1=value1\nkey1=value2";
5962

60-
Result<MiscInfo> parsed = ParseMiscInfo(serialized);
61-
ASSERT_THAT(parsed, IsError());
63+
ASSERT_THAT(ParseKeyEqualsValue(serialized), IsError());
6264
}
6365

6466
TEST(KeyEqualsValue, EmptyLines) {
6567
std::string serialized = "\n\n\n\n\n\n";
6668

67-
ASSERT_THAT(ParseMiscInfo(serialized), IsOkAndValue(MiscInfo()));
69+
ASSERT_THAT(ParseKeyEqualsValue(serialized),
70+
IsOkAndValue(std::map<std::string, std::string>()));
6871
}
6972

7073
} // namespace

base/cvd/cuttlefish/host/commands/assemble_cvd/BUILD.bazel

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,6 @@ cf_cc_library(
380380
hdrs = ["misc_info.h"],
381381
deps = [
382382
"//cuttlefish/common/libs/fs",
383-
"//cuttlefish/common/libs/key_equals_value",
384383
"//cuttlefish/common/libs/utils:contains",
385384
"//cuttlefish/common/libs/utils:result",
386385
"//cuttlefish/host/libs/avb",

base/cvd/cuttlefish/host/commands/assemble_cvd/guest_config.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Result<std::string> GetAndroidInfoConfig(
4646
CF_EXPECT(FileExists(android_info_file_path));
4747

4848
std::string android_info_contents = ReadFile(android_info_file_path);
49-
auto android_info_map = CF_EXPECT(ParseMiscInfo(android_info_contents));
49+
auto android_info_map = CF_EXPECT(ParseKeyEqualsValue(android_info_contents));
5050
CF_EXPECT(android_info_map.find(key) != android_info_map.end());
5151
return android_info_map[key];
5252
}

base/cvd/cuttlefish/host/commands/assemble_cvd/misc_info.cc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
#include <android-base/strings.h>
2929
#include <fmt/format.h>
3030

31-
#include "cuttlefish/common/libs/key_equals_value/key_equals_value.h"
3231
#include "cuttlefish/common/libs/utils/contains.h"
3332
#include "cuttlefish/common/libs/utils/result.h"
3433
#include "cuttlefish/host/libs/avb/avb.h"

base/cvd/cuttlefish/host/commands/assemble_cvd/misc_info.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@
1515

1616
#pragma once
1717

18+
#include <map>
1819
#include <set>
1920
#include <string>
2021

21-
#include "cuttlefish/common/libs/key_equals_value/key_equals_value.h"
2222
#include "cuttlefish/common/libs/utils/result.h"
2323
#include "cuttlefish/host/libs/avb/avb.h"
2424

2525
namespace cuttlefish {
2626

27+
using MiscInfo = std::map<std::string, std::string>;
28+
2729
struct VbmetaArgs {
2830
std::string algorithm;
2931
std::string key_path;

base/cvd/cuttlefish/host/commands/assemble_cvd/super_image_mixer.cc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ Result<MiscInfo> CombineDynamicPartitionsInfo(
137137
"System target files zip does not contain {}",
138138
kDynamicPartitionsPath);
139139

140-
const MiscInfo vendor_dp_info = CF_EXPECT(ParseMiscInfo(
140+
const MiscInfo vendor_dp_info = CF_EXPECT(ParseKeyEqualsValue(
141141
ExtractArchiveToMemory(target_files.vendor_zip, kDynamicPartitionsPath)));
142-
const MiscInfo system_dp_info = CF_EXPECT(ParseMiscInfo(
142+
const MiscInfo system_dp_info = CF_EXPECT(ParseKeyEqualsValue(
143143
ExtractArchiveToMemory(target_files.system_zip, kDynamicPartitionsPath)));
144144

145145
return CF_EXPECT(GetCombinedDynamicPartitions(vendor_dp_info, system_dp_info,
@@ -155,17 +155,17 @@ Result<MiscInfo> CombineMiscInfo(
155155
CF_EXPECTF(Contains(target_files.system_contents, kMiscInfoPath),
156156
"System target files zip does not contain {}", kMiscInfoPath);
157157

158-
const MiscInfo vendor_misc = CF_EXPECT(ParseMiscInfo(
158+
const MiscInfo vendor_misc = CF_EXPECT(ParseKeyEqualsValue(
159159
ExtractArchiveToMemory(target_files.vendor_zip, kMiscInfoPath)));
160-
const MiscInfo system_misc = CF_EXPECT(ParseMiscInfo(
160+
const MiscInfo system_misc = CF_EXPECT(ParseKeyEqualsValue(
161161
ExtractArchiveToMemory(target_files.system_zip, kMiscInfoPath)));
162162

163163
const auto combined_dp_info =
164164
CF_EXPECT(CombineDynamicPartitionsInfo(target_files, extracted_images));
165165
const auto output_misc = CF_EXPECT(MergeMiscInfos(
166166
vendor_misc, system_misc, combined_dp_info, system_partitions));
167167

168-
CF_EXPECT(WriteMiscInfo(output_misc, misc_output_path));
168+
CF_EXPECT(WriteKeyEqualsValue(output_misc, misc_output_path));
169169
return std::move(output_misc);
170170
}
171171

0 commit comments

Comments
 (0)