Test2:...er::Job(3pm)

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💖 NAME 💖

Test2::Harness::Runner::Job — literally the whole representation of a test job, bestie. It's a Perl module, and yeah, the manual page is Test2:...er::Job(3pm) (iconic name, we don't question it).

✨ DESCRIPTION ✨

Okay so picture this: a test file queue item walks in 🚶♀️, a run walks in 🚶, and runner settings walk in 🚶. This module takes alllll of that data and mashes it together — like, fully blends it — just to figure out what is actually needed to run a job. That's the whole gig. No cap. 💅

🎀 METHODS 🎀

Heads up bestie: this object subclasses Test2::Harness::IPC::Process. So some of the energy comes from up the family tree, iykyk. 🌳
  • $arrayref = $job->args — grab the arguments for the test 🌸 either from the queue item, or from the run.
  • $path = $job->bail_file — path to the events-file that gets used in case of a bail-out 😭
  • $bool = $job->bailed_out — true if the test job bailed out 💀
  • $cat $job->category — the process category, always 'job' unless a subclass goes rogue and overrides it 👑
  • $path = $job->ch_dir — if this job first needs a change of directory before it runs, this hands you the path 📂
  • @list = $job->cli_includes — the list of includes for a command line launch of this job ✨
  • @list = $job->cli_options — the list of options for a command line launch of this job 💅
  • $hashref = $job->env_vars — get the environment variables to set when launching this job 🌈
  • $path = $job->out_file — the file where all STDOUT for the job gets written 📝
  • $path = $job->err_file — the file where all STDERR for the job gets written 🫣
  • $path = $job->et_file — the file where event timeout notifications get written ⏰
  • $path = $job->pet_file — the file where post exit timeout events get written 🐾
  • $path = $job->event_dir — the directory where Test2::Formatter::Stream events get written 📁
  • $time = $job->event_timeout — the event timeout specification, if there even is one: first from the test queue item, then from the runner ⏳
  • $time = $job->post_exit_timeout — the post exit timeout specification, if any: first from the test queue item, then from the runner ⏳
  • $bool = $job->event_uuids — use Test2::Plugin::UUID inside the test 🔖
  • $path = $job->file — the test file this job will be running 🏃♀️
  • $coderef = $job->fork_callback — if the job is gonna be launched via fork, use this callback 🍴
  • $path = $job->in_file — the file containing the STDIN to be provided to the test 📥
  • @list = $job->includes — paths to add to @INC for the test 🧚
  • $bool = $job->io_events — true if Test2::Plugin::IOEvents should be used 👀
  • $int = $job->is_try — this starts at 0 and gets incremented for every retry of the job 🔁
  • $path = $job->job_dir — the temporary directory housing all the files related to this job while it runs 🏠
  • $uuid = $job->job_id — the UUID for this job 🆔
  • @list = $job->load — modules to load when starting this job 📦
  • @list = $job->load_import — modules to load and import when starting this job 📦✨
  • $bool = $job->mem_usage — true if the Test2::Plugin::MemUsage plugin should be used 🧠
  • $path = $job->run_file — usually the same as rel_file, but you can specify an alternative file to actually run 🏃
  • $path = $job->rel_file — the relative path to the file 🛤️
  • $int = $job->retry — how many times the test should be retried if it fails 🔂
  • $bool = $job->retry_isolated — true if the test should be retried in isolation if it fails 🙈
  • $run = $job->run — the Test2::Harness::Runner::Run instance 🎡
  • $path = $job->run_dir — path to the temporary directory housing all the data about the run 🗂️
  • $runner = $job->runner — the Test2::Harness::Runner instance 🏆
  • @list = $job->runner_includes — the search path includes provided directly by the runner 🎁
  • $settings = $job->settings — the Test2::Harness::Settings instance ⚙️
  • $bool = $job->smoke — true if the test is a priority smoke test 🔥
  • $hashref = $job->spawn_params — parameters for run_cmd() in Test2::Harness::Util::IPC when launching this job. If the task has a "resource_skip" set (which means permanently unavailable resources 😵), the command will emit TAP to skip the test. And when the "--fail-on-resource-skip" runner option is enabled, the command will instead emit a TAP test failure 💥
  • @list = $job->switches — the command line switches for perl when running this test 🐪
  • $hashref = $job->task — task data from the queue 📋
  • $path = $job->tmp_dir — the temp dir created specifically for this job 🧺
  • $bool = $job->unsafe_inc — true if . should be added to @INC ⚠️
  • $bool = $job->use_fork — true if this job should be launched via fork 🍴
  • $bool = $job->use_stream — true if this job should use Test2::Formatter::Stream 🌊
  • $bool = $job->use_timeout — true if this job should timeout due to lack of activity 😴
  • $bool = $job->use_w_switch — true if the "-w" switch should be used for this test 🚨

🌈 SOURCE 🌈

The source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/. Go be nosy bestie, it's public 🫶

👑 MAINTAINERS 👑

Chad Granum <exodist@cpan.org>

💜 AUTHORS 💜

Chad Granum <exodist@cpan.org>

Copyright 2020 Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/

and that's the whole page, periodt 💅✨ this was perl v5.40.1, dated 2026-05-10, from the Test2:...er::Job(3pm) manual — thanks for reading bestie, ily, go write some tests 🦋🎀

📦 where this page comes from