• Public/Stable/Replaceable
  • add_bugsystem
  • add_build_tool
  • add_docker_build_arg
  • add_docker_env
  • add_test
  • add_test_format
  • add_test_type
  • delete_bugsystem
  • delete_build_tool
  • delete_test
  • delete_test_format
  • delete_test_type
  • personality_plugins
  • replace_test_type
  • verify_needed_test
  • verify_plugin_enabled
  • yetus_add_array_element
  • yetus_del_array_element
  • yetus_relative_dir
  • yetus_sort_and_unique_array
  • yetus_sort_array
  • yetus_ver_array_element
• Public/Stable/Not Replaceable
  • add_version_data
  • common_defaults
  • delete_parameter
  • escape_html
  • generate_stack
  • module_file_fragment
  • patchfile_verify_zero
  • unescape_html
  • yetus_abs
  • yetus_debug
  • yetus_error
  • yetus_find_deepest_directory
  • yetus_get_ctime
  • yetus_run_and_redirect
  • yetus_set_trap_handler
  • yetus_trim
• Public/Evolving/Replaceable
  • get_artifact_url
• Public/Evolving/Not Replaceable
  • bugsystem_linecomments_queue
  • bugsystem_linecomments_trigger
  • guess_build_tool
  • list_plugins
  • personality_file_tests_wrapper
  • personality_modules_wrapper
  • plugin_usage_output
  • reaper_add_name
  • yetus_add_header
  • yetus_add_option
  • yetus_array_to_comma
  • yetus_comma_to_array
  • yetus_file_to_array
  • yetus_generic_columnprinter
  • yetus_is_container
• Private/Stable/Replaceable
  • docker_do_env_adds
  • reaper_initialize
  • yetus_array_contains
• Private/Evolving/Replaceable
  • activate_robots
  • pid_kill
  • reaper_coproc_func
  • reaper_finalize_results
  • reaper_post_exec
  • reaper_total_count
  • set_yetus_version

Public/Stable/Replaceable

add_bugsystem

• Synopsis

add_bugsystem bugsystem

• Description

Add the given bugsystem type

• Returns

Nothing

add_build_tool

• Synopsis

add_build_tool build tool

• Description

Add the given build tool type

• Returns

Nothing

add_docker_build_arg

• Synopsis

add_docker_build_arg envname [value]

• Description

Queue Docker build-args to add to the docker build

• Returns

Nothing

add_docker_env

• Synopsis

add_docker_env envname ...

• Description

Queue env vars to add to the docker env

• Returns

Nothing

add_test

• Synopsis

add_test test

• Description

Add the given test type

• Returns

Nothing

add_test_format

• Synopsis

add_test_format test format

• Description

Add the given test format type

• Returns

Nothing

add_test_type

• Synopsis

add_test_type plugin

• Description

Add the given test type

• Returns

Nothing

delete_bugsystem

• Synopsis

delete_bugsystem bugsystem

• Description

Remove the given bugsystem type

• Returns

Nothing

delete_build_tool

• Synopsis

delete_build_tool build tool

• Description

Remove the given build tool type

• Returns

Nothing

delete_test

• Synopsis

delete_test test

• Description

Remove the given test type

• Returns

Nothing

delete_test_format

• Synopsis

delete_test_format test format

• Description

Remove the given test format type

• Returns

Nothing

delete_test_type

• Synopsis

delete_test_type plugin

• Description

Remove the given test type

• Returns

Nothing

personality_plugins

• Synopsis

personality_plugins plug-in list string

• Description

Personality-defined plug-in list

• Returns

Nothing

replace_test_type

• Synopsis

replace_test_type plugin

• Description

Add the given test type

• Returns

Nothing

verify_needed_test

• Synopsis

verify_needed_test test

• Description

Verify if a given test was requested

• Returns

0 = yes
1 = no

verify_plugin_enabled

• Synopsis

verify_plugin_enabled test

• Description

Determine if a plugin was enabled by the user
ENABLED_PLUGINS must be defined

• Returns

Nothing

yetus_add_array_element

• Synopsis

yetus_add_array_element arrayname element

• Description

Add the element if it is not
present in the given array

• Returns

Nothing

yetus_del_array_element

• Synopsis

yetus_del_array_element arrayname element

• Description

Check if an array has a given value

• Returns

Nothing

yetus_relative_dir

• Synopsis

yetus_relative_dir dirpath filepath

• Description

is a given path relative to given dirpath?

• Returns

1 - no, path
0 - yes, path - dirpath

yetus_sort_and_unique_array

• Synopsis

yetus_sort_and_unique_array arrayvar

• Description

Sort and unique an array by its elements

• Returns

Nothing

yetus_sort_array

• Synopsis

yetus_sort_array arrayvar

• Description

Sort an array by its elements

• Returns

Nothing

yetus_ver_array_element

• Synopsis

yetus_ver_array_element arrayname element

• Description

Check if an arrayname has a given value

• Returns

@returns 0 = yes

@returns 1 = no

Public/Stable/Not Replaceable

add_version_data

• Synopsis

add_version_data executable name version

• Description

Report on executable versions

• Returns

Nothing

common_defaults

• Synopsis

common_defaults 

• Description

Setup the default global variables

• Returns

Nothing

delete_parameter

• Synopsis

delete_parameter parameter

• Description

remove entries from parameter tracker

• Returns

Nothing

escape_html

• Synopsis

escape_html parameter

• Description

escape common HTML entities

• Returns

Nothing

generate_stack

• Synopsis

generate_stack 

• Description

generate a stack trace when in debug mode

• Returns

exits

module_file_fragment

• Synopsis

module_file_fragment module

• Description

Convert the given module name to a file fragment

• Returns

Nothing

patchfile_verify_zero

• Synopsis

patchfile_verify_zero log filename

• Description

if patch-level zero, then verify we aren't
just adding files

• Returns

$?

unescape_html

• Synopsis

unescape_html parameter

• Description

unescape common HTML entities

• Returns

Nothing

yetus_abs

• Synopsis

yetus_abs fsobj

• Description

Given a filename or dir, return the absolute version of it

• Returns

0 success
1 failure
stdout abspath

yetus_debug

• Synopsis

yetus_debug string

• Description

Print a message to stderr if –debug is turned on

• Returns

Nothing

yetus_error

• Synopsis

yetus_error string

• Description

Print a message to stderr

• Returns

Nothing

yetus_find_deepest_directory

• Synopsis

yetus_find_deepest_directory array fn

• Description

find the deepest entry of a directory array.
this is different than yetus_relative_dir because
the provided directory array provides where the
directory breaks may occur rather than every
directory being a potential cut off point.
NOTE: array and filename MUST be absolute paths

• Returns

dir if match

yetus_get_ctime

• Synopsis

yetus_get_ctime 

• Description

Get the date in ctime format

• Returns

ctime

yetus_run_and_redirect

• Synopsis

yetus_run_and_redirect filename command [..]

• Description

run the command, sending stdout and stderr to the given filename

• Returns

$?

yetus_set_trap_handler

• Synopsis

yetus_set_trap_handler function signal [signal]

• Description

Set a trap passing the first param as the signal

• Returns

Nothing

yetus_trim

• Synopsis

yetus_trim 

• Description

Given a string, trim extra surrounding whitespace

• Returns

Nothing

Public/Evolving/Replaceable

get_artifact_url

• Synopsis

get_artifact_url 

• Description

Get the base URL of the artifacts

• Returns

urlstring

Public/Evolving/Not Replaceable

bugsystem_linecomments_queue

• Synopsis

bugsystem_linecomments_queue plugin filename

• Description

Queue up comments to write into bug systems
that have code review support, if such support
enabled/available.
File should be in the form of "file:line[:column]:comment"

• Returns

Nothing

bugsystem_linecomments_trigger

• Synopsis

bugsystem_linecomments_trigger 

• Description

Write all of the bugsystem linecomments

• Returns

Nothing

guess_build_tool

• Synopsis

guess_build_tool 

• Description

attempt to guess what the build tool should be

• Returns

Nothing

list_plugins

• Synopsis

list_plugins 

• Description

List all installed plug-ins, regardless of whether
they have been enabled

• Returns

Nothing

personality_file_tests_wrapper

• Synopsis

personality_file_tests_wrapper 

• Description

Pick a personality_file_tests function
tests that build support should call this
to make sure they get queued correct by the
personality or the build tool

• Returns

Nothing

personality_modules_wrapper

• Synopsis

personality_modules_wrapper 

• Description

Pick a personality_modules function
tests that build support should call this
to make sure they get queued correct by the
personality or the build tool

• Returns

Nothing

plugin_usage_output

• Synopsis

plugin_usage_output array

• Description

Print the plugin's usage info

• Returns

Nothing

reaper_add_name

• Synopsis

reaper_add_name 

• Description

Add a regex to the reaper's checklist
NOTE: Users WILL override anything added before
argument parsing!

• Returns

Nothing

yetus_add_header

• Synopsis

yetus_add_header header

• Description

Add a header to the usage output

• Returns

Nothing

yetus_add_option

• Synopsis

yetus_add_option subcommand subcommanddesc

• Description

Add an option to the usage output

• Returns

Nothing

yetus_array_to_comma

• Synopsis

yetus_array_to_comma arrayname string

• Description

Convert an array to a comma-delimited string

• Returns

Nothing

yetus_comma_to_array

• Synopsis

yetus_comma_to_array arrayname string

• Description

Convert a comma-delimited string to an array

• Returns

Nothing

yetus_file_to_array

• Synopsis

yetus_file_to_array arrayname file

• Description

Convert a file to an array.
Comments on the beginning of the line and empty lines are stripped.

• Returns

0 for success
1+ for failure

yetus_generic_columnprinter

• Synopsis

yetus_generic_columnprinter array

• Description

Print a screen-size aware two-column output

• Returns

Nothing

yetus_is_container

• Synopsis

yetus_is_container 

• Description

Determine if running in a container

• Returns

Nothing

Private/Stable/Replaceable

docker_do_env_adds

• Synopsis

docker_do_env_adds 

• Description

Do the work to add the env vars onto the Docker cmd

• Returns

Nothing

reaper_initialize

• Synopsis

reaper_initialize arguments

• Description

Initialize the reaper

• Returns

Nothing

yetus_array_contains

• Synopsis

yetus_array_contains element array

• Description

Check if an array has a given value

• Returns

@returns 0 = yes

@returns 1 = no

Private/Evolving/Replaceable

activate_robots

• Synopsis

activate_robots 

• Description

import and set defaults based upon any auto-detected automation

• Returns

Nothing

pid_kill

• Synopsis

pid_kill pid

• Description

Kill a process id

• Returns

Nothing

reaper_coproc_func

• Synopsis

reaper_coproc_func 

• Description

Reaper coprocessor function that
runs outside the law

• Returns

Nothing

reaper_finalize_results

• Synopsis

reaper_finalize_results jdkname

• Description

Reaper output to the user

• Returns

Nothing

reaper_post_exec

• Synopsis

reaper_post_exec module testlog testfrag

• Description

Run the reaper

• Returns

Nothing

reaper_total_count

• Synopsis

reaper_total_count jdkname

• Description

Reaper output to the user

• Returns

Nothing

set_yetus_version

• Synopsis

set_yetus_version 

• Description

set VERSION to the current version if not set

• Returns

Nothing