GNU.WIKI: The GNU/Linux Knowledge Base

  [HOME] [PHP Manual] [HowTo] [ABS] [MAN1] [MAN2] [MAN3] [MAN4] [MAN5] [MAN6] [MAN7] [MAN8] [MAN9]

  [0-9] [Aa] [Bb] [Cc] [Dd] [Ee] [Ff] [Gg] [Hh] [Ii] [Jj] [Kk] [Ll] [Mm] [Nn] [Oo] [Pp] [Qq] [Rr] [Ss] [Tt] [Uu] [Vv] [Ww] [Xx] [Yy] [Zz]


NAME

       OpenGuides::Test - Methods to help test OpenGuides applications.

DESCRIPTION

       Provides methods to help when writing tests for OpenGuides.
       Distributed and installed as part of the OpenGuides project, not
       intended for independent installation.  This documentation is probably
       only useful to OpenGuides developers.

SYNOPSIS

         use OpenGuides;
         use OpenGuides::Test;

         OpenGuides::Test::refresh_db();

         my $config = OpenGuides::Test->make_basic_config;
         $config->default_language( "nl" );

         my $guide = OpenGuides->new( config => $config );

         OpenGuides::Test->write_data(
                                       guide      => $guide,
                                       node       => "Crabtree Tavern",
                                       os_x       => 523465,
                                       os_y       => 177490,
                                       categories => "Pubs",
                                     );

METHODS

       make_basic_config
             my $config = OpenGuides::Test->make_basic_config;
             $config->default_language( "nl" );

           Makes an OpenGuides::Config object with needed fields pre-filled.
           You can mess with it as you like then.

       write_data
             my $config = OpenGuides::Test->make_basic_config;
             my $guide = OpenGuides->new( config => $config );

             OpenGuides::Test->write_data(
                                           guide      => $guide,
                                           node       => "Crabtree Tavern",
                                           os_x       => 523465,
                                           os_y       => 177490,
                                           categories => "Pubs
Pub Food",
                                         );

           This method calls the "make_cgi_object" method to make its CGI
           object; you can supply values for any key mentioned there.  You
           should supply them exactly as they would come from a CGI form, eg
           lines in a textarea are separated by "
".

           This method will automatically grab the checksum from the database,
           so even if the node already exists your data will still be written.
           If you don't want this behaviour (for example, if you're testing
           edit conflicts) then pass in a true value to the "omit_checksum"
           parameter:

             OpenGuides::Test->write_data(
                                           guide         => $guide,
                                           node          => "Crabtree Tavern",
                                           omit_checksum => 1,
                                         );

           If you want to grab the output, pass a true value to
           "return_output":

             my $output = OpenGuides::Test->write_data(
                                                        guide        => $guide,
                                                        node         => "Crabtree Tavern",
                                                        return_output => 1,
                                                      );

           Similarly, if you pass a true value to "return_tt_vars", the return
           value will be the variables which would have been passed to the
           template for output:

             my %vars = OpenGuides::Test->write_data(
                                                        guide        => $guide,
                                                        node         => "Crabtree Tavern",
                                                        return_tt_vars => 1,
                                                      );

       make_cgi_object
             my $q = OpenGuides::Test->make_cgi_object;

           You can supply values for the following keys: "content",
           "categories", "locales", "node_image", "node_image_licence",
           "node_image_copyright", "node_image_url", "phone", "fax",
           "website", "hours_text", "address", "postcode", "map_link", "os_x",
           "os_y", "osie_x", "osie_y", "latitude", "longitude", "summary",
           "username", "comment", "edit_type".  You should supply them exactly
           as they would come from a CGI form, eg lines in a textarea are
           separated by "
".

       refresh_db
             Openguides::Test::refresh_db();

           Unlink the existing SQLite database t/node.db and Plucene/Lucy
           indexes.  Then create a new SQLite database t/node.db

AUTHOR

       The OpenGuides Project (openguides-dev@lists.openguides.org)

COPYRIGHT

         Copyright (C) 2004-2013 The OpenGuides Project.  All Rights Reserved.

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



  All copyrights belong to their respective owners. Other content (c) 2014-2018, GNU.WIKI. Please report site errors to webmaster@gnu.wiki.
Page load time: 0.085 seconds. Last modified: November 04 2018 12:49:43.