Repository: yetus Updated Branches: refs/heads/master 5a4d4dba9 -> 966f9611a
YETUS-74. document test formats Signed-off-by: Allen Wittenauer <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/yetus/repo Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/966f9611 Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/966f9611 Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/966f9611 Branch: refs/heads/master Commit: 966f9611a65b45359a49c614f66e8b1a6e076c00 Parents: 5a4d4db Author: Kengo Seki <[email protected]> Authored: Tue Oct 20 08:48:57 2015 +0900 Committer: Allen Wittenauer <[email protected]> Committed: Tue Oct 20 13:49:10 2015 -0700 ---------------------------------------------------------------------- .../source/documentation/latest.html.md | 2 +- .../latest/precommit-testformats.md | 35 ++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/yetus/blob/966f9611/asf-site-src/source/documentation/latest.html.md ---------------------------------------------------------------------- diff --git a/asf-site-src/source/documentation/latest.html.md b/asf-site-src/source/documentation/latest.html.md index 40ddb5c..bd61a3c 100644 --- a/asf-site-src/source/documentation/latest.html.md +++ b/asf-site-src/source/documentation/latest.html.md @@ -26,7 +26,7 @@ The Yetus Precommit Patch Tester allows projects to codify their patch acceptanc * To get started on your project, including an explanation of what we'll expect in a runtime environment and what optional utilities we'll leverage, read through the [basic usage guide](precommit-basic). * If your project has advanced requirements such as module relationships not expressed in Maven, special profiles, or a need on os-specific prerequisites not managed by Maven then you'll need to use our [advanced usage guide](precommit-advanced). -There is also documentation on [build systems](precommit-buildtools) and [bug systems](precommit-bugsystems) +There is also documentation on [build systems](precommit-buildtools), [bug systems](precommit-bugsystems) and [test formats](precommit-testformats). # Yetus Release Doc Maker http://git-wip-us.apache.org/repos/asf/yetus/blob/966f9611/asf-site-src/source/documentation/latest/precommit-testformats.md ---------------------------------------------------------------------- diff --git a/asf-site-src/source/documentation/latest/precommit-testformats.md b/asf-site-src/source/documentation/latest/precommit-testformats.md new file mode 100644 index 0000000..41dbb11 --- /dev/null +++ b/asf-site-src/source/documentation/latest/precommit-testformats.md @@ -0,0 +1,35 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +Test Format Support +================== + +test-patch has the ability to support multiple test formats. Test formats have some extra hooks to process the output of test tools and write the results to some tables. Every test format plug-in must have one line in order to be recognized: + +```bash +add_test_format <pluginname> +``` + +* pluginname\_process\_tests + + - Given a path to the log file and tested module name, parse that file and store the test result into global variables and/or files. + +* pluginname\_finalize\_results + + - Using the results stored by pluginname\_process\_tests, write them to the test result table and/or the footer table for reporting.
