.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Dist::Zilla::Util::Test::KENTNL 3pm" .TH Dist::Zilla::Util::Test::KENTNL 3pm "2022-06-13" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Dist::Zilla::Util::Test::KENTNL \- KENTNL's DZil plugin testing tool .SH "VERSION" .IX Header "VERSION" version 1.005014 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is \s-1KENTNL\s0's kit for testing Dist::Zilla. .PP Most of his modules should be moving to using the `dztest` model instead which is more flexible source side. .SH "METHODS" .IX Header "METHODS" .ie n .SS """dztest""" .el .SS "\f(CWdztest\fP" .IX Subsection "dztest" Creates a \f(CW\*(C`Dist::Zilla::Util::Test::KENTNL\*(C'\fR object. .PP This is a much more sane approach to testing than \f(CW\*(C`test_config\*(C'\fR .SS "test_config" .IX Subsection "test_config" This is pretty much why this module exists. Its a little perverse, but makes testing \s-1WAY\s0 easier. .PP .Vb 10 \& my $plugin = test_config({ \& dist_root => \*(Aqcorpus/dist/DZT\*(Aq, \& ini => [ \& \*(AqGatherDir\*(Aq, \& [ \*(AqPrereqs\*(Aq => { \*(AqTest::Simple\*(Aq => \*(Aq0.88\*(Aq } ], \& ], \& post_build_callback => sub { \& my $config = shift; \& # Handy place to put post\-construction test code. \& die $config\->{error} if $config\->{error}; \& }, \& find_plugin => \*(AqSomePluginName\*(Aq \& }); .Ve .PP Additionally, you can add this section .PP .Vb 11 \& callback => { \& method => \*(Aqmetadata\*(Aq, \& args => [], \& code => sub { \& my $data = shift; \& print "Errors ( if any ) $data\->{error} "; \& dump $data\->{response}; # response from \->metadata \& $data\->{instance}\->doMorestuffbyhand(); \& # ok( .... \*(Aqgood place for a test!\*(Aq ) \& }, \& } .Ve .PP Generally, I find it easier to do 1\-off function wrappers, i.e.: .PP .Vb 10 \& sub make_plugin { \& my @args = @_; \& return test_config({ \& dist_root => \*(Aqcorpus/dist/DZT\*(Aq, \& ini => [ \& \*(AqGatherDir\*(Aq, \& [ \*(AqPrereqs\*(Aq => {\*(AqTest::Simple\*(Aq => \*(Aq0.88\*(Aq } ], \& [ \*(AqFakePlugin\*(Aq => {@args } ], \& ], \& post_build_callback => sub { \& my $config = shift; \& die $config\->{error} if $config\->{error}; \& }, \& find_plugin => \*(AqFakePlugin\*(Aq, \& }); \& } .Ve .PP Which lets us do .PP .Vb 1 \& ok( make_plugin( inherit_version => 1 )\->inherit_version , \*(Aqinherit_verion = 1 propagates\*(Aq ); .Ve .PP parameters .IX Subsection "parameters" .PP .Vb 10 \& my $foo = test_config({ \& dist_root => \*(AqSome/path\*(Aq # optional, strongly recommended. \& ini => [ # optional, strongly recommended. \& \*(AqBasicPlugin\*(Aq, \& [ \*(AqAdvancedPlugin\*(Aq => { %pluginargs }], \& ], \& build => 0/1 # works fine as 0, 1 tells it to call the \->build() method. \& post_build_callback => sub { \& my ( $conf ) = shift; \& $conf\->{error} # any errors that occured during construction/build \& $conf\->{instance} # the constructed instance \& # this is called immediately after construction, do what you will with this. \& # mostly for convenience \& }, \& find_plugin => \*(AqSome::Plugin::Name\*(Aq, # makes test_config find and return the plugin that matched that name instead of \& # the config instance \& \& callback => { # overrides the return value of find_plugin if it is called \& method => \*(Aqmethod_to_call\*(Aq, \& args => [qw( hello world )], \& code => sub { \& my ($conf) = shift; \& $conf\->{plugin} # the constructed plugin instance \& $conf\->{error} # any errors discovered when calling \->method( args ) \& $conf\->{instance} # the zilla instance \& $conf\->{response} # the return value of \->method( args ) \& # mostly just another convenience of declarative nature. \& return someValueHere # this value will be returned by test_config \& } \& }, \& }); .Ve .SH "AUTHOR" .IX Header "AUTHOR" Kent Fredric .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2017 by Kent Fredric . .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.