Simon Cozens > Maypole > Maypole::CLI

Download:
Maypole-1.7.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  7
Open  5
View/Report Bugs
Source   Latest Release: Maypole-2.13

NAME ^

Maypole::CLI - Command line interface to Maypole for testing and debugging

SYNOPSIS ^

  % setenv MAYPOLE_TEMPLATES /var/www/beerdb/
  % perl -MMaypole::CLI=BeerDB -e1 http://localhost/beerdb/brewery/frontpage

DESCRIPTION ^

This module is used to test Maypole sites without going through a web server or modifying them to use a CGI frontend. To use it, you should first either be in the template root for your Maypole site or set the environment variable MAYPOLE_TEMPLATES to the right value.

Next, you import the Maypole::CLI module specifying your base Maypole subclass. The usual way to do this is with the -M flag: perl -MMaypole::CLI=MyApp. This is equivalent to:

    use Maypole::CLI qw(MyApp);

Now Maypole will automatically call your application's handler with the URL specified as the first command line parameter. This should be the full URL, starting from whatever you have defined as the uri_base in your application's configuration, and may include query parameters.

The Maypole HTML output should then end up on standard output.

Support for testing ^

The module can also be used as part of a test script.

When used programmatically, rather than from the command line, its behaviour is slightly different.

Although the URL is taken from @ARGV as normal, your application's handler method is not called automatically, as it is when used on the command line; you need to call it manually. Additionally, when handler is called, the output is not printed to standard output but stored in $Maypole::CLI::buffer, to allow you to check the contents more easily.

For instance, a test script could look like this:

    use Test::More tests => 5;
    use Maypole::CLI qw(BeerDB);
    use Maypole::Constants;
    $ENV{MAYPOLE_TEMPLATES} = "t/templates";

    # Hack because isa_ok only supports object isa not class isa
    isa_ok( (bless {},"BeerDB") , "Maypole");

    @ARGV = ("http://localhost/beerdb/");
    is(BeerDB->handler, OK, "OK");
    like($Maypole::CLI::buffer, qr/frontpage/, "Got the front page");

    @ARGV = ("http://localhost/beerdb/beer/list");
    is(BeerDB->handler, OK, "OK");
    like($Maypole::CLI::buffer, qr/Organic Best/, "Found a beer in the list");
syntax highlighting: