Skip to content

Redesign 1.0 #1

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
merged 7 commits into from
Nov 22, 2024
Merged

Redesign 1.0 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
62b9ee4
feat: refactor arg_parser to be less context aware
nader-zouaoui Nov 19, 2024
78a8b21
chore: minor renaming
nader-zouaoui Nov 20, 2024
1059def
feat: add abstract arg class
nader-zouaoui Nov 21, 2024
de3daf9
feat: add new implementation of parser
nader-zouaoui Nov 22, 2024
0d012c9
Merge branch 'master' into redesign-1.0
nader-zouaoui Nov 22, 2024
e5edf65
fix: conflicts
nader-zouaoui Nov 22, 2024
c4257bb
fix: linkage on release mode
nader-zouaoui Nov 22, 2024
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
6 changes: 1 addition & 5 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@

name: MSBuild

on:
push:
branches: ["master"]
pull_request:
branches: ["master"]
on: push

env:
# Path to the solution file relative to the root of the project.
Expand Down
11 changes: 0 additions & 11 deletions parser-tests/mock-arg-parser.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,4 @@ class mock_arg_parser : public arg_parser
L"C:\\Program\\sample.exe",
L"C:\\Program\\sample.pdb"
};

protected:
void check_file_path(std::wstring file_path) override
{
if (existing_files.find(file_path) == existing_files.end())
{
// Simulate file does not exist
throw_invalid_arg(file_path, L"Mock: File does not exist.");
}
// Else, do nothing (file exists)
}
};
132 changes: 68 additions & 64 deletions parser-tests/parser-tests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,20 @@ namespace parsertests
TEST_CLASS(parsertests)
{
public:

bool check_value_in_vector(const std::vector<std::wstring>& vec, const std::wstring& value)
{
return std::find(vec.begin(), vec.end(), value) != vec.end();
}
TEST_METHOD(TEST_CORRECT_TEST_COMMAND)
{
const wchar_t* argv[] = { L"wperf", L"test", L"-v", L"--json" };
int argc = 4;
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::AreEqual(true, parser.do_verbose.get());
Assert::AreEqual(true, parser.do_json.get());
Assert::IsTrue(COMMAND_CLASS::TEST == parser.command);
Assert::AreEqual(true, parser.do_verbose.is_set());
Assert::AreEqual(true, parser.do_json.is_set());
Assert::IsTrue(COMMAND_CLASS::TEST == parser.m_command);
}
TEST_METHOD(TEST_RANDOM_ARGS_REJECTION)
{
Expand All @@ -63,16 +66,16 @@ namespace parsertests
}
);
}
// Test parsing the 'help' command with no arguments
// Test parsing the "help" command with no arguments
TEST_METHOD(TEST_HELP_COMMAND)
{
const wchar_t* argv[] = { L"wperf", L"--help" };
int argc = 2;
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_help.get());
Assert::IsTrue(COMMAND_CLASS::HELP == parser.command);
Assert::IsTrue(parser.do_help.is_set());
Assert::IsTrue(COMMAND_CLASS::HELP == parser.m_command);
}

// Test parsing the 'version' command with no arguments
Expand All @@ -83,8 +86,8 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_version.get());
Assert::IsTrue(COMMAND_CLASS::VERSION == parser.command);
Assert::IsTrue(parser.do_version.is_set());
Assert::IsTrue(COMMAND_CLASS::VERSION == parser.m_command);
}

// Test parsing the 'list' command with no arguments
Expand All @@ -95,21 +98,8 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_list.get());
Assert::IsTrue(COMMAND_CLASS::LIST == parser.command);
}

// Test parsing the 'sample' command with various flags
TEST_METHOD(TEST_SAMPLE_COMMAND_WITH_MULTIPLE_CORES)
{
const wchar_t* argv[] = { L"wperf", L"sample", L"--annotate", L"--timeout", L"5s", L"-c", L"0,1,2" };
int argc = 7;
mock_arg_parser parser;

Assert::ExpectException<std::invalid_argument>([&parser, argc, &argv]() {
parser.parse(argc, argv);
}
);
Assert::IsTrue(parser.do_list.is_set());
Assert::IsTrue(COMMAND_CLASS::LIST == parser.m_command);
}

// Test parsing the 'record' command with command line separator and arguments
Expand All @@ -119,12 +109,9 @@ namespace parsertests
int argc = 5;
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_record.get());
Assert::AreEqual(std::wstring(L"notepad.exe test_arg"), parser.record_commandline.get());
Assert::AreEqual(std::wstring(L"notepad.exe"), parser.sample_pe_file.get());
Assert::AreEqual(std::wstring(L"notepad.pdb"), parser.sample_pdb_file.get());
Assert::IsTrue(COMMAND_CLASS::RECORD == parser.command);
Assert::IsTrue(parser.do_record.is_set());
Assert::IsTrue(check_value_in_vector(parser.double_dash.get_values(), L"notepad.exe"));
Assert::IsTrue(COMMAND_CLASS::RECORD == parser.m_command);
}

// Test that missing required arguments cause exceptions
Expand Down Expand Up @@ -159,20 +146,9 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::AreEqual(120.0, parser.count_duration.get()); // 2 minutes in seconds
Assert::IsTrue(check_value_in_vector(parser.count_duration.get_values(), L"2m"));
}

// Test that invalid timeout format causes exception
TEST_METHOD(TEST_INVALID_TIMEOUT_WITH_WRONG_UNIT)
{
const wchar_t* argv[] = { L"wperf", L"sample", L"--timeout", L"5x" };
int argc = 4;
mock_arg_parser parser;
Assert::ExpectException<std::invalid_argument>([&parser, argc, &argv]() {
parser.parse(argc, argv);
}
);
}
TEST_METHOD(TEST_INVALID_TIMEOUT_WITH_WRONG_FORMAT)
{
const wchar_t* argv[] = { L"wperf", L"sample", L"--timeout", L"5.4", L"ms"};
Expand All @@ -192,22 +168,22 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_detect.get());
Assert::IsTrue(COMMAND_CLASS::DETECT == parser.command);
Assert::IsTrue(parser.do_detect.is_set());
Assert::IsTrue(COMMAND_CLASS::DETECT == parser.m_command);
}

// Test parsing multiple flags together
// Test parsing multiple flags tois_sether
TEST_METHOD(TEST_MULTIPLE_FLAGS)
{
const wchar_t* argv[] = { L"wperf", L"sample", L"--verbose", L"-q", L"--json" };
int argc = 5;
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_verbose.get());
Assert::IsTrue(parser.is_quite.get());
Assert::IsTrue(parser.do_json.get());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.command);
Assert::IsTrue(parser.do_verbose.is_set());
Assert::IsTrue(parser.is_quite.is_set());
Assert::IsTrue(parser.do_json.is_set());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.m_command);
}

// Test parsing sample command with symbol argument
Expand All @@ -218,8 +194,8 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::AreEqual(std::wstring(L"main"), parser.symbol_arg.get());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.command);
Assert::IsTrue(check_value_in_vector(parser.symbol_arg.get_values(), L"main"));
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.m_command);
}

// Test parsing sample command with sample display row
Expand All @@ -230,8 +206,8 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::AreEqual((uint32_t)100, parser.sample_display_row.get());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.command);
Assert::IsTrue(check_value_in_vector(parser.sample_display_row.get_values(), L"100"));
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.m_command);
}

// Test parsing sample command with pe_file
Expand All @@ -243,10 +219,8 @@ namespace parsertests

parser.parse(argc, argv);

Assert::AreEqual(std::wstring(L"C:\\Program\\sample.exe"), parser.sample_pe_file.get());
Assert::AreEqual(std::wstring(L"C:\\Program\\sample.pdb"), parser.sample_pdb_file.get());
Assert::AreEqual(std::wstring(L"C:\\Program\\sample.exe"), parser.sample_image_name.get());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.command);
Assert::IsTrue(check_value_in_vector(parser.sample_pe_file.get_values(), L"C:\\Program\\sample.exe"));
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.m_command);
}

// Test parsing sample command with pdb_file
Expand All @@ -259,8 +233,8 @@ namespace parsertests
// Similarly, adjust or mock check_file_path for testing
parser.parse(argc, argv);

Assert::AreEqual(std::wstring(L"C:\\Program\\sample.pdb"), parser.sample_pdb_file.get());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.command);
Assert::IsTrue(check_value_in_vector(parser.sample_pdb_file.get_values(), L"C:\\Program\\sample.pdb"));
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.m_command);
}

// Test parsing sample command with image_name
Expand All @@ -271,8 +245,8 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::AreEqual(std::wstring(L"notepad.exe"), parser.sample_image_name.get());
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.command);
Assert::IsTrue(check_value_in_vector(parser.sample_image_name.get_values(), L"notepad.exe"));
Assert::IsTrue(COMMAND_CLASS::SAMPLE == parser.m_command);
}

// Test parsing with --force-lock flag
Expand All @@ -283,8 +257,8 @@ namespace parsertests
mock_arg_parser parser;
parser.parse(argc, argv);

Assert::IsTrue(parser.do_force_lock.get());
Assert::IsTrue(COMMAND_CLASS::TEST == parser.command);
Assert::IsTrue(parser.do_force_lock.is_set());
Assert::IsTrue(COMMAND_CLASS::TEST == parser.m_command);
}

// Test parsing the 'stat' command (not fully implemented in the parser)
Expand All @@ -296,7 +270,7 @@ namespace parsertests
parser.parse(argc, argv);

// Assuming command is set correctly
Assert::IsTrue(COMMAND_CLASS::STAT == parser.command);
Assert::IsTrue(COMMAND_CLASS::STAT == parser.m_command);
}

// Test parsing with unknown flags
Expand All @@ -310,5 +284,35 @@ namespace parsertests
}
);
}

// Test parsing with no command
TEST_METHOD(TEST_NO_COMMAND)
{
const wchar_t* argv[] = { L"wperf", L"--annotate", L"--json" };
int argc = 3;
mock_arg_parser parser;
Assert::ExpectException<std::invalid_argument>([&parser, argc, &argv]() {
parser.parse(argc, argv);
}
);
}

// Test complex stat command
TEST_METHOD(TEST_FULL_STAT_COMMAND)
{
const wchar_t* argv[] = { L"wperf", L"stat", L"--output", L"_output_02.json", L"-e", L"inst_spec,vfp_spec,ase_spec,dp_spec,ld_spec,st_spec,br_immed_spec,crypto_spec", L"-c", L"0", L"sleep", L"5" };
int argc = 10;
mock_arg_parser parser;
parser.parse(argc, argv);
Assert::IsTrue(COMMAND_CLASS::STAT == parser.m_command);
Assert::IsTrue(parser.raw_events.is_set());
Assert::IsTrue(parser.output_filename.is_set());
Assert::IsTrue(parser.cores_idx.is_set());
Assert::IsTrue(parser.count_duration.is_set());
Assert::IsTrue(check_value_in_vector(parser.count_duration.get_values(), L"5"));
Assert::IsTrue(check_value_in_vector(parser.cores_idx.get_values(), L"0"));
Assert::IsTrue(check_value_in_vector(parser.output_filename.get_values(), L"_output_02.json"));
Assert::IsTrue(check_value_in_vector(parser.raw_events.get_values(), L"inst_spec,vfp_spec,ase_spec,dp_spec,ld_spec,st_spec,br_immed_spec,crypto_spec"));
}
};
}
4 changes: 2 additions & 2 deletions parser-tests/parser-tests.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
<Link>
<SubSystem>Windows</SubSystem>
<AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories);$(SolutionDir)parser\$(Platform)\$(Configuration)\</AdditionalLibraryDirectories>
<AdditionalDependencies>$(CoreLibraryDependencies);%(AdditionalDependencies);$(SolutionDir)parser\$(Platform)\$(Configuration)\arg-parser.obj;$(SolutionDir)parser\$(Platform)\$(Configuration)\utils.obj</AdditionalDependencies>
<AdditionalDependencies>$(CoreLibraryDependencies);%(AdditionalDependencies);$(SolutionDir)parser\$(Platform)\$(Configuration)\arg-parser.obj;$(SolutionDir)parser\$(Platform)\$(Configuration)\arg-parser-arg.obj</AdditionalDependencies>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
Expand Down Expand Up @@ -158,7 +158,7 @@
<EnableCOMDATFolding>true</EnableCOMDATFolding>
<OptimizeReferences>true</OptimizeReferences>
<AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories);$(SolutionDir)parser\$(Platform)\$(Configuration)\</AdditionalLibraryDirectories>
<AdditionalDependencies>$(CoreLibraryDependencies);%(AdditionalDependencies);$(SolutionDir)parser\$(Platform)\$(Configuration)\arg-parser.obj;$(SolutionDir)parser\$(Platform)\$(Configuration)\utils.obj</AdditionalDependencies>
<AdditionalDependencies>$(CoreLibraryDependencies);%(AdditionalDependencies);$(SolutionDir)parser\$(Platform)\$(Configuration)\arg-parser.obj;$(SolutionDir)parser\$(Platform)\$(Configuration)\arg-parser-arg.obj</AdditionalDependencies>
</Link>
</ItemDefinitionGroup>
<ItemGroup>
Expand Down
Loading
Loading