Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

Apache::TestConfig

NAME
SYNOPSIS
DESCRIPTION
FUNCTIONS
Environment Variables
Special Placeholders
AUTHOR
SEE ALSO

NAME

Apache::TestConfig −− Test Configuration setup module

SYNOPSIS

  use Apache::TestConfig;
  my $cfg = Apache::TestConfig−>new(%args)
  my $fh = $cfg−>genfile($file);
  $cfg−>writefile($file, $content);
  $cfg−>gendir($dir);
  ...

DESCRIPTION

"Apache::TestConfig" is used in creating the "Apache::Test" configuration files.

FUNCTIONS

genwarning()

my $warn = $cfg−>genwarning($filename)

genwarning() returns a warning string as a comment, saying that the file was autogenerated and that it’s not a good idea to modify this file. After the warning a perl trace of calls to this this function is appended. This trace is useful for finding what code has created the file.

my $warn = $cfg−>genwarning($filename, $from_filename)

If $from_filename is specified it’ll be used in the warning to tell which file it was generated from.

genwarning() automatically recognizes the comment type based on the file extension. If the extension is not recognized, the default "#" style is used.

Currently it support "<!−− −−>", "/* ... */" and "#" styles.

genfile()

my $fh = $cfg−>genfile($file);

genfile() creates a new file $file for writing and returns a file handle.

If parent directories of $file don’t exist they will be automagically created.

The file $file and any created parent directories (if found empty) will be automatically removed on cleanup.

A comment with a warning and calls trace is added to the top of this file. See genwarning() for more info about this comment.

my $fh = $cfg−>genfile($file, $from_file);

If $from_filename is specified it’ll be used in the warning to tell which file it was generated from.

my $fh = $cfg−>genfile($file, $from_file, $nowarning);

If $nowarning is true, the warning won’t be added. If using this optional argument and there is no $from_file you must pass undef as in:

my $fh = $cfg−>genfile($file, undef, $nowarning);

writefile()

$cfg−>writefile($file, $content, [$nowarning]);

writefile() creates a new file $file with the content of $content.

A comment with a warning and calls trace is added to the top of this file unless $nowarnings is passed and set to a true value. See genwarning() for more info about this comment.

If parent directories of $file don’t exist they will be automagically created.

The file $file and any created parent directories (if found empty) will be automatically removed on cleanup.

write_perlscript()

$cfg−>write_perlscript($filename, @lines);

Similar to writefile() but creates an executable Perl script with correctly set shebang line.

gendir()

$cfg−>gendir($dir);

gendir() creates a new directory $dir.

If parent directories of $dir don’t exist they will be automagically created.

The directory $dir and any created parent directories will be automatically removed on cleanup if found empty.

Environment Variables

The following environment variables affect the configuration and the run-time of the "Apache::Test" framework:

APACHE_TEST_COLOR
To aid visual control over the configuration process and the run-time phase, "Apache::Test" uses coloured fonts when the environment variable "APACHE_TEST_COLOR" is set to a true value.

APACHE_TEST_LIVE_DEV
When using "Apache::Test" during the project development phase, it’s often convenient to have the project/lib (live) directory appearing first in @INC so any changes to the Perl modules, residing in it, immediately affect the server, without a need to rerun "make" to update blib/lib. When the environment variable "APACHE_TEST_LIVE_DEV" is set to a true value during the configuration phase ("t/TEST −config", "Apache::Test" will automatically unshift the project/lib directory into @INC, via the autogenerated t/conf/modperl_inc.pl file.

Special Placeholders

When generating configuration files from the *.in templates, special placeholder variables get substituted. To embed a placeholder use the "@foo@" syntax. For example in extra.conf.in you can write:

Include @ServerRoot@/conf/myconfig.conf

When extra.conf is generated, "@ServerRoot@" will get replaced with the location of the server root.

Placeholders are case-insensitive.

Available placeholders:

Configuration Options
All configuration variables that can be passed to "t/TEST", such as "MaxClients", "DocumentRoot", "ServerRoot", etc. To see the complete list run:

% t/TEST −−help

and you will find them in the "configuration options" sections.

NextAvailablePort
Every time this placeholder is encountered it’ll be replaced with the next available port. This is very useful if you need to allocate a special port, but not hardcode it. Later when running:

% t/TEST −port=select

it’s possible to run several concurrent test suites on the same machine, w/o having port collisions.

AUTHOR

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.