Skip to content

Update C++ tsfile-cli command surface and data workflows #915

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

Open
SpriCoder wants to merge 16 commits into
base: develop
Choose a base branch
from
+3,693 −815
Open

Update C++ tsfile-cli command surface and data workflows #915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
261a506
test: capture tsfile cli v0.7 contracts
SpriCoder Aug 20, 2026
f89b2b1
feat: align tsfile cli surface with v0.7 contract
SpriCoder Aug 20, 2026
aa8a32d
docs: refresh tsfile cli usage reference
SpriCoder Aug 20, 2026
55e225b
fix: tighten tsfile cli contract edge cases
SpriCoder Aug 20, 2026
1691d90
fix: align cli machine value serialization
SpriCoder Aug 20, 2026
6f11f7b
style: format cli tests for spotless
SpriCoder Aug 20, 2026
469ce4c
fix: support cli file checks on windows
SpriCoder Aug 20, 2026
faa54b8
fix: require standalone cli help and version
SpriCoder Aug 20, 2026
e8c35f8
fix: reject repeated cli singleton options
SpriCoder Aug 20, 2026
292262c
fix: align stats and count output contracts
SpriCoder Aug 20, 2026
a729ead
fix: handle windows cli output paths
SpriCoder Aug 20, 2026
e9b2816
fix: align write csv contract
SpriCoder Aug 20, 2026
9de4cd9
fix: document cli command contracts
SpriCoder Aug 20, 2026
17c7f8f
test: stabilize cli skill reference check
SpriCoder Aug 20, 2026
9a5db8f
test: remove version label from cli requirement tests
SpriCoder Aug 21, 2026
909984b
style: format cli requirement test suite name
SpriCoder Aug 21, 2026
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
2 changes: 2 additions & 0 deletions cpp/test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,8 @@ if (VENDORED_GTEST_INCLUDE_DIRS)
endif ()
if (BUILD_TOOLS)
target_include_directories(TsFile_Test PRIVATE ${CMAKE_SOURCE_DIR}/tools)
target_compile_definitions(TsFile_Test PRIVATE
TSFILE_CPP_SOURCE_DIR="${CMAKE_SOURCE_DIR}")
endif ()
if (APPLE AND NOT MSVC)
target_compile_options(TsFile_Test PRIVATE -std=c++14)
Expand Down
100 changes: 54 additions & 46 deletions cpp/test/tools/cli_args_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,34 @@ TEST(RunCliTest, VersionFlagPrintsVersionAndReturnsOk) {
EXPECT_TRUE(err.str().empty());
}

TEST(RunCliTest, VersionMustAppearByItself) {
std::ostringstream out;
std::ostringstream err;
int code =
tsfile_cli::run_cli({"cat", "--version", "data.tsfile"}, out, err);
EXPECT_EQ(code, 1);
EXPECT_TRUE(out.str().empty());
EXPECT_NE(err.str().find("--version"), std::string::npos) << err.str();
}

TEST(RunCliTest, TopLevelHelpMustAppearByItself) {
std::ostringstream out;
std::ostringstream err;
int code = tsfile_cli::run_cli({"--help", "cat"}, out, err);
EXPECT_EQ(code, 1);
EXPECT_TRUE(out.str().empty());
EXPECT_NE(err.str().find("--help"), std::string::npos) << err.str();
}

TEST(RunCliTest, CommandHelpMustAppearByItself) {
std::ostringstream out;
std::ostringstream err;
int code = tsfile_cli::run_cli({"cat", "--help", "data.tsfile"}, out, err);
EXPECT_EQ(code, 1);
EXPECT_TRUE(out.str().empty());
EXPECT_NE(err.str().find("--help"), std::string::npos) << err.str();
}

TEST(RunCliTest, NoArgsPrintsUsageToErrAndReturnsUsageError) {
std::ostringstream out;
std::ostringstream err;
Expand All @@ -54,7 +82,7 @@ TEST(RunCliTest, LeadingOptionBeforeCommandIsClearError) {
std::ostringstream out;
std::ostringstream err;
int code =
tsfile_cli::run_cli({"-f", "json", "meta", "data.tsfile"}, out, err);
tsfile_cli::run_cli({"-f", "ndjson", "meta", "data.tsfile"}, out, err);
EXPECT_EQ(code, 1);
EXPECT_NE(err.str().find("command must come before options"),
std::string::npos)
Expand All @@ -69,14 +97,15 @@ TEST(ParseArgsTest, CommandAndFilePositional) {
}

TEST(ParseArgsTest, FormatFlagParsed) {
auto p = tsfile_cli::parse_args({"cat", "-f", "json", "data.tsfile"});
auto p = tsfile_cli::parse_args({"cat", "-f", "ndjson", "data.tsfile"});
EXPECT_TRUE(p.error.empty());
EXPECT_EQ(p.format, tsfile_cli::ParsedArgs::Format::kJson);
}

TEST(ParseArgsTest, MeasurementsSplitOnComma) {
auto p = tsfile_cli::parse_args({"cat", "-m", "s1,s2,s3", "data.tsfile"});
ASSERT_EQ(p.measurements.size(), 3u);
TEST(ParseArgsTest, MeasurementsRepeatOneNamePerOption) {
auto p =
tsfile_cli::parse_args({"cat", "-m", "s1", "-m", "s2", "data.tsfile"});
ASSERT_EQ(p.measurements.size(), 2u);
EXPECT_EQ(p.measurements[1], "s2");
}

Expand All @@ -97,27 +126,24 @@ TEST(ParseArgsTest, TagFilterParsed) {
{"cat", "--tag-filter", "id1", "eq", "dev_a", "data.tsfile"});
EXPECT_TRUE(p.error.empty());
EXPECT_TRUE(p.has_tag_filter);
EXPECT_EQ(p.tag_filter_op, tsfile_cli::ParsedArgs::TagFilterOp::kEq);
EXPECT_EQ(p.tag_filter_column, "id1");
EXPECT_EQ(p.tag_filter_value, "dev_a");
ASSERT_EQ(p.tag_filters.size(), 1u);
EXPECT_EQ(p.tag_filters[0].op, tsfile_cli::ParsedArgs::TagFilterOp::kEq);
EXPECT_EQ(p.tag_filters[0].column, "id1");
EXPECT_EQ(p.tag_filters[0].value, "dev_a");
}

TEST(ParseArgsTest, TagBetweenParsed) {
TEST(ParseArgsTest, TagBetweenIsNotSupported) {
auto p = tsfile_cli::parse_args(
{"cat", "--tag-between", "id1", "dev_a", "dev_c", "data.tsfile"});
EXPECT_TRUE(p.error.empty());
EXPECT_TRUE(p.has_tag_filter);
EXPECT_EQ(p.tag_filter_op, tsfile_cli::ParsedArgs::TagFilterOp::kBetween);
EXPECT_EQ(p.tag_filter_column, "id1");
EXPECT_EQ(p.tag_filter_value, "dev_a");
EXPECT_EQ(p.tag_filter_value2, "dev_c");
EXPECT_FALSE(p.error.empty());
}

TEST(ParseArgsTest, DuplicateTagFilterIsError) {
auto p = tsfile_cli::parse_args({"cat", "--tag-filter", "id1", "eq",
"dev_a", "--tag-between", "id1", "a", "z",
"dev_a", "--tag-filter", "id1", "neq", "z",
"data.tsfile"});
EXPECT_FALSE(p.error.empty());
EXPECT_TRUE(p.error.empty());
ASSERT_EQ(p.tag_filters.size(), 2u);
}

TEST(ParseArgsTest, UnknownFlagIsError) {
Expand All @@ -138,9 +164,9 @@ TEST(ParseArgsTest, MissingFileIsAllowedAtParseTime) {
}

TEST(ParseArgsTest, WriteFlagsParsed) {
auto p = tsfile_cli::parse_args({"write", "--table", "t1", "--columns",
"s1:INT64:field", "-o", "out.tsfile", "-v",
"--header-match", "in.csv"});
auto p = tsfile_cli::parse_args({"write", "--table", "t1", "--field", "s1",
"INT64", "-i", "in.csv", "-o",
"out.tsfile", "-v", "--header-match"});
EXPECT_TRUE(p.error.empty());
EXPECT_EQ(p.command, "write");
EXPECT_EQ(p.table, "t1");
Expand All @@ -149,36 +175,20 @@ TEST(ParseArgsTest, WriteFlagsParsed) {
EXPECT_TRUE(p.verbose);
EXPECT_TRUE(p.header_match);
EXPECT_EQ(p.file, "in.csv");
EXPECT_TRUE(p.input_set);
}

TEST(ParseArgsTest, OutputFlagNeedsValue) {
auto p = tsfile_cli::parse_args({"write", "-o"});
EXPECT_FALSE(p.error.empty());
}

TEST(ParseArgsTest, DashIsStdinPositional) {
auto p =
tsfile_cli::parse_args({"write", "--table", "t1", "--columns",
"s1:INT64:field", "-o", "out.tsfile", "-"});
TEST(ParseArgsTest, StdinFlagParsed) {
auto p = tsfile_cli::parse_args({"write", "--table", "t1", "--field", "s1",
"INT64", "--stdin", "-o", "out.tsfile"});
EXPECT_TRUE(p.error.empty());
EXPECT_EQ(p.file, "-");
}

TEST(ParseArgsTest, SeedFlagParsed) {
auto p = tsfile_cli::parse_args(
{"sample", "-m", "s1", "-n", "3", "--seed", "42", "data.tsfile"});
EXPECT_TRUE(p.error.empty());
EXPECT_EQ(p.command, "sample");
EXPECT_EQ(p.limit, 3);
EXPECT_TRUE(p.has_seed);
EXPECT_EQ(p.seed, 42);
}

TEST(ParseArgsTest, BadSeedValueIsError) {
auto p = tsfile_cli::parse_args(
{"sample", "--seed", "not_a_number", "data.tsfile"});
EXPECT_FALSE(p.error.empty());
EXPECT_NE(p.error.find("Invalid --seed"), std::string::npos);
EXPECT_TRUE(p.input_set);
}

TEST(RunCliTest, SelectIsNoLongerKnownCommand) {
Expand All @@ -195,16 +205,14 @@ TEST(RunCliTest, SeedOnCatIsUsageError) {
int code =
tsfile_cli::run_cli({"cat", "--seed", "7", "x.tsfile"}, out, err);
EXPECT_EQ(code, 1);
EXPECT_NE(err.str().find("--seed is only valid for sample"),
std::string::npos);
EXPECT_NE(err.str().find("--seed is not supported"), std::string::npos);
}

TEST(RunCliTest, OffsetOnSampleIsUsageError) {
TEST(RunCliTest, SampleIsUnknownCommand) {
std::ostringstream out;
std::ostringstream err;
int code =
tsfile_cli::run_cli({"sample", "--offset", "2", "x.tsfile"}, out, err);
EXPECT_EQ(code, 1);
EXPECT_NE(err.str().find("--offset is not valid for sample"),
std::string::npos);
EXPECT_NE(err.str().find("Unknown command"), std::string::npos);
}
Loading
Loading