test_utils.cc revision 0103c36caa2e38e034e0d22185736b9ccfb35c58 
1//
2// Copyright (C) 2012 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/common/test_utils.h"
18
19#include <dirent.h>
20#include <errno.h>
21#include <stdio.h>
22#include <stdlib.h>
23#include <sys/stat.h>
24#include <sys/types.h>
25#include <sys/xattr.h>
26#include <unistd.h>
27
28#include <set>
29#include <string>
30#include <vector>
31
32#include <base/files/file_util.h>
33#include <base/format_macros.h>
34#include <base/logging.h>
35#include <base/strings/string_util.h>
36#include <base/strings/stringprintf.h>
37
38#include "update_engine/common/utils.h"
39#include "update_engine/payload_consumer/file_writer.h"
40
41using base::StringPrintf;
42using std::set;
43using std::string;
44using std::vector;
45
46namespace chromeos_update_engine {
47
48void PrintTo(const Extent& extent, ::std::ostream* os) {
49  *os << "(" << extent.start_block() << ", " << extent.num_blocks() << ")";
50}
51
52namespace test_utils {
53
54const char* const kMountPathTemplate = "UpdateEngineTests_mnt-XXXXXX";
55
56const uint8_t kRandomString[] = {
57  0xf2, 0xb7, 0x55, 0x92, 0xea, 0xa6, 0xc9, 0x57,
58  0xe0, 0xf8, 0xeb, 0x34, 0x93, 0xd9, 0xc4, 0x8f,
59  0xcb, 0x20, 0xfa, 0x37, 0x4b, 0x40, 0xcf, 0xdc,
60  0xa5, 0x08, 0x70, 0x89, 0x79, 0x35, 0xe2, 0x3d,
61  0x56, 0xa4, 0x75, 0x73, 0xa3, 0x6d, 0xd1, 0xd5,
62  0x26, 0xbb, 0x9c, 0x60, 0xbd, 0x2f, 0x5a, 0xfa,
63  0xb7, 0xd4, 0x3a, 0x50, 0xa7, 0x6b, 0x3e, 0xfd,
64  0x61, 0x2b, 0x3a, 0x31, 0x30, 0x13, 0x33, 0x53,
65  0xdb, 0xd0, 0x32, 0x71, 0x5c, 0x39, 0xed, 0xda,
66  0xb4, 0x84, 0xca, 0xbc, 0xbd, 0x78, 0x1c, 0x0c,
67  0xd8, 0x0b, 0x41, 0xe8, 0xe1, 0xe0, 0x41, 0xad,
68  0x03, 0x12, 0xd3, 0x3d, 0xb8, 0x75, 0x9b, 0xe6,
69  0xd9, 0x01, 0xd0, 0x87, 0xf4, 0x36, 0xfa, 0xa7,
70  0x0a, 0xfa, 0xc5, 0x87, 0x65, 0xab, 0x9a, 0x7b,
71  0xeb, 0x58, 0x23, 0xf0, 0xa8, 0x0a, 0xf2, 0x33,
72  0x3a, 0xe2, 0xe3, 0x35, 0x74, 0x95, 0xdd, 0x3c,
73  0x59, 0x5a, 0xd9, 0x52, 0x3a, 0x3c, 0xac, 0xe5,
74  0x15, 0x87, 0x6d, 0x82, 0xbc, 0xf8, 0x7d, 0xbe,
75  0xca, 0xd3, 0x2c, 0xd6, 0xec, 0x38, 0xeb, 0xe4,
76  0x53, 0xb0, 0x4c, 0x3f, 0x39, 0x29, 0xf7, 0xa4,
77  0x73, 0xa8, 0xcb, 0x32, 0x50, 0x05, 0x8c, 0x1c,
78  0x1c, 0xca, 0xc9, 0x76, 0x0b, 0x8f, 0x6b, 0x57,
79  0x1f, 0x24, 0x2b, 0xba, 0x82, 0xba, 0xed, 0x58,
80  0xd8, 0xbf, 0xec, 0x06, 0x64, 0x52, 0x6a, 0x3f,
81  0xe4, 0xad, 0xce, 0x84, 0xb4, 0x27, 0x55, 0x14,
82  0xe3, 0x75, 0x59, 0x73, 0x71, 0x51, 0xea, 0xe8,
83  0xcc, 0xda, 0x4f, 0x09, 0xaf, 0xa4, 0xbc, 0x0e,
84  0xa6, 0x1f, 0xe2, 0x3a, 0xf8, 0x96, 0x7d, 0x30,
85  0x23, 0xc5, 0x12, 0xb5, 0xd8, 0x73, 0x6b, 0x71,
86  0xab, 0xf1, 0xd7, 0x43, 0x58, 0xa7, 0xc9, 0xf0,
87  0xe4, 0x85, 0x1c, 0xd6, 0x92, 0x50, 0x2c, 0x98,
88  0x36, 0xfe, 0x87, 0xaf, 0x43, 0x8f, 0x8f, 0xf5,
89  0x88, 0x48, 0x18, 0x42, 0xcf, 0x42, 0xc1, 0xa8,
90  0xe8, 0x05, 0x08, 0xa1, 0x45, 0x70, 0x5b, 0x8c,
91  0x39, 0x28, 0xab, 0xe9, 0x6b, 0x51, 0xd2, 0xcb,
92  0x30, 0x04, 0xea, 0x7d, 0x2f, 0x6e, 0x6c, 0x3b,
93  0x5f, 0x82, 0xd9, 0x5b, 0x89, 0x37, 0x65, 0x65,
94  0xbe, 0x9f, 0xa3, 0x5d,
95};
96
97bool IsXAttrSupported(const base::FilePath& dir_path) {
98  char *path = strdup(dir_path.Append("xattr_test_XXXXXX").value().c_str());
99
100  int fd = mkstemp(path);
101  if (fd == -1) {
102    PLOG(ERROR) << "Error creating temporary file in " << dir_path.value();
103    free(path);
104    return false;
105  }
106
107  if (unlink(path) != 0) {
108    PLOG(ERROR) << "Error unlinking temporary file " << path;
109    close(fd);
110    free(path);
111    return false;
112  }
113
114  int xattr_res = fsetxattr(fd, "user.xattr-test", "value", strlen("value"), 0);
115  if (xattr_res != 0) {
116    if (errno == ENOTSUP) {
117      // Leave it to call-sites to warn about non-support.
118    } else {
119      PLOG(ERROR) << "Error setting xattr on " << path;
120    }
121  }
122  close(fd);
123  free(path);
124  return xattr_res == 0;
125}
126
127bool WriteFileVector(const string& path, const brillo::Blob& data) {
128  return utils::WriteFile(path.c_str(), data.data(), data.size());
129}
130
131bool WriteFileString(const string& path, const string& data) {
132  return utils::WriteFile(path.c_str(), data.data(), data.size());
133}
134
135// Binds provided |filename| to an unused loopback device, whose name is written
136// to the string pointed to by |lo_dev_name_p|. Returns true on success, false
137// otherwise (along with corresponding test failures), in which case the content
138// of |lo_dev_name_p| is unknown.
139bool BindToUnusedLoopDevice(const string& filename, string* lo_dev_name_p) {
140  CHECK(lo_dev_name_p);
141
142  // Bind to an unused loopback device, sanity check the device name.
143  lo_dev_name_p->clear();
144  if (!(utils::ReadPipe("losetup --show -f " + filename, lo_dev_name_p) &&
145        base::StartsWith(*lo_dev_name_p, "/dev/loop",
146                         base::CompareCase::SENSITIVE))) {
147    ADD_FAILURE();
148    return false;
149  }
150
151  // Strip anything from the first newline char.
152  size_t newline_pos = lo_dev_name_p->find('\n');
153  if (newline_pos != string::npos)
154    lo_dev_name_p->erase(newline_pos);
155
156  return true;
157}
158
159bool ExpectVectorsEq(const brillo::Blob& expected,
160                     const brillo::Blob& actual) {
161  EXPECT_EQ(expected.size(), actual.size());
162  if (expected.size() != actual.size())
163    return false;
164  bool is_all_eq = true;
165  for (unsigned int i = 0; i < expected.size(); i++) {
166    EXPECT_EQ(expected[i], actual[i]) << "offset: " << i;
167    is_all_eq = is_all_eq && (expected[i] == actual[i]);
168  }
169  return is_all_eq;
170}
171
172void FillWithData(brillo::Blob* buffer) {
173  size_t input_counter = 0;
174  for (uint8_t& b : *buffer) {
175    b = kRandomString[input_counter];
176    input_counter++;
177    input_counter %= sizeof(kRandomString);
178  }
179}
180
181void CreateEmptyExtImageAtPath(const string& path,
182                               size_t size,
183                               int block_size) {
184  EXPECT_EQ(0, System(StringPrintf("dd if=/dev/zero of=%s"
185                                   " seek=%" PRIuS " bs=1 count=1 status=none",
186                                   path.c_str(), size)));
187  EXPECT_EQ(0, System(StringPrintf("mkfs.ext3 -q -b %d -F %s",
188                                   block_size, path.c_str())));
189}
190
191void CreateExtImageAtPath(const string& path, vector<string>* out_paths) {
192  // create 10MiB sparse file, mounted at a unique location.
193  string mount_path;
194  CHECK(utils::MakeTempDirectory(kMountPathTemplate, &mount_path));
195  ScopedDirRemover mount_path_unlinker(mount_path);
196
197  EXPECT_EQ(0, System(StringPrintf("dd if=/dev/zero of=%s"
198                                   " seek=10485759 bs=1 count=1 status=none",
199                                   path.c_str())));
200  EXPECT_EQ(0, System(StringPrintf("mkfs.ext3 -q -b 4096 -F %s",
201                                   path.c_str())));
202  EXPECT_EQ(0, System(StringPrintf("mount -o loop %s %s", path.c_str(),
203                                   mount_path.c_str())));
204  EXPECT_EQ(0, System(StringPrintf("echo hi > %s/hi", mount_path.c_str())));
205  EXPECT_EQ(0, System(StringPrintf("echo hello > %s/hello",
206                                   mount_path.c_str())));
207  EXPECT_EQ(0, System(StringPrintf("mkdir %s/some_dir", mount_path.c_str())));
208  EXPECT_EQ(0, System(StringPrintf("mkdir %s/some_dir/empty_dir",
209                                   mount_path.c_str())));
210  EXPECT_EQ(0, System(StringPrintf("mkdir %s/some_dir/mnt",
211                                   mount_path.c_str())));
212  EXPECT_EQ(0, System(StringPrintf("echo T > %s/some_dir/test",
213                                   mount_path.c_str())));
214  EXPECT_EQ(0, System(StringPrintf("mkfifo %s/some_dir/fifo",
215                                   mount_path.c_str())));
216  EXPECT_EQ(0, System(StringPrintf("mknod %s/cdev c 2 3", mount_path.c_str())));
217  EXPECT_EQ(0, System(StringPrintf("ln -s /some/target %s/sym",
218                                   mount_path.c_str())));
219  EXPECT_EQ(0, System(StringPrintf("ln %s/some_dir/test %s/testlink",
220                                   mount_path.c_str(), mount_path.c_str())));
221  EXPECT_EQ(0, System(StringPrintf("echo T > %s/srchardlink0",
222                                   mount_path.c_str())));
223  EXPECT_EQ(0, System(StringPrintf("ln %s/srchardlink0 %s/srchardlink1",
224                                   mount_path.c_str(), mount_path.c_str())));
225  EXPECT_EQ(0, System(StringPrintf("ln -s bogus %s/boguslink",
226                                   mount_path.c_str())));
227  EXPECT_TRUE(utils::UnmountFilesystem(mount_path.c_str()));
228
229  if (out_paths) {
230    out_paths->clear();
231    out_paths->push_back("");
232    out_paths->push_back("/hi");
233    out_paths->push_back("/boguslink");
234    out_paths->push_back("/hello");
235    out_paths->push_back("/some_dir");
236    out_paths->push_back("/some_dir/empty_dir");
237    out_paths->push_back("/some_dir/mnt");
238    out_paths->push_back("/some_dir/test");
239    out_paths->push_back("/some_dir/fifo");
240    out_paths->push_back("/cdev");
241    out_paths->push_back("/testlink");
242    out_paths->push_back("/sym");
243    out_paths->push_back("/srchardlink0");
244    out_paths->push_back("/srchardlink1");
245    out_paths->push_back("/lost+found");
246  }
247}
248
249ScopedLoopMounter::ScopedLoopMounter(const string& file_path,
250                                     string* mnt_path,
251                                     unsigned long flags) {  // NOLINT - long
252  EXPECT_TRUE(utils::MakeTempDirectory("mnt.XXXXXX", mnt_path));
253  dir_remover_.reset(new ScopedDirRemover(*mnt_path));
254
255  string loop_dev;
256  loop_binder_.reset(new ScopedLoopbackDeviceBinder(file_path, &loop_dev));
257
258  EXPECT_TRUE(utils::MountFilesystem(loop_dev, *mnt_path, flags));
259  unmounter_.reset(new ScopedFilesystemUnmounter(*mnt_path));
260}
261
262base::FilePath GetBuildArtifactsPath() {
263  base::FilePath exe_path;
264  base::ReadSymbolicLink(base::FilePath("/proc/self/exe"), &exe_path);
265  return exe_path.DirName();
266}
267
268}  // namespace test_utils
269}  // namespace chromeos_update_engine
270