1 /*
2 * Copyright 2008 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11 #include <memory>
12
13 #include "webrtc/base/fileutils.h"
14 #include "webrtc/base/gunit.h"
15 #include "webrtc/base/optionsfile.h"
16 #include "webrtc/base/pathutils.h"
17
18 namespace rtc {
19
20 static const std::string kTestOptionA = "test-option-a";
21 static const std::string kTestOptionB = "test-option-b";
22 static const std::string kTestString1 = "a string";
23 static const std::string kTestString2 = "different string";
24 static const std::string kOptionWithEquals = "foo=bar";
25 static const std::string kOptionWithNewline = "foo\nbar";
26 static const std::string kValueWithEquals = "baz=quux";
27 static const std::string kValueWithNewline = "baz\nquux";
28 static const std::string kEmptyString = "";
29 static const char kOptionWithUtf8[] = {'O', 'p', 't', '\302', '\256', 'i', 'o',
30 'n', '\342', '\204', '\242', '\0'}; // Opt(R)io(TM).
31 static const char kValueWithUtf8[] = {'V', 'a', 'l', '\302', '\256', 'v', 'e',
32 '\342', '\204', '\242', '\0'}; // Val(R)ue(TM).
33 static int kTestInt1 = 12345;
34 static int kTestInt2 = 67890;
35 static int kNegInt = -634;
36 static int kZero = 0;
37
38 #if defined (WEBRTC_ANDROID)
39 // Fails on Android: https://bugs.chromium.org/p/webrtc/issues/detail?id=4364.
40 #define MAYBE_OptionsFileTest DISABLED_OptionsFileTest
41 #else
42 #define MAYBE_OptionsFileTest OptionsFileTest
43 #endif
44
45 class MAYBE_OptionsFileTest : public testing::Test {
46 public:
MAYBE_OptionsFileTest()47 MAYBE_OptionsFileTest() {
48 Pathname dir;
49 ASSERT(Filesystem::GetTemporaryFolder(dir, true, NULL));
50 test_file_ = Filesystem::TempFilename(dir, ".testfile");
51 OpenStore();
52 }
53
~MAYBE_OptionsFileTest()54 ~MAYBE_OptionsFileTest() override {
55 remove(test_file_.c_str());
56 }
57
58 protected:
OpenStore()59 void OpenStore() {
60 store_.reset(new OptionsFile(test_file_));
61 }
62
63 std::unique_ptr<OptionsFile> store_;
64
65 private:
66 std::string test_file_;
67 };
68
TEST_F(MAYBE_OptionsFileTest,GetSetString)69 TEST_F(MAYBE_OptionsFileTest, GetSetString) {
70 // Clear contents of the file on disk.
71 EXPECT_TRUE(store_->Save());
72 std::string out1, out2;
73 EXPECT_FALSE(store_->GetStringValue(kTestOptionA, &out1));
74 EXPECT_FALSE(store_->GetStringValue(kTestOptionB, &out2));
75 EXPECT_TRUE(store_->SetStringValue(kTestOptionA, kTestString1));
76 EXPECT_TRUE(store_->Save());
77 EXPECT_TRUE(store_->Load());
78 EXPECT_TRUE(store_->SetStringValue(kTestOptionB, kTestString2));
79 EXPECT_TRUE(store_->Save());
80 EXPECT_TRUE(store_->Load());
81 EXPECT_TRUE(store_->GetStringValue(kTestOptionA, &out1));
82 EXPECT_TRUE(store_->GetStringValue(kTestOptionB, &out2));
83 EXPECT_EQ(kTestString1, out1);
84 EXPECT_EQ(kTestString2, out2);
85 EXPECT_TRUE(store_->RemoveValue(kTestOptionA));
86 EXPECT_TRUE(store_->Save());
87 EXPECT_TRUE(store_->Load());
88 EXPECT_TRUE(store_->RemoveValue(kTestOptionB));
89 EXPECT_TRUE(store_->Save());
90 EXPECT_TRUE(store_->Load());
91 EXPECT_FALSE(store_->GetStringValue(kTestOptionA, &out1));
92 EXPECT_FALSE(store_->GetStringValue(kTestOptionB, &out2));
93 }
94
TEST_F(MAYBE_OptionsFileTest,GetSetInt)95 TEST_F(MAYBE_OptionsFileTest, GetSetInt) {
96 // Clear contents of the file on disk.
97 EXPECT_TRUE(store_->Save());
98 int out1, out2;
99 EXPECT_FALSE(store_->GetIntValue(kTestOptionA, &out1));
100 EXPECT_FALSE(store_->GetIntValue(kTestOptionB, &out2));
101 EXPECT_TRUE(store_->SetIntValue(kTestOptionA, kTestInt1));
102 EXPECT_TRUE(store_->Save());
103 EXPECT_TRUE(store_->Load());
104 EXPECT_TRUE(store_->SetIntValue(kTestOptionB, kTestInt2));
105 EXPECT_TRUE(store_->Save());
106 EXPECT_TRUE(store_->Load());
107 EXPECT_TRUE(store_->GetIntValue(kTestOptionA, &out1));
108 EXPECT_TRUE(store_->GetIntValue(kTestOptionB, &out2));
109 EXPECT_EQ(kTestInt1, out1);
110 EXPECT_EQ(kTestInt2, out2);
111 EXPECT_TRUE(store_->RemoveValue(kTestOptionA));
112 EXPECT_TRUE(store_->Save());
113 EXPECT_TRUE(store_->Load());
114 EXPECT_TRUE(store_->RemoveValue(kTestOptionB));
115 EXPECT_TRUE(store_->Save());
116 EXPECT_TRUE(store_->Load());
117 EXPECT_FALSE(store_->GetIntValue(kTestOptionA, &out1));
118 EXPECT_FALSE(store_->GetIntValue(kTestOptionB, &out2));
119 EXPECT_TRUE(store_->SetIntValue(kTestOptionA, kNegInt));
120 EXPECT_TRUE(store_->GetIntValue(kTestOptionA, &out1));
121 EXPECT_EQ(kNegInt, out1);
122 EXPECT_TRUE(store_->SetIntValue(kTestOptionA, kZero));
123 EXPECT_TRUE(store_->GetIntValue(kTestOptionA, &out1));
124 EXPECT_EQ(kZero, out1);
125 }
126
TEST_F(MAYBE_OptionsFileTest,Persist)127 TEST_F(MAYBE_OptionsFileTest, Persist) {
128 // Clear contents of the file on disk.
129 EXPECT_TRUE(store_->Save());
130 EXPECT_TRUE(store_->SetStringValue(kTestOptionA, kTestString1));
131 EXPECT_TRUE(store_->SetIntValue(kTestOptionB, kNegInt));
132 EXPECT_TRUE(store_->Save());
133
134 // Load the saved contents from above.
135 OpenStore();
136 EXPECT_TRUE(store_->Load());
137 std::string out1;
138 int out2;
139 EXPECT_TRUE(store_->GetStringValue(kTestOptionA, &out1));
140 EXPECT_TRUE(store_->GetIntValue(kTestOptionB, &out2));
141 EXPECT_EQ(kTestString1, out1);
142 EXPECT_EQ(kNegInt, out2);
143 }
144
TEST_F(MAYBE_OptionsFileTest,SpecialCharacters)145 TEST_F(MAYBE_OptionsFileTest, SpecialCharacters) {
146 // Clear contents of the file on disk.
147 EXPECT_TRUE(store_->Save());
148 std::string out;
149 EXPECT_FALSE(store_->SetStringValue(kOptionWithEquals, kTestString1));
150 EXPECT_FALSE(store_->GetStringValue(kOptionWithEquals, &out));
151 EXPECT_FALSE(store_->SetStringValue(kOptionWithNewline, kTestString1));
152 EXPECT_FALSE(store_->GetStringValue(kOptionWithNewline, &out));
153 EXPECT_TRUE(store_->SetStringValue(kOptionWithUtf8, kValueWithUtf8));
154 EXPECT_TRUE(store_->SetStringValue(kTestOptionA, kTestString1));
155 EXPECT_TRUE(store_->Save());
156 EXPECT_TRUE(store_->Load());
157 EXPECT_TRUE(store_->GetStringValue(kTestOptionA, &out));
158 EXPECT_EQ(kTestString1, out);
159 EXPECT_TRUE(store_->GetStringValue(kOptionWithUtf8, &out));
160 EXPECT_EQ(kValueWithUtf8, out);
161 EXPECT_FALSE(store_->SetStringValue(kTestOptionA, kValueWithNewline));
162 EXPECT_TRUE(store_->GetStringValue(kTestOptionA, &out));
163 EXPECT_EQ(kTestString1, out);
164 EXPECT_TRUE(store_->SetStringValue(kTestOptionA, kValueWithEquals));
165 EXPECT_TRUE(store_->Save());
166 EXPECT_TRUE(store_->Load());
167 EXPECT_TRUE(store_->GetStringValue(kTestOptionA, &out));
168 EXPECT_EQ(kValueWithEquals, out);
169 EXPECT_TRUE(store_->SetStringValue(kEmptyString, kTestString2));
170 EXPECT_TRUE(store_->Save());
171 EXPECT_TRUE(store_->Load());
172 EXPECT_TRUE(store_->GetStringValue(kEmptyString, &out));
173 EXPECT_EQ(kTestString2, out);
174 EXPECT_TRUE(store_->SetStringValue(kTestOptionB, kEmptyString));
175 EXPECT_TRUE(store_->Save());
176 EXPECT_TRUE(store_->Load());
177 EXPECT_TRUE(store_->GetStringValue(kTestOptionB, &out));
178 EXPECT_EQ(kEmptyString, out);
179 }
180
181 } // namespace rtc
182