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
|
/*
* (C) Copyright 1996- ECMWF.
*
* This software is licensed under the terms of the Apache Licence Version 2.0
* which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
* In applying this licence, ECMWF does not waive the privileges and immunities
* granted to it by virtue of its status as an intergovernmental organisation
* nor does it submit to any jurisdiction.
*/
/// @file test_c_api.cc
/// @date Dec 2024
/// @author Christopher Bradley
#include <cstring>
#include <set>
#include <string>
#include <vector>
#include "eckit/testing/Test.h"
#include "eckit/types/Date.h"
#include "metkit/api/metkit_c.h"
#include "metkit/mars/MarsRequest.h"
namespace metkit::test {
using ::eckit::testing::TestException;
// Wrapper around the C function calls that will throw an exception if the function fails
// i.e. if the return value is not METKIT_SUCCESS
void test_success(int e) {
metkit_error_values_t err = static_cast<metkit_error_values_t>(e);
if (err != METKIT_SUCCESS)
throw TestException("C-API error: " + std::string(metkit_get_error_string(err)), Here());
}
void EXPECT_STR_EQUAL(const char* a, const char* b) {
if (std::strcmp(a, b) != 0) {
throw TestException("Expected: " + std::string(a) + " == " + std::string(b), Here());
}
}
// Fairly minimal test coverage
CASE("metkit_marsrequest") {
// -----------------------------------------------------------------
// Basics
// -----------------------------------------------------------------
metkit_marsrequest_t* request{};
test_success(metkit_marsrequest_new(&request));
EXPECT(request);
// set/get verb
test_success(metkit_marsrequest_set_verb(request, "retrieve"));
const char* verb{};
test_success(metkit_marsrequest_verb(request, &verb));
EXPECT_STR_EQUAL(verb, "retrieve");
// set array of values
const char* dates[] = {"20200101", "20200102", "-1"};
test_success(metkit_marsrequest_set(request, "date", dates, 3));
// set single value
const char* expver = "xxxx";
test_success(metkit_marsrequest_set_one(request, "expver", expver));
test_success(metkit_marsrequest_set_one(request, "param", "2t"));
// check values
bool has = false;
test_success(metkit_marsrequest_has_param(request, "date", &has));
EXPECT(has);
test_success(metkit_marsrequest_has_param(request, "random", &has));
EXPECT(!has);
size_t count = 0;
test_success(metkit_marsrequest_count_values(request, "date", &count));
EXPECT_EQUAL(count, 3);
for (size_t i = 0; i < count; i++) {
const char* value{};
test_success(metkit_marsrequest_value(request, "date", i, &value));
EXPECT_STR_EQUAL(value, dates[i]);
}
// -----------------------------------------------------------------
// Expand
// -----------------------------------------------------------------
metkit_marsrequest_t* expandedRequest{};
test_success(metkit_marsrequest_new(&expandedRequest));
test_success(metkit_marsrequest_expand(request, false, true, expandedRequest));
// Check date expanded -1 -> yesterday
test_success(metkit_marsrequest_count_values(expandedRequest, "date", &count));
EXPECT_EQUAL(count, 3);
std::array<const char*, 3> dates_expanded;
for (size_t i = 0; i < count; i++) {
test_success(metkit_marsrequest_value(expandedRequest, "date", i, &dates_expanded[i]));
}
EXPECT_STR_EQUAL(dates_expanded[2], std::to_string(eckit::Date(-1).yyyymmdd()).c_str());
// check param expanded 2t -> 167
const char* param{};
test_success(metkit_marsrequest_value(expandedRequest, "param", 0, ¶m));
EXPECT_STR_EQUAL(param, "167");
// -----------------------------------------------------------------
// Merge
// -----------------------------------------------------------------
metkit_marsrequest_t* req_manydates{};
test_success(metkit_marsrequest_new(&req_manydates));
const char* dates_many[] = {"19000101", "19000102", "19000103"};
test_success(metkit_marsrequest_set(req_manydates, "date", dates_many, 3));
test_success(metkit_marsrequest_merge(request, req_manydates));
test_success(metkit_marsrequest_count_values(request, "date", &count));
EXPECT_EQUAL(count, 6);
// -----------------------------------------------------------------
// done
metkit_marsrequest_delete(request);
metkit_marsrequest_delete(expandedRequest);
metkit_marsrequest_delete(req_manydates);
}
//-----------------------------------------------------------------------------
CASE("metkit_requestiterator_t parsing") {
metkit_requestiterator_t* it{};
test_success(
metkit_parse_marsrequests("retrieve,date=-1,param=2t \n retrieve,date=20200102,param=2t,step=10/to/20/by/2",
&it, true)); // two separate requests
std::vector<metkit_marsrequest_t*> requests;
metkit_iterator_status_t status;
while ((status = metkit_requestiterator_next(it)) == METKIT_ITERATOR_SUCCESS) {
metkit_marsrequest_t* req{};
test_success(metkit_marsrequest_new(&req));
EXPECT_EQUAL(metkit_requestiterator_current(it, req), METKIT_ITERATOR_SUCCESS);
requests.push_back(req);
}
EXPECT_EQUAL(status, METKIT_ITERATOR_COMPLETE);
EXPECT_EQUAL(requests.size(), 2);
// check the date
const char* date{};
test_success(metkit_marsrequest_value(requests[0], "date", 0, &date));
EXPECT_STR_EQUAL(date, std::to_string(eckit::Date(-1).yyyymmdd()).c_str()); // parser also calls expand
test_success(metkit_marsrequest_value(requests[1], "date", 0, &date));
EXPECT_STR_EQUAL(date, "20200102");
// Check steps have been parsed
size_t count = 0;
test_success(metkit_marsrequest_count_values(requests[1], "step", &count));
EXPECT_EQUAL(count, 6);
for (size_t i = 0; i < count; i++) {
const char* step{};
test_success(metkit_marsrequest_value(requests[1], "step", i, &step));
EXPECT_STR_EQUAL(step, std::to_string(10 + i * 2).c_str());
}
// cleanup
metkit_requestiterator_delete(it); // NB: requests have been moved out of the iterator
for (auto& req : requests) {
metkit_marsrequest_delete(req);
}
}
// Ensure that the param iterator works as expected
CASE("metkit_paramiterator_t ") {
std::string str = "retrieve,date=20200102,param=2t,step=10/to/20/by/2";
metkit_marsrequest_t* request{};
test_success(metkit_marsrequest_new(&request));
test_success(metkit_parse_marsrequest(str.c_str(), request, true));
metkit_paramiterator_t* it{};
test_success(metkit_marsrequest_params(request, &it));
metkit_iterator_status_t status;
std::set<std::string> keys;
while ((status = metkit_paramiterator_next(it)) == METKIT_ITERATOR_SUCCESS) {
const char* key{};
EXPECT_EQUAL(metkit_paramiterator_current(it, &key), METKIT_ITERATOR_SUCCESS);
keys.insert(key);
}
EXPECT_EQUAL(status, METKIT_ITERATOR_COMPLETE);
// Compare with C++ impl for consistency
mars::MarsRequest req = mars::MarsRequest::parse(str, true);
std::set<std::string> keys_cpp;
for (const auto& k : req.params()) {
keys_cpp.insert(k);
}
EXPECT_EQUAL(keys, keys_cpp);
}
CASE("metkit_requestiterator_t 1 item") {
// Edge case: verify iterator with one item works the same way.
metkit_requestiterator_t* it{};
test_success(metkit_parse_marsrequests("retrieve,date=-1,param=2t", &it, true));
std::vector<metkit_marsrequest_t*> requests;
metkit_iterator_status_t status;
while ((status = metkit_requestiterator_next(it)) == METKIT_ITERATOR_SUCCESS) {
metkit_marsrequest_t* req{};
test_success(metkit_marsrequest_new(&req));
EXPECT_EQUAL(metkit_requestiterator_current(it, req), METKIT_ITERATOR_SUCCESS);
requests.push_back(req);
}
EXPECT_EQUAL(status, METKIT_ITERATOR_COMPLETE);
EXPECT_EQUAL(requests.size(), 1);
// cleanup
metkit_requestiterator_delete(it);
for (auto& req : requests) {
metkit_marsrequest_delete(req);
}
}
} // namespace metkit::test
int main(int argc, char** argv) {
return eckit::testing::run_tests(argc, argv);
}
|