Test::...Script(3pm)

📦
version 2.214 · 3 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ Test::...Script ✨

okay bestie, so this is Test::...Script from the Test::Inline fam (it's a Perl module, it lives in section 3pm of your man pages, iykyk) 💖

🌸 VERSION 🌸

version 2.214 — that's the one, no cap ✨

🦋 DESCRIPTION 🦋

so like. this class is where the heavy lifting happens. the actual generating of a test file? yeah, that's all happening right here, bestie 💅

give it a source filename and it will:

  1. load it
  2. parse out the relevant bits
  3. put them into order based on the tags
  4. merge them into a test file

and that's it. that's the whole vibe. iconic honestly 👑

🎀 METHODS 🎀

new

my $File = Test::Inline::Script->new( $class, \@sections, $check_count );

the new constructor takes a class name, a set of Section objects, and an optional check_count flag. that's the trio 🫶

returns a Test::Inline::Script object when it goes well ✨ returns undef when it does not 😭

class

returns the class that the test file will test. simple as that, main character energy 👑

filename

my $filename = $File->filename;

the filename method hands you back the name of the output file that the tests should be written to. for example, the class Foo::Bar would have the filename value foo_bar.t 🍓

config

my $config = $File->config;

the config method returns the config object for the file, assuming it has one. if more than one are found, the first will be used, and any additional config sections get discarded 💀 (sorry to the extras)

returns a Test::Inline::Config object on success, or false if the file does not contain a config section.

setup

my @setup = $File->setup;

the setup method returns the setup sections from the file, in the same order as in the file. keeping it chronological, periodt ✨

returns a list of setup Test::Inline::Section objects, the null array () if the file does not contain any setup objects.

sections

my @sections = $File->sections;

the sections method returns all normal sections from the file, in the same order as in the file. heads up tho — this may not be the order they will be written to the test file, for that you should see the sorted method 👀

returns a list of Test::Inline::Section objects, or the null array () if the file does not contain any non-setup sections.

sorted

the sorted method returns all normal sections from the file, in an order that satisfies any dependencies in the sections. it's giving organized 🧚

returns a reference to an array of Test::Inline::Section objects, 0 if the file does not contain any non-setup sections, or undef on error.

tests

if the number of tests for all of the sections within the file are known, then the number of tests for the entire file can also be determined. math is mathing 🔥

the tests method determines if the number of tests can be known, and if so, calculates and returns the number of tests. returns false if the number of tests is not known.

merged_content

the merged_content method generates and returns the merged contents of all the sections in the file, including the setup sections at the beginning 📝 the method does not return the entire file, merely the part contained in the sections. for the full file contents, see the file_content method.

returns a string containing the merged section content on success, false if there is no content, despite the existence of sections ( which would have been empty ), or undef on error.

💜 SUPPORT 💜

see the main SUPPORT section.

bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Test-Inline> (or bug-Test-Inline@rt.cpan.org <mailto:bug-Test-Inline@rt.cpan.org>).

bestie if you find a bug, please do report it, don't just scream into the void 🙈

👑 AUTHOR 👑

Adam Kennedy <adamk@cpan.org>

this software is copyright (c) 2003 by Adam Kennedy.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay 💅

that's the whole page, babe 🫶 this was perl v5.32.0, dated 2021-01-31, and it's Test::...Script(3pm) — go forth and generate those test files ✨💖🌸

📦 where this page comes from