Skip to content

Commit c067775

Browse files
jhiemstrawiscjhiemstrawisc
committed
Remove config_set/get APIs and change prefixed from scitokens to scitoken
It looks like the config_set/get_blah APIs weren't actually in use and hadn't been released, so instead of keeping them around, we decided to just delete them. Also, the `scitokens`-prefixed versions of these APIs were changed to be prefixed by `scitoken` to match other functions in the library.
1 parent 38af01c commit c067775

File tree

3 files changed

+20
-48
lines changed

3 files changed

+20
-48
lines changed

‎src/scitokens.cpp‎

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -955,11 +955,7 @@ int keycache_set_jwks(const char *issuer, const char *jwks, char **err_msg) {
955955
return 0;
956956
}
957957

958-
int config_set_int(const char *key, int value, char **err_msg) {
959-
return scitokens_config_set_int(key, value, err_msg);
960-
}
961-
962-
int scitokens_config_set_int(const char *key, int value, char **err_msg) {
958+
int scitoken_config_set_int(const char *key, int value, char **err_msg) {
963959
if (!key) {
964960
if (err_msg) {
965961
*err_msg = strdup("A key must be provided.");
@@ -998,11 +994,7 @@ int scitokens_config_set_int(const char *key, int value, char **err_msg) {
998994
}
999995
}
1000996

1001-
int config_get_int(const char *key, char **err_msg) {
1002-
return scitokens_config_get_int(key, err_msg);
1003-
}
1004-
1005-
int scitokens_config_get_int(const char *key, char **err_msg) {
997+
int scitoken_config_get_int(const char *key, char **err_msg) {
1006998
if (!key) {
1007999
if (err_msg) {
10081000
*err_msg = strdup("A key must be provided.");
@@ -1027,11 +1019,7 @@ int scitokens_config_get_int(const char *key, char **err_msg) {
10271019
}
10281020
}
10291021

1030-
int config_set_str(const char *key, const char *value, char **err_msg) {
1031-
return scitokens_config_set_str(key, value, err_msg);
1032-
}
1033-
1034-
int scitokens_config_set_str(const char *key, const char *value,
1022+
int scitoken_config_set_str(const char *key, const char *value,
10351023
char **err_msg) {
10361024
if (!key) {
10371025
if (err_msg) {
@@ -1060,11 +1048,7 @@ int scitokens_config_set_str(const char *key, const char *value,
10601048
return 0;
10611049
}
10621050

1063-
int config_get_str(const char *key, char **output, char **err_msg) {
1064-
return scitokens_config_get_str(key, output, err_msg);
1065-
}
1066-
1067-
int scitokens_config_get_str(const char *key, char **output, char **err_msg) {
1051+
int scitoken_config_get_str(const char *key, char **output, char **err_msg) {
10681052
if (!key) {
10691053
if (err_msg) {
10701054
*err_msg = strdup("A key must be provided.");

‎src/scitokens.h‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -294,47 +294,35 @@ int keycache_set_jwks(const char *issuer, const char *jwks, char **err_msg);
294294
* APIs for managing scitokens configuration parameters.
295295
*/
296296

297-
// On its way to deprecation
298-
int config_set_int(const char *key, int value, char **err_msg);
299-
300297
/**
301298
* Update scitokens int parameters.
302299
* Takes in key/value pairs and assigns the input value to whatever
303300
* configuration variable is indicated by the key.
304301
* Returns 0 on success, and non-zero for invalid keys or values.
305302
*/
306-
int scitokens_config_set_int(const char *key, int value, char **err_msg);
307-
308-
// On its way to deprecation
309-
int config_get_int(const char *key, char **err_msg);
303+
int scitoken_config_set_int(const char *key, int value, char **err_msg);
310304

311305
/**
312306
* Get current scitokens int parameters.
313307
* Returns the value associated with the supplied input key on success, and -1
314308
* on failure. This assumes there are no keys for which a negative return value
315309
* is permissible.
316310
*/
317-
int scitokens_config_get_int(const char *key, char **err_msg);
318-
319-
// On its way to deprecation
320-
int config_set_str(const char *key, const char *value, char **err_msg);
311+
int scitoken_config_get_int(const char *key, char **err_msg);
321312

322313
/**
323314
* Set current scitokens str parameters.
324315
* Returns 0 on success, nonzero on failure
325316
*/
326-
int scitokens_config_set_str(const char *key, const char *value,
317+
int scitoken_config_set_str(const char *key, const char *value,
327318
char **err_msg);
328319

329-
// On its way to deprecation
330-
int config_get_str(const char *key, char **output, char **err_msg);
331-
332320
/**
333321
* Get current scitokens str parameters.
334322
* Returns 0 on success, nonzero on failure, and populates the value associated
335323
* with the input key to output.
336324
*/
337-
int scitokens_config_get_str(const char *key, char **output, char **err_msg);
325+
int scitoken_config_get_str(const char *key, char **output, char **err_msg);
338326

339327
#ifdef __cplusplus
340328
}

‎test/main.cpp‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ TEST_F(KeycacheTest, SetGetConfiguredCacheHome) {
173173
char *err_msg;
174174
std::string key = "keycache.cache_home";
175175

176-
auto rv = config_set_str(key.c_str(), cache_path, &err_msg);
176+
auto rv = scitoken_config_set_str(key.c_str(), cache_path, &err_msg);
177177
ASSERT_TRUE(rv == 0) << err_msg;
178178

179179
// Set the jwks at the new cache home
@@ -193,71 +193,71 @@ TEST_F(KeycacheTest, SetGetConfiguredCacheHome) {
193193

194194
// Check that cache home is still what was set
195195
char *output;
196-
rv = config_get_str(key.c_str(), &output, &err_msg);
196+
rv = scitoken_config_get_str(key.c_str(), &output, &err_msg);
197197
ASSERT_TRUE(rv == 0) << err_msg;
198198
EXPECT_EQ(*output, *cache_path);
199199
free(output);
200200

201201
// Reset cache home to whatever it was before by setting empty config
202-
rv = config_set_str(key.c_str(), "", &err_msg);
202+
rv = scitoken_config_set_str(key.c_str(), "", &err_msg);
203203
ASSERT_TRUE(rv == 0) << err_msg;
204204
}
205205

206206
TEST_F(KeycacheTest, InvalidConfigKeyTest) {
207207
char *err_msg;
208208
int new_update_interval = 400;
209209
std::string key = "invalid key";
210-
auto rv = config_set_int(key.c_str(), new_update_interval, &err_msg);
210+
auto rv = scitoken_config_set_int(key.c_str(), new_update_interval, &err_msg);
211211
ASSERT_FALSE(rv == 0);
212212

213213
const char *key2 = nullptr;
214-
rv = config_set_int(key2, new_update_interval, &err_msg);
214+
rv = scitoken_config_set_int(key2, new_update_interval, &err_msg);
215215
ASSERT_FALSE(rv == 0);
216216
}
217217

218218
TEST_F(KeycacheTest, SetGetUpdateTest) {
219219
char *err_msg;
220220
int new_update_interval = 400;
221221
std::string key = "keycache.update_interval_s";
222-
auto rv = config_set_int(key.c_str(), new_update_interval, &err_msg);
222+
auto rv = scitoken_config_set_int(key.c_str(), new_update_interval, &err_msg);
223223
ASSERT_TRUE(rv == 0);
224224

225-
rv = config_get_int(key.c_str(), &err_msg);
225+
rv = scitoken_config_get_int(key.c_str(), &err_msg);
226226
EXPECT_EQ(rv, new_update_interval);
227227
}
228228

229229
TEST_F(KeycacheTest, SetGetExpirationTest) {
230230
char *err_msg;
231231
int new_expiration_interval = 2 * 24 * 3600;
232232
std::string key = "keycache.expiration_interval_s";
233-
auto rv = config_set_int(key.c_str(), new_expiration_interval, &err_msg);
233+
auto rv = scitoken_config_set_int(key.c_str(), new_expiration_interval, &err_msg);
234234
ASSERT_TRUE(rv == 0);
235235

236-
rv = config_get_int(key.c_str(), &err_msg);
236+
rv = scitoken_config_get_int(key.c_str(), &err_msg);
237237
EXPECT_EQ(rv, new_expiration_interval);
238238
}
239239

240240
TEST_F(KeycacheTest, SetInvalidUpdateTest) {
241241
char *err_msg;
242242
int new_update_interval = -1;
243243
std::string key = "keycache.update_interval_s";
244-
auto rv = config_set_int(key.c_str(), new_update_interval, &err_msg);
244+
auto rv = scitoken_config_set_int(key.c_str(), new_update_interval, &err_msg);
245245
ASSERT_FALSE(rv == 0);
246246
}
247247

248248
TEST_F(KeycacheTest, SetInvalidExpirationTest) {
249249
char *err_msg;
250250
int new_expiration_interval = -2 * 24 * 3600;
251251
std::string key = "keycache.expiration_interval_s";
252-
auto rv = config_set_int(key.c_str(), new_expiration_interval, &err_msg);
252+
auto rv = scitoken_config_set_int(key.c_str(), new_expiration_interval, &err_msg);
253253
ASSERT_FALSE(rv == 0);
254254
}
255255

256256
TEST_F(KeycacheTest, RefreshExpiredTest) {
257257
char *err_msg, *jwks;
258258
int new_expiration_interval = 0;
259259
std::string key = "keycache.expiration_interval_s";
260-
auto rv = config_set_int(key.c_str(), new_expiration_interval, &err_msg);
260+
auto rv = scitoken_config_set_int(key.c_str(), new_expiration_interval, &err_msg);
261261
ASSERT_TRUE(rv == 0);
262262

263263
rv = keycache_refresh_jwks(demo_scitokens_url.c_str(), &err_msg);

0 commit comments

Comments
 (0)