Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/online-judge-tools/verification-helper
a testing framework for snippet libraries used in competitive programming
https://github.com/online-judge-tools/verification-helper
aizu-online-jadge competitive-programming continuous-integration documentation hackerrank programming-contests testing yosupo
Last synced: 2 days ago
JSON representation
a testing framework for snippet libraries used in competitive programming
- Host: GitHub
- URL: https://github.com/online-judge-tools/verification-helper
- Owner: online-judge-tools
- License: mit
- Created: 2019-11-23T18:59:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T08:12:33.000Z (3 months ago)
- Last Synced: 2025-01-13T03:01:29.319Z (9 days ago)
- Topics: aizu-online-jadge, competitive-programming, continuous-integration, documentation, hackerrank, programming-contests, testing, yosupo
- Language: Python
- Homepage:
- Size: 1.38 MB
- Stars: 232
- Watchers: 8
- Forks: 56
- Open Issues: 42
-
Metadata Files:
- Readme: README.ja.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# online-judge-tools/verification-helper
[](https://github.com/online-judge-tools/verification-helper/actions/workflows/verify.yml?query=branch%3Amaster)
[](https://online-judge-tools.github.io/verification-helper/)
[](https://pypi.org/project/online-judge-verify-helper/)
[](https://github.com/online-judge-tools/verification-helper/blob/master/LICENSE)
[README in English](README.md)
## なにこれ
競プロライブラリの verify をお手軽に自動化するためのツールです。
## 使い方
### 競プロライブラリのリポジトリに設定する
これ読んで:
### 手元で実行する
#### インストール
``` console
$ pip3 install online-judge-verify-helper
```
Python のバージョンは 3.8 以上が必要です。
#### verify 自動実行
拡張子の前に `.test` をつけたファイルに、特定の方法で verify 用問題の URL を書いておきます。 (たとえば `C++` であれば、`example.test.cpp` のようなファイルに `#define PROBLEM "https://judge.yosupo.jp/problem/unionfind"` のような形で書きます。他の言語については[リファレンス](https://online-judge-tools.github.io/verification-helper/document.ja.html)を参照してください。)
このとき、次のコマンドで verify できているかを確認してくれます。
``` console
$ oj-verify run
```
利用できる問題は主に [Library Checker](https://judge.yosupo.jp/) の問題と [Aizu Online Judge](https://onlinejudge.u-aizu.ac.jp/home) の問題です。
他にもいくつかのサービスの問題が利用可能です。
より詳しい説明は[リファレンス](https://online-judge-tools.github.io/verification-helper/document.ja.html)にあります。
#### `#include` の自動展開
与えられたファイル中の `#include "foo.hpp"` の形の include 文を展開して出力します。
JavaScript で言うところの [webpack](https://webpack.js.org/) のような機能であり、ファイル分割をしても実際のオンラインジャッジへの提出が困難にならないようにするために存在しています。
以下のように実行します。
``` console
$ oj-bundle main.cpp
```
競プロライブラリのディレクトリの外側にいる状態で実行する場合は `-I path/to/your/library` のように指定してください。`alias oj-bundle='\oj-bundle -I path/to/your/library'` のようなシェルのエイリアスを貼っておくのがおすすめです。
`#pragma once` などの [include guard](https://ja.wikibooks.org/wiki/More_C%2B%2B_Idioms/%E3%82%A4%E3%83%B3%E3%82%AF%E3%83%AB%E3%83%BC%E3%83%89%E3%82%AC%E3%83%BC%E3%83%89%E3%83%9E%E3%82%AF%E3%83%AD%28Include_Guard_Macro%29) に部分的に対応しています。複数回の include の対象になっているが出力には一度のみ含まれてほしいようなファイルがあれば、その 1 行目に `#pragma once` と書いておいてください。
#### ドキュメント生成
以下のコマンドを実行すると `.verify-helper/markdown/` にドキュメントが生成されます。例: [https://online-judge-tools.github.io/verification-helper/ ](https://online-judge-tools.github.io/verification-helper/)
``` console
$ oj-verify docs
```
ドキュメント生成時に [Doxygen](http://www.doxygen.jp/) 風のコメントが見つかれば、それらは自動で利用されます。
また、TeX 記法の数式 (例: `$O(N \sum_i A_i)$`) の [MathJax](https://www.mathjax.org/) による表示にも対応しています。
より詳しい説明は[リファレンス](https://online-judge-tools.github.io/verification-helper/document.ja.html)にあります。
## Tips
- ライブラリを verify するための問題が見つからないときは他の人のライブラリを参考にするとよいでしょう。`online-judge-verify-helper` のユーザの一覧は から見ることができます
- ライブラリを verify するための問題がそれでも見つからないときは [Library Checker](https://judge.yosupo.jp/) に問題を追加してください。[Hello World](http://judge.u-aizu.ac.jp/onlinejudge/description.jsp?id=ITP1_1_A) などをダミーの問題として指定して、自前で書いたストレステストを実行することもできます。
- GitHub Actions から online-judge-verify-helper を呼び出すといった通常想定される利用法においては MIT License に関する著作権表示は要求されません ([詳細](https://github.com/online-judge-tools/verification-helper/issues/34))
- これはライブラリを効率良く verify するためのツールであり、コードの検査や整形をするためのツールではありません。必要なら [clang-format](https://clang.llvm.org/docs/ClangFormat.html) などの formatter や [cppcheck](http://cppcheck.sourceforge.net/) などの linter を利用してください
## Authors
- committer: [@kmyk](https://github.com/kmyk) (AtCoder: [kimiyuki](https://atcoder.jp/users/kimiyuki)): pip での配布や [online-judge-tools](https://github.com/kmyk/online-judge-tools) などその他の諸々の担当
- committer: [@beet-aizu](https://github.com/beet-aizu) (AtCoder: [beet](https://atcoder.jp/users/beet)): verify 機能担当
- committer: [@tsutaj](https://github.com/tsutaj) (AtCoder: [tsutaj](https://atcoder.jp/users/tsutaj)): documents 生成担当