From commits-return-1038-archive-asf-public=cust-asf.ponee.io@yetus.apache.org Mon Jan 29 06:38:46 2018 Return-Path: X-Original-To: archive-asf-public@eu.ponee.io Delivered-To: archive-asf-public@eu.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by mx-eu-01.ponee.io (Postfix) with ESMTP id DDFE118067A for ; Mon, 29 Jan 2018 06:38:45 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id CDFC8160C53; Mon, 29 Jan 2018 05:38:45 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C1CE3160C54 for ; Mon, 29 Jan 2018 06:38:43 +0100 (CET) Received: (qmail 29436 invoked by uid 500); 29 Jan 2018 05:38:42 -0000 Mailing-List: contact commits-help@yetus.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@yetus.apache.org Delivered-To: mailing list commits@yetus.apache.org Received: (qmail 29385 invoked by uid 99); 29 Jan 2018 05:38:42 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 29 Jan 2018 05:38:42 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id BC675ED31C; Mon, 29 Jan 2018 05:38:41 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: aw@apache.org To: commits@yetus.apache.org Date: Mon, 29 Jan 2018 05:38:44 -0000 Message-Id: <847c8c29b3aa4a1a8b5b07ac1edbbf27@git.apache.org> In-Reply-To: <15296ea00b2844ddae8f903d3498d6b5@git.apache.org> References: <15296ea00b2844ddae8f903d3498d6b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [04/14] yetus git commit: git hash cf2ce0fff670b00122d9739fa3476cd45b9c7f10 http://git-wip-us.apache.org/repos/asf/yetus/blob/961ea845/documentation/0.7.0/precommit-apidocs/smart-apply-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-apidocs/smart-apply-patch/index.html b/documentation/0.7.0/precommit-apidocs/smart-apply-patch/index.html new file mode 100644 index 0000000..29ff40b --- /dev/null +++ b/documentation/0.7.0/precommit-apidocs/smart-apply-patch/index.html @@ -0,0 +1,373 @@ + + + + + + Apache Yetus + + + + + + + + + + + + + + + +
+ + + + +
+ +

Public/Stable/Not Replaceable

+ +

setup_defaults

+ +
    +
  • Synopsis
    • +
+
setup_defaults
+
+
    +
  • Description
    • +
+ +

Setup the default global variables

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

yetus_usage

+ +
    +
  • Synopsis
    • +
+
yetus_usage
+
+
    +
  • Description
    • +
+ +

Print the usage information

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

None/None/Not Replaceable

+ + + +
    +
  • Synopsis
    • +
+
add_footer_table
+
+
    +
  • Description
    • +
+ +

None

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+

add_test

+ +
    +
  • Synopsis
    • +
+
add_test
+
+
    +
  • Description
    • +
+ +

None

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+

add_vote_table

+ +
    +
  • Synopsis
    • +
+
add_vote_table
+
+
    +
  • Description
    • +
+ +

None

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+

big_console_header

+ +
    +
  • Synopsis
    • +
+
big_console_header
+
+
    +
  • Description
    • +
+ +

None

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudienceNone
StabilityNone
ReplaceableNo
+
+
+
+ +
+ + + http://git-wip-us.apache.org/repos/asf/yetus/blob/961ea845/documentation/0.7.0/precommit-apidocs/test-patch/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-apidocs/test-patch/index.html b/documentation/0.7.0/precommit-apidocs/test-patch/index.html new file mode 100644 index 0000000..62a9ca7 --- /dev/null +++ b/documentation/0.7.0/precommit-apidocs/test-patch/index.html @@ -0,0 +1,1963 @@ + + + + + + Apache Yetus + + + + + + + + + + + + + + + +
+ + + + +
+ +

Public/Stable/Replaceable

+ +

relative_dir

+ +
    +
  • Synopsis
    • +
+
relative_dir path
+
+
    +
  • Description
    • +
+ +

is a given directory relative to BASEDIR?

+ +
    +
  • Returns
    • +
+ +

1 - no, path

+ +

0 - yes, path - BASEDIR

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+

verify_multijdk_test

+ +
    +
  • Synopsis
    • +
+
verify_multijdk_test test
+
+
    +
  • Description
    • +
+ +

Verify if a given test is multijdk

+ +
    +
  • Returns
    • +
+ +

0 = yes

+ +

1 = no

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableYes
+

Public/Stable/Not Replaceable

+ + + +
    +
  • Synopsis
    • +
+
add_footer_table subsystem string
+
+
    +
  • Description
    • +
+ +

Add to the footer of the display. @@BASE@@ will get replaced with the correct location for the local filesystem in dev mode or the URL for Jenkins mode.

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

add_header_line

+ +
    +
  • Synopsis
    • +
+
add_header_line string
+
+
    +
  • Description
    • +
+ +

Add to the header of the display

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

add_test_table

+ +
    +
  • Synopsis
    • +
+
add_test_table failurereason testlist
+
+
    +
  • Description
    • +
+ +

Special table just for unit test failures

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

add_vote_table

+ +
    +
  • Synopsis
    • +
+
add_vote_table +1/0/-1/H subsystem string
+
+
    +
  • Description
    • +
+ +

Add to the output table. If the first parameter is a number that is the vote for that column and calculates the elapsed time based upon the last start_clock(). The second parameter is the reporting subsystem (or test) that is providing the vote. The second parameter is always required. The third parameter is any extra verbage that goes with that subsystem. if the vote is H, then that designates that subsystem should be a header in the vote table comment output. The other parameters are ignored

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

big_console_header

+ +
    +
  • Synopsis
    • +
+
big_console_header string
+
+
    +
  • Description
    • +
+ +

Large display for the user console

+ +
    +
  • Returns
    • +
+ +

large chunk of text

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

clock_display

+ +
    +
  • Synopsis
    • +
+
clock_display seconds
+
+
    +
  • Description
    • +
+ +

Convert time in seconds to m + s

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

echo_and_redirect

+ +
    +
  • Synopsis
    • +
+
echo_and_redirect filename command [..]
+
+
    +
  • Description
    • +
+ +

Print the command to be executing to the screen. Then run the command, sending stdout and stderr to the given filename This will also ensure that any directories in ${BASEDIR} have the exec bit set as a pre-exec step.

+ +
    +
  • Returns
    • +
+ +

$?

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

generate_stack

+ +
    +
  • Synopsis
    • +
+
generate_stack
+
+
    +
  • Description
    • +
+ +

generate a stack trace when in debug mode

+ +
    +
  • Returns
    • +
+ +

exits

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

module_file_fragment

+ +
    +
  • Synopsis
    • +
+
module_file_fragment module
+
+
    +
  • Description
    • +
+ +

Convert the given module name to a file fragment

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

offset_clock

+ +
    +
  • Synopsis
    • +
+
offset_clock seconds
+
+
    +
  • Description
    • +
+ +

Add time to the local timer

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

setup_defaults

+ +
    +
  • Synopsis
    • +
+
setup_defaults
+
+
    +
  • Description
    • +
+ +

Setup the default global variables

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

start_clock

+ +
    +
  • Synopsis
    • +
+
start_clock
+
+
    +
  • Description
    • +
+ +

Activate the local timer

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

stop_clock

+ +
    +
  • Synopsis
    • +
+
stop_clock
+
+
    +
  • Description
    • +
+ +

Print the elapsed time in seconds since the start of the local timer

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

write_comment

+ +
    +
  • Synopsis
    • +
+
write_comment filename
+
+
    +
  • Description
    • +
+ +

Write the contents of a file to all of the bug systems (so content should avoid special formatting)

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

yetus_usage

+ +
    +
  • Synopsis
    • +
+
yetus_usage
+
+
    +
  • Description
    • +
+ +

Print the usage information

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityStable
ReplaceableNo
+

Public/Evolving/Not Replaceable

+ +

archive

+ +
    +
  • Synopsis
    • +
+
archive
+
+
    +
  • Description
    • +
+ +

Save file names and directory to the patch dir

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

bugsystem_linecomments

+ +
    +
  • Synopsis
    • +
+
bugsystem_linecomments filename
+
+
    +
  • Description
    • +
+ +

Write comments onto bug systems that have code review support. File should be in the form of file:line:comment

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

buildtool_cwd

+ +
    +
  • Synopsis
    • +
+
buildtool_cwd MODULE_ index
+
+
    +
  • Description
    • +
+ +

change the working directory to execute the buildtool

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

calcdiffs

+ +
    +
  • Synopsis
    • +
+
calcdiffs branchlog patchlog testtype
+
+
    +
  • Description
    • +
+ +

Wrapper to call specific version of calcdiffs if available otherwise calls error_calcdiffs

+ +
    +
  • Returns
    • +
+ +

differences

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

clear_personality_queue

+ +
    +
  • Synopsis
    • +
+
clear_personality_queue
+
+
    +
  • Description
    • +
+ +

Reset the queue for tests

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

column_calcdiffs

+ +
    +
  • Synopsis
    • +
+
column_calcdiffs branchlog patchlog
+
+
    +
  • Description
    • +
+ +

Calculate the differences between the specified files using just the column+ messages (third+ column in a

+ +
    +
  • Returns
    • +
+ +

differences

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

compile

+ +
    +
  • Synopsis
    • +
+
compile branch|patch
+
+
    +
  • Description
    • +
+ +

Execute the compile phase. This will callout to _compile

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

compile_cycle

+ +
    +
  • Synopsis
    • +
+
compile_cycle branch|patch
+
+
    +
  • Description
    • +
+ +

Execute the static analysis test cycle. This will callout to _precompile, compile, _postcompile and _rebuild

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

compile_jvm

+ +
    +
  • Synopsis
    • +
+
compile_jvm branch|patch
+
+
    +
  • Description
    • +
+ +

Execute the compile phase. This will callout to _compile

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

compile_nonjvm

+ +
    +
  • Synopsis
    • +
+
compile_nonjvm branch|patch
+
+
    +
  • Description
    • +
+ +

Execute the compile phase. This will callout to _compile

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

dequeue_personality_module

+ +
    +
  • Synopsis
    • +
+
dequeue_personality_module modulenames
+
+
    +
  • Description
    • +
+ +

Remove a module

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

distclean

+ +
    +
  • Synopsis
    • +
+
distclean
+
+
    +
  • Description
    • +
+ +

Wipe the repo clean to not invalidate tests

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

error_calcdiffs

+ +
    +
  • Synopsis
    • +
+
error_calcdiffs branchlog patchlog
+
+
    +
  • Description
    • +
+ +

Calculate the differences between the specified files using just the error messages (last column in a

+ +
    +
  • Returns
    • +
+ +

differences

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

generic_calcdiff_status

+ +
    +
  • Synopsis
    • +
+
generic_calcdiff_status totalbranchissues totalpatchissues newpatchissues
+
+
    +
  • Description
    • +
+ +

generate a standarized calcdiff status message

+ +
    +
  • Returns
    • +
+ +

errorstring

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

generic_logfilter

+ +
    +
  • Synopsis
    • +
+
generic_logfilter
+
+
    +
  • Description
    • +
+ +

Helper routine for plugins to ask projects, etc to count problems in a log file and output it to stdout.

+ +
    +
  • Returns
    • +
+ +

number of issues

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

generic_post_handler

+ +
    +
  • Synopsis
    • +
+
generic_post_handler origlog testtype multijdkmode run commands
+
+
    +
  • Description
    • +
+ +

Generic post-patch handler

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

generic_postlog_compare

+ +
    +
  • Synopsis
    • +
+
generic_postlog_compare origlog testtype multijdkmode
+
+
    +
  • Description
    • +
+ +

Generic post-patch log handler

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

generic_pre_handler

+ +
    +
  • Synopsis
    • +
+
generic_pre_handler testype multijdk
+
+
    +
  • Description
    • +
+ +

Helper routine for plugins to do a pre-patch prun

+ +
    +
  • Returns
    • +
+ +

1 on failure

+ +

0 on success

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

initialize

+ +
    +
  • Synopsis
    • +
+
initialize $@
+
+
    +
  • Description
    • +
+ +

Setup to execute

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

module_status

+ +
    +
  • Synopsis
    • +
+
module_status moduleindex -1-0|0|+1 logvalue message
+
+
    +
  • Description
    • +
+ +

Add or update a test result. Update requires at least the first two parameters. WARNING: If the message is updated, then the JDK version is also calculated to match the current JAVA_HOME.

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

modules_backup

+ +
    +
  • Synopsis
    • +
+
modules_backup
+
+
    +
  • Description
    • +
+ +

Backup the MODULE globals prior to loop processing

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

modules_messages

+ +
    +
  • Synopsis
    • +
+
modules_messages repostatus testtype summarymode
+
+
    +
  • Description
    • +
+ +

Utility to print standard module errors

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

modules_reset

+ +
    +
  • Synopsis
    • +
+
modules_reset
+
+
    +
  • Description
    • +
+ +

Reset the test results

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

modules_restore

+ +
    +
  • Synopsis
    • +
+
modules_restore
+
+
    +
  • Description
    • +
+ +

Restore the backup

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

modules_workers

+ +
    +
  • Synopsis
    • +
+
modules_workers repostatus testtype mvncmdline
+
+
    +
  • Description
    • +
+ +

run the tests for the queued modules

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

patchfiletests

+ +
    +
  • Synopsis
    • +
+
patchfiletests branch|patch
+
+
    +
  • Description
    • +
+ +

Execute the patch file test phase. Calls out to to _patchfile

+ +
    +
  • Returns
    • +
+ +

0 on success

+ +

1 on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

personality_enqueue_module

+ +
    +
  • Synopsis
    • +
+
personality_enqueue_module module profiles/flags/etc
+
+
    +
  • Description
    • +
+ +

Build the queue for tests

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePublic
StabilityEvolving
ReplaceableNo
+

Private/Stable/Replaceable

+ + + +
    +
  • Synopsis
    • +
+
prepopulate_footer
+
+
    +
  • Description
    • +
+ +

Put the opening environment information at the bottom of the footer table

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePrivate
StabilityStable
ReplaceableYes
+

report_jvm_version

+ +
    +
  • Synopsis
    • +
+
report_jvm_version directory
+
+
    +
  • Description
    • +
+ +

Report the JVM version of the given directory

+ +
    +
  • Returns
    • +
+ +

version

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePrivate
StabilityStable
ReplaceableYes
+

Private/Evolving/Replaceable

+ +

start_coprocessors

+ +
    +
  • Synopsis
    • +
+
start_coprocessors
+
+
    +
  • Description
    • +
+ +

Start any coprocessors

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePrivate
StabilityEvolving
ReplaceableYes
+

stop_coprocessors

+ +
    +
  • Synopsis
    • +
+
stop_coprocessors
+
+
    +
  • Description
    • +
+ +

Stop any coprocessors

+ +
    +
  • Returns
    • +
+ +

Nothing

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePrivate
StabilityEvolving
ReplaceableYes
+

verify_patchdir_still_exists

+ +
    +
  • Synopsis
    • +
+
verify_patchdir_still_exists
+
+
    +
  • Description
    • +
+ +

Verify that the patch directory is still in working order since bad actors on some systems wipe it out. If not, recreate it and then exit

+ +
    +
  • Returns
    • +
+ +

may exit on failure

+ + + + + + + + + + + + + + + + +
ClassificationLevel
AudiencePrivate
StabilityEvolving
ReplaceableYes
+
+
+
+ +
+ + + http://git-wip-us.apache.org/repos/asf/yetus/blob/961ea845/documentation/0.7.0/precommit-architecture/index.html ---------------------------------------------------------------------- diff --git a/documentation/0.7.0/precommit-architecture/index.html b/documentation/0.7.0/precommit-architecture/index.html new file mode 100644 index 0000000..f5d9ead --- /dev/null +++ b/documentation/0.7.0/precommit-architecture/index.html @@ -0,0 +1,235 @@ + + + + + + Apache Yetus + + + + + + + + + + + + + + + +
+ + +

Some Philosophy

+ +
    +

  • Everyone’s time is valuable. The quicker contributors can get feedback and iterate, the more likely and faster their contribution will get checked in. A committer should be able to focus on the core issues of a contribution rather than details that can be determined automatically.

    • +

  • Precommit checks should be fast. There is no value in testing parts of the source tree that are not immediately impacted by a change. Unit testing is the target. They are not a replacement for full builds or integration tests.

    • +

  • Many open source projects have a desire to have this capability. Why not generalize a solution?

    • +

  • In many build systems (especially with maven), a modular design has been picked. Why not leverage that design to make checks faster?

    • +

  • Projects that use the same language will, with a high degree of certainty, benefit from the same types of checks.

    • +

  • Portability matters. Tooling should be as operating system and language agnostic as possible.

    • +
+ +

Phases

+ +

test-patch works effectively under several different phases:

+ +

Initialize

+ +

This is where test-patch configures and validates the environment. Some things done in this phase:

+ +
    +
  • Defaults
    • +
  • Parameter handling
    • +
  • Importing plug-ins and personalities
    • +
  • Docker container launching
    • +
  • Re-exec support
    • +
  • Patch file downloading
    • +
  • git repository management (fresh pull, branch switching, etc)
    • +
+ +

Precheck

+ +

Checks done here are fatal.

+ +

This acts as a verification of all of the setup parts and is the final place to short-cut the full test cycle. The most significant built-in check done here is verifying the patch file is a valid.

+ +

Patch File Tests

+ +

Tests that only require the patch file are run. Note that the repository is still from the initial checkout!

+ +

Compile Cycle (Branch)

+ +

When compilation must be done, we follow these five steps:

+ +
    +
  • The list of modules that require analysis is built.
    • +
  • A precompile step to set things up for the actual compile
    • +
  • The actual compile
    • +
  • A postcompile to do analysis on the output of that compile phase
    • +
  • A rebuild phase to run tests that require recompiles
    • +
+ +

The first time this is done is with the pristine checkout. This is called the branch compile. For this pass, this is where the ‘before’ work is handled. Some things that typically get checked in this phase:

+ +
    +
  • The first pass of files and modules that will get patched
    • +
  • Validation and information gathering of the source tree pre-patch
    • +
  • javadoc, scaladoc, etc
    • +
+ +

Distribution Clean

+ +

This step is to wipe the repository clean back to a pristine state such that the previous cycle will not impact the next cycle.

+ +

Patch Application

+ +

The patch gets applied.

+ +

Compile Cycle (Patch)

+ +

Now that the patch has been applied the steps to compile we outlined in the compilation (branch) phase are repeated but with the patch applied. This is where a lot of ‘after’ checks are performed.

+ +

Unit Tests

+ +

Since unit tests are generally the slowest part of the precommit process, they are run last. At this point, all the prerequisites to running them should be in place and ready to go.

+ +

Reporting

+ +

Finally, the results are reported to the screen and, optionally, to JIRA and/or whatever bug system has been configured.

+ +

Test Flow

+ +

The basic workflow for many of the sub-items in individual phases are:

+ +
    +
  1. print a header, so the end user knows that something is happening
    2. +
  2. verify if the test is needed. If so, continue on. Otherwise, return success and let the next part of the phase execute.
    3. +
  3. Ask the personality about what modules and what flags should get used
    4. +
  4. Execute maven (or some other build tool) in the given modules with the given flags. Log the output and record the time and result code.
    5. +
  5. Do any extra work as appropriate (diffs, counts, etc) and either accept the status and message given by the maven run or change the vote, message, log file, etc, based upon this extra work.
    6. +
  6. Add the outcome(s) to the report generator
    7. +
+ +

As one can see, the modules list is one of the key inputs into what actually gets executed. As a result, projects must full flexibility in either adding, modifying, or even removing modules from the test list. If a personality removes the entire list of modules, then that test should just be ignored.

+ +
+
+
+ +
+ + +