1 //
2 // Copyright (C) 2015 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 "update_engine/payload_generator/ext2_filesystem.h"
18
19 #include <unistd.h>
20
21 #include <map>
22 #include <set>
23 #include <string>
24 #include <vector>
25
26 #include <base/format_macros.h>
27 #include <base/logging.h>
28 #include <base/strings/string_number_conversions.h>
29 #include <android-base/stringprintf.h>
30 #include <gtest/gtest.h>
31
32 #include "update_engine/common/test_utils.h"
33 #include "update_engine/common/utils.h"
34 #include "update_engine/payload_generator/extent_utils.h"
35
36 using chromeos_update_engine::test_utils::GetBuildArtifactsPath;
37 using std::map;
38 using std::set;
39 using std::string;
40 using std::unique_ptr;
41 using std::vector;
42
43 namespace chromeos_update_engine {
44
45 namespace {
46
47 uint64_t kDefaultFilesystemSize = 4 * 1024 * 1024;
48 size_t kDefaultFilesystemBlockCount = 1024;
49 size_t kDefaultFilesystemBlockSize = 4096;
50
51 // Checks that all the blocks in |extents| are in the range [0, total_blocks).
ExpectBlocksInRange(const vector<Extent> & extents,uint64_t total_blocks)52 void ExpectBlocksInRange(const vector<Extent>& extents, uint64_t total_blocks) {
53 for (const Extent& extent : extents) {
54 EXPECT_LE(0U, extent.start_block());
55 EXPECT_LE(extent.start_block() + extent.num_blocks(), total_blocks);
56 }
57 }
58
59 class Ext2FilesystemTest : public ::testing::Test {};
60
61 } // namespace
62
TEST_F(Ext2FilesystemTest,InvalidFilesystem)63 TEST_F(Ext2FilesystemTest, InvalidFilesystem) {
64 ScopedTempFile fs_filename_{"Ext2FilesystemTest-XXXXXX"};
65 ASSERT_EQ(0, truncate(fs_filename_.path().c_str(), kDefaultFilesystemSize));
66 unique_ptr<Ext2Filesystem> fs =
67 Ext2Filesystem::CreateFromFile(fs_filename_.path());
68 ASSERT_EQ(nullptr, fs.get());
69
70 fs = Ext2Filesystem::CreateFromFile("/path/to/invalid/file");
71 ASSERT_EQ(nullptr, fs.get());
72 }
73
TEST_F(Ext2FilesystemTest,EmptyFilesystem)74 TEST_F(Ext2FilesystemTest, EmptyFilesystem) {
75 unique_ptr<Ext2Filesystem> fs = Ext2Filesystem::CreateFromFile(
76 GetBuildArtifactsPath("gen/disk_ext2_4k_empty.img"));
77
78 ASSERT_NE(nullptr, fs.get());
79 EXPECT_EQ(kDefaultFilesystemBlockCount, fs->GetBlockCount());
80 EXPECT_EQ(kDefaultFilesystemBlockSize, fs->GetBlockSize());
81
82 vector<FilesystemInterface::File> files;
83 EXPECT_TRUE(fs->GetFiles(&files));
84
85 map<string, FilesystemInterface::File> map_files;
86 for (const auto& file : files) {
87 EXPECT_EQ(map_files.end(), map_files.find(file.name))
88 << "File " << file.name << " repeated in the list.";
89 map_files[file.name] = file;
90 ExpectBlocksInRange(file.extents, fs->GetBlockCount());
91 }
92 EXPECT_EQ(2U, map_files["/"].file_stat.st_ino);
93 EXPECT_FALSE(map_files["<free-space>"].extents.empty());
94 }
95
96 // This test parses the sample images generated during build time with the
97 // "generate_image.sh" script. The expected conditions of each file in these
98 // images is encoded in the file name, as defined in the mentioned script.
TEST_F(Ext2FilesystemTest,ParseGeneratedImages)99 TEST_F(Ext2FilesystemTest, ParseGeneratedImages) {
100 const vector<string> kGeneratedImages = {"disk_ext2_1k.img",
101 "disk_ext2_4k.img"};
102 base::FilePath build_path = GetBuildArtifactsPath().Append("gen");
103 for (const string& fs_name : kGeneratedImages) {
104 LOG(INFO) << "Testing " << fs_name;
105 unique_ptr<Ext2Filesystem> fs =
106 Ext2Filesystem::CreateFromFile(build_path.Append(fs_name).value());
107 ASSERT_NE(nullptr, fs.get());
108
109 vector<FilesystemInterface::File> files;
110 map<string, FilesystemInterface::File> map_files;
111 set<string> filenames;
112 EXPECT_TRUE(fs->GetFiles(&files));
113 for (const auto& file : files) {
114 // Check no repeated files. We should parse hard-links with two different
115 // names.
116 EXPECT_EQ(map_files.end(), map_files.find(file.name))
117 << "File " << file.name << " repeated in the list.";
118 map_files[file.name] = file;
119 filenames.insert(file.name);
120 ExpectBlocksInRange(file.extents, fs->GetBlockCount());
121 }
122
123 // Check that all the files are parsed, and the /removed file should not
124 // be included in the list.
125 set<string> kExpectedFiles = {
126 "/",
127 "/cdev",
128 "/dir1",
129 "/dir1/file",
130 "/dir1/dir2",
131 "/dir1/dir2/file",
132 "/dir1/dir2/dir1",
133 "/empty-file",
134 "/fifo",
135 "/link-hard-regular-16k",
136 "/link-long_symlink",
137 "/link-short_symlink",
138 "/lost+found",
139 "/regular-small",
140 "/regular-16k",
141 "/regular-32k-zeros",
142 "/regular-with_net_cap",
143 "/sparse_empty-10k",
144 "/sparse_empty-2blocks",
145 "/sparse-10000blocks",
146 "/sparse-16k-last_block",
147 "/sparse-16k-first_block",
148 "/sparse-16k-holes",
149 "<inode-blocks>",
150 "<free-space>",
151 "<group-descriptors>",
152 };
153 EXPECT_EQ(kExpectedFiles, filenames);
154
155 FilesystemInterface::File file;
156
157 // Small symlinks don't actually have data blocks.
158 EXPECT_TRUE(map_files["/link-short_symlink"].extents.empty());
159 EXPECT_EQ(1U,
160 utils::BlocksInExtents(map_files["/link-long_symlink"].extents));
161
162 // Hard-links report the same list of blocks.
163 EXPECT_EQ(map_files["/link-hard-regular-16k"].extents,
164 map_files["/regular-16k"].extents);
165 EXPECT_FALSE(map_files["/regular-16k"].extents.empty());
166
167 // The number of blocks in these files doesn't depend on the
168 // block size.
169 EXPECT_TRUE(map_files["/empty-file"].extents.empty());
170 EXPECT_EQ(1U, utils::BlocksInExtents(map_files["/regular-small"].extents));
171 EXPECT_EQ(
172 1U, utils::BlocksInExtents(map_files["/regular-with_net_cap"].extents));
173 EXPECT_TRUE(map_files["/sparse_empty-10k"].extents.empty());
174 EXPECT_TRUE(map_files["/sparse_empty-2blocks"].extents.empty());
175 EXPECT_EQ(
176 1U,
177 utils::BlocksInExtents(map_files["/sparse-16k-last_block"].extents));
178 EXPECT_EQ(
179 1U,
180 utils::BlocksInExtents(map_files["/sparse-16k-first_block"].extents));
181 EXPECT_EQ(2U,
182 utils::BlocksInExtents(map_files["/sparse-16k-holes"].extents));
183 }
184 }
185
186 } // namespace chromeos_update_engine
187