[p5sagit/p5-mst-13.2.git] / cpan / CPANPLUS / t / inc / conf.pl

### On VMS, the ENV is not reset after the program terminates.
### So reset it here explicitly
my ($old_env_path, $old_env_perl5lib);
BEGIN {
    use FindBin; 
    use File::Spec;
    
    ### paths to our own 'lib' and 'inc' dirs
    ### include them, relative from t/
    my @paths   = map { "$FindBin::Bin/$_" } qw[../lib inc];

    ### absolute'ify the paths in @INC;
    my @rel2abs = map { File::Spec->rel2abs( $_ ) }
                    grep { not File::Spec->file_name_is_absolute( $_ ) } @INC;
    
    ### use require to make devel::cover happy
    require lib;
    for ( @paths, @rel2abs ) { 
        my $l = 'lib'; 
        $l->import( $_ ) 
    }

    use Config;

    ### and add them to the environment, so shellouts get them
    $old_env_perl5lib = $ENV{'PERL5LIB'};
    $ENV{'PERL5LIB'}  = join $Config{'path_sep'}, 
                        grep { defined } $ENV{'PERL5LIB'}, @paths, @rel2abs;
    
    ### add our own path to the front of $ENV{PATH}, so that cpanp-run-perl
    ### and friends get picked up
    $old_env_path = $ENV{PATH};
    if ( $ENV{PERL_CORE} ) {
      $ENV{'PATH'}  = join $Config{'path_sep'},
                    grep { defined } "$FindBin::Bin/../../../utils", $ENV{'PATH'};
    }
    else {
      $ENV{'PATH'}  = join $Config{'path_sep'},
                    grep { defined } "$FindBin::Bin/../bin", $ENV{'PATH'};
    }

    ### Fix up the path to perl, as we're about to chdir
    ### but only under perlcore, or if the path contains delimiters,
    ### meaning it's relative, but not looked up in your $PATH
    $^X = File::Spec->rel2abs( $^X ) 
        if $ENV{PERL_CORE} or ( $^X =~ m|[/\\]| );

    ### chdir to our own test dir, so we know all files are relative 
    ### to this point, no matter whether run from perlcore tests or
    ### regular CPAN installs
    chdir "$FindBin::Bin" if -d "$FindBin::Bin"
}

BEGIN {
    use IPC::Cmd;
   
    ### Win32 has issues with redirecting FD's properly in IPC::Run:
    ### Can't redirect fd #4 on Win32 at IPC/Run.pm line 2801
    $IPC::Cmd::USE_IPC_RUN = 0 if $^O eq 'MSWin32';
    $IPC::Cmd::USE_IPC_RUN = 0 if $^O eq 'MSWin32';
}

### Use a $^O comparison, as depending on module at this time
### may cause weird errors/warnings
END {
    if ($^O eq 'VMS') {
        ### VMS environment variables modified by this test need to be put back
        ### path is "magic" on VMS, we can not tell if it really existed before
        ### this was run, because VMS will magically pretend that a PATH
        ### environment variable exists set to the current working directory
        $ENV{PATH} = $old_env_path;

        if (defined $old_env_perl5lib) {
            $ENV{PERL5LIB} = $old_env_perl5lib;
        } else {
            delete $ENV{PERL5LIB};
        }
    }
}

use strict;
use CPANPLUS::Configure;
use CPANPLUS::Error ();

use File::Path      qw[rmtree];
use FileHandle;
use File::Basename  qw[basename];

{   ### Force the ignoring of .po files for L::M::S
    $INC{'Locale::Maketext::Lexicon.pm'} = __FILE__;
    $Locale::Maketext::Lexicon::VERSION = 0;
}

my $Env = 'PERL5_CPANPLUS_TEST_VERBOSE';

# prereq has to be in our package file && core!
use constant TEST_CONF_PREREQ           => 'Cwd';   
use constant TEST_CONF_MODULE           => 'Foo::Bar::EU::NOXS';
use constant TEST_CONF_MODULE_SUB       => 'Foo::Bar::EU::NOXS::Sub';
use constant TEST_CONF_AUTHOR           => 'EUNOXS';
use constant TEST_CONF_INST_MODULE      => 'Foo::Bar';
use constant TEST_CONF_INVALID_MODULE   => 'fnurk';
use constant TEST_CONF_MIRROR_DIR       => 'dummy-localmirror';
use constant TEST_CONF_CPAN_DIR         => 'dummy-CPAN';
use constant TEST_CONF_CPANPLUS_DIR     => 'dummy-cpanplus';
use constant TEST_CONF_INSTALL_DIR      => File::Spec->rel2abs(
                                                File::Spec->catdir(      
                                                    TEST_CONF_CPANPLUS_DIR,
                                                    'install'
                                                )
                                            );

sub dummy_cpan_dir {
    ### VMS needs this in directory format for rel2abs
    my $test_dir = $^O eq 'VMS'
                    ? File::Spec->catdir(TEST_CONF_CPAN_DIR)
                    : TEST_CONF_CPAN_DIR;

    ### Convert to an absolute file specification
    my $abs_test_dir = File::Spec->rel2abs($test_dir);
    
    ### According to John M: the hosts path needs to be in UNIX format.  
    ### File::Spec::Unix->rel2abs does not work at all on VMS
    $abs_test_dir    = VMS::Filespec::unixify( $abs_test_dir ) if $^O eq 'VMS';

    return $abs_test_dir;
}

sub gimme_conf { 

    ### don't load any other configs than the heuristic one
    ### during tests. They might hold broken/incorrect data
    ### for our test suite. Bug [perl #43629] showed this.
    my $conf = CPANPLUS::Configure->new( load_configs => 0 );

    my $dummy_cpan = dummy_cpan_dir();
    
    $conf->set_conf( hosts  => [ { 
                        path        => $dummy_cpan,
                        scheme      => 'file',
                    } ],      
    );
    $conf->set_conf( base       => File::Spec->rel2abs(TEST_CONF_CPANPLUS_DIR));
    $conf->set_conf( dist_type  => '' );
    $conf->set_conf( signature  => 0 );
    $conf->set_conf( verbose    => 1 ) if $ENV{ $Env };
    
    ### never use a pager in the test suite
    $conf->set_program( pager   => '' );

    ### dmq tells us that we should run with /nologo
    ### if using nmake, as it's very noisy otherwise.
    {   my $make = $conf->get_program('make');
        if( $make and basename($make) =~ /^nmake/i ) {
            $conf->set_conf( makeflags => '/nologo' );
        }
    }

    ### CPANPLUS::Config checks 3 specific scenarios first
    ### when looking for cpanp-run-perl: parallel to cpanp,
    ### parallel to CPANPLUS.pm, or installed into a custom
    ### prefix like /tmp/foo. Only *THEN* does it check the
    ### the path.
    ### If the perl core is extracted to a directory that has
    ### cpanp-run-perl installed the same amount of 'uplevels'
    ### as the /tmp/foo prefix, we'll pull in the wrong script
    ### by accident.
    ### Since we set the path to cpanp-run-perl explicitily
    ### at the top of this script, it's best to update the config
    ### ourselves with a path lookup, rather than rely on its
    ### heuristics. Thanks to David Wheeler, Josh Jore and Vincent
    ### Pit for helping to track this down.
    if( $ENV{PERL_CORE} ) {
        $conf->set_program( "perlwrapper" => IPC::Cmd::can_run('cpanp-run-perl') );
    }

    $conf->set_conf( source_engine =>  $ENV{CPANPLUS_SOURCE_ENGINE} )
        if $ENV{CPANPLUS_SOURCE_ENGINE};
    
    _clean_test_dir( [
        $conf->get_conf('base'),     
        TEST_CONF_MIRROR_DIR,
#         TEST_INSTALL_DIR_LIB,
#         TEST_INSTALL_DIR_BIN,
#         TEST_INSTALL_DIR_MAN1, 
#         TEST_INSTALL_DIR_MAN3,
    ], (  $ENV{PERL_CORE} ? 0 : 1 ) );
        
    return $conf;
};

{
    my $fh;
    my $file = ".".basename($0).".output";
    sub output_handle {
        return $fh if $fh;
        
        $fh = FileHandle->new(">$file")
                    or warn "Could not open output file '$file': $!";
       
        $fh->autoflush(1);
        return $fh;
    }
    
    sub output_file { return $file }
    
    
    ### redirect output from msg() and error() output to file
    unless( $ENV{$Env} ) {
    
        print "# To run tests in verbose mode, set ".
              "\$ENV{$Env} = 1\n" unless $ENV{PERL_CORE};
    
        1 while unlink $file;   # just in case
    
        $CPANPLUS::Error::ERROR_FH  =
        $CPANPLUS::Error::ERROR_FH  = output_handle();
        
        $CPANPLUS::Error::MSG_FH    =
        $CPANPLUS::Error::MSG_FH    = output_handle();
        
    }        
}


### clean these files if we're under perl core
END { 
    if ( $ENV{PERL_CORE} ) {
        close output_handle(); 1 while unlink output_file();

        _clean_test_dir( [
            gimme_conf->get_conf('base'),   
            TEST_CONF_MIRROR_DIR,
    #         TEST_INSTALL_DIR_LIB,
    #         TEST_INSTALL_DIR_BIN,
    #         TEST_INSTALL_DIR_MAN1, 
    #         TEST_INSTALL_DIR_MAN3,
        ], 0 ); # DO NOT be verbose under perl core -- makes tests fail
    }
}

### whenever we start a new script, we want to clean out our
### old files from the test '.cpanplus' dir..
sub _clean_test_dir {
    my $dirs    = shift || [];
    my $verbose = shift || 0;

    for my $dir ( @$dirs ) {

        ### no point if it doesn't exist;
        next unless -d $dir;

        my $dh;
        opendir $dh, $dir or die "Could not open basedir '$dir': $!";
        while( my $file = readdir $dh ) { 
            next if $file =~ /^\./;  # skip dot files
            
            my $path = File::Spec->catfile( $dir, $file );
            
            ### directory, rmtree it
            if( -d $path ) {

                ### John Malmberg reports yet another VMS issue:
                ### A directory name on VMS in VMS format ends with .dir 
                ### when it is referenced as a file.
                ### In UNIX format traditionally PERL on VMS does not remove the
                ### '.dir', however the VMS C library conversion routines do
                ### remove the '.dir' and the VMS C library routines can not 
                ### handle the '.dir' being present on UNIX format filenames.
                ### So code doing the fixup has on VMS has to be able to handle 
                ### both UNIX format names and VMS format names. 
                
                ### XXX See http://www.xray.mpe.mpg.de/
                ### mailing-lists/perl5-porters/2007-10/msg00064.html
                ### for details -- the below regex could use some touchups
                ### according to John. M.            
                $file =~ s/\.dir$//i if $^O eq 'VMS';
                
                my $dirpath = File::Spec->catdir( $dir, $file );

                print "# Deleting directory '$dirpath'\n" if $verbose;
                eval { rmtree( $dirpath ) };
                warn "Could not delete '$dirpath' while cleaning up '$dir'" 
                    if $@;
           
            ### regular file
            } else {
                print "# Deleting file '$path'\n" if $verbose;
                1 while unlink $path;
            }            
        }       
    
        close $dh;
    }
    
    return 1;
}
1;
Commit	Line	Data
5bc5f6dc	1	### On VMS, the ENV is not reset after the program terminates.
	2	### So reset it here explicitly
	3	my ($old_env_path, $old_env_perl5lib);
6aaee015	4	BEGIN {
	5	use FindBin;
	6	use File::Spec;
	7
	8	### paths to our own 'lib' and 'inc' dirs
	9	### include them, relative from t/
	10	my @paths = map { "$FindBin::Bin/$_" } qw[../lib inc];
	11
	12	### absolute'ify the paths in @INC;
	13	my @rel2abs = map { File::Spec->rel2abs( $_ ) }
	14	grep { not File::Spec->file_name_is_absolute( $_ ) } @INC;
	15
	16	### use require to make devel::cover happy
	17	require lib;
	18	for ( @paths, @rel2abs ) {
	19	my $l = 'lib';
	20	$l->import( $_ )
	21	}
	22
	23	use Config;
	24
	25	### and add them to the environment, so shellouts get them
5bc5f6dc	26	$old_env_perl5lib = $ENV{'PERL5LIB'};
768b421c	27	$ENV{'PERL5LIB'} = join $Config{'path_sep'},
6aaee015	28	grep { defined } $ENV{'PERL5LIB'}, @paths, @rel2abs;
	29
	30	### add our own path to the front of $ENV{PATH}, so that cpanp-run-perl
	31	### and friends get picked up
5bc5f6dc	32	$old_env_path = $ENV{PATH};
983cf2d8	33	if ( $ENV{PERL_CORE} ) {
	34	$ENV{'PATH'} = join $Config{'path_sep'},
	35	grep { defined } "$FindBin::Bin/../../../utils", $ENV{'PATH'};
	36	}
	37	else {
	38	$ENV{'PATH'} = join $Config{'path_sep'},
6aaee015	39	grep { defined } "$FindBin::Bin/../bin", $ENV{'PATH'};
983cf2d8	40	}
6aaee015	41
	42	### Fix up the path to perl, as we're about to chdir
	43	### but only under perlcore, or if the path contains delimiters,
	44	### meaning it's relative, but not looked up in your $PATH
	45	$^X = File::Spec->rel2abs( $^X )
	46	if $ENV{PERL_CORE} or ( $^X =~ m\|[/\\]\| );
	47
	48	### chdir to our own test dir, so we know all files are relative
	49	### to this point, no matter whether run from perlcore tests or
	50	### regular CPAN installs
	51	chdir "$FindBin::Bin" if -d "$FindBin::Bin"
	52	}
	53
	54	BEGIN {
	55	use IPC::Cmd;
	56
	57	### Win32 has issues with redirecting FD's properly in IPC::Run:
	58	### Can't redirect fd #4 on Win32 at IPC/Run.pm line 2801
	59	$IPC::Cmd::USE_IPC_RUN = 0 if $^O eq 'MSWin32';
	60	$IPC::Cmd::USE_IPC_RUN = 0 if $^O eq 'MSWin32';
	61	}
	62
5bc5f6dc	63	### Use a $^O comparison, as depending on module at this time
	64	### may cause weird errors/warnings
	65	END {
	66	if ($^O eq 'VMS') {
	67	### VMS environment variables modified by this test need to be put back
	68	### path is "magic" on VMS, we can not tell if it really existed before
	69	### this was run, because VMS will magically pretend that a PATH
	70	### environment variable exists set to the current working directory
75046b50	71	$ENV{PATH} = $old_env_path;
5bc5f6dc	72
75046b50	73	if (defined $old_env_perl5lib) {
75046b50	74	$ENV{PERL5LIB} = $old_env_perl5lib;
5bc5f6dc	75	} else {
	76	delete $ENV{PERL5LIB};
	77	}
	78	}
	79	}
	80
6aaee015	81	use strict;
6aaee015	82	use CPANPLUS::Configure;
983ffab6	83	use CPANPLUS::Error ();
6aaee015	84
	85	use File::Path qw[rmtree];
	86	use FileHandle;
	87	use File::Basename qw[basename];
	88
	89	{ ### Force the ignoring of .po files for L::M::S
	90	$INC{'Locale::Maketext::Lexicon.pm'} = __FILE__;
	91	$Locale::Maketext::Lexicon::VERSION = 0;
	92	}
	93
5bc5f6dc	94	my $Env = 'PERL5_CPANPLUS_TEST_VERBOSE';
5bc5f6dc	95
6aaee015	96	# prereq has to be in our package file && core!
	97	use constant TEST_CONF_PREREQ => 'Cwd';
	98	use constant TEST_CONF_MODULE => 'Foo::Bar::EU::NOXS';
5879cbe1	99	use constant TEST_CONF_MODULE_SUB => 'Foo::Bar::EU::NOXS::Sub';
5bc5f6dc	100	use constant TEST_CONF_AUTHOR => 'EUNOXS';
6aaee015	101	use constant TEST_CONF_INST_MODULE => 'Foo::Bar';
6aaee015	102	use constant TEST_CONF_INVALID_MODULE => 'fnurk';
494f1016	103	use constant TEST_CONF_MIRROR_DIR => 'dummy-localmirror';
5bc5f6dc	104	use constant TEST_CONF_CPAN_DIR => 'dummy-CPAN';
4443dd53	105	use constant TEST_CONF_CPANPLUS_DIR => 'dummy-cpanplus';
	106	use constant TEST_CONF_INSTALL_DIR => File::Spec->rel2abs(
	107	File::Spec->catdir(
	108	TEST_CONF_CPANPLUS_DIR,
	109	'install'
	110	)
20afcebf	111	);
6aaee015	112
4443dd53	113	sub dummy_cpan_dir {
5879cbe1	114	### VMS needs this in directory format for rel2abs
	115	my $test_dir = $^O eq 'VMS'
	116	? File::Spec->catdir(TEST_CONF_CPAN_DIR)
	117	: TEST_CONF_CPAN_DIR;
	118
	119	### Convert to an absolute file specification
	120	my $abs_test_dir = File::Spec->rel2abs($test_dir);
	121
	122	### According to John M: the hosts path needs to be in UNIX format.
	123	### File::Spec::Unix->rel2abs does not work at all on VMS
	124	$abs_test_dir = VMS::Filespec::unixify( $abs_test_dir ) if $^O eq 'VMS';
4443dd53	125
	126	return $abs_test_dir;
	127	}
	128
	129	sub gimme_conf {
	130
	131	### don't load any other configs than the heuristic one
	132	### during tests. They might hold broken/incorrect data
	133	### for our test suite. Bug [perl #43629] showed this.
	134	my $conf = CPANPLUS::Configure->new( load_configs => 0 );
	135
	136	my $dummy_cpan = dummy_cpan_dir();
5879cbe1	137
6aaee015	138	$conf->set_conf( hosts => [ {
4443dd53	139	path => $dummy_cpan,
6aaee015	140	scheme => 'file',
	141	} ],
	142	);
4443dd53	143	$conf->set_conf( base => File::Spec->rel2abs(TEST_CONF_CPANPLUS_DIR));
6aaee015	144	$conf->set_conf( dist_type => '' );
6aaee015	145	$conf->set_conf( signature => 0 );
5bc5f6dc	146	$conf->set_conf( verbose => 1 ) if $ENV{ $Env };
	147
	148	### never use a pager in the test suite
	149	$conf->set_program( pager => '' );
6aaee015	150
622d31ac	151	### dmq tells us that we should run with /nologo
74ae8479	152	### if using nmake, as it's very noisy otherwise.
622d31ac	153	{ my $make = $conf->get_program('make');
74ae8479	154	if( $make and basename($make) =~ /^nmake/i ) {
74ae8479	155	$conf->set_conf( makeflags => '/nologo' );
622d31ac	156	}
622d31ac	157	}
4443dd53	158
8c576062	159	### CPANPLUS::Config checks 3 specific scenarios first
	160	### when looking for cpanp-run-perl: parallel to cpanp,
	161	### parallel to CPANPLUS.pm, or installed into a custom
	162	### prefix like /tmp/foo. Only THEN does it check the
	163	### the path.
	164	### If the perl core is extracted to a directory that has
	165	### cpanp-run-perl installed the same amount of 'uplevels'
	166	### as the /tmp/foo prefix, we'll pull in the wrong script
	167	### by accident.
	168	### Since we set the path to cpanp-run-perl explicitily
	169	### at the top of this script, it's best to update the config
	170	### ourselves with a path lookup, rather than rely on its
	171	### heuristics. Thanks to David Wheeler, Josh Jore and Vincent
	172	### Pit for helping to track this down.
	173	if( $ENV{PERL_CORE} ) {
	174	$conf->set_program( "perlwrapper" => IPC::Cmd::can_run('cpanp-run-perl') );
	175	}
	176
4443dd53	177	$conf->set_conf( source_engine => $ENV{CPANPLUS_SOURCE_ENGINE} )
4443dd53	178	if $ENV{CPANPLUS_SOURCE_ENGINE};
622d31ac	179
6aaee015	180	_clean_test_dir( [
6aaee015	181	$conf->get_conf('base'),
494f1016	182	TEST_CONF_MIRROR_DIR,
6aaee015	183	# TEST_INSTALL_DIR_LIB,
	184	# TEST_INSTALL_DIR_BIN,
	185	# TEST_INSTALL_DIR_MAN1,
	186	# TEST_INSTALL_DIR_MAN3,
53873a16	187	], ( $ENV{PERL_CORE} ? 0 : 1 ) );
6aaee015	188
	189	return $conf;
	190	};
	191
494f1016	192	{
	193	my $fh;
	194	my $file = ".".basename($0).".output";
	195	sub output_handle {
	196	return $fh if $fh;
	197
	198	$fh = FileHandle->new(">$file")
	199	or warn "Could not open output file '$file': $!";
	200
	201	$fh->autoflush(1);
	202	return $fh;
	203	}
6aaee015	204
494f1016	205	sub output_file { return $file }
983ffab6	206
983ffab6	207
5bc5f6dc	208
983ffab6	209	### redirect output from msg() and error() output to file
5bc5f6dc	210	unless( $ENV{$Env} ) {
983ffab6	211
983ffab6	212	print "# To run tests in verbose mode, set ".
5bc5f6dc	213	"\$ENV{$Env} = 1\n" unless $ENV{PERL_CORE};
983ffab6	214
5bc5f6dc	215	1 while unlink $file; # just in case
983ffab6	216
	217	$CPANPLUS::Error::ERROR_FH =
	218	$CPANPLUS::Error::ERROR_FH = output_handle();
	219
	220	$CPANPLUS::Error::MSG_FH =
	221	$CPANPLUS::Error::MSG_FH = output_handle();
	222
	223	}
6aaee015	224	}
6aaee015	225
494f1016	226
	227	### clean these files if we're under perl core
	228	END {
	229	if ( $ENV{PERL_CORE} ) {
	230	close output_handle(); 1 while unlink output_file();
	231
	232	_clean_test_dir( [
	233	gimme_conf->get_conf('base'),
	234	TEST_CONF_MIRROR_DIR,
	235	# TEST_INSTALL_DIR_LIB,
	236	# TEST_INSTALL_DIR_BIN,
	237	# TEST_INSTALL_DIR_MAN1,
	238	# TEST_INSTALL_DIR_MAN3,
53873a16	239	], 0 ); # DO NOT be verbose under perl core -- makes tests fail
494f1016	240	}
	241	}
	242
6aaee015	243	### whenever we start a new script, we want to clean out our
	244	### old files from the test '.cpanplus' dir..
	245	sub _clean_test_dir {
	246	my $dirs = shift \|\| [];
	247	my $verbose = shift \|\| 0;
	248
	249	for my $dir ( @$dirs ) {
	250
53873a16	251	### no point if it doesn't exist;
	252	next unless -d $dir;
	253
6aaee015	254	my $dh;
	255	opendir $dh, $dir or die "Could not open basedir '$dir': $!";
	256	while( my $file = readdir $dh ) {
	257	next if $file =~ /^\./; # skip dot files
	258
	259	my $path = File::Spec->catfile( $dir, $file );
	260
	261	### directory, rmtree it
	262	if( -d $path ) {
5879cbe1	263
	264	### John Malmberg reports yet another VMS issue:
	265	### A directory name on VMS in VMS format ends with .dir
	266	### when it is referenced as a file.
	267	### In UNIX format traditionally PERL on VMS does not remove the
	268	### '.dir', however the VMS C library conversion routines do
	269	### remove the '.dir' and the VMS C library routines can not
	270	### handle the '.dir' being present on UNIX format filenames.
	271	### So code doing the fixup has on VMS has to be able to handle
	272	### both UNIX format names and VMS format names.
	273
	274	### XXX See http://www.xray.mpe.mpg.de/
	275	### mailing-lists/perl5-porters/2007-10/msg00064.html
	276	### for details -- the below regex could use some touchups
	277	### according to John. M.
75046b50	278	$file =~ s/\.dir$//i if $^O eq 'VMS';
5879cbe1	279
	280	my $dirpath = File::Spec->catdir( $dir, $file );
	281
	282	print "# Deleting directory '$dirpath'\n" if $verbose;
	283	eval { rmtree( $dirpath ) };
	284	warn "Could not delete '$dirpath' while cleaning up '$dir'"
	285	if $@;
6aaee015	286
	287	### regular file
	288	} else {
983ffab6	289	print "# Deleting file '$path'\n" if $verbose;
6aaee015	290	1 while unlink $path;
	291	}
	292	}
	293
	294	close $dh;
	295	}
	296
	297	return 1;
	298	}
	299	1;