Skip to content

[compression] Improve logging in rosbag2_compression #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zmichaels11 merged 1 commit into from
Feb 7, 2020
Merged

[compression] Improve logging in rosbag2_compression #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions rosbag2_compression/src/rosbag2_compression/zstd_compressor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,11 @@ std::vector<uint8_t> get_input_buffer(const std::string & uri)
// Read in buffer, handling accordingly
const auto file_pointer = open_file(uri.c_str(), "rb");
if (file_pointer == nullptr) {
throw std::runtime_error{"Error opening file"};
std::stringstream errmsg;
errmsg << "Error opening file: \"" << uri <<
"\" for binary reading! errno(" << errno << ")";

throw std::runtime_error{errmsg.str()};
}

const auto decompressed_buffer_length = rcutils_get_file_size(uri.c_str());
Expand All @@ -73,7 +77,7 @@ std::vector<uint8_t> get_input_buffer(const std::string & uri)
fclose(file_pointer);

std::stringstream errmsg;
errmsg << "Unable to get size of file: " << uri;
errmsg << "Unable to get size of file: \"" << uri << "\"";

throw std::runtime_error{errmsg.str()};
}
Expand All @@ -93,7 +97,11 @@ std::vector<uint8_t> get_input_buffer(const std::string & uri)

if (ferror(file_pointer)) {
fclose(file_pointer);
throw std::runtime_error{"Unable to read file"};

std::stringstream errmsg;
errmsg << "Unable to read binary data from file: \"" << uri << "\"!";

throw std::runtime_error{errmsg.str()};
}
fclose(file_pointer);
return decompressed_buffer;
Expand All @@ -110,7 +118,7 @@ void write_output_buffer(
{
if (output_buffer.empty()) {
std::stringstream errmsg;
errmsg << "Cannot write empty buffer to file: " << uri;
errmsg << "Cannot write empty buffer to file: \"" << uri << "\"";

throw std::runtime_error{errmsg.str()};
}
Expand All @@ -131,7 +139,11 @@ void write_output_buffer(

if (ferror(file_pointer)) {
fclose(file_pointer);
throw std::runtime_error{"Unable to write compressed file"};

std::stringstream errmsg;
errmsg << "Unable to write compressed data to file: \"" << uri << "\"!";

throw std::runtime_error{errmsg.str()};
}
fclose(file_pointer);
}
Expand Down
10 changes: 6 additions & 4 deletions rosbag2_compression/src/rosbag2_compression/zstd_decompressor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ std::vector<uint8_t> get_input_buffer(const std::string & uri)
const auto file_pointer = open_file(uri.c_str(), "rb");
if (file_pointer == nullptr) {
std::stringstream errmsg;
errmsg << "Failed to open file: \"" << uri << "\" for binary reading!";
errmsg << "Failed to open file: \"" << uri <<
"\" for binary reading! errno(" << errno << ")";

throw std::runtime_error{errmsg.str()};
}
Expand All @@ -77,7 +78,7 @@ std::vector<uint8_t> get_input_buffer(const std::string & uri)
fclose(file_pointer);

std::stringstream errmsg;
errmsg << "Unable to get size of file: " << uri;
errmsg << "Unable to get size of file: \"" << uri << "\"";

throw std::runtime_error{errmsg.str()};
}
Expand Down Expand Up @@ -123,15 +124,16 @@ void write_output_buffer(
{
if (output_buffer.empty()) {
std::stringstream errmsg;
errmsg << "Cannot write empty buffer to file: " << uri;
errmsg << "Cannot write empty buffer to file: \"" << uri << "\"";

throw std::runtime_error{errmsg.str()};
}

const auto file_pointer = open_file(uri.c_str(), "wb");
if (file_pointer == nullptr) {
std::stringstream errmsg;
errmsg << "Failed to open file: \"" << uri << "\" for binary writing!";
errmsg << "Failed to open file: \"" << uri <<
"\" for binary writing! errno(" << errno << ")";

throw std::runtime_error{errmsg.str()};
}
Expand Down
35 changes: 23 additions & 12 deletions rosbag2_compression/test/rosbag2_compression/test_zstd_compressor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ TEST_F(CompressionHelperFixture, zstd_compress_file_uri)
EXPECT_EQ(compressed_uri, expected_compressed_uri);
EXPECT_LT(compressed_file_size, uncompressed_file_size);
EXPECT_GT(compressed_file_size, 0u);
EXPECT_TRUE(rcpputils::fs::path(compressed_uri).exists());
EXPECT_TRUE(rcpputils::fs::exists(compressed_uri)) <<
"Expected compressed path: \"" << compressed_uri << "\" to exist!";
}

TEST_F(CompressionHelperFixture, zstd_decompress_file_uri)
Expand All @@ -114,7 +115,10 @@ TEST_F(CompressionHelperFixture, zstd_decompress_file_uri)
auto zstd_compressor = rosbag2_compression::ZstdCompressor{};
const auto compressed_uri = zstd_compressor.compress_uri(uri);

ASSERT_EQ(0, std::remove(uri.c_str())); // The test is invalid if the initial file is not deleted
// The test is invalid if the initial file is not deleted
ASSERT_EQ(0, std::remove(uri.c_str())) <<
"Removal of \"" << uri << "\" failed! The remaining tests require \"" <<
uri << "\" to be deleted!";

auto zstd_decompressor = rosbag2_compression::ZstdDecompressor{};
const auto decompressed_uri = zstd_decompressor.decompress_uri(compressed_uri);
Expand All @@ -126,16 +130,17 @@ TEST_F(CompressionHelperFixture, zstd_decompress_file_uri)
EXPECT_NE(decompressed_uri, compressed_uri);
EXPECT_EQ(uri, expected_decompressed_uri);
EXPECT_EQ(initial_file_size, decompressed_file_size);
EXPECT_TRUE(rcpputils::fs::path(decompressed_uri).exists());
EXPECT_TRUE(rcpputils::fs::exists(decompressed_uri)) <<
"Expected decompressed file: \"" << decompressed_uri << "\" to exist!";
}

TEST_F(CompressionHelperFixture, zstd_decompress_file_contents)
{
const auto uri = (rcpputils::fs::path(temporary_dir_path_) / "file2.txt").string();
create_garbage_file(uri);

ASSERT_TRUE(rcpputils::fs::path{uri}.exists()) <<
"Initial file was not created!";
ASSERT_TRUE(rcpputils::fs::exists(uri)) <<
"Expected initial file: \"" << uri << "\" to exist!";

const auto initial_data = read_file(uri);
const auto initial_file_size = rcutils_get_file_size(uri.c_str());
Expand All @@ -147,15 +152,19 @@ TEST_F(CompressionHelperFixture, zstd_decompress_file_contents)
auto compressor = rosbag2_compression::ZstdCompressor{};
const auto compressed_uri = compressor.compress_uri(uri);

ASSERT_TRUE(rcpputils::fs::path{compressed_uri}.exists()) <<
"Compressed file does not exist!";
ASSERT_EQ(0, std::remove(uri.c_str())) << "Failed to remove initial file!";
ASSERT_TRUE(rcpputils::fs::exists(compressed_uri)) <<
"Expected compressed file: \"" << compressed_uri << "\" to exist!";

ASSERT_EQ(0, std::remove(uri.c_str())) <<
"Removal of initial file: \"" << uri <<
"\" failed! The remaining tests require \"" << uri << "\" to be deleted.";

auto decompressor = rosbag2_compression::ZstdDecompressor{};
const auto decompressed_uri = decompressor.decompress_uri(compressed_uri);

ASSERT_TRUE(rcpputils::fs::path{decompressed_uri}.exists()) <<
"Decompressed file must exist!";
ASSERT_TRUE(rcpputils::fs::exists(decompressed_uri)) <<
"Decompressed file: \"" << decompressed_uri << "\" must exist!";

EXPECT_EQ(uri, decompressed_uri) <<
"Expected decompressed file name to be same as initial!";

Expand All @@ -179,13 +188,15 @@ TEST_F(CompressionHelperFixture, zstd_decompress_fails_on_bad_file)
create_garbage_file(uri);

auto decompressor = rosbag2_compression::ZstdDecompressor{};
EXPECT_THROW(decompressor.decompress_uri(uri), std::runtime_error);
EXPECT_THROW(decompressor.decompress_uri(uri), std::runtime_error) <<
"Expected decompress(\"" << uri << "\") to fail!";
}

TEST_F(CompressionHelperFixture, zstd_decompress_fails_on_bad_uri)
{
const auto bad_uri = (rcpputils::fs::path(temporary_dir_path_) / "bad_uri.txt").string();
auto decompressor = rosbag2_compression::ZstdDecompressor{};

EXPECT_THROW(decompressor.decompress_uri(bad_uri), std::runtime_error);
EXPECT_THROW(decompressor.decompress_uri(bad_uri), std::runtime_error) <<
"Expected decompress_uri(\"" << bad_uri << "\") to fail!";
}