XML::C...Tester(3pm)

💖 XML::Compile::Tester — the manual, but make it cute ✨

okay bestie, gather round, because this is XML::C...Tester(3pm) from the User Contributed Perl Documentation crew, and she's here to help you write regression tests for your XML::Compile situation. no cap. 🎀

---

✨ NAME ✨

XML::Compile::Tester — support for XML::Compile related regression testing 💅

---

🌈 INHERITANCE 🌈

XML::Compile::Tester
  is a Exporter

yeah she's an Exporter, so all her little helper functions can come hang out in your namespace, no invite needed. 🫶

---

🦋 SYNOPSIS 🦋

use XML::Compile::Tester;

# default additional compile flags, avoids repetition
set_compile_defaults(validation => 0, @other_opts);
set_compile_defaults();  # reset

# set default namespace, such that $type only needs to use local
my $ns     = 'some-schemas-targetNamespace';
my $type   = pack_type($ns, 'localName'); # X::C::Util
set_default_namespace($ns);
my $type   = 'localName'; # now implicit in $ns

my $reader = reader_create($schema, "my reader", $type, @opts);
my $data   = $reader->($xml);  # $xml is string, filename, node

my $writer = writer_create($schema, "my writer", $type, @opts);
my $xml    = $writer->($doc, $data);
my $xml    = writer_test($writer, $data);

my $rerror = reader_error($schema, $type, $xml);
my $werror = writer_error($schema, $type, $data);

my $output = templ_xml($schema, $type, @options);
my $output = templ_perl($schema, $type, @options);

look at her. iconic. 🧚

---

🌸 DESCRIPTION 🌸

the XML::Compile module suite has extensive regression testing. and like, probably? you want to do regression testing too? valid. so this module hands you a bunch of functions that simplify writing tests for XML::Compile related distributions. it's giving "we already wrote the annoying part so you don't have to." periodt. 👑

---

💜 FUNCTIONS 💜

🎀 Reader checks 🎀

• reader_create($schema, $comment, $type, %options) — makes you a reader for $type. one test gets created, reporting success or failure of the creation. obviously XML::Compile::Schema subroutine compile is being called under the hood, with some options. by default, check_values is true, and include_namespaces is false. you can overrule these using set_compile_defaults(), and with the %options parameter list. bestie behaviour fr fr.

example: reader_create

my $type   = pack_type('namespace', 'localName');
my $reader = reader_create($schema, 'my test', $type
  , check_occurs => 0, @other_options);

my $data   = $reader->($xml);
is_deeply($data, $expected, 'my test');  # Test::More
cmp_deeply($data, $expected, 'my test'); # Test::Deep

# alternative for $type:
set_default_namespace('namespace');
my $reader = reader_create($schema, 'my test', 'localName'
  , check_occurs => 0, @other_options);

• reader_error($schema, $type, $xml) — parsing the $xml to interpret the $type should return an error. and the error text is returned to you. like, the error is the point. 😌

example: reader_error

my $error = reader_error($schema, $type, <<_XML);
<test1>...</test1>
_XML

is($error, 'error text', 'my test');
like($error, qr/error pattern/, 'my test');

✨ Writer checks ✨

• writer_create($schema, $comment, $type, %options) — creates a writer for $type. one test (in the Test::More sense, iykyk) is created, reporting success or failure of the creation. and yes, XML::Compile::Schema subroutine compile is being called, with some options. by default, check_values and use_default_namespace are true, and include_namespaces is false. overrule them with set_compile_defaults(), and with the %options parameter list. 💅

example: writer_create

set_default_namespace('namespace');
my $writer = writer_create($schema, 'my test', 'test1');

my $doc    = XML::LibXML::Document->new('1.0', 'UTF-8');
my $xml    = $writer->($doc, $data);
compare_xml($xml, <<_EXPECTED, 'my test');
  <test1>...</test1>
_EXPECTED

# implicit creation of $doc
my $xml    = writer_test($writer, $data);

• writer_error($schema, $type, $data) — translating the Perl $data into the XML type should return a validation error, which is returned. (yes, again: the error is the whole vibe.) 🙈

example: writer_error

my $error = writer_error($schema, $type, $data);

is($error, 'error text', 'my test');
like($error, qr/error pattern/, 'my test');

• writer_test( $writer, $data, [$doc] ) — runs the test with a compiled $writer, which was created with writer_create(). when no $doc (XML::LibXML::Document object) was specified, then one will be created for you. she's thoughtful like that. 🫶

🦋 Check templates 🦋

• templ_perl($schema, $type, %options)
• templ_xml($schema, $type, %options)

create an example template for $type, as XML message. the %options are passed to XML::Compile::Schema subroutine template.

example: templ_xml

my $out = templ_xml($schema, $type, show => 'ALL');
is($out, $expected);

🌟 Helpers 🌟

• compare_xml( $created, $expected, [$comment] ) — compares the $created XML (either a string or an XML::LibXML::Element) with the $expected string. both sources are stripped from layout before comparing. lowkey magical.

heads up bestie: in a future release, this algorithm will get improved to compare the parsed XML node trees, not the strings. so like, don't build your whole personality on the string behaviour, k? 💀

example: compare_xml

compare_xml($xml, <<_XML, 'my test');
  <test1>...</test1>
_XML

• set_compile_defaults(%options) — every call to create a reader or writer (also indirectly) with XML::Compile::Schema subroutine compile will get these %options passed, on top (and overruling) the usual settings. main character energy for your defaults. 👑

example:

# defaults for XML::Compile::Schema::compile()
set_compile_defaults(include_namespaces => 1, validate => 0
  , sloppy_intergers => 1, sloppy_floats => 1);

set_compile_defaults();   # reset

• set_default_namespace($testns) — defines which namespace to use when a relative (only localName) type is provided. by default, this is undef — which means an error when used. so set it, or catch hands. 😭

---

🌈 SEE ALSO 🌈

this module is part of the XML-Compile-Tester distribution version 0.91, built on May 11, 2018. website: http://perl.overmeer.net/CPAN/ 🦋

---

💖 LICENSE 💖

copyrights 2008-2018 by [Mark Overmeer <markov@cpan.org>]. for other contributors see ChangeLog.

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 bestie, no cap. she's XML-Compile-Tester version 0.91, built on May 11, 2018, and this particular rendering rode in on perl v5.36.0 dated 2022-12-01 — from XML::C...Tester(3pm) with love. slay, go write some tests. 💅✨🎀