Debian Codegraph @

tests/unit/tst_config.cpp

raw
1 /*
2 * Copyright (C) 2020 UBports foundation.
3 * Author(s): Marius Gripsgard <[email protected]>
4 *
5 * This program is free software: you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License version 3, as published by
7 * the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
11 * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 *
17 */
18
19 #include <gtest/gtest.h>
20 #include <memory>
21
22 #include "config.h"
23 #include "logger.h"
24
25 #include "mock_platform.h"
26
27 class BaseConfigTest : public ::testing::Test
28 {
29 public:
30 BaseConfigTest()
31 {
32 Logger::setMode(DeviceInfo::PrintMode::Verbose);
33 unsetenv(ENV_CONFIG_PATH);
34 unsetenv(ENV_DEFAULT_CONFIG);
35 unsetenv(ENV_DEVICE_PATH);
36 unsetenv(ENV_DEVICE_NAME);
37 unsetenv(ENV_LEGACY_PATH);
38 }
39 };
40
41 class DefaultsConfigTest : public BaseConfigTest
42 {
43 public:
44 DefaultsConfigTest() : BaseConfigTest()
45 {
46 setenv(ENV_CONFIG_PATH, TEST_DEFAULT_DIR, true);
47 }
48 };
49
50 class DeviceConfigTest : public BaseConfigTest
51 {
52 public:
53 DeviceConfigTest() : BaseConfigTest()
54 {
55 setenv(ENV_DEVICE_PATH, TEST_DEVICE_DIR, true);
56 }
57 };
58
59 class DeviceDefaultConfigTest : public DefaultsConfigTest
60 {
61 public:
62 DeviceDefaultConfigTest() : DefaultsConfigTest()
63 {
64 setenv(ENV_DEVICE_PATH, TEST_DEVICE_DIR, true);
65 }
66 };
67
68 class CommonConfigTest : public DeviceDefaultConfigTest
69 {
70 public:
71 CommonConfigTest() : DeviceDefaultConfigTest(),
72 m_platform(std::make_shared<DummyPlatform>("vendor1-device1", "Dummy Device")),
73 m_config(std::make_shared<Config>(m_platform))
74 {};
75
76 std::shared_ptr<Config> config() { return m_config; };
77
78 private:
79 std::shared_ptr<Platform> m_platform;
80 std::shared_ptr<Config> m_config;
81 };
82
83 TEST_F(BaseConfigTest, checkNoConfigFallbackValue)
84 {
85 auto platform = std::make_shared<DummyPlatform>();
86 auto config = std::make_shared<Config>(platform);
87
88 // As long as we dont provide any default files
89 // We should not "contain" anything info
90 EXPECT_FALSE(config->contains("Name"));
91 EXPECT_FALSE(config->contains("PrettyName"));
92
93 // Test that get retruns "default" provided fallback value
94 EXPECT_EQ(config->get("Name", "NoName"), "NoName");
95 EXPECT_EQ(config->get("PrettyName", "No Name"), "No Name");
96 }
97
98 TEST_F(DefaultsConfigTest, checkDefaultsNoDeviceFound)
99 {
100 auto platform = std::make_shared<DummyPlatform>();
101 auto config = std::make_shared<Config>(platform);
102
103 EXPECT_TRUE(config->contains("Name"));
104 EXPECT_EQ(config->get("Name", ""), "generic");
105
106 EXPECT_TRUE(config->contains("PrettyName"));
107 EXPECT_EQ(config->get("PrettyName", ""), "Generic device");
108 }
109
110
111 TEST_F(BaseConfigTest, checkPlatformDefaults)
112 {
113 auto platform = std::make_shared<DummyPlatform>("Dummy", "Dummy Device");
114 auto config = std::make_shared<Config>(platform);
115
116 EXPECT_TRUE(config->contains("Name"));
117 EXPECT_EQ(config->get("Name", ""), "Dummy");
118
119 EXPECT_TRUE(config->contains("PrettyName"));
120 EXPECT_EQ(config->get("PrettyName", ""), "Dummy Device");
121 }
122
123 TEST_F(DeviceConfigTest, checkContains)
124 {
125 auto platform = std::make_shared<DummyPlatform>("Dummy", "Dummy Device");
126 auto config = std::make_shared<Config>(platform);
127
128 EXPECT_TRUE(config->contains("Name"));
129 EXPECT_TRUE(config->contains("PrettyName"));
130
131 EXPECT_FALSE(config->contains("ddssdsd"));
132 EXPECT_FALSE(config->contains("343543257'[;p-;a"));
133 EXPECT_FALSE(config->contains("435r 6 23k'le[ =-r0-thioj23d m,"));
134 }
135
136 TEST_F(DeviceConfigTest, testDeviceConfigOnly)
137 {
138 auto platform = std::make_shared<DummyPlatform>("device1", "Dummy Device");
139 auto config = std::make_shared<Config>(platform);
140
141 EXPECT_TRUE(config->contains("Name"));
142 EXPECT_EQ(config->get("Name", ""), "device1");
143
144 EXPECT_TRUE(config->contains("PrettyName"));
145 EXPECT_EQ(config->get("PrettyName", ""), "Device 1");
146 }
147
148 TEST_F(DeviceConfigTest, testVendorConfigOnly)
149 {
150 auto platform = std::make_shared<DummyPlatform>("vendor1-device1", "Dummy Device");
151 auto config = std::make_shared<Config>(platform);
152
153 EXPECT_TRUE(config->contains("Name"));
154 EXPECT_EQ(config->get("Name", ""), "vendor1-device1");
155
156 EXPECT_TRUE(config->contains("PrettyName"));
157 EXPECT_EQ(config->get("PrettyName", ""), "Vendor 1 Device 1");
158 }
159
160 TEST_F(DeviceDefaultConfigTest, testDeviceOverridesDefault)
161 {
162 auto platform = std::make_shared<DummyPlatform>("vendor1-device1", "Dummy Device");
163 auto config = std::make_shared<Config>(platform);
164
165 EXPECT_TRUE(config->contains("Name"));
166 EXPECT_EQ(config->get("Name"), "vendor1-device1");
167
168 EXPECT_TRUE(config->contains("DetectedName"));
169 EXPECT_EQ(config->get("DetectedName"), "vendor1-device1");
170
171 EXPECT_TRUE(config->contains("PrettyName"));
172 EXPECT_EQ(config->get("PrettyName"), "Vendor 1 Device 1");
173 }
174
175 TEST_F(DeviceDefaultConfigTest, testDeviceAlias)
176 {
177 auto platform = std::make_shared<DummyPlatform>("device1-alias2", "Dummy Device");
178 auto config = std::make_shared<Config>(platform);
179
180 EXPECT_TRUE(config->contains("Name"));
181 EXPECT_EQ(config->get("Name"), "device1");
182
183 EXPECT_TRUE(config->contains("DetectedName"));
184 EXPECT_EQ(config->get("DetectedName"), "device1-alias2");
185
186 EXPECT_TRUE(config->contains("PrettyName"));
187 EXPECT_EQ(config->get("PrettyName"), "Device 1");
188 }
189
190 TEST_F(DeviceDefaultConfigTest, testVectorGet)
191 {
192 auto platform = std::make_shared<DummyPlatform>("vendor1-device1", "Dummy Device");
193 auto config = std::make_shared<Config>(platform);
194
195 EXPECT_TRUE(config->contains("SupportedOrientations"));
196 EXPECT_EQ(config->get("SupportedOrientations"), "Portrait,InvertedPortrait,Landscape,InvertedLandscape");
197 }
198
199 TEST_F(DeviceDefaultConfigTest, testGetMoDefault)
200 {
201 auto platform = std::make_shared<DummyPlatform>("vendor1-device1", "Dummy Device");
202 auto config = std::make_shared<Config>(platform);
203
204 EXPECT_TRUE(config->contains("Name"));
205 EXPECT_EQ(config->get("Name"), "vendor1-device1");
206 }
207
208
209 TEST_F(DefaultsConfigTest, testLegacyProps)
210 {
211 setenv(ENV_LEGACY_PATH, TEST_DEFAULT_DIR, true);
212
213 auto platform = std::make_shared<DummyPlatform>("legacy", "Dummy Device");
214 auto config = std::make_shared<Config>(platform);
215
216 EXPECT_TRUE(config->contains("GridUnit"));
217 EXPECT_EQ(config->get("GridUnit"), "16");
218
219 EXPECT_TRUE(config->contains("WebkitDpr"));
220 EXPECT_EQ(config->get("WebkitDpr"), "1.8");
221
222 EXPECT_TRUE(config->contains("PrimaryOrientation"));
223 EXPECT_EQ(config->get("PrimaryOrientation"), "InvertedLandscape");
224
225 // Special case: convert between Hostnamed & DeviceInfo convention.
226 EXPECT_TRUE(config->contains("DeviceType"));
227 EXPECT_EQ(config->get("DeviceType"), "phone");
228 }
229
230 // Test fallback of legacy prop reader to "android.conf", as used for bind mounting
231 // from a system.img-based ports.
232 TEST_F(DefaultsConfigTest, testLegacyPropsFallback)
233 {
234 setenv(ENV_LEGACY_PATH, TEST_DEFAULT_DIR, true);
235
236 auto platform = std::make_shared<DummyPlatform>("legacy2", "Dummy Device");
237 auto config = std::make_shared<Config>(platform);
238
239 EXPECT_TRUE(config->contains("GridUnit"));
240 EXPECT_EQ(config->get("GridUnit"), "24");
241
242 EXPECT_TRUE(config->contains("WebkitDpr"));
243 EXPECT_EQ(config->get("WebkitDpr"), "2.7");
244
245 EXPECT_TRUE(config->contains("PrimaryOrientation"));
246 EXPECT_EQ(config->get("PrimaryOrientation"), "InvertedPortrait");
247
248 EXPECT_TRUE(config->contains("DeviceType"));
249 EXPECT_EQ(config->get("DeviceType"), "tablet");
250 }
251
252 TEST_F(DeviceConfigTest, testDeviceMachingCaseInsensitiv)
253 {
254 auto platform = std::make_shared<DummyPlatform>("DeVIce1", "DuMMy Device");
255 auto config = std::make_shared<Config>(platform);
256
257 EXPECT_TRUE(config->contains("Name"));
258 EXPECT_EQ(config->get("Name", ""), "device1");
259
260 EXPECT_TRUE(config->contains("DetectedName"));
261 EXPECT_EQ(config->get("DetectedName", ""), "DeVIce1");
262
263 EXPECT_TRUE(config->contains("PrettyName"));
264 EXPECT_EQ(config->get("PrettyName", ""), "Device 1");
265 }
266
267 TEST_F(DeviceConfigTest, testDeviceMachingCaseInsensitivAlias)
268 {
269 auto platform = std::make_shared<DummyPlatform>("DevICE1-aLiAs1", "DuMMy Device");
270 auto config = std::make_shared<Config>(platform);
271
272 EXPECT_TRUE(config->contains("Name"));
273 EXPECT_EQ(config->get("Name", ""), "device1");
274
275 EXPECT_TRUE(config->contains("DetectedName"));
276 EXPECT_EQ(config->get("DetectedName", ""), "DevICE1-aLiAs1");
277
278 EXPECT_TRUE(config->contains("PrettyName"));
279 EXPECT_EQ(config->get("PrettyName", ""), "Device 1");
280 }