This project provides a set of tools for testing the correctness of solutions in coding competitions. Because scripts are all command-line interface (CLI), the project is independent of text editors/ IDEs. vscode and nvim are the recommended text editors.

This project is in the early stage of development, so there is a lot of room for improvement. Nevertheless, it is mature enough for casual coding competition.

1. Bazel build system
2. Java JDK 11+ for running the simple task editor interface

1. Clone the repo and run bazel run //:install.
2. Create your workspace directory with sub directories:
   • task
   • archive
   • output
3. Create new task and solve problem

This file should named project_config.json and place directly on the top level the your workspace folder.

{
  "root": "/Users/cunbidun/competitive_programming", // your workspace folder
  "task_editor_exec": "java -jar ~/.local/share/cpcli/frontend/TaskConfigEditor.jar",
  "cpp_compiler": "g++",
  "cpp_compile_flag": "-DLOCAL -O2 -std=c++17",
  "cpp_debug_flag": "-DLOCAL -Wall -Wshadow -std=c++17 -g -fsanitize=address -fsanitize=undefined -D_GLIBCXX_DEBUG",
  "use_precompiled_header": false,
  "use_cache": true
}

<your workspace>
├── archive
│   ├── Archive
│   ├── AtCoder - ACL Beginner Contest
│   ├── TopCoder SRM #456
│   ├── Topcoder - TCO 2021 Regional Qualifier 1 DIV 1
│   ├── Topcoder 2021 Round 1B
│   ├── Topcoder Open Algo 2019
│   ├── Unsorted
│   └── vnoi.info
├── include
│   ├── genlib.hpp
│   ├── interactive.hpp
│   └── testlib.h
├── output
│   └── solution.cpp
├── project_config.json
├── task
│   └── F - Keep Connect
│       ├── config.json
│       └── solution.cpp
└── template
    ├── checker.template
    ├── gen.template
    ├── interactor.template
    └── solution.template

Please take a look at the archive folder for more information.

$ cpcli_app --project-config=project_config.json task --root-dir="/Users/cunbidun/competitive_programming/task/F - Keep Connect" --build

Here is an example: problem E. Trees of Tranquillity has the following configuration:

{
  "timeLimit": 3000,
  "tests": [
    {
      "output": "1",
      "input": "1",
      "index": 0,
      "active": true
    },
    {
      "output": "2",
      "input": "2",
      "index": 1,
      "active": true
    }
  ],
  "name": "E. Trees of Tranquillity",
  "group": "Codeforces - Codeforces Round #722 (Div. 2)"
  "truncateLongTest": false,
  "checker": "custom",

  "url": "https://codeforces.com/contest/1529/problem/E",

  "useGeneration": true,
  "numTest": 10,
  "knowGenAns": true,
  "genParameters": "",
  "generatorSeed": "",

  "interactive": false,
  "stopAtWrongAnswer": false,

  "hideAcceptedTest": false,
}

There are 16 attributes:

Others checker included:

1. double_4: checking up to 4 decimals digit
2. double_6: checking up to 6 decimals digit
3. double_9: checking up to 9 decimals digit
4. token_checker: compare output files token by token
5. custom: user's custom checker

The recommend text editor for developing this project is vscode

1. Build the project

   bazel run //:install

2. Build compile_commands.json for autocomplete

   bazel run @hedron_compile_commands//:refresh_all

3. .vscode setup

   Create a .vscode at the top level directory of the repository

   .vscode
   ├── c_cpp_properties.json
   └── settings.json
   

   c_cpp_properties.json content:

   {
     "configurations": [
       {
         "name": "cpcli_app",
         "compileCommands": "${workspaceFolder}/compile_commands.json"
       }
     ],
     "version": 4
   }

   settings.json content:

   {
    "java.project.referencedLibraries": [
      "bazel-bin/default/task_editor/java_task_editor/java_task_editor.runfiles/gson/jar/*.jar",
      "bazel-bin/default/task_editor/java_task_editor/java_task_editor.runfiles/common_cli/jar/*.jar"
    ],
   }

bazel run //default/task_editor/java_task_editor --  -r ~/cpcli/default/task_editor -p ~/cpcli/default/task_editor/config.json

bazel test --test_output=all //core/test:cpcli_test

Make sure you have lcov installed

bazel coverage //core/test:cpcli_test --coverage_report_generator="@bazel_tools//tools/test/CoverageOutputGenerator/java/com/google/devtools/coverageoutputgenerator:Main" --instrumentation_filter="//..."
genhtml --output coverage "$(bazel info output_path)/_coverage/_coverage_report.dat"
open coverage/index.html

Make sure to have sphinx and sphinx-rtd-theme installed

$ pip install -U sphinx sphinx-rtd-theme

$ cd docs
$ make clean html
$ open build/html/index.html

1. The project is heavily inspired by Egor Kulikov's idea-chelper.

2. Checkers and generators use Mike Mirzayanov's testlib

3. The precompiled header feature is inspired by Dushyant Singh's script Speed-Up-GCC-Compile-Time.