3 Copyright (C) 2010-2014 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include "mapgen_v5.h"
25 #include "util/sha1.h"
26 #include "map_settings_manager.h"
28 class TestMapSettingsManager : public TestBase {
30 TestMapSettingsManager() { TestManager::registerTestModule(this); }
31 const char *getName() { return "TestMapSettingsManager"; }
33 void makeUserConfig(Settings *conf);
34 std::string makeMetaFile(bool make_corrupt);
36 void runTests(IGameDef *gamedef);
38 void testMapSettingsManager();
39 void testMapMetaSaveLoad();
40 void testMapMetaFailures();
43 static TestMapSettingsManager g_test_instance;
45 void TestMapSettingsManager::runTests(IGameDef *gamedef)
47 TEST(testMapSettingsManager);
48 TEST(testMapMetaSaveLoad);
49 TEST(testMapMetaFailures);
52 ////////////////////////////////////////////////////////////////////////////////
55 void check_noise_params(const NoiseParams *np1, const NoiseParams *np2)
57 UASSERTEQ(float, np1->offset, np2->offset);
58 UASSERTEQ(float, np1->scale, np2->scale);
59 UASSERT(np1->spread == np2->spread);
60 UASSERTEQ(s32, np1->seed, np2->seed);
61 UASSERTEQ(u16, np1->octaves, np2->octaves);
62 UASSERTEQ(float, np1->persist, np2->persist);
63 UASSERTEQ(float, np1->lacunarity, np2->lacunarity);
64 UASSERTEQ(u32, np1->flags, np2->flags);
68 std::string read_file_to_string(const std::string &filepath)
71 FILE *f = fopen(filepath.c_str(), "rb");
75 fseek(f, 0, SEEK_END);
77 long filesize = ftell(f);
86 UASSERTEQ(size_t, fread(&buf[0], 1, filesize, f), 1);
93 void TestMapSettingsManager::makeUserConfig(Settings *conf)
95 conf->set("mg_name", "v7");
96 conf->set("seed", "5678");
97 conf->set("water_level", "20");
98 conf->set("mgv5_np_factor", "0, 12, (500, 250, 500), 920382, 5, 0.45, 3.0");
99 conf->set("mgv5_np_height", "0, 15, (500, 250, 500), 841746, 5, 0.5, 3.0");
100 conf->set("mgv5_np_filler_depth", "20, 1, (150, 150, 150), 261, 4, 0.7, 1.0");
101 conf->set("mgv5_np_ground", "-43, 40, (80, 80, 80), 983240, 4, 0.55, 2.0");
105 std::string TestMapSettingsManager::makeMetaFile(bool make_corrupt)
107 std::string metafile = getTestTempFile();
109 const char *metafile_contents =
113 "mgv5_np_filler_depth = 20, 1, (150, 150, 150), 261, 4, 0.7, 1.0\n"
114 "mgv5_np_height = 20, 10, (250, 250, 250), 84174, 4, 0.5, 1.0\n";
116 FILE *f = fopen(metafile.c_str(), "wb");
119 fputs(metafile_contents, f);
121 fputs("[end_of_params]\n", f);
129 void TestMapSettingsManager::testMapSettingsManager()
131 Settings user_settings;
132 makeUserConfig(&user_settings);
134 std::string test_mapmeta_path = makeMetaFile(false);
136 MapSettingsManager mgr(&user_settings, test_mapmeta_path);
139 UASSERT(mgr.getMapSetting("mg_name", &value));
140 UASSERT(value == "v7");
142 // Pretend we're initializing the ServerMap
143 UASSERT(mgr.loadMapMeta());
145 // Pretend some scripts are requesting mapgen params
146 UASSERT(mgr.getMapSetting("mg_name", &value));
147 UASSERT(value == "v5");
148 UASSERT(mgr.getMapSetting("seed", &value));
149 UASSERT(value == "1234");
150 UASSERT(mgr.getMapSetting("water_level", &value));
151 UASSERT(value == "20");
153 // Pretend we have some mapgen settings configured from the scripting
154 UASSERT(mgr.setMapSetting("water_level", "15"));
155 UASSERT(mgr.setMapSetting("seed", "02468"));
156 UASSERT(mgr.setMapSetting("mg_flags", "nolight", true));
158 NoiseParams script_np_filler_depth(0, 100, v3f(200, 100, 200), 261, 4, 0.7, 2.0);
159 NoiseParams script_np_factor(0, 100, v3f(50, 50, 50), 920381, 3, 0.45, 2.0);
160 NoiseParams script_np_height(0, 100, v3f(450, 450, 450), 84174, 4, 0.5, 2.0);
161 NoiseParams meta_np_height(20, 10, v3f(250, 250, 250), 84174, 4, 0.5, 1.0);
162 NoiseParams user_np_ground(-43, 40, v3f(80, 80, 80), 983240, 4, 0.55, 2.0, NOISE_FLAG_EASED);
164 mgr.setMapSettingNoiseParams("mgv5_np_filler_depth", &script_np_filler_depth, true);
165 mgr.setMapSettingNoiseParams("mgv5_np_height", &script_np_height);
166 mgr.setMapSettingNoiseParams("mgv5_np_factor", &script_np_factor);
168 // Now make our Params and see if the values are correctly sourced
169 MapgenParams *params = mgr.makeMapgenParams();
170 UASSERT(params->mgtype == MAPGEN_V5);
171 UASSERT(params->chunksize == 5);
172 UASSERT(params->water_level == 15);
173 UASSERT(params->seed == 1234);
174 UASSERT((params->flags & MG_LIGHT) == 0);
176 MapgenV5Params *v5params = (MapgenV5Params *)params;
178 check_noise_params(&v5params->np_filler_depth, &script_np_filler_depth);
179 check_noise_params(&v5params->np_factor, &script_np_factor);
180 check_noise_params(&v5params->np_height, &meta_np_height);
181 check_noise_params(&v5params->np_ground, &user_np_ground);
183 UASSERT(mgr.setMapSetting("foobar", "25") == false);
185 // Pretend the ServerMap is shutting down
186 UASSERT(mgr.saveMapMeta());
188 // Make sure our interface expectations are met
189 UASSERT(mgr.mapgen_params == params);
190 UASSERT(mgr.makeMapgenParams() == params);
193 // TODO(paramat or hmmmm): change this to compare the result against a static file
195 // Load the resulting map_meta.txt and make sure it contains what we expect
196 unsigned char expected_contents_hash[20] = {
197 0x48, 0x3f, 0x88, 0x5a, 0xc0, 0x7a, 0x14, 0x48, 0xa4, 0x71,
198 0x78, 0x56, 0x95, 0x2d, 0xdc, 0x6a, 0xf7, 0x61, 0x36, 0x5f
202 std::string metafile_contents = read_file_to_string(test_mapmeta_path);
203 ctx.addBytes(&metafile_contents[0], metafile_contents.size());
204 unsigned char *sha1_result = ctx.getDigest();
205 int resultdiff = memcmp(sha1_result, expected_contents_hash, 20);
208 UASSERT(!resultdiff);
213 void TestMapSettingsManager::testMapMetaSaveLoad()
216 std::string path = getTestTempDirectory()
217 + DIR_DELIM + "foobar" + DIR_DELIM + "map_meta.txt";
219 // Create a set of mapgen params and save them to map meta
220 conf.set("seed", "12345");
221 conf.set("water_level", "5");
222 MapSettingsManager mgr1(&conf, path);
223 MapgenParams *params1 = mgr1.makeMapgenParams();
225 UASSERT(mgr1.saveMapMeta());
227 // Now try loading the map meta to mapgen params
228 conf.set("seed", "67890");
229 conf.set("water_level", "32");
230 MapSettingsManager mgr2(&conf, path);
231 UASSERT(mgr2.loadMapMeta());
232 MapgenParams *params2 = mgr2.makeMapgenParams();
235 // Check that both results are correct
236 UASSERTEQ(u64, params1->seed, 12345);
237 UASSERTEQ(s16, params1->water_level, 5);
238 UASSERTEQ(u64, params2->seed, 12345);
239 UASSERTEQ(s16, params2->water_level, 5);
243 void TestMapSettingsManager::testMapMetaFailures()
245 std::string test_mapmeta_path;
248 // Check to see if it'll fail on a non-existent map meta file
249 test_mapmeta_path = "woobawooba/fgdfg/map_meta.txt";
250 UASSERT(!fs::PathExists(test_mapmeta_path));
252 MapSettingsManager mgr1(&conf, test_mapmeta_path);
253 UASSERT(!mgr1.loadMapMeta());
255 // Check to see if it'll fail on a corrupt map meta file
256 test_mapmeta_path = makeMetaFile(true);
257 UASSERT(fs::PathExists(test_mapmeta_path));
259 MapSettingsManager mgr2(&conf, test_mapmeta_path);
260 UASSERT(!mgr2.loadMapMeta());