Skip to content

Commit

Permalink
Add null-terminated character when converting a string to a vector<ch…
Browse files Browse the repository at this point in the history 
…ar>.
  • Loading branch information
@s-trinh
s-trinh committed May 7, 2024
1 parent 5b2f4b8 commit e5dd971
Showing 1 changed file with 129 additions and 82 deletions.
211 changes: 129 additions & 82 deletions modules/core/test/tools/io/testNPZ.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@
#include <iostream>
#include <visp3/core/vpConfig.h>

#if defined(VISP_HAVE_CATCH2)
#define CATCH_CONFIG_RUNNER
#include <catch.hpp>
#if defined(VISP_HAVE_CATCH2) && \
(defined(_WIN32) || (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__))))
// #define CATCH_CONFIG_RUNNER
// #include <catch.hpp>

#include <visp3/core/vpIoTools.h>

namespace
{
std::string createTmpDir()
{
#if defined(_WIN32) || (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__)))
std::string username;
vpIoTools::getUserName(username);

Expand All @@ -62,94 +62,141 @@ std::string createTmpDir()
}
}

TEST_CASE("Test visp::cnpy::npy_load/npz_save", "[visp::cnpy I/O]")
{
std::string directory_filename = createTmpDir();
REQUIRE(vpIoTools::checkDirectory(directory_filename));
std::string npz_filename = directory_filename + "/test_npz_read_write.npz";
// TEST_CASE("Test visp::cnpy::npy_load/npz_save", "[visp::cnpy I/O]")
// {
// std::string directory_filename = createTmpDir();
// REQUIRE(vpIoTools::checkDirectory(directory_filename));
// std::string npz_filename = directory_filename + "/test_npz_read_write.npz";

// SECTION("Read/Save string data")
// {
// const std::string save_string = "Open Source Visual Servoing Platform";
// std::vector<char> vec_save_string(save_string.begin(), save_string.end());
// // Manually add a null-terminated character
// // https://stackoverflow.com/a/8247804
// vec_save_string.push_back('\0');
// const std::string identifier = "String";
// visp::cnpy::npz_save(npz_filename, identifier, &vec_save_string[0], { vec_save_string.size() }, "w");

// visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
// visp::cnpy::NpyArray arr_string_data = npz_data[identifier];
// const std::string read_string = std::string(arr_string_data.data<char>());
// CHECK(save_string == read_string);
// }

// SECTION("Read/Save multi-dimensional array")
// {
// size_t height = 5, width = 7, channels = 3;
// std::vector<int> save_vec;
// save_vec.reserve(height*width*channels);
// for (size_t i = 0; i < height*width*channels; i++) {
// save_vec.push_back(i);
// }

// const std::string identifier = "Array";
// visp::cnpy::npz_save(npz_filename, identifier, &save_vec[0], { height, width, channels }, "a"); // append
// visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
// visp::cnpy::NpyArray arr_vec_data = npz_data[identifier];
// std::vector<int> read_vec = arr_vec_data.as_vec<int>();

// REQUIRE(save_vec.size() == read_vec.size());
// for (size_t i = 0; i < read_vec.size(); i++) {
// CHECK(save_vec[i] == read_vec[i]);
// }
// }

// REQUIRE(vpIoTools::remove(directory_filename));
// REQUIRE(!vpIoTools::checkDirectory(directory_filename));
// }

// // https://en.cppreference.com/w/cpp/types/integer
// // https://github.com/catchorg/Catch2/blob/devel/docs/test-cases-and-sections.md#type-parametrised-test-cases
// using BasicTypes = std::tuple<uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double>;
// TEMPLATE_LIST_TEST_CASE("Test visp::cnpy::npy_load/npz_save", "[BasicTypes][list]", BasicTypes)
// {
// std::string directory_filename = createTmpDir();
// REQUIRE(vpIoTools::checkDirectory(directory_filename));
// std::string npz_filename = directory_filename + "/test_npz_read_write.npz";

// const std::string identifier = "data";
// TestType save_data = std::numeric_limits<TestType>::min();
// visp::cnpy::npz_save(npz_filename, identifier, &save_data, { 1 }, "w");

// visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
// visp::cnpy::NpyArray arr_data = npz_data[identifier];
// TestType read_data = *arr_data.data<TestType>();
// CHECK(save_data == read_data);

// save_data = std::numeric_limits<TestType>::max();
// visp::cnpy::npz_save(npz_filename, identifier, &save_data, { 1 }, "a"); // append

// npz_data = visp::cnpy::npz_load(npz_filename);
// arr_data = npz_data[identifier];
// read_data = *arr_data.data<TestType>();
// CHECK(save_data == read_data);

// REQUIRE(vpIoTools::remove(directory_filename));
// REQUIRE(!vpIoTools::checkDirectory(directory_filename));
// }

SECTION("Read/Save string data")
{
const std::string save_string = "Open Source Visual Servoing Platform";
std::vector<char> vec_save_string(save_string.begin(), save_string.end());
const std::string identifier = "String";
visp::cnpy::npz_save(npz_filename, identifier, &vec_save_string[0], { vec_save_string.size() }, "w");

visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
visp::cnpy::NpyArray arr_string_data = npz_data[identifier];
const std::string read_string = std::string(arr_string_data.data<char>());
CHECK(save_string == read_string);
}

SECTION("Read/Save multi-dimensional array")
int main(int argc, char *argv[])
{
// DEBUG:
{
size_t height = 5, width = 7, channels = 3;
std::vector<int> save_vec;
save_vec.reserve(height*width*channels);
for (size_t i = 0; i < height*width*channels; i++) {
save_vec.push_back(i);
std::string directory_filename = createTmpDir();
std::string npz_filename = directory_filename + "/test_npz_read_write.npz";

{
const std::string save_string = "Open Source Visual Servoing Platform";
std::vector<char> vec_save_string(save_string.begin(), save_string.end());
// Manually add a null-terminated character
// https://stackoverflow.com/a/8247804
// vec_save_string.push_back('\0');
const std::string identifier = "String";
visp::cnpy::npz_save(npz_filename, identifier, &vec_save_string[0], { vec_save_string.size() }, "w");

visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
visp::cnpy::NpyArray arr_string_data = npz_data[identifier];
std::vector<char> vec_arr_string_data = arr_string_data.as_vec<char>();
const std::string read_string = std::string(vec_arr_string_data.begin(), vec_arr_string_data.end());
std::cout << "(save_string == read_string)=" << (save_string == read_string) << std::endl;
}

const std::string identifier = "Array";
visp::cnpy::npz_save(npz_filename, identifier, &save_vec[0], { height, width, channels }, "a"); // append
visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
visp::cnpy::NpyArray arr_vec_data = npz_data[identifier];
std::vector<int> read_vec = arr_vec_data.as_vec<int>();

REQUIRE(save_vec.size() == read_vec.size());
for (size_t i = 0; i < read_vec.size(); i++) {
CHECK(save_vec[i] == read_vec[i]);
{
size_t height = 5, width = 7, channels = 3;
std::vector<int> save_vec;
save_vec.reserve(height*width*channels);
for (size_t i = 0; i < height*width*channels; i++) {
save_vec.push_back(i);
}

const std::string identifier = "Array";
visp::cnpy::npz_save(npz_filename, identifier, &save_vec[0], { height, width, channels }, "a"); // append
visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
visp::cnpy::NpyArray arr_vec_data = npz_data[identifier];
std::vector<int> read_vec = arr_vec_data.as_vec<int>();

std::cout << "(save_vec.size() == read_vec.size())=" << (save_vec.size() == read_vec.size()) << std::endl;
for (size_t i = 0; i < read_vec.size(); i++) {
if (save_vec[i] != read_vec[i]) {
std::cerr << "save_vec[i]=" << save_vec[i] << " ; read_vec[i]=" << read_vec[i] << std::endl;
}
}
}
}
return 0;

REQUIRE(vpIoTools::remove(directory_filename));
REQUIRE(!vpIoTools::checkDirectory(directory_filename));
#endif
}

// https://en.cppreference.com/w/cpp/types/integer
// https://github.com/catchorg/Catch2/blob/devel/docs/test-cases-and-sections.md#type-parametrised-test-cases
using BasicTypes = std::tuple<uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double>;
TEMPLATE_LIST_TEST_CASE("Test visp::cnpy::npy_load/npz_save", "[BasicTypes][list]", BasicTypes)
{
std::string directory_filename = createTmpDir();
REQUIRE(vpIoTools::checkDirectory(directory_filename));
std::string npz_filename = directory_filename + "/test_npz_read_write.npz";

const std::string identifier = "data";
TestType save_data = std::numeric_limits<TestType>::min();
visp::cnpy::npz_save(npz_filename, identifier, &save_data, { 1 }, "w");

visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename);
visp::cnpy::NpyArray arr_data = npz_data[identifier];
TestType read_data = *arr_data.data<TestType>();
CHECK(save_data == read_data);

save_data = std::numeric_limits<TestType>::max();
visp::cnpy::npz_save(npz_filename, identifier, &save_data, { 1 }, "a"); // append

npz_data = visp::cnpy::npz_load(npz_filename);
arr_data = npz_data[identifier];
read_data = *arr_data.data<TestType>();
CHECK(save_data == read_data);

REQUIRE(vpIoTools::remove(directory_filename));
REQUIRE(!vpIoTools::checkDirectory(directory_filename));
}

int main(int argc, char *argv[])
{
Catch::Session session; // There must be exactly one instance
// Catch::Session session; // There must be exactly one instance

// Let Catch (using Clara) parse the command line
session.applyCommandLine(argc, argv);
// // Let Catch (using Clara) parse the command line
// session.applyCommandLine(argc, argv);

int numFailed = session.run();
// int numFailed = session.run();

// numFailed is clamped to 255 as some unices only use the lower 8 bits.
// This clamping has already been applied, so just return it here
// You can also do any post run clean-up here
return numFailed;
// // numFailed is clamped to 255 as some unices only use the lower 8 bits.
// // This clamping has already been applied, so just return it here
// // You can also do any post run clean-up here
// return numFailed;
}
#else
int main() { return EXIT_SUCCESS; }
Expand Down

0 comments on commit e5dd971

Please sign in to comment.