Run::Env - running environment detection


Run-Env documentation Contained in the Run-Env distribution.

Index


Code Index:

NAME

Top

Run::Env - running environment detection

SYNOPSIS

Top

	MyLogger->set_log_level('ERROR')
		if Run::Env::production;

	my $config = 'config.cfg';
	$config = 'test-config.cfg'
		if Run::Env::testing;

	print Dumper \$config
		if Run::Env::debug;

	print 'Content-Type: text/html'
		if Run::Env::cgi || Run::Env::mod_perl;

DESCRIPTION

Top

Usefull in cases if the program/script should behave in slightly different way depending on if it's run on developers machine, user acceptance test server, staging server or a production server.

There can be 4 running environments:

	qw{
		development
        uat
		staging
		production
	}

'development' are machines that the developers run. 'uat' is where the code is internally tested. 'staging' is where the code is tested just before deployment to the production. 'production' is the wilde world in production.

There can be 3 execution modes:

	qw{
		cgi
		mod_perl
		shell
	};




In all of them we can turn on debugging.

In all of them we can set testing. That is when the tests are run.

Module is using module global variables to store envs and modes so the first time it is initialized/set it will be the same in all other modules that use it as well. Module is also using %ENV variables ('RUN_ENV_*') so that the initialized/set envs and modes are propagated to the shell scripts that can be executed by system() or ``.

USAGE EXAMPLES

Top

According to the Run::Env decide what logleves to show in the logger. Disable debug and info and show only errors.

When running tests you can skip (or include) particular tests depending if run on a developer, an uat, a staging or a production machine.

If running in testing mode configuration loading and parsing module can decide to include additional path (ex. ./) to search for a configuration.

Disable access to some special web test sections if running in production.

METHODS

Top

import()

You can pass any running environment or execution environment or 'testing' or 'debug' to force them, '-debug', '-testing' to clear them.

	use Run::Env qw( testing debug );
	# or
	use Run::Env 'production';
	# or
	use Run::Env '-debug';

running environment

detect_running_env()

Detects in which environment are we running. First checks the $ENV{'RUN_ENV_current'} and then check for a presence of special file in system configuration directories. Currently is lookup for:

	/etc/development-machine
	/etc/uat-machine
	/etc/staging-machine

The default running environment is production.

current()

Return current running environment.

dev()

development()

Return true/false if curently running in development environment.

uat()

Return true/false if curently running in uat environment.

stg()

staging()

Return true/false if curently running in staging environment.

prod()

production()

Return true/false if curently running in production environment.

set($running_env)

Set one of the 'development', 'uat', 'staging', 'production' that is passed as argument.

set_development()

Set running environment to development.

set_uat()

Set running environment to uat.

set_staging()

Set running environment to staging.

set_production()

Set running environment to production.

debug mode

debug()

Return true/false if curently running with debug on.

set_debug()

Turn on debug mode.

Option is to pass an argument then the debug status is set depending on that argument.

clear_debug()

Turn off debug.

detect_debug()

Detect if debug is on or off.

On if $ENV{'RUN_ENV_debug'} set and true or if any of the @ARGV is '--debug'.

execution mode

execution()

Return how the script is executed: cgi || mod_perl || shell.

cgi()

Return true/false if script is executed as cgi.

mod_perl()

Return true/false if script is executed in mod_perl.

shell()

Return true/false if script is executed as schell script.

set_execution()

Set current execution mode.

detect_execution()

Detect execution mode based on the %ENV variables. 'mod_perl if '$ENV{'MOD_PERL'} is set. 'cgi' if $ENV{'REQUEST_METHOD'} is set. Otherwise 'shell'.

set_cgi()

Set execution mode to cgi.

set_mod_perl()

Set execution mode to mod_perl.

set_shell()

Set execution mode to shell.

testing mode

testing()

Return true/false if script is executed in testing mode.

detect_testing

Try to detect testing mode. Checks for $ENV{'RUN_ENV_testing'} or it the current working folder is 't/'.

set_testing

Turn on testing mode.

clear_testing

Turn off testing mode.

SEE ALSO

Top

http://dltj.org/article/software-development-practice/, http://spacebug.com/effective_development_environments/

AUTHOR

Top

Jozef Kutej

LICENSE AND COPYRIGHT

Top


Run-Env documentation Contained in the Run-Env distribution.

package Run::Env;

use warnings;
use strict;

use Carp::Clan ();
use File::Spec ();
use FindBin::Real ();
use List::MoreUtils 'any';

our $VERSION = '0.08';


our @running_envs =	qw{
	development
	uat
	staging
	production
};

our @execution_modes = qw{
	cgi
	mod_perl
	shell
};


my $os_root_dir  = File::Spec->rootdir();
our @os_conf_location = ($os_root_dir, 'etc');

sub import {
	my $class = shift;
	
	foreach my $env (@_) {
		next if not $env;
		
		  $env eq 'testing'  ? set_testing()
		: $env eq '-testing' ? clear_testing()
		: $env eq 'debug'    ? set_debug()
		: $env eq '-debug'   ? clear_debug()
		: any { $env eq $_ } @running_envs
		                     ? set($env)
		: any { $env eq $_ } @execution_modes
		                     ? set_execution($env)
		: Carp::Clan::croak 'no such env/mode: '.$env
	}
}

do {
	our $running_env    = set(detect_running_env());
		
	sub detect_running_env {
		return $ENV{'RUN_ENV_current'}
			if $ENV{'RUN_ENV_current'};
	
		return 'development'
			if (-e File::Spec->catfile(@os_conf_location, 'development-machine'));
		return 'uat'
			if (-e File::Spec->catfile(@os_conf_location, 'uat-machine'));
		return 'staging'
			if (-e File::Spec->catfile(@os_conf_location, 'staging-machine'));
	
		# default is production
		return 'production';
	}

	sub _decide {
		return 1 if $running_env eq shift;
		return 0;	
	}

	sub _set {
		my $set_running_env = shift;
		$running_env = $set_running_env;
		$ENV{'RUN_ENV_current'} = $set_running_env; 
	}

	sub current {
		return $running_env;
	}
	
	*dev = *development; 
	sub development {
		return _decide('development');
	}
	
	sub uat {
		return _decide('uat');
	}
	
	*stg = *staging;
	sub staging {
		return _decide('staging');
	}
	
	*prod = *production;
	sub production {
		return _decide('production');
	}
	
	sub set {
		my $set_running_env = shift;
		
		if ($set_running_env eq 'development') {
			set_development();
		}
		elsif ($set_running_env eq 'uat') {
			set_uat();
		}
		elsif ($set_running_env eq 'staging') {
			set_staging();
		}
		elsif ($set_running_env eq 'production') {
			set_production();
		}
		else {
			Carp::Clan::croak 'no such running environment: '.$set_running_env;
		}
	}
	
	sub set_development {
		_set('development');
	}
	
	sub set_uat {
		_set('uat');
	}
	
	sub set_staging {
		_set('staging');
	}
	
	sub set_production {
		_set('production'); 
	}

};

do {
	our $debug_mode = set_debug(detect_debug());
	
	sub detect_debug {
		return 1 if $ENV{'RUN_ENV_debug'};
		return 1 if any { $_ eq '--debug' } @ARGV;
		return 0;
	}

	sub debug {
		return $debug_mode;
	}
	
	sub set_debug {
		# turn on debugging when called whitout argument
		return set_debug(1) if (@_ == 0);
		
		$debug_mode = shift;
		if ($debug_mode) {
			$ENV{'RUN_ENV_debug'} = $debug_mode;
		}
		else {
			clear_debug();
		}
	}
	
	sub clear_debug {
		$debug_mode = 0;
		delete $ENV{'RUN_ENV_debug'};
	}	
};


do {
	our $execution_mode = set_execution(detect_execution());

	sub detect_execution {
		return 'mod_perl'
			if exists $ENV{'MOD_PERL'};
		return 'cgi'
			if exists $ENV{'REQUEST_METHOD'};
		return 'shell';
	}

	sub _decide_execution {
		return 1 if $execution_mode eq shift;
		return 0;	
	}
    
	sub execution {
		return $execution_mode;
	}
	
	sub cgi {
		return _decide_execution('cgi');
	}
		
	sub mod_perl {
		return _decide_execution('mod_perl');
	}
		
	sub shell {
		return _decide_execution('shell');
	}
	
	sub set_execution {
		my $set_execution = shift;
		
		if ($set_execution eq 'cgi') {
			set_cgi();
		}
		elsif ($set_execution eq 'mod_perl') {
			set_mod_perl();
		}
		elsif ($set_execution eq 'shell') {
			set_shell();
		}
		else {
			Carp::Clan::croak 'no such execution mode: '.$set_execution;
		}
	}
	
	sub set_cgi {
		_set_execution('cgi');
	}

	sub set_mod_perl {
		_set_execution('mod_perl');
	}

	sub set_shell {
		_set_execution('shell');
	}

	sub _set_execution {
		my $set_execution = shift;
		$execution_mode = $set_execution;
	}
	
};

do {
	our $testing = set_testing(detect_testing());
	
	sub detect_testing {
		return 1
			if $ENV{'RUN_ENV_testing'};
	
		# testing if current folder is 't'
		my @bin = eval { FindBin::Real::Bin() } || File::Spec->rootdir();
		my @current_path = File::Spec->splitdir(@bin);
		return 1
			if (pop @current_path eq 't');
	
		return 0;
	}

	sub testing {
		return $testing;
	}
	
	sub set_testing {
		# turn on testing when called whitout argument
		return set_testing(1) if (@_ == 0);

		$testing = shift;
		if ($testing) {
			$ENV{'RUN_ENV_testing'} = $testing;
		}
		else {
			clear_testing();
		}
	}
	
	sub clear_testing {
		$testing = 0;
		delete $ENV{'RUN_ENV_testing'};
	}
};


qq/ I wonder what is Domm actually listenning to at the moment ;) /;


__END__