File: monitoring_test.cpp

package info (click to toggle)
scitokens-cpp 1.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,172 kB
  • sloc: cpp: 11,717; ansic: 596; sh: 161; python: 132; makefile: 22
file content (441 lines) | stat: -rw-r--r-- 15,159 bytes parent folder | download | duplicates (2)
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/**
 * Monitoring API unit tests
 *
 * Tests the monitoring API for per-issuer validation statistics including:
 * - Counter increments for successful/unsuccessful validations
 * - Duration tracking
 * - Failed issuer lookup tracking
 * - DDoS protection (max entries limit)
 * - Reset functionality
 */

#include "../src/scitokens.h"

#include <cmath>
#include <gtest/gtest.h>
#include <string>

#ifndef PICOJSON_USE_INT64
#define PICOJSON_USE_INT64
#endif
#include <picojson/picojson.h>

namespace {

// Helper class to parse monitoring JSON
class MonitoringStats {
  public:
    struct IssuerStats {
        uint64_t successful_validations{0};
        uint64_t unsuccessful_validations{0};
        uint64_t expired_tokens{0};
        // Validation started counters
        uint64_t sync_validations_started{0};
        uint64_t async_validations_started{0};
        // Duration tracking
        double sync_total_time_s{0.0};
        double async_total_time_s{0.0};
        double total_validation_time_s{0.0};
        // Key lookup statistics
        uint64_t successful_key_lookups{0};
        uint64_t failed_key_lookups{0};
        double failed_key_lookup_time_s{0.0};
        // Key refresh statistics
        uint64_t expired_keys{0};
        uint64_t failed_refreshes{0};
        uint64_t stale_key_uses{0};
    };

    struct FailedIssuerLookup {
        uint64_t count{0};
        double total_time_s{0.0};
    };

    bool parse(const std::string &json) {
        picojson::value root;
        std::string err = picojson::parse(root, json);
        if (!err.empty()) {
            return false;
        }

        if (!root.is<picojson::object>()) {
            return false;
        }

        auto &root_obj = root.get<picojson::object>();

        // Parse issuers
        issuers_.clear();
        auto issuers_it = root_obj.find("issuers");
        if (issuers_it != root_obj.end() &&
            issuers_it->second.is<picojson::object>()) {
            auto &issuers_obj = issuers_it->second.get<picojson::object>();
            for (const auto &issuer_entry : issuers_obj) {
                if (issuer_entry.second.is<picojson::object>()) {
                    IssuerStats stats;
                    auto &stats_obj =
                        issuer_entry.second.get<picojson::object>();

                    auto it = stats_obj.find("successful_validations");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.successful_validations =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("unsuccessful_validations");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.unsuccessful_validations =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("expired_tokens");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.expired_tokens =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    // Validation started counters
                    it = stats_obj.find("sync_validations_started");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.sync_validations_started =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("async_validations_started");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.async_validations_started =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    // Duration tracking
                    it = stats_obj.find("sync_total_time_s");
                    if (it != stats_obj.end() && it->second.is<double>()) {
                        stats.sync_total_time_s = it->second.get<double>();
                    }

                    it = stats_obj.find("async_total_time_s");
                    if (it != stats_obj.end() && it->second.is<double>()) {
                        stats.async_total_time_s = it->second.get<double>();
                    }

                    it = stats_obj.find("total_validation_time_s");
                    if (it != stats_obj.end() && it->second.is<double>()) {
                        stats.total_validation_time_s =
                            it->second.get<double>();
                    }

                    // Key lookup statistics
                    it = stats_obj.find("successful_key_lookups");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.successful_key_lookups =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("failed_key_lookups");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.failed_key_lookups =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("failed_key_lookup_time_s");
                    if (it != stats_obj.end() && it->second.is<double>()) {
                        stats.failed_key_lookup_time_s =
                            it->second.get<double>();
                    }

                    // Key refresh statistics
                    it = stats_obj.find("expired_keys");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.expired_keys =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("failed_refreshes");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.failed_refreshes =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = stats_obj.find("stale_key_uses");
                    if (it != stats_obj.end() && it->second.is<int64_t>()) {
                        stats.stale_key_uses =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    issuers_[issuer_entry.first] = stats;
                }
            }
        }

        // Parse failed issuer lookups (now has count and total_time_s)
        failed_issuer_lookups_.clear();
        auto failed_it = root_obj.find("failed_issuer_lookups");
        if (failed_it != root_obj.end() &&
            failed_it->second.is<picojson::object>()) {
            auto &failed_obj = failed_it->second.get<picojson::object>();
            for (const auto &entry : failed_obj) {
                if (entry.second.is<picojson::object>()) {
                    FailedIssuerLookup lookup;
                    auto &lookup_obj = entry.second.get<picojson::object>();

                    auto it = lookup_obj.find("count");
                    if (it != lookup_obj.end() && it->second.is<int64_t>()) {
                        lookup.count =
                            static_cast<uint64_t>(it->second.get<int64_t>());
                    }

                    it = lookup_obj.find("total_time_s");
                    if (it != lookup_obj.end() && it->second.is<double>()) {
                        lookup.total_time_s = it->second.get<double>();
                    }

                    failed_issuer_lookups_[entry.first] = lookup;
                }
            }
        }

        return true;
    }

    IssuerStats getIssuerStats(const std::string &issuer) const {
        auto it = issuers_.find(issuer);
        if (it != issuers_.end()) {
            return it->second;
        }
        return IssuerStats{};
    }

    FailedIssuerLookup getFailedLookup(const std::string &issuer) const {
        auto it = failed_issuer_lookups_.find(issuer);
        if (it != failed_issuer_lookups_.end()) {
            return it->second;
        }
        return FailedIssuerLookup{};
    }

    uint64_t getFailedLookupCount(const std::string &issuer) const {
        return getFailedLookup(issuer).count;
    }

    double getFailedLookupTime(const std::string &issuer) const {
        return getFailedLookup(issuer).total_time_s;
    }

    size_t getIssuerCount() const { return issuers_.size(); }

    size_t getFailedIssuerCount() const {
        return failed_issuer_lookups_.size();
    }

  private:
    std::map<std::string, IssuerStats> issuers_;
    std::map<std::string, FailedIssuerLookup> failed_issuer_lookups_;
};

// Helper to get current monitoring stats
MonitoringStats getCurrentStats() {
    char *json_out = nullptr;
    char *err_msg = nullptr;
    MonitoringStats stats;

    int rv = scitoken_get_monitoring_json(&json_out, &err_msg);
    if (rv == 0 && json_out) {
        stats.parse(json_out);
        free(json_out);
    }
    if (err_msg)
        free(err_msg);

    return stats;
}

class MonitoringTest : public ::testing::Test {
  protected:
    void SetUp() override {
        // Reset monitoring stats before each test
        char *err_msg = nullptr;
        scitoken_reset_monitoring_stats(&err_msg);
        if (err_msg)
            free(err_msg);
    }
};

TEST_F(MonitoringTest, GetMonitoringJson) {
    char *json_out = nullptr;
    char *err_msg = nullptr;

    int rv = scitoken_get_monitoring_json(&json_out, &err_msg);
    ASSERT_EQ(rv, 0) << "Failed to get monitoring JSON: "
                     << (err_msg ? err_msg : "unknown");
    ASSERT_NE(json_out, nullptr);

    // Should be valid JSON with "issuers" key
    MonitoringStats stats;
    EXPECT_TRUE(stats.parse(json_out));
    EXPECT_EQ(stats.getIssuerCount(), 0); // Should be empty after reset

    free(json_out);
    if (err_msg)
        free(err_msg);
}

TEST_F(MonitoringTest, GetMonitoringJsonNullOutput) {
    char *err_msg = nullptr;

    int rv = scitoken_get_monitoring_json(nullptr, &err_msg);
    EXPECT_NE(rv, 0);
    EXPECT_NE(err_msg, nullptr);

    if (err_msg)
        free(err_msg);
}

TEST_F(MonitoringTest, ResetMonitoringStats) {
    char *err_msg = nullptr;

    int rv = scitoken_reset_monitoring_stats(&err_msg);
    EXPECT_EQ(rv, 0);

    auto stats = getCurrentStats();
    EXPECT_EQ(stats.getIssuerCount(), 0);
    EXPECT_EQ(stats.getFailedIssuerCount(), 0);

    if (err_msg)
        free(err_msg);
}

TEST_F(MonitoringTest, DDoSProtection) {
    // The monitoring system should limit tracking failed issuers to
    // MAX_FAILED_ISSUERS (100)
    const int DDOS_TEST_COUNT = 150;
    char *err_msg = nullptr;

    // Try to create many tokens with different invalid issuers
    for (int i = 0; i < DDOS_TEST_COUNT; i++) {
        std::string fake_token = "invalid.token." + std::to_string(i);
        SciToken temp_token = nullptr;
        scitoken_deserialize(fake_token.c_str(), &temp_token, nullptr,
                             &err_msg);
        if (err_msg) {
            free(err_msg);
            err_msg = nullptr;
        }
    }

    auto stats = getCurrentStats();

    // The system should have limited entries to prevent resource exhaustion
    // We can't check exact count since malformed tokens may fail before issuer
    // extraction, but we should verify the system didn't crash and stats work
    char *json_out = nullptr;
    int rv = scitoken_get_monitoring_json(&json_out, &err_msg);
    EXPECT_EQ(rv, 0);
    EXPECT_NE(json_out, nullptr);

    if (json_out)
        free(json_out);
    if (err_msg)
        free(err_msg);
}

// Test monitoring file configuration API
TEST_F(MonitoringTest, MonitoringFileConfiguration) {
    char *err_msg = nullptr;
    char *path = nullptr;
    int interval = 0;

    // Initially disabled (empty string)
    int rv = scitoken_config_get_str("monitoring.file", &path, &err_msg);
    EXPECT_EQ(rv, 0);
    EXPECT_NE(path, nullptr);
    EXPECT_STREQ(path, "");
    free(path);
    path = nullptr;

    // Default interval should be 60 seconds
    interval = scitoken_config_get_int("monitoring.file_interval_s", &err_msg);
    EXPECT_EQ(interval, 60);

    // Set a monitoring file path
    rv = scitoken_config_set_str(
        "monitoring.file", "/tmp/scitokens_test_monitoring.json", &err_msg);
    EXPECT_EQ(rv, 0);

    rv = scitoken_config_get_str("monitoring.file", &path, &err_msg);
    EXPECT_EQ(rv, 0);
    EXPECT_NE(path, nullptr);
    EXPECT_STREQ(path, "/tmp/scitokens_test_monitoring.json");
    free(path);
    path = nullptr;

    // Set a custom interval
    rv = scitoken_config_set_int("monitoring.file_interval_s", 30, &err_msg);
    EXPECT_EQ(rv, 0);

    interval = scitoken_config_get_int("monitoring.file_interval_s", &err_msg);
    EXPECT_EQ(interval, 30);

    // Disable by setting to empty string
    rv = scitoken_config_set_str("monitoring.file", "", &err_msg);
    EXPECT_EQ(rv, 0);

    rv = scitoken_config_get_str("monitoring.file", &path, &err_msg);
    EXPECT_EQ(rv, 0);
    EXPECT_NE(path, nullptr);
    EXPECT_STREQ(path, "");
    free(path);
    path = nullptr;

    // Disable by setting to nullptr
    rv = scitoken_config_set_str("monitoring.file", nullptr, &err_msg);
    EXPECT_EQ(rv, 0);

    rv = scitoken_config_get_str("monitoring.file", &path, &err_msg);
    EXPECT_EQ(rv, 0);
    EXPECT_NE(path, nullptr);
    EXPECT_STREQ(path, "");
    free(path);
    path = nullptr;

    // Reset interval to default for other tests
    scitoken_config_set_int("monitoring.file_interval_s", 60, &err_msg);
}

// Test monitoring file write with zero interval (immediate write)
TEST_F(MonitoringTest, MonitoringFileWrite) {
    char *err_msg = nullptr;

    // Set up a test file path and zero interval for immediate write
    std::string test_file = "/tmp/scitokens_monitoring_test_" +
                            std::to_string(time(nullptr)) + ".json";
    scitoken_config_set_str("monitoring.file", test_file.c_str(), &err_msg);
    scitoken_config_set_int("monitoring.file_interval_s", 0, &err_msg);

    // Clean up any existing file
    std::remove(test_file.c_str());

    // Reset stats and record something
    scitoken_reset_monitoring_stats(&err_msg);

    // The maybe_write_monitoring_file is called during verify(), but we can't
    // easily trigger that without a valid token/issuer. However, we can test
    // the configuration API works and that files aren't written when disabled.

    // Verify file doesn't exist yet (nothing to trigger write)
    FILE *f = fopen(test_file.c_str(), "r");
    EXPECT_EQ(f, nullptr); // File should not exist

    // Disable monitoring file
    scitoken_config_set_str("monitoring.file", "", &err_msg);
    scitoken_config_set_int("monitoring.file_interval_s", 60, &err_msg);

    // Clean up test file if it was created
    std::remove(test_file.c_str());
}

} // namespace

int main(int argc, char **argv) {
    ::testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}