1 /*
2 * Copyright (C) 2016 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 <string>
18 #include <string_view>
19 #include <vector>
20
21 #include <android-base/file.h>
22 #include <android-base/strings.h>
23 #include <bootloader_message/bootloader_message.h>
24 #include <gtest/gtest.h>
25
26 using namespace std::string_literals;
27
28 extern void SetMiscBlockDeviceForTest(std::string_view misc_device);
29
TEST(BootloaderMessageTest,read_and_write_bootloader_message)30 TEST(BootloaderMessageTest, read_and_write_bootloader_message) {
31 TemporaryFile temp_misc;
32
33 // Write the BCB.
34 bootloader_message boot = {};
35 strlcpy(boot.command, "command", sizeof(boot.command));
36 strlcpy(boot.recovery, "message1\nmessage2\n", sizeof(boot.recovery));
37 strlcpy(boot.status, "status1", sizeof(boot.status));
38
39 std::string err;
40 ASSERT_TRUE(write_bootloader_message_to(boot, temp_misc.path, &err))
41 << "Failed to write BCB: " << err;
42
43 // Read and verify.
44 bootloader_message boot_verify;
45 ASSERT_TRUE(read_bootloader_message_from(&boot_verify, temp_misc.path, &err))
46 << "Failed to read BCB: " << err;
47
48 ASSERT_EQ(std::string(reinterpret_cast<const char*>(&boot), sizeof(boot)),
49 std::string(reinterpret_cast<const char*>(&boot_verify), sizeof(boot_verify)));
50 }
51
TEST(BootloaderMessageTest,update_bootloader_message_in_struct)52 TEST(BootloaderMessageTest, update_bootloader_message_in_struct) {
53 // Write the options to BCB.
54 std::vector<std::string> options = { "option1", "option2" };
55
56 bootloader_message boot = {};
57 // Inject some bytes into boot.
58 strlcpy(boot.recovery, "random message", sizeof(boot.recovery));
59 strlcpy(boot.status, "status bytes", sizeof(boot.status));
60 strlcpy(boot.stage, "stage bytes", sizeof(boot.stage));
61 strlcpy(boot.reserved, "reserved bytes", sizeof(boot.reserved));
62
63 ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
64
65 // Verify that command and recovery fields should be set.
66 ASSERT_EQ("boot-recovery", std::string(boot.command));
67 std::string expected = "recovery\n" + android::base::Join(options, "\n") + "\n";
68 ASSERT_EQ(expected, std::string(boot.recovery));
69
70 // The rest should be intact.
71 ASSERT_EQ("status bytes", std::string(boot.status));
72 ASSERT_EQ("stage bytes", std::string(boot.stage));
73 ASSERT_EQ("reserved bytes", std::string(boot.reserved));
74 }
75
TEST(BootloaderMessageTest,update_bootloader_message_recovery_options_empty)76 TEST(BootloaderMessageTest, update_bootloader_message_recovery_options_empty) {
77 // Write empty vector.
78 std::vector<std::string> options;
79
80 // Read and verify.
81 bootloader_message boot = {};
82 ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
83
84 // command and recovery fields should be set.
85 ASSERT_EQ("boot-recovery", std::string(boot.command));
86 ASSERT_EQ("recovery\n", std::string(boot.recovery));
87
88 // The rest should be empty.
89 ASSERT_EQ(std::string(sizeof(boot.status), '\0'), std::string(boot.status, sizeof(boot.status)));
90 ASSERT_EQ(std::string(sizeof(boot.stage), '\0'), std::string(boot.stage, sizeof(boot.stage)));
91 ASSERT_EQ(std::string(sizeof(boot.reserved), '\0'),
92 std::string(boot.reserved, sizeof(boot.reserved)));
93 }
94
TEST(BootloaderMessageTest,update_bootloader_message_recovery_options_long)95 TEST(BootloaderMessageTest, update_bootloader_message_recovery_options_long) {
96 // Write super long message.
97 std::vector<std::string> options;
98 for (int i = 0; i < 100; i++) {
99 options.push_back("option: " + std::to_string(i));
100 }
101
102 // Read and verify.
103 bootloader_message boot = {};
104 ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
105
106 // Make sure it's long enough.
107 std::string expected = "recovery\n" + android::base::Join(options, "\n") + "\n";
108 ASSERT_GE(expected.size(), sizeof(boot.recovery));
109
110 // command and recovery fields should be set.
111 ASSERT_EQ("boot-recovery", std::string(boot.command));
112 ASSERT_EQ(expected.substr(0, sizeof(boot.recovery) - 1), std::string(boot.recovery));
113 ASSERT_EQ('\0', boot.recovery[sizeof(boot.recovery) - 1]);
114
115 // The rest should be empty.
116 ASSERT_EQ(std::string(sizeof(boot.status), '\0'), std::string(boot.status, sizeof(boot.status)));
117 ASSERT_EQ(std::string(sizeof(boot.stage), '\0'), std::string(boot.stage, sizeof(boot.stage)));
118 ASSERT_EQ(std::string(sizeof(boot.reserved), '\0'),
119 std::string(boot.reserved, sizeof(boot.reserved)));
120 }
121