.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "OpenGuides::Test 3pm"
.TH OpenGuides::Test 3pm "2021-01-30" "perl v5.32.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"
OpenGuides::Test \- Methods to help test OpenGuides applications.
.SH "DESCRIPTION"
.IX Header "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.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  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",
\&                              );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBmake_basic_config\fR" 4
.IX Item "make_basic_config"
.Vb 2
\&  my $config = OpenGuides::Test\->make_basic_config;
\&  $config\->default_language( "nl" );
.Ve
.Sp
Makes an OpenGuides::Config object with needed fields pre-filled.  You can
mess with it as you like then.
.IP "\fBwrite_data\fR" 4
.IX Item "write_data"
.Vb 2
\&  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\er\enPub Food",
\&                              );
.Ve
.Sp
This method calls the \f(CW\*(C`make_cgi_object\*(C'\fR method to make its \s-1CGI\s0
object; you can supply values for any key mentioned there.  You should
supply them exactly as they would come from a \s-1CGI\s0 form, eg lines in a
textarea are separated by \f(CW\*(C`\er\en\*(C'\fR.
.Sp
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 \f(CW\*(C`omit_checksum\*(C'\fR parameter:
.Sp
.Vb 5
\&  OpenGuides::Test\->write_data(
\&                                guide         => $guide,
\&                                node          => "Crabtree Tavern",
\&                                omit_checksum => 1,
\&                              );
.Ve
.Sp
If you want to grab the output, pass a true value to \f(CW\*(C`return_output\*(C'\fR:
.Sp
.Vb 5
\&  my $output = OpenGuides::Test\->write_data(
\&                                             guide        => $guide,
\&                                             node         => "Crabtree Tavern",
\&                                             return_output => 1,
\&                                           );
.Ve
.Sp
Similarly, if you pass a true value to \f(CW\*(C`return_tt_vars\*(C'\fR, the return value
will be the variables which would have been passed to the template for output:
.Sp
.Vb 5
\&  my %vars = OpenGuides::Test\->write_data(
\&                                             guide        => $guide,
\&                                             node         => "Crabtree Tavern",
\&                                             return_tt_vars => 1,
\&                                           );
.Ve
.IP "\fBmake_cgi_object\fR" 4
.IX Item "make_cgi_object"
.Vb 1
\&  my $q = OpenGuides::Test\->make_cgi_object;
.Ve
.Sp
You can supply values for the following keys: \f(CW\*(C`content\*(C'\fR, \f(CW\*(C`categories\*(C'\fR,
\&\f(CW\*(C`locales\*(C'\fR, \f(CW\*(C`node_image\*(C'\fR, \f(CW\*(C`node_image_licence\*(C'\fR,
\&\f(CW\*(C`node_image_copyright\*(C'\fR, \f(CW\*(C`node_image_url\*(C'\fR, \f(CW\*(C`phone\*(C'\fR, \f(CW\*(C`fax\*(C'\fR,
\&\f(CW\*(C`website\*(C'\fR, \f(CW\*(C`hours_text\*(C'\fR, \f(CW\*(C`address\*(C'\fR, \f(CW\*(C`postcode\*(C'\fR, \f(CW\*(C`map_link\*(C'\fR,
\&\f(CW\*(C`os_x\*(C'\fR, \f(CW\*(C`os_y\*(C'\fR, \f(CW\*(C`osie_x\*(C'\fR, \f(CW\*(C`osie_y\*(C'\fR, \f(CW\*(C`latitude\*(C'\fR, \f(CW\*(C`longitude\*(C'\fR,
\&\f(CW\*(C`summary\*(C'\fR, \f(CW\*(C`username\*(C'\fR, \f(CW\*(C`comment\*(C'\fR, \f(CW\*(C`edit_type\*(C'\fR.  You should supply
them exactly as they would come from a \s-1CGI\s0 form, eg lines in a textarea
are separated by \f(CW\*(C`\er\en\*(C'\fR.
.IP "\fBrefresh_db\fR" 4
.IX Item "refresh_db"
.Vb 1
\&  Openguides::Test::refresh_db();
.Ve
.Sp
Unlink the existing SQLite database t/node.db and Plucene/Lucy indexes.
Then create a new SQLite database t/node.db
.SH "AUTHOR"
.IX Header "AUTHOR"
The OpenGuides Project (openguides\-dev@lists.openguides.org)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 1
\&  Copyright (C) 2004\-2013 The OpenGuides Project.  All Rights Reserved.
.Ve
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.