1Test2::Harness::Runner:U:sJeorb(C3o)ntributed Perl DocumTeenstta2t:i:oHnarness::Runner::Job(3)
2
3
4

NAME

6       Test2::Harness::Runner::Job - Representation of a test job.
7

DESCRIPTION

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

METHODS

14       Note, this object subclasses Test2::Harness::IPC::Process.
15
16       $arrayref = $job->args
17           Get the arguments for the test either formt he queue item, or from
18           the run.
19
20       $path = $job->bail_file
21           Path to the events-file used in case of a bail-out
22
23       $bool = $job->bailed_out
24           True if the test job bailed out.
25
26       $cat $job->category
27           Process category, always 'job' unless overriden in a subclass.
28
29       $path = $job->ch_dir
30           If this job first requires a change in directory before running,
31           this will return the path.
32
33       @list = $job->cli_includes
34           List of includes for a command line launch of this job.
35
36       @list = $job->cli_options
37           List of options for a command line launch of this job.
38
39       $hashref = $job->env_vars
40           Get environment variables to set when launching this job.
41
42       $path = $job->out_file
43           File to which all STDOUT for the job will be written.
44
45       $path = $job->err_file
46           File to which all STDERR for the job will be written.
47
48       $path = $job->et_file
49           File to which event timeout notifications will be written.
50
51       $path = $job->pet_file
52           File to which post exit timeout events will be written.
53
54       $path = $job->event_dir
55           Directory to which Test2::Formatter::Stream events will be written.
56
57       $time = $job->event_timeout
58           Event timeout specification, if any, first from test queue item,
59           then from runner.
60
61       $time = $job->post_exit_timeout
62           Post exit timeout specification, if any, first from test queue
63           item, then from runner.
64
65       $bool = $job->event_uuids
66           Use Test2::Plugin::UUID inside the test.
67
68       $path = $job->file
69           Test file the job will be running.
70
71       $coderef = $job->fork_callback
72           If the job is to be launched via fork, use this callback.
73
74       $path = $job->in_file
75           File containing STDIN to be provided to the test.
76
77       @list = $job->includes
78           Paths to add to @INC for the test.
79
80       $bool = $job->io_events
81           True if Test2::Plugin::IOEvents should be used.
82
83       $int = $job->is_try
84           This starts at 0 and will be incremented for every retry of the
85           job.
86
87       $path = $job->job_dir
88           Temporary directory housing all files related to this job when it
89           runs.
90
91       $uuid = $job->job_id
92           UUID for this job.
93
94       @list = $job->load
95           Modules to load when starting this job.
96
97       @list = $job->load_import
98           Modules to load and import when starting this job.
99
100       $bool = $job->mem_usage
101           True if the Test2::Plugin::MemUsage plugin should be used.
102
103       $path = $job->rel_file
104           Relative path to the file.
105
106       $int = $job->retry
107           How many times the test should be retried if it fails.
108
109       $bool = $job->retry_isolated
110           True if the test should be retried in isolation if it fails.
111
112       $run = $job->run
113           The Test2::Harness::Runner::Run instance.
114
115       $path = $job->run_dir
116           Path to the temporary directory housing all the data about the run.
117
118       $runner = $job->runner
119           The Test2::Harness::Runner instance.
120
121       @list = $job->runner_includes
122           Search path includes provided directly by the runner.
123
124       $settings = $job->settings
125           The Test2::Harness::Settings instance.
126
127       $bool = $job->smoke
128           True if the test is a priority smoke test.
129
130       $hashref = $job->spawn_params
131           Parameters for "run_cmd()" in Test2::Harness::Util::IPC when
132           launching this job.
133
134       @list = $job->switches
135           Command line switches for perl when running this test.
136
137       $hashref = $job->task
138           Task data from the queue.
139
140       $path = $job->tmp_dir
141           Temp dir created specifically for this job.
142
143       $bool = $job->unsafe_inc
144           True if '.' should be added to @INC.
145
146       $bool = $job->use_fork
147           True if this job should be launched via fork.
148
149       $bool = $job->use_stream
150           True if this job should use Test2::Formatter::Stream.
151
152       $bool = $job->use_timeout
153           True if this job should timeout due to lack of activity.
154
155       $bool = $job->use_w_switch
156           True if the "-w" switch should be used for this test.
157

SOURCE

159       The source code repository for Test2-Harness can be found at
160       http://github.com/Test-More/Test2-Harness/.
161

MAINTAINERS

163       Chad Granum <exodist@cpan.org>
164

AUTHORS

166       Chad Granum <exodist@cpan.org>
167

169       Copyright 2020 Chad Granum <exodist7@gmail.com>.
170
171       This program is free software; you can redistribute it and/or modify it
172       under the same terms as Perl itself.
173
174       See http://dev.perl.org/licenses/
175
176
177
178perl v5.32.0                      2020-07-28    Test2::Harness::Runner::Job(3)
Impressum