Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork1.8k
[Suggestion][Feedback Wanted] using cmake + google test for writing tests#1464
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
yuuurchyk wants to merge1 commit intocp-algorithms:mainChoose a base branch fromyuuurchyk:feature/update-tests-building-approach
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Draft
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
3 changes: 2 additions & 1 deletiontest/.gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
include/snippets/ | ||
build/ |
42 changes: 42 additions & 0 deletionstest/CMakeLists.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
cmake_minimum_required(VERSION 3.30 FATAL_ERROR) | ||
project(cp-algorithms LANGUAGES CXX) | ||
# generating snippets | ||
set(SNIPPETS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include/snippets) | ||
find_package(Python3 3.10 REQUIRED COMPONENTS Interpreter) | ||
execute_process( | ||
COMMAND | ||
${Python3_EXECUTABLE} | ||
"${CMAKE_CURRENT_SOURCE_DIR}/scripts/extract_snippets.py" | ||
--src-dir=${CMAKE_CURRENT_SOURCE_DIR}/../src | ||
--target-dir=${SNIPPETS_DIR} | ||
--remove-prev-target-dir | ||
COMMAND_ERROR_IS_FATAL ANY | ||
) | ||
# loading googletest | ||
include(FetchContent) | ||
FetchContent_Declare( | ||
googletest | ||
GIT_REPOSITORY https://github.com/google/googletest.git | ||
GIT_TAG v1.17.0 | ||
) | ||
# For Windows: Prevent overriding the parent project's compiler/linker settings | ||
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) | ||
FetchContent_MakeAvailable(googletest) | ||
include(GoogleTest) | ||
set(CMAKE_CXX_STANDARD 20) | ||
set(CMAKE_CXX_STANDARD_REQUIRED ON) | ||
set(CMAKE_CXX_EXTENSIONS OFF) | ||
file(GLOB_RECURSE SNIPPETS_SOURCES CONFIGURE_DEPENDS ${SNIPPETS_DIR}/*.h) | ||
file(GLOB_RECURSE TEST_SOURCES CONFIGURE_DEPENDS src/test_*.cpp) | ||
add_executable(main ${TEST_SOURCES} ${SNIPPETS_SOURCES}) | ||
target_link_libraries(main PRIVATE GTest::gtest_main GTest::gtest GTest::gmock) | ||
target_include_directories(main PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include) | ||
enable_testing() | ||
gtest_discover_tests(main) |
40 changes: 0 additions & 40 deletionstest/extract_snippets.py
This file was deleted.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
128 changes: 128 additions & 0 deletionstest/scripts/extract_snippets.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
import argparse | ||
import re | ||
import os | ||
import sys | ||
import shutil | ||
import logging | ||
from typing import List, Optional | ||
from dataclasses import dataclass | ||
@dataclass | ||
class Snippet: | ||
name: str | ||
lines: List[str] | ||
def write_snippet(target_dir: os.PathLike, snippet: Snippet): | ||
assert os.path.exists(target_dir) and os.path.isdir(target_dir) | ||
file_name = f'{snippet.name}.h' | ||
with open(os.path.join(target_dir, file_name), 'w', encoding='utf-8') as f: | ||
f.writelines(snippet.lines) | ||
def extract_snippets(filepath: os.PathLike) -> List[Snippet]: | ||
with open(filepath, 'r', encoding='utf-8') as f: | ||
lines = f.readlines() | ||
snippets = [] | ||
snippet_start = re.compile(r"^```\{.cpp\s+file=(\S+)\}$") | ||
snippet_end = re.compile(r"^```$") | ||
snippet_start_line: Optional[int] = None | ||
snippet_name: Optional[str] = None | ||
for line_idx, line in enumerate(lines): | ||
match_snippet_start = snippet_start.match(line) | ||
match_snippet_end = snippet_end.match(line) | ||
assert not (match_snippet_start and match_snippet_end) | ||
if match_snippet_start: | ||
assert snippet_start_line is None | ||
assert snippet_name is None | ||
snippet_start_line = line_idx | ||
snippet_name = match_snippet_start.group(1) | ||
elif match_snippet_end: | ||
if snippet_start_line is not None: | ||
assert snippet_start_line is not None | ||
assert snippet_name is not None | ||
snippet = lines[snippet_start_line + 1: line_idx] | ||
snippets.append(Snippet(name=snippet_name, lines=snippet)) | ||
snippet_start_line = None | ||
snippet_name = None | ||
return snippets | ||
def main(args: argparse.Namespace) -> None: | ||
src_dir = args.src_dir | ||
target_dir = args.target_dir | ||
logging.info(f'--src-dir="{src_dir}"') | ||
logging.info(f'--target-dir="{target_dir}"') | ||
assert os.path.isdir(src_dir) | ||
if args.remove_prev_target_dir and os.path.exists(target_dir): | ||
logging.info(f'Script launched with --remove-prev-target-dir flag') | ||
logging.info(f'Removing --target-dir="{target_dir}"') | ||
shutil.rmtree(target_dir) | ||
if not os.path.exists(target_dir): | ||
logging.info( | ||
f'--target-dir="{target_dir}" does not exist, creating') | ||
os.makedirs(target_dir, exist_ok=False) | ||
assert os.path.isdir( | ||
target_dir), f'Failed to create --target-dir: "{target_dir}"' | ||
snippets = [] | ||
for subdir, _, files in os.walk(src_dir): | ||
for filename in files: | ||
if filename.lower().endswith('.md'): | ||
filepath = os.path.join(subdir, filename) | ||
logging.debug(f'Extracting snippets from {filename}') | ||
snippets.extend(extract_snippets(filepath)) | ||
n_snippets = len(snippets) | ||
for snippet_idx, snippet in enumerate(snippets, start=1): | ||
logging.debug( | ||
f'({snippet_idx}/{n_snippets}) writing snippet {snippet.name} to "{target_dir}"') | ||
write_snippet(target_dir, snippet) | ||
logging.info( | ||
f'All done, {n_snippets} snippets have been written to "{target_dir}"') | ||
if __name__ == '__main__': | ||
parser = argparse.ArgumentParser( | ||
description='Recursively extracts specially annotation cpp code snippets from src dir with .md files') | ||
parser.add_argument('--src-dir', type=str, required=True, | ||
help='path to the directory with .md source to recursively look for cpp snippets with {.cpp file=...} annotation') | ||
parser.add_argument('--target-dir', type=str, required=True, | ||
help='path to the resulting directory with .h snippets extracted from src-dir') | ||
parser.add_argument('--remove-prev-target-dir', action='store_true', | ||
help='remove --target-dir prior to generating snippets') | ||
logging_level_names = list(logging.getLevelNamesMapping().keys()) | ||
assert 'INFO' in logging_level_names | ||
parser.add_argument('--logging-level', type=str, choices=logging_level_names, | ||
default='INFO', help='script logging level') | ||
args = parser.parse_args() | ||
logging.basicConfig( | ||
stream=sys.stdout, | ||
format='%(asctime)s %(module)-15s - [%(levelname)-6s] - %(message)s', | ||
datefmt='%H:%M:%S', | ||
level=args.logging_level | ||
) | ||
main(args) |
53 changes: 53 additions & 0 deletionstest/src/test_2sat_new.cpp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
#include <gtest/gtest.h> | ||
#include <gmock/gmock.h> | ||
#include <vector> | ||
using namespace std; | ||
#include "snippets/2sat.h" | ||
namespace | ||
{ | ||
TEST(TwoSAT, ExampleUsage) | ||
{ | ||
TwoSatSolver::example_usage(); | ||
} | ||
TEST(TwoSAT, ArticleExample) | ||
{ | ||
TwoSatSolver solver(3); // a, b, c | ||
solver.add_disjunction(0, false, 1, true); // a v not b | ||
solver.add_disjunction(0, true, 1, false); // not a v b | ||
solver.add_disjunction(0, true, 1, true); // not a v not b | ||
solver.add_disjunction(0, false, 2, true); // a v not c | ||
EXPECT_TRUE(solver.solve_2SAT()); | ||
auto expected = vector<bool>{{false, false, false}}; | ||
EXPECT_EQ(solver.assignment, expected); | ||
} | ||
TEST(TwoSAT, Unsatisfiable) | ||
{ | ||
TwoSatSolver solver(2); // a, b | ||
solver.add_disjunction(0, false, 1, false); // a v b | ||
solver.add_disjunction(0, false, 1, true); // a v not b | ||
solver.add_disjunction(0, true, 1, false); // not a v b | ||
solver.add_disjunction(0, true, 1, true); // not a v not b | ||
EXPECT_FALSE(solver.solve_2SAT()); | ||
} | ||
TEST(TwoSAT, OtherSatisfiableExample) | ||
{ | ||
TwoSatSolver solver(4); // a, b, c, d | ||
solver.add_disjunction(0, false, 1, true); // a v not b | ||
solver.add_disjunction(0, true, 2, true); // not a v not c | ||
solver.add_disjunction(0, false, 1, false); // a v b | ||
solver.add_disjunction(3, false, 2, true); // d v not c | ||
solver.add_disjunction(3, false, 0, true); // d v not a | ||
EXPECT_TRUE(solver.solve_2SAT()); | ||
// two solutions | ||
auto expected_1 = vector<bool>{{true, true, false, true}}; | ||
auto expected_2 = vector<bool>{{true, false, false, true}}; | ||
EXPECT_THAT(solver.assignment, ::testing::AnyOf(expected_1, expected_2)); | ||
} | ||
} // namespace |
61 changes: 61 additions & 0 deletionstest/src/test_aho_korasick_new.cpp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
#include <gtest/gtest.h> | ||
#include <vector> | ||
#include <string> | ||
#include <iostream> | ||
using namespace std; | ||
namespace { | ||
namespace Trie { | ||
#include "snippets/aho_corasick_trie_definition.h" | ||
#include "snippets/aho_corasick_trie_add.h" | ||
} // namespace Trie | ||
namespace Automaton { | ||
#include "snippets/aho_corasick_automaton.h" | ||
} // namespace Automation | ||
TEST(AhoKorasick, TrieAddString) | ||
{ | ||
using namespace Trie; | ||
vector<string> set = {"a", "to", "tea", "ted", "ten", "i", "in", "inn"}; | ||
for (string s : set) { | ||
add_string(s); | ||
} | ||
EXPECT_EQ(trie.size(), 11); | ||
} | ||
TEST(AhoKorasick, TrieAutomation) | ||
{ | ||
using namespace Automaton; | ||
vector<string> set = {"a", "ab", "bab", "bc", "bca", "c", "caa"}; | ||
for (string s : set) { | ||
add_string(s); | ||
} | ||
EXPECT_EQ(t.size(), 11); | ||
int v = 0; | ||
v = go(v, 'a'); | ||
EXPECT_TRUE(t[v].output); | ||
v = go(v, 'b'); | ||
EXPECT_TRUE(t[v].output); | ||
v = go(v, 'c'); | ||
EXPECT_TRUE(t[v].output); | ||
v = go(v, 'd'); | ||
EXPECT_FALSE(t[v].output); | ||
EXPECT_EQ(v, 0); | ||
v = go(v, 'b'); | ||
EXPECT_FALSE(t[v].output); | ||
v = go(v, 'a'); | ||
EXPECT_FALSE(t[v].output); | ||
v = go(v, 'a'); | ||
EXPECT_TRUE(t[v].output); | ||
v = go(v, 'b'); | ||
EXPECT_TRUE(t[v].output); | ||
} | ||
} // namespace |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.