1Test2::Harness::Runner:U:sJeorb(C3o)ntributed Perl DocumTeenstta2t:i:oHnarness::Runner::Job(3)
2
6 Test2::Harness::Runner::Job - Representation of a test job.
7
9 This module takes all the data from a test file queue item, a run, and
10 runner settings, and mashes them together to figure out what is
11 actually needed to run a job.
12
14 Note, this object subclasses Test2::Harness::IPC::Process.
15 $arrayref = $job->args
17 Get the arguments for the test either formt he queue item, or from
18 the run.
19 $path = $job->bail_file
21 Path to the events-file used in case of a bail-out
22 $bool = $job->bailed_out
24 True if the test job bailed out.
25 $cat $job->category
27 Process category, always 'job' unless overriden in a subclass.
28 $path = $job->ch_dir
30 If this job first requires a change in directory before running,
31 this will return the path.
32 @list = $job->cli_includes
34 List of includes for a command line launch of this job.
35 @list = $job->cli_options
37 List of options for a command line launch of this job.
38 $hashref = $job->env_vars
40 Get environment variables to set when launching this job.
41 $path = $job->out_file
43 File to which all STDOUT for the job will be written.
44 $path = $job->err_file
46 File to which all STDERR for the job will be written.
47 $path = $job->et_file
49 File to which event timeout notifications will be written.
50 $path = $job->pet_file
52 File to which post exit timeout events will be written.
53 $path = $job->event_dir
55 Directory to which Test2::Formatter::Stream events will be written.
56 $time = $job->event_timeout
58 Event timeout specification, if any, first from test queue item,
59 then from runner.
60 $time = $job->post_exit_timeout
62 Post exit timeout specification, if any, first from test queue
63 item, then from runner.
64 $bool = $job->event_uuids
66 Use Test2::Plugin::UUID inside the test.
67 $path = $job->file
69 Test file the job will be running.
70 $coderef = $job->fork_callback
72 If the job is to be launched via fork, use this callback.
73 $path = $job->in_file
75 File containing STDIN to be provided to the test.
76 @list = $job->includes
78 Paths to add to @INC for the test.
79 $bool = $job->io_events
81 True if Test2::Plugin::IOEvents should be used.
82 $int = $job->is_try
84 This starts at 0 and will be incremented for every retry of the
85 job.
86 $path = $job->job_dir
88 Temporary directory housing all files related to this job when it
89 runs.
90 $uuid = $job->job_id
92 UUID for this job.
93 @list = $job->load
95 Modules to load when starting this job.
96 @list = $job->load_import
98 Modules to load and import when starting this job.
99 $bool = $job->mem_usage
101 True if the Test2::Plugin::MemUsage plugin should be used.
102 $path = $job->run_file
104 Usually the same as rel_file, but you can specify an alternative
105 file to actually run.
106 $path = $job->rel_file
108 Relative path to the file.
109 $int = $job->retry
111 How many times the test should be retried if it fails.
112 $bool = $job->retry_isolated
114 True if the test should be retried in isolation if it fails.
115 $run = $job->run
117 The Test2::Harness::Runner::Run instance.
118 $path = $job->run_dir
120 Path to the temporary directory housing all the data about the run.
121 $runner = $job->runner
123 The Test2::Harness::Runner instance.
124 @list = $job->runner_includes
126 Search path includes provided directly by the runner.
127 $settings = $job->settings
129 The Test2::Harness::Settings instance.
130 $bool = $job->smoke
132 True if the test is a priority smoke test.
133 $hashref = $job->spawn_params
135 Parameters for "run_cmd()" in Test2::Harness::Util::IPC when
136 launching this job.
137 @list = $job->switches
139 Command line switches for perl when running this test.
140 $hashref = $job->task
142 Task data from the queue.
143 $path = $job->tmp_dir
145 Temp dir created specifically for this job.
146 $bool = $job->unsafe_inc
148 True if '.' should be added to @INC.
149 $bool = $job->use_fork
151 True if this job should be launched via fork.
152 $bool = $job->use_stream
154 True if this job should use Test2::Formatter::Stream.
155 $bool = $job->use_timeout
157 True if this job should timeout due to lack of activity.
158 $bool = $job->use_w_switch
160 True if the "-w" switch should be used for this test.
161
163 The source code repository for Test2-Harness can be found at
164 http://github.com/Test-More/Test2-Harness/.
165
167 Chad Granum <exodist@cpan.org>
168
170 Chad Granum <exodist@cpan.org>
171
173 Copyright 2020 Chad Granum <exodist7@gmail.com>.
174 This program is free software; you can redistribute it and/or modify it
176 under the same terms as Perl itself.
177 See http://dev.perl.org/licenses/
179perl v5.34.1 2022-07-11 Test2::Harness::Runner::Job(3)