libcros 0.5.2

A Rust library that provides easy-to-use functions for interacting with a Chrome device
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

// Copyright 2024 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "vpd/util/file.h"

#include <stdint.h>

#include <optional>
#include <set>
#include <vector>

#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "gtest/gtest.h"

namespace vpd {

class FileUtilTest : public ::testing::Test {
 protected:
  void SetUp() override { ASSERT_TRUE(temp_dir_.CreateUniqueTempDir()); }

  base::ScopedTempDir temp_dir_;
};

TEST_F(FileUtilTest, ReadFileToBytesTest_RegularContent) {
  auto file_path =
      temp_dir_.GetPath().Append("ReadFileToBytesTest_RegularContent");
  std::vector<uint8_t> test_data = {'\0', '\1', '\2', '\3'};
  ASSERT_TRUE(base::WriteFile(file_path, test_data));

  auto bytes = vpd::util::ReadFileToBytes(file_path.value());
  EXPECT_TRUE(bytes.has_value());
  EXPECT_EQ(bytes, test_data);
}

TEST_F(FileUtilTest, ReadFileToBytesTest_EmptyContent) {
  auto file_path =
      temp_dir_.GetPath().Append("ReadFileToBytesTest_EmptyContent");
  ASSERT_TRUE(base::WriteFile(file_path, ""));

  auto bytes = vpd::util::ReadFileToBytes(file_path.value());
  EXPECT_TRUE(bytes.has_value());
  EXPECT_TRUE(bytes->empty());
}

TEST_F(FileUtilTest, ReadFileToBytesTest_FileNotExist) {
  auto file_path =
      temp_dir_.GetPath().Append("ReadFileToBytesTest_FileNotExist");
  ASSERT_FALSE(base::PathExists(file_path));
  EXPECT_FALSE(vpd::util::ReadFileToBytes(file_path.value()));
}

TEST_F(FileUtilTest, ReadFileToStringTest_RegularContent) {
  auto file_path =
      temp_dir_.GetPath().Append("ReadFileToStringTest_RegularContent");
  ASSERT_TRUE(base::WriteFile(file_path, "hello world"));

  auto buf = vpd::util::ReadFileToString(file_path.value());
  EXPECT_TRUE(buf.has_value());
  EXPECT_EQ(buf, "hello world");
}

TEST_F(FileUtilTest, ReadFileToStringTest_EmptyContent) {
  auto file_path =
      temp_dir_.GetPath().Append("ReadFileToStringTest_EmptyContent");
  ASSERT_TRUE(base::WriteFile(file_path, ""));

  auto buf = vpd::util::ReadFileToString(file_path.value());
  EXPECT_TRUE(buf.has_value());
  EXPECT_EQ(buf, "");
}

TEST_F(FileUtilTest, ReadFileToStringTest_FileNotExist) {
  auto file_path =
      temp_dir_.GetPath().Append("ReadFileToStringTest_FileNotExist");
  ASSERT_FALSE(base::PathExists(file_path));
  EXPECT_FALSE(vpd::util::ReadFileToString(file_path.value()));
}

TEST_F(FileUtilTest, WriteFileTest_RegularContent) {
  std::string test_cases[] = {
      "hello world",
      "foo\nbar\n",
  };
  auto file_path = temp_dir_.GetPath().Append("WriteFileTest_RegularContent");

  for (const std::string& tc : test_cases) {
    EXPECT_TRUE(vpd::util::WriteFile(file_path.value(), tc));
    std::string buf;
    EXPECT_TRUE(base::ReadFileToString(file_path, &buf));
    EXPECT_EQ(buf, tc);
  }
}

TEST_F(FileUtilTest, WriteFileTest_EmptyContent) {
  auto file_path = temp_dir_.GetPath().Append("WriteFileTest_EmptyContent");
  EXPECT_TRUE(vpd::util::WriteFile(file_path.value(), ""));

  std::string buf;
  EXPECT_TRUE(base::ReadFileToString(file_path, &buf));
  EXPECT_EQ(buf, "");
}

TEST_F(FileUtilTest, WriteFileTest_BinaryContent) {
  std::string test_cases[] = {
      // Regular binary data.
      "\x0a\x0b\x0c",
      // The NULL char is written.
      std::string({'\0'}),
      // The contents after NULL char are written.
      std::string({'\0', '\1', '\2', '\3'}),
  };
  auto file_path = temp_dir_.GetPath().Append("WriteFileTest_BinaryContent");

  for (const std::string& tc : test_cases) {
    EXPECT_TRUE(vpd::util::WriteFile(file_path.value(), tc));
    auto buf = base::ReadFileToBytes(file_path);
    EXPECT_TRUE(buf.has_value());
    EXPECT_EQ(buf, std::vector<uint8_t>(tc.begin(), tc.end()));
  }
}

TEST_F(FileUtilTest, WriteFileTest_PathIsNotFile) {
  EXPECT_TRUE(base::DirectoryExists(temp_dir_.GetPath()));
  EXPECT_FALSE(
      vpd::util::WriteFile(temp_dir_.GetPath().value(), "hello world"));
}

TEST_F(FileUtilTest, WriteFileTest_InvalidFileName) {
  EXPECT_FALSE(vpd::util::WriteFile("", "hello world"));
  EXPECT_FALSE(vpd::util::WriteFile(std::string({'\0'}), "hello world"));
}

TEST_F(FileUtilTest, ListFilesTest_NonEmptyDirectory) {
  auto f1 = temp_dir_.GetPath().Append("ListFilesTest_NonEmptyDirectory_1");
  auto f2 = temp_dir_.GetPath().Append("ListFilesTest_NonEmptyDirectory_2");
  auto f3 = temp_dir_.GetPath().Append("ListFilesTest_NonEmptyDirectory_3");
  auto d1 = temp_dir_.GetPath().Append("ListFilesTest_NonEmptyDirectory_d1");
  auto d2 = temp_dir_.GetPath().Append("ListFilesTest_NonEmptyDirectory_d2");
  auto l1 = temp_dir_.GetPath().Append("ListFilesTest_NonEmptyDirectory_l1");
  ASSERT_TRUE(base::WriteFile(f1, ""));
  ASSERT_TRUE(base::WriteFile(f2, ""));
  ASSERT_TRUE(base::WriteFile(f3, ""));
  ASSERT_TRUE(base::CreateDirectory(d1));
  ASSERT_TRUE(base::CreateDirectory(d2));
  ASSERT_TRUE(base::CreateSymbolicLink(f1, l1));
  ASSERT_TRUE(base::PathExists(f1));
  ASSERT_TRUE(base::PathExists(f2));
  ASSERT_TRUE(base::PathExists(f3));
  ASSERT_TRUE(base::DirectoryExists(d1));
  ASSERT_TRUE(base::DirectoryExists(d2));
  ASSERT_TRUE(base::PathExists(l1));

  std::set<std::string> want = {
      f1.BaseName().value(),
      f2.BaseName().value(),
      f3.BaseName().value(),
  };
  auto got = vpd::util::ListFiles(temp_dir_.GetPath().value());
  EXPECT_EQ(std::set<std::string>(got.begin(), got.end()), want);
}

TEST_F(FileUtilTest, ListFilesTest_EmptyDirectory) {
  EXPECT_TRUE(vpd::util::ListFiles(temp_dir_.GetPath().value()).empty());
}

TEST_F(FileUtilTest, ListFilesTest_DirectoryNotExist) {
  auto f = temp_dir_.GetPath().Append("ListFilesTest_DirectoryNotExist");
  ASSERT_FALSE(base::PathExists(f));
  EXPECT_TRUE(vpd::util::ListFiles(f.value()).empty());
}

TEST_F(FileUtilTest, ListFilesTest_PathIsNotDirectory) {
  auto f = temp_dir_.GetPath().Append("ListFilesTest_PathIsNotDirectory");
  ASSERT_TRUE(base::WriteFile(f, ""));
  ASSERT_TRUE(base::PathExists(f));
  ASSERT_FALSE(base::DirectoryExists(f));
  EXPECT_TRUE(vpd::util::ListFiles(f.value()).empty());
}

TEST_F(FileUtilTest, ListFilesTest_InvalidPathName) {
  EXPECT_TRUE(vpd::util::ListFiles("").empty());
  EXPECT_TRUE(vpd::util::ListFiles(std::string({'\0'})).empty());
}

TEST_F(FileUtilTest, PathExistsTest_PathExists) {
  // Directory exists.
  ASSERT_TRUE(base::DirectoryExists(temp_dir_.GetPath()));
  EXPECT_TRUE(vpd::util::PathExists(temp_dir_.GetPath().value()));

  // File exists.
  auto f = temp_dir_.GetPath().Append("PathExistsTest_PathExists");
  ASSERT_TRUE(base::WriteFile(f, ""));
  ASSERT_TRUE(base::PathExists(f));
  EXPECT_TRUE(vpd::util::PathExists(f.value()));
}

TEST_F(FileUtilTest, PathExistsTest_PathNotExists) {
  auto f = temp_dir_.GetPath().Append("PathExistsTest_PathExists");
  ASSERT_FALSE(base::PathExists(f));
  EXPECT_FALSE(vpd::util::PathExists(f.value()));
}

TEST_F(FileUtilTest, PathExistsTest_InvalidPathName) {
  EXPECT_FALSE(vpd::util::PathExists(""));
  EXPECT_FALSE(vpd::util::PathExists(std::string({'\0'})));
}

TEST_F(FileUtilTest, JoinPathTest) {
  EXPECT_EQ(vpd::util::JoinPath("/", "foo"), "/foo");
  EXPECT_EQ(vpd::util::JoinPath("/", "/foo"), "/foo");
  EXPECT_EQ(vpd::util::JoinPath("/foo", "bar"), "/foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("/foo", "/bar"), "/foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("/foo/", "bar"), "/foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("/foo/", "/bar"), "/foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("/foo/bar", "baz"), "/foo/bar/baz");
  EXPECT_EQ(vpd::util::JoinPath("/foo/bar", "/baz"), "/foo/bar/baz");
  EXPECT_EQ(vpd::util::JoinPath("/foo/bar/", "baz"), "/foo/bar/baz");
  EXPECT_EQ(vpd::util::JoinPath("/foo/bar/", "/baz"), "/foo/bar/baz");

  EXPECT_EQ(vpd::util::JoinPath("foo", "bar"), "foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("foo", "/bar"), "foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("foo/", "bar"), "foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("foo/", "/bar"), "foo/bar");
  EXPECT_EQ(vpd::util::JoinPath("foo/bar", "baz"), "foo/bar/baz");
  EXPECT_EQ(vpd::util::JoinPath("foo/bar", "/baz"), "foo/bar/baz");
  EXPECT_EQ(vpd::util::JoinPath("foo/bar/", "baz"), "foo/bar/baz");
  EXPECT_EQ(vpd::util::JoinPath("foo/bar/", "/baz"), "foo/bar/baz");

  EXPECT_EQ(vpd::util::JoinPath("", ""), "");
  EXPECT_EQ(vpd::util::JoinPath("", "foo"), "foo");
  EXPECT_EQ(vpd::util::JoinPath("", "/foo"), "foo");
  EXPECT_EQ(vpd::util::JoinPath("/foo", ""), "/foo");
  EXPECT_EQ(vpd::util::JoinPath("foo", ""), "foo");
  EXPECT_EQ(vpd::util::JoinPath("foo/", ""), "foo");
  EXPECT_EQ(vpd::util::JoinPath("/foo/", ""), "/foo");
}

}  // namespace vpd