Grid::Request::Test - Helper funcations for unit Grid::Request tests.

Grid-Request documentation Contained in the Grid-Request distribution.

Index

Code Index:

NAME

Top

Grid::Request::Test - Helper funcations for unit Grid::Request tests.

SYNOPSIS

Top

 use Grid::Request::Test;

 my $project = Grid::Request:Test->get_test_project();

 my $hostname = Grid::Request:Test->get_test_host();

DESCRIPTION

Top

A module that models Grid::Request parameters.

get_test_project();

Description: Retrieves the project to use when running the Grid::Request unit tests. Many of the unit tests trigger actual grid jobs, so the user/tester must be able to specify which project string to use.

Parameters: None.

Returns: A scalar.

get_test_host();

Description: Retrieves the host to use to help test the hosts() method in Grid::Request.

Parameters: None.

Returns: A scalar.

ENVIRONMENT

Top

This module checks for two (2) environment variables:

  GRID_REQUEST_TEST_PROJECT - Used to set the project to use for grid tests.

  GRID_REQUEST_TEST_HOST - Used to set the hostname to use for grid tests
                           which use the Grid::Request hosts() method.

BUGS

Top

None known.

SEE ALSO

Top

 Grid::Request
Grid-Request documentation Contained in the Grid-Request distribution. 
package Grid::Request::Test;


my $GR_PROJECT_NAME = "GRID_REQUEST_TEST_PROJECT";
my $GR_HOST_NAME = "GRID_REQUEST_TEST_HOST";

our $VERSION = '0.9';

sub get_test_project {
    if (exists $ENV{$GR_PROJECT_NAME} &&
        defined $ENV{$GR_PROJECT_NAME} &&
        length($ENV{$GR_PROJECT_NAME})) {

        # Return the value.
        # TODO: Validation.
        return $ENV{$GR_PROJECT_NAME};
    } else {
        warn "Please define the \"$GR_PROJECT_NAME\" environment variable.\n";
        exit 1;
    }
}



sub get_test_host {
    if (exists $ENV{$GR_HOST_NAME} &&
        defined $ENV{$GR_HOST_NAME} &&
        length($ENV{$GR_HOST_NAME})) {

        # Return the value.
        # TODO: Validation.
        return $ENV{$GR_HOST_NAME};
    } else {
        warn "Please define the \"$GR_HOST_NAME\" environment variable.\n";
        exit 1;
    }
}

1;

__END__