Merge pull request #358 from online-judge-tools/docs/improve-custom

Update documents about user-defined languages

Author: kmyk

.verify-helper/docs/static/document.ja.md

@@ -93,13 +93,15 @@ NIMFLAGS = ["--warning:on", "--opt:none"]
 
 上記以外の言語でも実行可能です (例: [examples/awk/circle.test.awk](https://github.com/online-judge-tools/verification-helper/blob/master/examples/awk/circle.test.awk))。
 `.verify-helper/config.toml` というファイルを作って、以下のようにコンパイルや実行のためのコマンドを書いてください (例: [.verify-helper/config.toml](https://github.com/online-judge-tools/verification-helper/blob/master/.verify-helper/config.toml))。
+`compile` と `execute` のフィールドは必須で、その他は省略可能です。
 
 ``` toml
 [languages.awk]
 compile = "bash -c 'echo hello > {tempdir}/hello'"
 execute = "env AWKPATH={basedir} awk -f {path}"
 bundle = "false"
 list_dependencies = "sed 's/^@include \"\\(.*\\)\"$/\\1/ ; t ; d' {path}"
+verification_file_suffix = ".test.sed"
 ```
 
 ## verify 自動実行

.verify-helper/docs/static/document.md

@@ -92,13 +92,15 @@ You can customize the method to list depending files with `languages.rust.list_d
 ### Settings for other languages
 
 You can use languages other than above (e.g. AWK [examples/awk/circle.test.awk](https://github.com/online-judge-tools/verification-helper/blob/master/examples/awk/circle.test.awk)). Please write commands to compile and execute in the config file `.verify-helper/config.toml` (e.g. [.verify-helper/config.toml](https://github.com/kmyk/online-judge-verify-helper/blob/master/.verify-helper/config.toml)).
+`compile` field and `execute` field is required, and other fields are optional.
 
 ``` toml
 [languages.awk]
 compile = "bash -c 'echo hello > {tempdir}/hello'"
 execute = "env AWKPATH={basedir} awk -f {path}"
 bundle = "false"
 list_dependencies = "sed 's/^@include \"\\(.*\\)\"$/\\1/ ; t ; d' {path}"
+verification_file_suffix = ".test.sed"
 ```
 
 ## Automating the verification

onlinejudge_verify/languages/user_defined.py

@@ -64,7 +64,8 @@ def list_dependencies(self, path: pathlib.Path, *, basedir: pathlib.Path) -> Lis
         return dependencies
 
     def bundle(self, path: pathlib.Path, *, basedir: pathlib.Path, options: Dict[str, Any]) -> bytes:
-        assert 'bundle' in self.config
+        if 'bundle' not in self.config:
+            raise RuntimeError('bundler is not specified: {}'.format(str(path)))
         command = self.config['bundle'].format(path=str(path), basedir=str(basedir))
         logger.info('$ %s', command)
         return subprocess.check_output(shlex.split(command))