1*e7c364b6SAndroid Build Coastguard Worker /*
2*e7c364b6SAndroid Build Coastguard Worker * Copyright (C) 2016 The Android Open Source Project
3*e7c364b6SAndroid Build Coastguard Worker *
4*e7c364b6SAndroid Build Coastguard Worker * Licensed under the Apache License, Version 2.0 (the "License");
5*e7c364b6SAndroid Build Coastguard Worker * you may not use this file except in compliance with the License.
6*e7c364b6SAndroid Build Coastguard Worker * You may obtain a copy of the License at
7*e7c364b6SAndroid Build Coastguard Worker *
8*e7c364b6SAndroid Build Coastguard Worker * http://www.apache.org/licenses/LICENSE-2.0
9*e7c364b6SAndroid Build Coastguard Worker *
10*e7c364b6SAndroid Build Coastguard Worker * Unless required by applicable law or agreed to in writing, software
11*e7c364b6SAndroid Build Coastguard Worker * distributed under the License is distributed on an "AS IS" BASIS,
12*e7c364b6SAndroid Build Coastguard Worker * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*e7c364b6SAndroid Build Coastguard Worker * See the License for the specific language governing permissions and
14*e7c364b6SAndroid Build Coastguard Worker * limitations under the License.
15*e7c364b6SAndroid Build Coastguard Worker */
16*e7c364b6SAndroid Build Coastguard Worker
17*e7c364b6SAndroid Build Coastguard Worker #include <string>
18*e7c364b6SAndroid Build Coastguard Worker #include <string_view>
19*e7c364b6SAndroid Build Coastguard Worker #include <vector>
20*e7c364b6SAndroid Build Coastguard Worker
21*e7c364b6SAndroid Build Coastguard Worker #include <android-base/file.h>
22*e7c364b6SAndroid Build Coastguard Worker #include <android-base/strings.h>
23*e7c364b6SAndroid Build Coastguard Worker #include <bootloader_message/bootloader_message.h>
24*e7c364b6SAndroid Build Coastguard Worker #include <gtest/gtest.h>
25*e7c364b6SAndroid Build Coastguard Worker
26*e7c364b6SAndroid Build Coastguard Worker using namespace std::string_literals;
27*e7c364b6SAndroid Build Coastguard Worker
28*e7c364b6SAndroid Build Coastguard Worker extern void SetMiscBlockDeviceForTest(std::string_view misc_device);
29*e7c364b6SAndroid Build Coastguard Worker
TEST(BootloaderMessageTest,read_and_write_bootloader_message)30*e7c364b6SAndroid Build Coastguard Worker TEST(BootloaderMessageTest, read_and_write_bootloader_message) {
31*e7c364b6SAndroid Build Coastguard Worker TemporaryFile temp_misc;
32*e7c364b6SAndroid Build Coastguard Worker
33*e7c364b6SAndroid Build Coastguard Worker // Write the BCB.
34*e7c364b6SAndroid Build Coastguard Worker bootloader_message boot = {};
35*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.command, "command", sizeof(boot.command));
36*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.recovery, "message1\nmessage2\n", sizeof(boot.recovery));
37*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.status, "status1", sizeof(boot.status));
38*e7c364b6SAndroid Build Coastguard Worker
39*e7c364b6SAndroid Build Coastguard Worker std::string err;
40*e7c364b6SAndroid Build Coastguard Worker ASSERT_TRUE(write_bootloader_message_to(boot, temp_misc.path, &err))
41*e7c364b6SAndroid Build Coastguard Worker << "Failed to write BCB: " << err;
42*e7c364b6SAndroid Build Coastguard Worker
43*e7c364b6SAndroid Build Coastguard Worker // Read and verify.
44*e7c364b6SAndroid Build Coastguard Worker bootloader_message boot_verify;
45*e7c364b6SAndroid Build Coastguard Worker ASSERT_TRUE(read_bootloader_message_from(&boot_verify, temp_misc.path, &err))
46*e7c364b6SAndroid Build Coastguard Worker << "Failed to read BCB: " << err;
47*e7c364b6SAndroid Build Coastguard Worker
48*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(reinterpret_cast<const char*>(&boot), sizeof(boot)),
49*e7c364b6SAndroid Build Coastguard Worker std::string(reinterpret_cast<const char*>(&boot_verify), sizeof(boot_verify)));
50*e7c364b6SAndroid Build Coastguard Worker }
51*e7c364b6SAndroid Build Coastguard Worker
TEST(BootloaderMessageTest,update_bootloader_message_in_struct)52*e7c364b6SAndroid Build Coastguard Worker TEST(BootloaderMessageTest, update_bootloader_message_in_struct) {
53*e7c364b6SAndroid Build Coastguard Worker // Write the options to BCB.
54*e7c364b6SAndroid Build Coastguard Worker std::vector<std::string> options = { "option1", "option2" };
55*e7c364b6SAndroid Build Coastguard Worker
56*e7c364b6SAndroid Build Coastguard Worker bootloader_message boot = {};
57*e7c364b6SAndroid Build Coastguard Worker // Inject some bytes into boot.
58*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.recovery, "random message", sizeof(boot.recovery));
59*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.status, "status bytes", sizeof(boot.status));
60*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.stage, "stage bytes", sizeof(boot.stage));
61*e7c364b6SAndroid Build Coastguard Worker strlcpy(boot.reserved, "reserved bytes", sizeof(boot.reserved));
62*e7c364b6SAndroid Build Coastguard Worker
63*e7c364b6SAndroid Build Coastguard Worker ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
64*e7c364b6SAndroid Build Coastguard Worker
65*e7c364b6SAndroid Build Coastguard Worker // Verify that command and recovery fields should be set.
66*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("boot-recovery", std::string(boot.command));
67*e7c364b6SAndroid Build Coastguard Worker std::string expected = "recovery\n" + android::base::Join(options, "\n") + "\n";
68*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(expected, std::string(boot.recovery));
69*e7c364b6SAndroid Build Coastguard Worker
70*e7c364b6SAndroid Build Coastguard Worker // The rest should be intact.
71*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("status bytes", std::string(boot.status));
72*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("stage bytes", std::string(boot.stage));
73*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("reserved bytes", std::string(boot.reserved));
74*e7c364b6SAndroid Build Coastguard Worker }
75*e7c364b6SAndroid Build Coastguard Worker
TEST(BootloaderMessageTest,update_bootloader_message_recovery_options_empty)76*e7c364b6SAndroid Build Coastguard Worker TEST(BootloaderMessageTest, update_bootloader_message_recovery_options_empty) {
77*e7c364b6SAndroid Build Coastguard Worker // Write empty vector.
78*e7c364b6SAndroid Build Coastguard Worker std::vector<std::string> options;
79*e7c364b6SAndroid Build Coastguard Worker
80*e7c364b6SAndroid Build Coastguard Worker // Read and verify.
81*e7c364b6SAndroid Build Coastguard Worker bootloader_message boot = {};
82*e7c364b6SAndroid Build Coastguard Worker ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
83*e7c364b6SAndroid Build Coastguard Worker
84*e7c364b6SAndroid Build Coastguard Worker // command and recovery fields should be set.
85*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("boot-recovery", std::string(boot.command));
86*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("recovery\n", std::string(boot.recovery));
87*e7c364b6SAndroid Build Coastguard Worker
88*e7c364b6SAndroid Build Coastguard Worker // The rest should be empty.
89*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(sizeof(boot.status), '\0'), std::string(boot.status, sizeof(boot.status)));
90*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(sizeof(boot.stage), '\0'), std::string(boot.stage, sizeof(boot.stage)));
91*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(sizeof(boot.reserved), '\0'),
92*e7c364b6SAndroid Build Coastguard Worker std::string(boot.reserved, sizeof(boot.reserved)));
93*e7c364b6SAndroid Build Coastguard Worker }
94*e7c364b6SAndroid Build Coastguard Worker
TEST(BootloaderMessageTest,update_bootloader_message_recovery_options_long)95*e7c364b6SAndroid Build Coastguard Worker TEST(BootloaderMessageTest, update_bootloader_message_recovery_options_long) {
96*e7c364b6SAndroid Build Coastguard Worker // Write super long message.
97*e7c364b6SAndroid Build Coastguard Worker std::vector<std::string> options;
98*e7c364b6SAndroid Build Coastguard Worker for (int i = 0; i < 100; i++) {
99*e7c364b6SAndroid Build Coastguard Worker options.push_back("option: " + std::to_string(i));
100*e7c364b6SAndroid Build Coastguard Worker }
101*e7c364b6SAndroid Build Coastguard Worker
102*e7c364b6SAndroid Build Coastguard Worker // Read and verify.
103*e7c364b6SAndroid Build Coastguard Worker bootloader_message boot = {};
104*e7c364b6SAndroid Build Coastguard Worker ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
105*e7c364b6SAndroid Build Coastguard Worker
106*e7c364b6SAndroid Build Coastguard Worker // Make sure it's long enough.
107*e7c364b6SAndroid Build Coastguard Worker std::string expected = "recovery\n" + android::base::Join(options, "\n") + "\n";
108*e7c364b6SAndroid Build Coastguard Worker ASSERT_GE(expected.size(), sizeof(boot.recovery));
109*e7c364b6SAndroid Build Coastguard Worker
110*e7c364b6SAndroid Build Coastguard Worker // command and recovery fields should be set.
111*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ("boot-recovery", std::string(boot.command));
112*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(expected.substr(0, sizeof(boot.recovery) - 1), std::string(boot.recovery));
113*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ('\0', boot.recovery[sizeof(boot.recovery) - 1]);
114*e7c364b6SAndroid Build Coastguard Worker
115*e7c364b6SAndroid Build Coastguard Worker // The rest should be empty.
116*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(sizeof(boot.status), '\0'), std::string(boot.status, sizeof(boot.status)));
117*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(sizeof(boot.stage), '\0'), std::string(boot.stage, sizeof(boot.stage)));
118*e7c364b6SAndroid Build Coastguard Worker ASSERT_EQ(std::string(sizeof(boot.reserved), '\0'),
119*e7c364b6SAndroid Build Coastguard Worker std::string(boot.reserved, sizeof(boot.reserved)));
120*e7c364b6SAndroid Build Coastguard Worker }
121