File: test_config.cpp

package info (click to toggle)
duckdb 1.5.1-3
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 299,196 kB
  • sloc: cpp: 865,414; ansic: 57,292; python: 18,871; sql: 12,663; lisp: 11,751; yacc: 7,412; lex: 1,682; sh: 747; makefile: 564
file content (243 lines) | stat: -rw-r--r-- 8,372 bytes parent folder | download | duplicates (4)
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
242
243
#include "catch.hpp"
#include "test_helpers.hpp"
#include "duckdb/common/local_file_system.hpp"

#include <set>
#include <map>

using namespace duckdb;
using namespace std;

class FileCleaner {
public:
	FileCleaner(LocalFileSystem *fs, string file) : fs(*fs), file(std::move(file)) {
	}

	~FileCleaner() {
		if (fs.FileExists(file)) {
			fs.RemoveFile(file);
		}
	}

private:
	LocalFileSystem &fs;
	string file;
};

TEST_CASE("Test DB config configuration", "[api]") {
	DBConfig config;

	auto options = config.GetOptions();

	map<string, duckdb::vector<string>> test_options;
	test_options["access_mode"] = {"automatic", "read_only", "read_write"};
	test_options["default_order"] = {"asc", "desc"};
	test_options["default_null_order"] = {"nulls_first", "nulls_last"};
	test_options["enable_external_access"] = {"true", "false"};
	test_options["max_memory"] = {"-1", "16GB"};
	test_options["threads"] = {"1", "4"};

	REQUIRE(config.GetOptionByName("unknownoption") == nullptr);

	for (auto &option : options) {
		auto op = config.GetOptionByName(option.name);
		REQUIRE(op);

		auto entry = test_options.find(option.name);
		if (entry != test_options.end()) {
			for (auto &str_val : entry->second) {
				Value val(str_val);
				REQUIRE_NOTHROW(config.SetOption(option, val));
			}
			Value invalid_val("___this_is_probably_invalid");
			REQUIRE_THROWS(config.SetOption(option, invalid_val));
		}
	}
}

TEST_CASE("Test allowed options", "[api]") {
	case_insensitive_map_t<Value> config_dict;
	string option;

	SECTION("allowed_directories") {
		config_dict.emplace("allowed_directories", Value::LIST({Value("test")}));
		option = "allowed_directories";
	}
	SECTION("allowed_paths") {
		config_dict.emplace("allowed_paths", Value::LIST({Value("test")}));
		option = "allowed_paths";
	}

	SECTION("enable_logging") {
		config_dict.emplace("enable_logging", Value::BOOLEAN(false));
		option = "enable_logging";
	}

	SECTION("disabled_filesystems") {
		config_dict.emplace("disabled_filesystems", Value::BOOLEAN(false));
		option = "disabled_filesystems";
	}

	SECTION("logging_mode") {
		config_dict.emplace("logging_mode", Value::BOOLEAN(false));
		option = "logging_mode";
	}

	SECTION("logging_storage") {
		config_dict.emplace("logging_storage", Value::BOOLEAN(false));
		option = "logging_storage";
	}

	SECTION("logging_level") {
		config_dict.emplace("logging_level", Value::BOOLEAN(false));
		option = "logging_level";
	}

	SECTION("enabled_log_types") {
		config_dict.emplace("enabled_log_types", Value::BOOLEAN(false));
		option = "enabled_log_types";
	}

	SECTION("disabled_log_types") {
		config_dict.emplace("disabled_log_types", Value::BOOLEAN(false));
		option = "disabled_log_types";
	}

	try {
		DBConfig config(config_dict, false);
	} catch (std::exception &ex) {
		ErrorData error_data(ex);
		REQUIRE(error_data.Type() == ExceptionType::INVALID_INPUT);
		REQUIRE(error_data.RawMessage() ==
		        StringUtil::Format("Cannot change/set %s before the database is started", option));
	}
}

TEST_CASE("Test user_agent", "[api]") {
	{
		// Default duckdb_api is cpp
		DuckDB db(nullptr);
		Connection con(db);
		auto res = con.Query("PRAGMA user_agent");
		REQUIRE_THAT(res->GetValue(0, 0).ToString(), Catch::Matchers::Matches("duckdb/.*(.*) cpp"));
	}
	{
		// The latest provided duckdb_api is used
		DBConfig config;
		config.SetOptionByName("duckdb_api", "capi");
		config.SetOptionByName("duckdb_api", "go");
		DuckDB db("", &config);
		Connection con(db);
		auto res = con.Query("PRAGMA user_agent");
		REQUIRE_THAT(res->GetValue(0, 0).ToString(), Catch::Matchers::Matches("duckdb/.*(.*) go"));
	}
}

TEST_CASE("Test secret_directory configuration", "[api]") {
	DBConfig config;

	auto options = config.GetOptions();

	config.SetOptionByName("secret_directory", Value("my_secret_dir"));
	config.SetOptionByName("extension_directory", Value("my_extension_dir"));

	DuckDB db(nullptr, &config);
	Connection con(db);

	// Ensure that the extension directory is set correctly (according to the inital config)
	auto select_extension_dir = con.Query("SELECT current_setting('extension_directory') AS extdir;");
	REQUIRE(select_extension_dir->GetValue(0, 0).ToString() == "my_extension_dir");

	auto select_secret_dir = con.Query("SELECT current_setting('secret_directory') AS secretdir;");
	REQUIRE(select_secret_dir->GetValue(0, 0).ToString() == "my_secret_dir");
}

TEST_CASE("Test secret creation with a custom secret_directory configuration", "[api]") {
	LocalFileSystem fs;
	string directory_path = TestDirectoryPath();
	string my_secret_dir = fs.JoinPath(directory_path, "my_secret_dir");
	string my_secret_file = fs.JoinPath(my_secret_dir, "my_secret.duckdb_secret");
	FileCleaner cleaner(&fs, my_secret_file);

	DBConfig config;

	auto options = config.GetOptions();

	config.SetOptionByName("secret_directory", Value(my_secret_dir));

	DuckDB db(nullptr, &config);
	Connection con(db);

	// Ensure that the extension directory is set correctly (according to the inital config)
	auto select_secret_dir = con.Query("SELECT current_setting('secret_directory') AS secretdir;");
	REQUIRE(select_secret_dir->GetValue(0, 0).ToString() == my_secret_dir);

	// Ensure that creating a secret works and the secret file is created in the correct directory
	auto create_secret = con.Query("CREATE PERSISTENT SECRET my_secret (TYPE http, BEARER_TOKEN 'token')");
	REQUIRE(create_secret->GetValue(0, 0).GetValue<bool>());
	REQUIRE(fs.FileExists(my_secret_file));
}

TEST_CASE("Test secret creation with a custom secret_directory configuration update", "[api]") {
	LocalFileSystem fs;
	string directory_path = TestDirectoryPath();
	string my_secret_dir = fs.JoinPath(directory_path, "my_secret_dir");
	string new_secret_dir = fs.JoinPath(directory_path, "new_secret_dir");
	string my_other_secret_file = fs.JoinPath(new_secret_dir, "my_other_secret.duckdb_secret");
	FileCleaner cleaner(&fs, my_other_secret_file);

	DBConfig config;

	auto options = config.GetOptions();

	config.SetOptionByName("secret_directory", Value(my_secret_dir));

	DuckDB db(nullptr, &config);
	Connection con(db);

	// Ensure that the extension directory is set correctly (according to the inital config)
	auto select_secret_dir = con.Query("SELECT current_setting('secret_directory') AS secretdir;");
	REQUIRE(select_secret_dir->GetValue(0, 0).ToString() == my_secret_dir);

	// Do not create a secret here because it will initialize the secret manager and forbid us to update the value.

	// Update the secret directory and ensure that the setting is updated
	con.Query("SET secret_directory='" + new_secret_dir + "';");
	auto select_new_secret_dir = con.Query("SELECT current_setting('secret_directory') AS secretdir;");
	REQUIRE(select_new_secret_dir->GetValue(0, 0).ToString() == new_secret_dir);

	// Create another secret and ensure that it is created in the new directory
	auto new_create_secret = con.Query("CREATE PERSISTENT SECRET my_other_secret (TYPE http, BEARER_TOKEN 'token')");
	REQUIRE(new_create_secret->GetValue(0, 0).GetValue<bool>());
	REQUIRE(fs.FileExists(my_other_secret_file));
}

TEST_CASE("Test secret_directory configuration update after secret creation", "[api]") {
	LocalFileSystem fs;
	string directory_path = TestDirectoryPath();
	string my_secret_dir = fs.JoinPath(directory_path, "my_secret_dir");
	string my_secret_file = fs.JoinPath(my_secret_dir, "my_secret.duckdb_secret");
	FileCleaner cleaner(&fs, my_secret_file);

	DBConfig config;

	auto options = config.GetOptions();

	config.SetOptionByName("secret_directory", Value(my_secret_dir));

	DuckDB db(nullptr, &config);
	Connection con(db);

	// Ensure that the extension directory is set correctly (according to the inital config)
	auto select_secret_dir = con.Query("SELECT current_setting('secret_directory') AS secretdir;");
	REQUIRE(select_secret_dir->GetValue(0, 0).ToString() == my_secret_dir);

	// Create a secret here to initialize the secret manager
	auto create_secret = con.Query("CREATE PERSISTENT SECRET my_secret (TYPE http, BEARER_TOKEN 'token')");
	REQUIRE(create_secret->GetValue(0, 0).GetValue<bool>());
	REQUIRE(fs.FileExists(my_secret_file));

	// Try to update the secret directory and expect failure as the secret manager is already initialized
	auto update_secret_directory = con.Query("SET secret_directory='new_secret_dir';");
	REQUIRE_FAIL(update_secret_directory);
}