From: Dagfinn Ilmari Mannsåker Date: Sat, 13 Jun 2015 13:06:35 +0000 (+0100) Subject: Import the latest ::Optional::Dependencies from DBIC X-Git-Tag: 0.07044~13 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-Schema-Loader.git;a=commitdiff_plain;h=406a97c2aab476c7a52f7c623a95f275eeb376f3 Import the latest ::Optional::Dependencies from DBIC There should be no behavioural changes, only less code and time spent skipping things. --- diff --git a/Makefile.PL b/Makefile.PL index e7573a7..4463582 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -91,9 +91,15 @@ if ($Module::Install::AUTHOR && ! $args->{skip_author_deps}) { require DBIx::Class::Schema::Loader::Optional::Dependencies; - test_requires map %$_, values %{ DBIx::Class::Schema::Loader::Optional::Dependencies->req_group_list }; - - DBIx::Class::Schema::Loader::Optional::Dependencies->_gen_pod; + test_requires %{DBIx::Class::Schema::Loader::Optional::Dependencies + ->modreq_list_for([ + grep { !/rdbms/ } + keys %{ DBIx::Class::Schema::Loader::Optional::Dependencies + ->req_group_list + } + ])}; + + DBIx::Class::Schema::Loader::Optional::Dependencies->_gen_pod(undef, 'lib'); readme_from( 'lib/DBIx/Class/Schema/Loader.pm' ); realclean_files( qw[README MANIFEST lib/DBIx/Class/Schema/Loader/Optional/Dependencies.pod] ); diff --git a/lib/DBIx/Class/Schema/Loader/Optional/Dependencies.pm b/lib/DBIx/Class/Schema/Loader/Optional/Dependencies.pm index 0e53541..6c886dd 100644 --- a/lib/DBIx/Class/Schema/Loader/Optional/Dependencies.pm +++ b/lib/DBIx/Class/Schema/Loader/Optional/Dependencies.pm @@ -1,11 +1,19 @@ package DBIx::Class::Schema::Loader::Optional::Dependencies; -use warnings; -use strict; - -use Carp; +### This may look crazy, but it in fact tangibly ( by 50(!)% ) shortens +# the skip-test time when everything requested is unavailable +BEGIN { + if ( $ENV{RELEASE_TESTING} ) { + require warnings and warnings->import; + require strict and strict->import; + } +} -# Stolen from DBIx::Class +sub croak { + require Carp; + Carp::croak(@_); +}; +### # NO EXTERNAL NON-5.8.1 CORE DEPENDENCIES EVER (e.g. C::A::G) # This module is to be loaded by Makefile.PM on a pristine system @@ -13,170 +21,976 @@ use Carp; # POD is generated automatically by calling _gen_pod from the # Makefile.PL in $AUTHOR mode -my $reqs = { - dist => { - #'Module::Install::Pod::Inherit' => '0.01', - }, - - use_moose => { - req => { - 'Moose' => '1.12', - 'MooseX::NonMoose' => '0.25', - 'namespace::autoclean' => '0.09', - 'MooseX::MarkAsMethods' => '0.13', - }, - pod => { - title => 'use_moose', - desc => 'Modules required for the use_moose option', - }, - }, - - dbicdump_config => { - req => { - 'Config::Any' => '0', - }, - pod => { - title => 'dbicdump config file', - desc => 'Modules required for using a config file with dbicdump', - }, - }, - - test_dbicdump_config => { - req => { - 'Config::Any' => '0', - 'Config::General' => '0', - }, - pod => { - title => 'dbicdump config file testing', - desc => 'Modules required for using testing using a config file with dbicdump', - }, - }, - - test_pod => { - req => { - 'Test::Pod' => '1.14', - 'Pod::Simple' => '3.22', - }, - pod => { - title => 'POD testing', - desc => 'Modules required for testing POD in this distribution', - }, +my $dbic_reqs = { + + use_moose => { + req => { + 'Moose' => '1.12', + 'MooseX::NonMoose' => '0.25', + 'namespace::autoclean' => '0.09', + 'MooseX::MarkAsMethods' => '0.13', + }, + pod => { + title => 'use_moose', + desc => 'Modules required for the use_moose option', + }, + }, + + dbicdump_config => { + req => { + 'Config::Any' => '0', + }, + pod => { + title => 'dbicdump config file', + desc => 'Modules required for using a config file with dbicdump', + }, + }, + + test_dbicdump_config => { + include => 'dbicdump_config', + req => { + 'Config::General' => '0', + }, + pod => { + title => 'dbicdump config file testing', + desc => 'Modules required for using testing using a config file with dbicdump', + }, + }, + + _rdbms_generic_odbc => { + req => { + 'DBD::ODBC' => 0, + } + }, + + _rdbms_generic_ado => { + req => { + 'DBD::ADO' => 0, + } + }, + + # must list any dep used by adhoc testing + # this prevents the "skips due to forgotten deps" issue + test_adhoc => { + req => { + }, + }, + + id_shortener => { + req => { + 'Math::BigInt' => '1.80', + 'Math::Base36' => '0.07', + }, + }, + + test_pod => { + req => { + 'Test::Pod' => '1.14', + 'Pod::Simple' => '3.22', + }, + pod => { + title => 'POD testing', + desc => 'Modules required for testing POD in this distribution', + }, + release_testing_mandatory => 1, + }, + + test_podcoverage => { + req => { + 'Test::Pod::Coverage' => '1.08', + 'Pod::Coverage' => '0.20', + }, + release_testing_mandatory => 1, + }, + + test_whitespace => { + req => { + 'Test::EOL' => '1.0', + 'Test::NoTabs' => '0.9', + }, + release_testing_mandatory => 1, + }, + + test_strictures => { + req => { + 'Test::Strict' => '0.20', + }, + release_testing_mandatory => 1, + }, + + test_backcompat => { + env => [ + SCHEMA_LOADER_TESTS_BACKCOMPAT => 1, + ], + }, + + # this is just for completeness as SQLite + # is a core dep of DBIC for testing + rdbms_sqlite => { + req => { + 'DBD::SQLite' => 0, + }, + pod => { + title => 'SQLite support', + desc => 'Modules required to connect to SQLite', + }, + augment => { + }, + }, + + rdbms_pg => { + req => { + # when changing this list make sure to adjust xt/optional_deps.t + 'DBD::Pg' => 0, + }, + pod => { + title => 'PostgreSQL support', + desc => 'Modules required to connect to PostgreSQL', + }, + }, + + _rdbms_mssql_common => { + }, + + rdbms_mssql_odbc => { + include => [qw( _rdbms_generic_odbc _rdbms_mssql_common )], + pod => { + title => 'MSSQL support via DBD::ODBC', + desc => 'Modules required to connect to MSSQL via DBD::ODBC', + }, + }, + + rdbms_mssql_sybase => { + include => '_rdbms_mssql_common', + req => { + 'DBD::Sybase' => 0, + }, + pod => { + title => 'MSSQL support via DBD::Sybase', + desc => 'Modules required to connect to MSSQL via DBD::Sybase', + }, + }, + + rdbms_mssql_ado => { + include => [qw( _rdbms_generic_ado _rdbms_mssql_common )], + pod => { + title => 'MSSQL support via DBD::ADO (Windows only)', + desc => 'Modules required to connect to MSSQL via DBD::ADO. This particular DBD is available on Windows only', + }, + }, + + _rdbms_msaccess_common => { + }, + + rdbms_msaccess_odbc => { + include => [qw( _rdbms_generic_odbc _rdbms_msaccess_common )], + pod => { + title => 'MS Access support via DBD::ODBC', + desc => 'Modules required to connect to MS Access via DBD::ODBC', + }, + }, + + rdbms_msaccess_ado => { + include => [qw( _rdbms_generic_ado _rdbms_msaccess_common )], + pod => { + title => 'MS Access support via DBD::ADO (Windows only)', + desc => 'Modules required to connect to MS Access via DBD::ADO. This particular DBD is available on Windows only', + }, + }, + + rdbms_mysql => { + req => { + 'DBD::mysql' => 0, + }, + pod => { + title => 'MySQL support', + desc => 'Modules required to connect to MySQL', + }, + }, + + rdbms_oracle => { + include => 'id_shortener', + req => { + 'DBD::Oracle' => 0, + }, + pod => { + title => 'Oracle support', + desc => 'Modules required to connect to Oracle', + }, + augment => { + }, + }, + + rdbms_ase => { + req => { + 'DBD::Sybase' => 0, + }, + pod => { + title => 'Sybase ASE support', + desc => 'Modules required to connect to Sybase ASE', + }, + }, + + rdbms_db2 => { + req => { + 'DBD::DB2' => 0, }, + pod => { + title => 'DB2 support', + desc => 'Modules required to connect to DB2', + }, + }, + + rdbms_informix => { + req => { + 'DBD::Informix' => 0, + }, + pod => { + title => 'Informix support', + desc => 'Modules required to connect to Informix', + }, + }, + + _rdbms_sqlanywhere_common => { + }, + + rdbms_sqlanywhere => { + include => '_rdbms_sqlanywhere_common', + req => { + 'DBD::SQLAnywhere' => 0, + }, + pod => { + title => 'SQLAnywhere support', + desc => 'Modules required to connect to SQLAnywhere', + }, + }, + + rdbms_sqlanywhere_odbc => { + include => [qw( _rdbms_generic_odbc _rdbms_sqlanywhere_common )], + pod => { + title => 'SQLAnywhere support via DBD::ODBC', + desc => 'Modules required to connect to SQLAnywhere via DBD::ODBC', + }, + }, + + _rdbms_firebird_common => { + }, + + rdbms_firebird => { + include => '_rdbms_firebird_common', + req => { + 'DBD::Firebird' => 0, + }, + pod => { + title => 'Firebird support', + desc => 'Modules required to connect to Firebird', + }, + }, + + rdbms_firebird_interbase => { + include => '_rdbms_firebird_common', + req => { + 'DBD::InterBase' => 0, + }, + pod => { + title => 'Firebird support via DBD::InterBase', + desc => 'Modules required to connect to Firebird via DBD::InterBase', + }, + }, + + rdbms_firebird_odbc => { + include => [qw( _rdbms_generic_odbc _rdbms_firebird_common )], + pod => { + title => 'Firebird support via DBD::ODBC', + desc => 'Modules required to connect to Firebird via DBD::ODBC', + }, + }, + + test_rdbms_sqlite => { + include => 'rdbms_sqlite', + req => { + ### + ### IMPORTANT - do not raise this dependency + ### even though many bugfixes are present in newer versions, the general DBIC + ### rule is to bend over backwards for available DBDs (given upgrading them is + ### often *not* easy or even possible) + ### + 'DBD::SQLite' => '1.29', + }, + }, + + test_rdbms_pg => { + include => 'rdbms_pg', + env => [ + DBICTEST_PG_DSN => 1, + DBICTEST_PG_USER => 0, + DBICTEST_PG_PASS => 0, + ], + req => { + # the order does matter because the rdbms support group might require + # a different version that the test group + # + # when changing this list make sure to adjust xt/optional_deps.t + 'DBD::Pg' => '2.009002', # specific version to test bytea + }, + }, + + test_rdbms_mssql_odbc => { + include => 'rdbms_mssql_odbc', + env => [ + DBICTEST_MSSQL_ODBC_DSN => 1, + DBICTEST_MSSQL_ODBC_USER => 0, + DBICTEST_MSSQL_ODBC_PASS => 0, + ], + }, + + test_rdbms_mssql_ado => { + include => 'rdbms_mssql_ado', + env => [ + DBICTEST_MSSQL_ADO_DSN => 1, + DBICTEST_MSSQL_ADO_USER => 0, + DBICTEST_MSSQL_ADO_PASS => 0, + ], + }, + + test_rdbms_mssql_sybase => { + include => 'rdbms_mssql_sybase', + env => [ + DBICTEST_MSSQL_DSN => 1, + DBICTEST_MSSQL_USER => 0, + DBICTEST_MSSQL_PASS => 0, + ], + }, + + test_rdbms_msaccess_odbc => { + include => 'rdbms_msaccess_odbc', + env => [ + DBICTEST_MSACCESS_ODBC_DSN => 1, + DBICTEST_MSACCESS_ODBC_USER => 0, + DBICTEST_MSACCESS_ODBC_PASS => 0, + ], + req => { + 'Data::GUID' => '0', + }, + }, + + test_rdbms_msaccess_ado => { + include => 'rdbms_msaccess_ado', + env => [ + DBICTEST_MSACCESS_ADO_DSN => 1, + DBICTEST_MSACCESS_ADO_USER => 0, + DBICTEST_MSACCESS_ADO_PASS => 0, + ], + req => { + 'Data::GUID' => 0, + }, + }, + + test_rdbms_mysql => { + include => 'rdbms_mysql', + env => [ + DBICTEST_MYSQL_DSN => 1, + DBICTEST_MYSQL_USER => 0, + DBICTEST_MYSQL_PASS => 0, + ], + }, + + test_rdbms_oracle => { + include => 'rdbms_oracle', + env => [ + DBICTEST_ORA_DSN => 1, + DBICTEST_ORA_USER => 0, + DBICTEST_ORA_PASS => 0, + ], + req => { + 'DBD::Oracle' => '1.24', + }, + }, + + test_rdbms_ase => { + include => 'rdbms_ase', + env => [ + DBICTEST_SYBASE_DSN => 1, + DBICTEST_SYBASE_USER => 0, + DBICTEST_SYBASE_PASS => 0, + ], + }, + + test_rdbms_db2 => { + include => 'rdbms_db2', + env => [ + DBICTEST_DB2_DSN => 1, + DBICTEST_DB2_USER => 0, + DBICTEST_DB2_PASS => 0, + ], + }, + + test_rdbms_informix => { + include => 'rdbms_informix', + env => [ + DBICTEST_INFORMIX_DSN => 1, + DBICTEST_INFORMIX_USER => 0, + DBICTEST_INFORMIX_PASS => 0, + ], + }, + + test_rdbms_sqlanywhere => { + include => 'rdbms_sqlanywhere', + env => [ + DBICTEST_SQLANYWHERE_DSN => 1, + DBICTEST_SQLANYWHERE_USER => 0, + DBICTEST_SQLANYWHERE_PASS => 0, + ], + }, + + test_rdbms_sqlanywhere_odbc => { + include => 'rdbms_sqlanywhere_odbc', + env => [ + DBICTEST_SQLANYWHERE_ODBC_DSN => 1, + DBICTEST_SQLANYWHERE_ODBC_USER => 0, + DBICTEST_SQLANYWHERE_ODBC_PASS => 0, + ], + }, + + test_rdbms_firebird => { + include => 'rdbms_firebird', + env => [ + DBICTEST_FIREBIRD_DSN => 1, + DBICTEST_FIREBIRD_USER => 0, + DBICTEST_FIREBIRD_PASS => 0, + ], + }, + + test_rdbms_firebird_interbase => { + include => 'rdbms_firebird_interbase', + env => [ + DBICTEST_FIREBIRD_INTERBASE_DSN => 1, + DBICTEST_FIREBIRD_INTERBASE_USER => 0, + DBICTEST_FIREBIRD_INTERBASE_PASS => 0, + ], + }, + + test_rdbms_firebird_odbc => { + include => 'rdbms_firebird_odbc', + env => [ + DBICTEST_FIREBIRD_ODBC_DSN => 1, + DBICTEST_FIREBIRD_ODBC_USER => 0, + DBICTEST_FIREBIRD_ODBC_PASS => 0, + ], + }, + }; -sub req_list_for { - my ($class, $group) = @_; - croak "req_list_for() expects a requirement group name" - unless $group; - my $deps = $reqs->{$group}{req} - or croak "Requirement group '$group' does not exist"; +### Public API - return { %$deps }; +sub import { + my $class = shift; + + if (@_) { + + my $action = shift; + + if ($action eq '-die_without') { + my $err; + { + local $@; + eval { $class->die_unless_req_ok_for(\@_); 1 } + or $err = $@; + } + die "\n$err\n" if $err; + } + elsif ($action eq '-list_missing') { + print $class->modreq_missing_for(\@_); + print "\n"; + exit 0; + } + elsif ($action eq '-skip_all_without') { + + # sanity check - make sure ->current_test is 0 and no plan has been declared + do { + local $@; + defined eval { + Test::Builder->new->current_test + or + Test::Builder->new->has_plan + }; + } and croak("Unable to invoke -skip_all_without after testing has started"); + + if ( my $missing = $class->req_missing_for(\@_) ) { + + die ("\nMandatory requirements not satisfied during release-testing: $missing\n\n") + if $ENV{RELEASE_TESTING} and $class->_groups_to_reqs(\@_)->{release_testing_mandatory}; + + print "1..0 # SKIP requirements not satisfied: $missing\n"; + exit 0; + } + } + elsif ($action =~ /^-/) { + croak "Unknown import-time action '$action'"; + } + else { + croak "$class is not an exporter, unable to import '$action'"; + } + } + + 1; } +sub unimport { + croak( __PACKAGE__ . " does not implement unimport" ); +} -our %req_availability_cache; -sub req_ok_for { - my ($class, $group) = @_; +# OO for (mistakenly considered) ease of extensibility, not due to any need to +# carry state of any sort. This API is currently used outside, so leave as-is. +# FIXME - make sure to not propagate this further if module is extracted as a +# standalone library - keep the stupidity to a DBIC-secific shim! +# +sub req_list_for { + shift->_groups_to_reqs(shift)->{effective_modreqs}; +} - croak "req_ok_for() expects a requirement group name" - unless $group; +sub modreq_list_for { + shift->_groups_to_reqs(shift)->{modreqs}; +} + +sub req_group_list { + +{ map + { $_ => $_[0]->_groups_to_reqs($_) } + grep { $_ !~ /^_/ } keys %$dbic_reqs + } +} - $class->_check_deps ($group) unless $req_availability_cache{$group}; +sub req_errorlist_for { shift->modreq_errorlist_for(shift) } # deprecated +sub modreq_errorlist_for { + my ($self, $groups) = @_; + $self->_errorlist_for_modreqs( $self->_groups_to_reqs($groups)->{modreqs} ); +} - return $req_availability_cache{$group}{status}; +sub req_ok_for { + shift->req_missing_for(shift) ? 0 : 1; } sub req_missing_for { - my ($class, $group) = @_; + my ($self, $groups) = @_; + + my $reqs = $self->_groups_to_reqs($groups); + + my $mods_missing = $reqs->{missing_envvars} + ? $self->_list_physically_missing_modules( $reqs->{modreqs} ) + : $self->modreq_missing_for($groups) + ; + + return '' if + ! $mods_missing + and + ! $reqs->{missing_envvars} + ; + + my @res = $mods_missing || (); + + push @res, 'the following group(s) of environment variables: ' . join ' and ', sort map + { __envvar_group_desc($_) } + @{$reqs->{missing_envvars}} + if $reqs->{missing_envvars}; + + return ( + ( join ' as well as ', @res ) + . + ( $reqs->{modreqs_fully_documented} ? " (see @{[ ref $self || $self ]} documentation for details)" : '' ), + ); +} - croak "req_missing_for() expects a requirement group name" - unless $group; +sub modreq_missing_for { + my ($self, $groups) = @_; - $class->_check_deps ($group) unless $req_availability_cache{$group}; + my $reqs = $self->_groups_to_reqs($groups); + my $modreq_errors = $self->_errorlist_for_modreqs($reqs->{modreqs}) + or return ''; - return $req_availability_cache{$group}{missing}; + join ' ', map + { $reqs->{modreqs}{$_} ? "$_~$reqs->{modreqs}{$_}" : $_ } + sort { lc($a) cmp lc($b) } keys %$modreq_errors + ; } -sub req_errorlist_for { - my ($class, $group) = @_; +my $tb; +sub skip_without { + my ($self, $groups) = @_; - croak "req_errorlist_for() expects a requirement group name" - unless $group; + $tb ||= do { local $@; eval { Test::Builder->new } } + or croak "Calling skip_without() before loading Test::Builder makes no sense"; - $class->_check_deps ($group) unless $req_availability_cache{$group}; + if ( my $err = $self->req_missing_for($groups) ) { + my ($fn, $ln) = (caller(0))[1,2]; + $tb->skip("block in $fn around line $ln requires $err"); + local $^W = 0; + last SKIP; + } - return $req_availability_cache{$group}{errorlist}; + 1; } -sub _check_deps { - my ($class, $group) = @_; +sub die_unless_req_ok_for { + if (my $err = shift->req_missing_for(shift) ) { + die "Unable to continue due to missing requirements: $err\n"; + } +} - my $deps = $class->req_list_for ($group); - my %errors; - for my $mod (keys %$deps) { - if (my $ver = $deps->{$mod}) { - eval "use $mod $ver ()"; + +### Private functions + +# potentially shorten group desc +sub __envvar_group_desc { + my @envs = @{$_[0]}; + + my (@res, $last_prefix); + while (my $ev = shift @envs) { + my ($pref, $sep, $suff) = split / ([\_\-]) (?= [^\_\-]+ \z )/x, $ev; + + if ( defined $sep and ($last_prefix||'') eq $pref ) { + push @res, "...${sep}${suff}" } else { - eval "require $mod"; + push @res, $ev; } - $errors{$mod} = $@ if $@; + $last_prefix = $pref if $sep; } - if (keys %errors) { - my $missing = join (', ', map { $deps->{$_} ? "$_ >= $deps->{$_}" : $_ } (sort keys %errors) ); - $missing .= " (see $class for details)" if $reqs->{$group}{pod}; - $req_availability_cache{$group} = { - status => 0, - errorlist => { %errors }, - missing => $missing, - }; + join '/', @res; +} + +my $groupname_re = qr/ [a-z_] [0-9_a-z]* /x; +my $modname_re = qr/ [A-Z_a-z] [0-9A-Z_a-z]* (?:::[0-9A-Z_a-z]+)* /x; +my $modver_re = qr/ [0-9]+ (?: \. [0-9]+ )? /x; + +# Expand includes from a random group in a specific order: +# nonvariable groups first, then their includes, then the variable groups, +# then their includes. +# This allows reliably marking the rest of the mod reqs as variable (this is +# also why variable includes are currently not allowed) +sub __expand_includes { + my ($groups, $seen) = @_; + + # !! DIFFERENT !! behavior and return depending on invocation mode + # (easier to recurse this way) + my $is_toplevel = $seen + ? 0 + : !! ($seen = {}) + ; + + my ($res_per_type, $missing_envvars); + + # breadth-first evaluation, with non-variable includes on top + for my $g (@$groups) { + + croak "Invalid requirement group name '$g': only ascii alphanumerics and _ are allowed" + if $g !~ qr/ \A $groupname_re \z/x; + + my $r = $dbic_reqs->{$g} + or croak "Requirement group '$g' is not defined"; + + # always do this check *before* the $seen check + croak "Group '$g' with variable effective_modreqs can not be specified as an 'include'" + if ( $r->{env} and ! $is_toplevel ); + + next if $seen->{$g}++; + + my $req_type = 'static'; + + if ( my @e = @{$r->{env}||[]} ) { + + croak "Unexpected 'env' attribute under group '$g' (only allowed in test_* groups)" + unless $g =~ /^test_/; + + croak "Unexpected *odd* list in 'env' under group '$g'" + if @e % 2; + + # deconstruct the whole thing + my (@group_envnames_list, $some_envs_required, $some_required_missing); + while (@e) { + push @group_envnames_list, my $envname = shift @e; + + # env required or not + next unless shift @e; + + $some_envs_required ||= 1; + + $some_required_missing ||= ( + ! defined $ENV{$envname} + or + ! length $ENV{$envname} + ); + } + + croak "None of the envvars in group '$g' declared as required, making the requirement moot" + unless $some_envs_required; + + if ($some_required_missing) { + push @{$missing_envvars->{$g}}, \@group_envnames_list; + $req_type = 'variable'; + } + } + + push @{$res_per_type->{"base_${req_type}"}}, $g; + + if (my $i = $dbic_reqs->{$g}{include}) { + $i = [ $i ] unless ref $i eq 'ARRAY'; + + croak "Malformed 'include' for group '$g': must be another existing group name or arrayref of existing group names" + unless @$i; + + push @{$res_per_type->{"incs_${req_type}"}}, @$i; + } } - else { - $req_availability_cache{$group} = { - status => 1, - errorlist => {}, - missing => '', - }; + + my @ret = map { + @{ $res_per_type->{"base_${_}"} || [] }, + ( $res_per_type->{"incs_${_}"} ? __expand_includes( $res_per_type->{"incs_${_}"}, $seen ) : () ), + } qw(static variable); + + return ! $is_toplevel ? @ret : do { + my $rv = {}; + $rv->{$_} = { + idx => 1 + keys %$rv, + missing_envvars => $missing_envvars->{$_}, + } for @ret; + $rv->{$_}{user_requested} = 1 for @$groups; + $rv; + }; +} + +### Private OO API +our %req_unavailability_cache; + +# this method is just a lister and envvar/metadata checker - it does not try to load anything +sub _groups_to_reqs { + my ($self, $want) = @_; + + $want = [ $want || () ] + unless ref $want eq 'ARRAY'; + + croak "@{[ (caller(1))[3] ]}() expects a requirement group name or arrayref of group names" + unless @$want; + + my $ret = { + modreqs => {}, + modreqs_fully_documented => 1, + }; + + my $groups; + for my $piece (@$want) { + if ($piece =~ qr/ \A $groupname_re \z /x) { + push @$groups, $piece; + } + elsif ( my ($mod, $ver) = $piece =~ qr/ \A ($modname_re) \>\= ($modver_re) \z /x ) { + croak "Ad hoc module specification lists '$mod' twice" + if exists $ret->{modreqs}{$mod}; + + croak "Ad hoc module specification '${mod} >= $ver' (or greater) not listed in the test_adhoc optdep group" if ( + ! defined $dbic_reqs->{test_adhoc}{req}{$mod} + or + $dbic_reqs->{test_adhoc}{req}{$mod} < $ver + ); + + $ret->{modreqs}{$mod} = $ver; + $ret->{modreqs_fully_documented} = 0; + } + else { + croak "Unsupported argument '$piece' supplied to @{[ (caller(1))[3] ]}()" + } } + + my $all_groups = __expand_includes($groups); + + # pre-assemble list of augmentations, perform basic sanity checks + # Note that below we *DO NOT* respect the source/target reationship, but + # instead always default to augment the "later" group + # This is done so that the "stable/variable" boundary keeps working as + # expected + my $augmentations; + for my $requesting_group (keys %$all_groups) { + if (my $ag = $dbic_reqs->{$requesting_group}{augment}) { + for my $target_group (keys %$ag) { + + croak "Group '$requesting_group' claims to augment a non-existent group '$target_group'" + unless $dbic_reqs->{$target_group}; + + croak "Augmentation combined with variable effective_modreqs currently unsupported for group '$requesting_group'" + if $dbic_reqs->{$requesting_group}{env}; + + croak "Augmentation of group '$target_group' with variable effective_modreqs unsupported (requested by '$requesting_group')" + if $dbic_reqs->{$target_group}{env}; + + if (my @foreign = grep { $_ ne 'req' } keys %{$ag->{$target_group}} ) { + croak "Only 'req' augmentations are currently supported (group '$requesting_group' attempts to alter '$foreign[0]' of group '$target_group'"; + } + + $ret->{augments}{$target_group} = 1; + + # no augmentation for stuff that hasn't been selected + if ( $all_groups->{$target_group} and my $ar = $ag->{$target_group}{req} ) { + push @{$augmentations->{ + ( $all_groups->{$requesting_group}{idx} < $all_groups->{$target_group}{idx} ) + ? $target_group + : $requesting_group + }}, $ar; + } + } + } + } + + for my $group (sort { $all_groups->{$a}{idx} <=> $all_groups->{$b}{idx} } keys %$all_groups ) { + + my $group_reqs = $dbic_reqs->{$group}{req}; + + # sanity-check + for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) { + for (keys %$req_bag) { + + $_ =~ / \A $modname_re \z /x + or croak "Requirement '$_' in group '$group' is not a valid module name"; + + # !!!DO NOT CHANGE!!! + # remember - version.pm may not be available on the system + croak "Requirement '$_' in group '$group' specifies an invalid version '$req_bag->{$_}' (only plain non-underscored floating point decimals are supported)" + if ( ($req_bag->{$_}||0) !~ qr/ \A $modver_re \z /x ); + } + } + + if (my $e = $all_groups->{$group}{missing_envvars}) { + push @{$ret->{missing_envvars}}, @$e; + } + + # assemble into the final ret + for my $type ( + 'modreqs', + ( $ret->{missing_envvars} ? () : 'effective_modreqs' ), + ) { + for my $req_bag ($group_reqs, @{ $augmentations->{$group} || [] } ) { + for my $mod (keys %$req_bag) { + + $ret->{$type}{$mod} = $req_bag->{$mod}||0 if ( + + ! exists $ret->{$type}{$mod} + or + # we sanitized the version to be numeric above - we can just -gt it + ($req_bag->{$mod}||0) > $ret->{$type}{$mod} + + ); + } + } + } + + $ret->{modreqs_fully_documented} &&= !!$dbic_reqs->{$group}{pod} + if $all_groups->{$group}{user_requested}; + + $ret->{release_testing_mandatory} ||= !!$dbic_reqs->{$group}{release_testing_mandatory}; + } + + return $ret; } -sub req_group_list { - return { map { $_ => { %{ $reqs->{$_}{req} || {} } } } (keys %$reqs) }; + +# this method tries to find/load specified modreqs and returns a hashref of +# module/loaderror pairs for anything that failed +sub _errorlist_for_modreqs { + # args supposedly already went through _groups_to_reqs and are therefore sanitized + # safe to eval at will + my ($self, $reqs) = @_; + + my $ret; + + for my $m ( keys %$reqs ) { + my $v = $reqs->{$m}; + + if (! exists $req_unavailability_cache{$m}{$v} ) { + local $@; + eval( "require $m;" . ( $v ? "$m->VERSION(q($v))" : '' ) ); + $req_unavailability_cache{$m}{$v} = $@; + } + + $ret->{$m} = $req_unavailability_cache{$m}{$v} + if $req_unavailability_cache{$m}{$v}; + } + + $ret; +} + +# Unlike the above DO NOT try to load anything +# This is executed when some needed envvars are not available +# which in turn means a module load will never be reached anyway +# This is important because some modules (especially DBDs) can be +# *really* fickle when a require() is attempted, with pretty confusing +# side-effects (especially on windows) +sub _list_physically_missing_modules { + my ($self, $modreqs) = @_; + + # in case there is a coderef in @INC there is nothing we can definitively prove + # so short circuit directly + return '' if grep { length ref $_ } @INC; + + my @definitely_missing; + for my $mod (keys %$modreqs) { + (my $fn = $mod . '.pm') =~ s|::|/|g; + + push @definitely_missing, $mod unless grep + # this should work on any combination of slashes + { $_ and -d $_ and -f "$_/$fn" and -r "$_/$fn" } + @INC + ; + } + + join ' ', map + { $modreqs->{$_} ? "$_~$modreqs->{$_}" : $_ } + sort { lc($a) cmp lc($b) } @definitely_missing + ; } + # This is to be called by the author only (automatically in Makefile.PL) sub _gen_pod { + my ($class, $distver, $pod_dir) = @_; - my $class = shift; - my $modfn = __PACKAGE__ . '.pm'; - $modfn =~ s/\:\:/\//g; - - my $podfn = __FILE__; - $podfn =~ s/\.pm$/\.pod/; + die "No POD root dir supplied" unless $pod_dir; - my $distver = - eval { require DBIx::Class::Schema::Loader; DBIx::Class::Schema::Loader->VERSION; } - || - do { - warn + $distver ||= + eval { + require DBIx::Class::Schema::Loader; + DBIx::Class::Schema::Loader->VERSION; + } || + die "\n\n---------------------------------------------------------------------\n" . -'Unable to load the DBIx::Class::Schema::Loader module to determine current ' . -'version, possibly due to missing dependencies. Author-mode autodocumentation ' . +'Unable to load core DBIx::Class::Schema::Loader module to determine current version, '. +'possibly due to missing dependencies. Author-mode autodocumentation ' . "halted\n\n" . $@ . "\n\n---------------------------------------------------------------------\n" - ; - '*UNKNOWN*'; # rv - } ; - my @chunks = ( - <<"EOC", + # do not ask for a recent version, use 1.x API calls + # this *may* execute on a smoker with old perl or whatnot + require File::Path; + + (my $modfn = __PACKAGE__ . '.pm') =~ s|::|/|g; + + (my $podfn = "$pod_dir/$modfn") =~ s/\.pm$/\.pod/; + (my $dir = $podfn) =~ s|/[^/]+$||; + + File::Path::mkpath([$dir]); + + my $moosever = $class->req_list_for('use_moose')->{'Moose'} + or die "Hrmm? No Moose dep?"; + + + my @chunks; + +#@@ +#@@ HEADER +#@@ + push @chunks, <<"EOC"; ######################################################################### ##################### A U T O G E N E R A T E D ######################## ######################################################################### @@ -185,136 +999,415 @@ sub _gen_pod { # will be lost. If you need to change the generated text edit _gen_pod() # at the end of $modfn # + +=head1 NAME + +$class - Optional module dependency specifications (for module authors) EOC - '=head1 NAME', - "$class - Optional module dependency specifications (for module authors)", - '=head1 SYNOPSIS', - <'s Makefile.PL): + + +#@@ +#@@ SYNOPSIS HEADING +#@@ + push @chunks, <<"EOC"; +=head1 SYNOPSIS + +Somewhere in your build-file (e.g. L's F): ... - configure_requires 'DBIx::Class::Schema::Loader' => '$distver'; + \$EUMM_ARGS{CONFIGURE_REQUIRES} = { + \%{ \$EUMM_ARGS{CONFIGURE_REQUIRES} || {} }, + 'DBIx::Class::Schema::Loader' => '$distver', + }; - require $class; + ... - my \$use_moose_deps = $class->req_list_for ('use_moose'); + my %DBIC_CONFIG_AND_ORACLE_DEPS = %{ eval { + require $class; + $class->req_list_for([qw( dbicdump_config rdbms_oracle )]); + } || {} }; - for (keys %\$use_moose_deps) { - requires \$_ => \$use_moose_deps->{\$_}; - } + \$EUMM_ARGS{PREREQ_PM} = { + \%DBIC_CONFIG_AND_ORACLE_DEPS, + \%{ \$EUMM_ARGS{PREREQ_PM} || {} }, + }; ... -Note that there are some caveats regarding C, more info -can be found at L -EOS - '=head1 DESCRIPTION', - <<'EOD', -Some of the features of L have external + ExtUtils::MakeMaker::WriteMakefile(\%EUMM_ARGS); + +B: The C protection within the example is due to support for +requirements during L build phase|CPAN::Meta::Spec/Phases> +not being available on a sufficient portion of production installations of +Perl. Robust support for such dependency requirements is available in the +L installer only since version C<1.94_56> first made available for +production with perl version C<5.12>. It is the belief of the current +maintainer that support for requirements during the C build phase +will not be sufficiently ubiquitous until the B at the earliest, +hence the extra care demonstrated above. It should also be noted that some +3rd party installers (e.g. L) do the right thing +with configure requirements independent from the versions of perl and CPAN +available. +EOC + + +#@@ +#@@ DESCRIPTION HEADING +#@@ + push @chunks, <<'EOC'; +=head1 DESCRIPTION + +Some of the less-frequently used features of L have external module dependencies on their own. In order not to burden the average user -with modules he will never use, these optional dependencies are not included +with modules they will never use, these optional dependencies are not included in the base Makefile.PL. Instead an exception with a descriptive message is -thrown when a specific feature is missing one or several modules required for -its operation. This module is the central holding place for the current list -of such dependencies. -EOD - '=head1 CURRENT REQUIREMENT GROUPS', - <<'EOD', -Dependencies are organized in C and each group can list one or more -required modules, with an optional minimum version (or 0 for any version). -EOD - ); +thrown when a specific feature can't find one or several modules required for +its operation. This module is the central holding place for the current list +of such dependencies, for DBIx::Class::Schema::Loader core authors, and DBIx::Class::Schema::Loader extension +authors alike. + +Dependencies are organized in L where each +group can list one or more required modules, with an optional minimum version +(or 0 for any version). In addition groups prefixed with C can specify +a set of environment variables, some (or all) of which are marked as required +for the group to be considered by L + +Each group name (or a combination thereof) can be used in the +L as described below. +EOC + + +#@@ +#@@ REQUIREMENT GROUPLIST HEADING +#@@ + push @chunks, '=head1 CURRENT REQUIREMENT GROUPS'; - for my $group (sort keys %$reqs) { - my $p = $reqs->{$group}{pod} - or next; + my $standalone_info; - my $modlist = $reqs->{$group}{req} - or next; + for my $group (sort keys %$dbic_reqs) { - next unless keys %$modlist; + my $info = $standalone_info->{$group} ||= $class->_groups_to_reqs($group); + + next unless ( + $info->{modreqs_fully_documented} + and + ( $info->{augments} or $info->{modreqs} ) + ); + + my $p = $dbic_reqs->{$group}{pod}; push @chunks, ( "=head2 $p->{title}", - "$p->{desc}", + "=head3 $group", + $p->{desc}, '=over', - ( map { "=item * $_" . ($modlist->{$_} ? " >= $modlist->{$_}" : '') } (sort keys %$modlist) ), - '=back', - "Requirement group: B<$group>", ); + + if ( keys %{ $info->{modreqs}||{} } ) { + push @chunks, map + { "=item * $_" . ($info->{modreqs}{$_} ? " >= $info->{modreqs}{$_}" : '') } + ( sort keys %{ $info->{modreqs} } ) + ; + } + else { + push @chunks, '=item * No standalone requirements', + } + + push @chunks, '=back'; + + for my $ag ( sort keys %{ $info->{augments} || {} } ) { + my $ag_info = $standalone_info->{$ag} ||= $class->_groups_to_reqs($ag); + + my $newreqs = $class->modreq_list_for([ $group, $ag ]); + for (keys %$newreqs) { + delete $newreqs->{$_} if ( + ( defined $info->{modreqs}{$_} and $info->{modreqs}{$_} == $newreqs->{$_} ) + or + ( defined $ag_info->{modreqs}{$_} and $ag_info->{modreqs}{$_} == $newreqs->{$_} ) + ); + } + + if (keys %$newreqs) { + push @chunks, ( + "Combined with L additionally requires:", + '=over', + ( map + { "=item * $_" . ($newreqs->{$_} ? " >= $newreqs->{$_}" : '') } + ( sort keys %$newreqs ) + ), + '=back', + ); + } + } } - push @chunks, ( - '=head1 METHODS', - '=head2 req_group_list', - '=over', - '=item Arguments: $none', - '=item Returns: \%list_of_requirement_groups', - '=back', - < version of -L. See the L for a real-world -example. -EOD - - '=head2 req_ok_for', - '=over', - '=item Arguments: $group_name', - '=item Returns: 1|0', - '=back', - 'Returns true or false depending on whether all modules required by C<$group_name> are present on the system and loadable', - - '=head2 req_missing_for', - '=over', - '=item Arguments: $group_name', - '=item Returns: $error_message_string', - '=back', - < -maintainers, to indicate to the user that he needs to install specific modules -before he will be able to use a specific feature. - -For example if some of the requirements for C are not available, + +#@@ +#@@ API DOCUMENTATION HEADING +#@@ + push @chunks, <<'EOC'; + +=head1 IMPORT-LIKE ACTIONS + +Even though this module is not an L, it recognizes several C +supplied to its C method. + +=head2 -skip_all_without + +=over + +=item Arguments: @group_names + +=back + +A convenience wrapper for use during testing: +EOC + + push @chunks, " use $class -skip_all_without => qw(admin test_rdbms_mysql);"; + + push @chunks, 'Roughly equivalent to the following code:'; + + push @chunks, sprintf <<'EOS', ($class) x 2; + + BEGIN { + require %s; + if ( my $missing = %s->req_missing_for(\@group_names_) ) { + print "1..0 # SKIP requirements not satisfied: $missing\n"; + exit 0; + } + } +EOS + + push @chunks, <<'EOC'; + +It also takes into account the C environment variable and +behaves like L for any requirement groups marked as +C. + +=head2 -die_without + +=over + +=item Arguments: @group_names + +=back + +A convenience wrapper around L: +EOC + + push @chunks, " use $class -die_without => qw(deploy admin);"; + + push @chunks, <<'EOC'; + +=head2 -list_missing + +=over + +=item Arguments: @group_names + +=back + +A convenience wrapper around L: + + perl -Ilib -MDBIx::Class::Schema::Loader::Optional::Dependencies=-list_missing,dbicdump_config,rdbms_oracle | cpanm + +=head1 METHODS + +=head2 req_group_list + +=over + +=item Arguments: none + +=item Return Value: \%list_of_requirement_groups + +=back + +This method should be used by DBIx::Class::Schema::Loader packagers, to get a hashref of all +dependencies B by dependency group. Each key (group name), or a combination +thereof (as an arrayref) can be supplied to the methods below. +The B of the returned hash are currently a set of options B. If you have use for any of the contents - contact the +maintainers, instead of treating this as public (left alone stable) API. + +=head2 req_list_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: \%set_of_module_version_pairs + +=back + +This method should be used by DBIx::Class::Schema::Loader extension authors, to determine the +version of modules a specific set of features requires for this version of +DBIx::Class::Schema::Loader (regardless of their availability on the system). +See the L for a real-world example. + +When handling C groups this method behaves B from +L below (and is the only such inconsistency among the +C methods). If a particular group declares as requirements some +C and these requirements are not satisfied (the envvars +are unset) - then the C of this group are not included in +the returned list. + +=head2 modreq_list_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: \%set_of_module_version_pairs + +=back + +Same as L but does not take into consideration any +C - returns just the list of required +modules. + +=head2 req_ok_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: 1|0 + +=back + +Returns true or false depending on whether all modules/envvars required by +the group(s) are loadable/set on the system. + +=head2 req_missing_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: $error_message_string + +=back + +Returns a single-line string suitable for inclusion in larger error messages. +This method would normally be used by DBIx::Class::Schema::Loader core features, to indicate to +the user that they need to install specific modules and/or set specific +environment variables before being able to use a specific feature set. + +For example if some of the requirements for C are not available, the returned string could look like: +EOC - Moose >= 0 (see use_moose for details) + push @chunks, qq{ "Moose~$moosever" (see $class documentation for details)}; + push @chunks, <<'EOC'; The author is expected to prepend the necessary text to this message before -returning the actual error seen by the user. -EOD - - '=head2 req_errorlist_for', - '=over', - '=item Arguments: $group_name', - '=item Returns: \%list_of_loaderrors_per_module', - '=back', - <<'EOD', +returning the actual error seen by the user. See also L + +=head2 modreq_missing_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: $error_message_string + +=back + +Same as L except that the error string is guaranteed to be +either empty, or contain a set of module requirement specifications suitable +for piping to e.g. L. The method explicitly does not +attempt to validate the state of required environment variables (if any). + +For instance if some of the requirements for C are not available, +the returned string could look like: +EOC + + push @chunks, qq{ "Moose~$moosever"}; + + push @chunks, <<'EOC'; + +See also L. + +=head2 skip_without + +=over + +=item Arguments: $group_name | \@group_names + +=back + +A convenience wrapper around L. It does not take neither +a reason (it is generated by L) nor an amount of skipped tests +(it is always C<1>, thus mandating unconditional use of +L). Most useful in combination with ad hoc +requirement specifications: +EOC + + push @chunks, <skip_without([ deploy YAML>=0.90 ]); + + ... + } +EOC + + push @chunks, <<'EOC'; + +=head2 die_unless_req_ok_for + +=over + +=item Arguments: $group_name | \@group_names + +=back + +Checks if L passes for the supplied group(s), and +in case of failure throws an exception including the information +from L. See also L. + +=head2 modreq_errorlist_for + +=over + +=item Arguments: $group_name | \@group_names + +=item Return Value: \%set_of_loaderrors_per_module + +=back + Returns a hashref containing the actual errors that occurred while attempting -to load each module in the requirement group. -EOD - '=head1 AUTHOR', - 'See L.', - '=head1 LICENSE', - 'You may distribute this code under the same terms as Perl itself', - ); +to load each module in the requirement group(s). + +=head2 req_errorlist_for + +Deprecated method name, equivalent (via proxy) to L. + +EOC + +#@@ +#@@ FOOTER +#@@ + push @chunks, <<'EOC'; +=head1 FURTHER QUESTIONS? + +Check the list of L. + +=head1 COPYRIGHT AND LICENSE + +This module is free software L +by the L. +You can redistribute it and/or modify it under the same terms as the +L. +EOC - open (my $fh, '>', $podfn) or croak "Unable to write to $podfn: $!"; - print $fh join ("\n\n", @chunks); - close ($fh); + eval { + open (my $fh, '>', $podfn) or die; + print $fh join ("\n\n", @chunks) or die; + print $fh "\n" or die; + close ($fh) or die; + } or croak( "Unable to write $podfn: " . ( $! || $@ || 'unknown error') ); } 1; diff --git a/maint/travis-ci_scripts/30_before_script.bash b/maint/travis-ci_scripts/30_before_script.bash index bfb8350..c25e966 100755 --- a/maint/travis-ci_scripts/30_before_script.bash +++ b/maint/travis-ci_scripts/30_before_script.bash @@ -110,11 +110,11 @@ else parallel_installdeps_notest File::Spec Data::Dumper Module::Runtime parallel_installdeps_notest Test::Exception Encode::Locale Test::Fatal parallel_installdeps_notest Test::Warn B::Hooks::EndOfScope Test::Differences HTTP::Status - parallel_installdeps_notest Test::Pod::Coverage Test::EOL Devel::GlobalDestruction Sub::Util MRO::Compat Class::XSAccessor URI::Escape HTML::Entities + parallel_installdeps_notest Test::Pod::Coverage Test::EOL Test::NoTabs Test::Strict Devel::GlobalDestruction Sub::Util MRO::Compat Class::XSAccessor URI::Escape HTML::Entities parallel_installdeps_notest YAML LWP Class::Trigger JSON::XS DateTime::Format::Builder Class::Accessor::Grouped Package::Variant parallel_installdeps_notest SQL::Abstract Moose Module::Install JSON SQL::Translator File::Which - parallel_installdeps_notest Module::Install::ReadmeFromPod - parallel_installdeps_notest Math::Base36 DBD::mysql DBD::Pg Math::BigInt + parallel_installdeps_notest Module::Install::ReadmeFromPod Module::Install::AuthorTests + parallel_installdeps_notest Math::Base36 DBD::mysql DBD::Pg Math::BigInt String::CamelCase parallel_installdeps_notest MooseX::NonMoose MooseX::MarkAsMethods namespace::autoclean if env | grep -q '^DBICTEST_.*_ODBC_DSN'; then diff --git a/t/10_02mysql_common.t b/t/10_02mysql_common.t index 2f21a42..082ac52 100644 --- a/t/10_02mysql_common.t +++ b/t/10_02mysql_common.t @@ -1,10 +1,12 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_rdbms_mysql'; + use strict; use warnings; use Test::More; use Test::Exception; use Try::Tiny; use File::Path 'rmtree'; -use DBIx::Class::Optional::Dependencies; use DBIx::Class::Schema::Loader::Utils 'slurp_file'; use DBIx::Class::Schema::Loader 'make_schema_at'; @@ -26,7 +28,9 @@ my $innodb = $test_innodb ? q{Engine=InnoDB} : ''; my ($schema, $databases_created); # for cleanup in END for extra tests -my $tester = dbixcsl_common_tests->new( +diag $skip_rels_msg if not $test_innodb; + +dbixcsl_common_tests->new( vendor => 'Mysql', auto_inc_pk => 'INTEGER NOT NULL PRIMARY KEY AUTO_INCREMENT', innodb => $innodb, @@ -499,18 +503,7 @@ EOF } }, }, -); - -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_MYSQL_DSN, DBICTEST_MYSQL_USER, and DBICTEST_MYSQL_PASS environment variables'); -} -elsif (!DBIx::Class::Optional::Dependencies->req_ok_for ('rdbms_mysql')) { - $tester->skip_tests('You need to install ' . DBIx::Class::Optional::Dependencies->req_missing_for ('rdbms_mysql')); -} -else { - diag $skip_rels_msg if not $test_innodb; - $tester->run_tests(); -} +)->run_tests; END { if (not $ENV{SCHEMA_LOADER_TESTS_NOCLEANUP}) { diff --git a/t/10_03pg_common.t b/t/10_03pg_common.t index 0c66a3c..0225b33 100644 --- a/t/10_03pg_common.t +++ b/t/10_03pg_common.t @@ -1,7 +1,9 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_rdbms_pg'; + use strict; use warnings; use utf8; -use DBIx::Class::Optional::Dependencies; use DBIx::Class::Schema::Loader 'make_schema_at'; use DBIx::Class::Schema::Loader::Utils qw/no_warnings slurp_file/; use Test::More; @@ -20,7 +22,7 @@ my $dsn = $ENV{DBICTEST_PG_DSN} || ''; my $user = $ENV{DBICTEST_PG_USER} || ''; my $password = $ENV{DBICTEST_PG_PASS} || ''; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'Pg', auto_inc_pk => 'SERIAL NOT NULL PRIMARY KEY', dsn => $dsn, @@ -485,17 +487,7 @@ my $tester = dbixcsl_common_tests->new( 'unique indexes are dumped correctly'; }, }, -); - -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_PG_DSN, _USER, and _PASS environment variables'); -} -elsif (!DBIx::Class::Optional::Dependencies->req_ok_for ('rdbms_pg')) { - $tester->skip_tests('You need to install ' . DBIx::Class::Optional::Dependencies->req_missing_for ('rdbms_pg')); -} -else { - $tester->run_tests(); -} +)->run_tests(); END { rmtree EXTRA_DUMP_DIR unless $ENV{SCHEMA_LOADER_TESTS_NOCLEANUP}; diff --git a/t/10_04db2_common.t b/t/10_04db2_common.t index 34e176a..0533dc0 100644 --- a/t/10_04db2_common.t +++ b/t/10_04db2_common.t @@ -1,10 +1,12 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_rdbms_db2'; + use strict; use warnings; use Test::More; use Test::Exception; use Try::Tiny; use File::Path 'rmtree'; -use DBIx::Class::Optional::Dependencies; use DBIx::Class::Schema::Loader 'make_schema_at'; use lib qw(t/lib); @@ -18,12 +20,6 @@ my $dsn = $ENV{DBICTEST_DB2_DSN} || ''; my $user = $ENV{DBICTEST_DB2_USER} || ''; my $password = $ENV{DBICTEST_DB2_PASS} || ''; -plan skip_all => 'You need to set the DBICTEST_DB2_DSN, _USER, and _PASS environment variables' - unless ($dsn && $user); - -plan skip_all => 'You need to install ' . DBIx::Class::Optional::Dependencies->req_missing_for ('rdbms_db2') - unless DBIx::Class::Optional::Dependencies->req_ok_for ('rdbms_db2'); - my ($schema, $schemas_created); # for cleanup in END for extra tests my $srv_ver = do { @@ -41,7 +37,7 @@ my $extra_graphics_data_types = { 'dbclob' => { data_type => 'dbclob' }, }; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'DB2', auto_inc_pk => 'INTEGER GENERATED BY DEFAULT AS IDENTITY NOT NULL PRIMARY KEY', dsn => $dsn, @@ -356,9 +352,7 @@ EOF }, }, -); - -$tester->run_tests(); +)->run_tests(); END { if (not $ENV{SCHEMA_LOADER_TESTS_NOCLEANUP}) { diff --git a/t/10_05ora_common.t b/t/10_05ora_common.t index 160d885..8f248be 100644 --- a/t/10_05ora_common.t +++ b/t/10_05ora_common.t @@ -1,8 +1,10 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_rdbms_oracle'; + use strict; use warnings; use Test::More; use Test::Exception; -use DBIx::Class::Optional::Dependencies; use DBIx::Class::Schema::Loader 'make_schema_at'; use DBIx::Class::Schema::Loader::Utils qw/slurp_file split_name/; use Try::Tiny; @@ -42,7 +44,7 @@ my $auto_inc_drop_cb = sub { return qq{ DROP SEQUENCE ${table}_${col}_seq }; }; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'Oracle', auto_inc_pk => 'INTEGER NOT NULL PRIMARY KEY', auto_inc_cb => $auto_inc_cb, @@ -493,17 +495,8 @@ EOF } }, }, -); +)->run_tests(); -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_ORA_DSN, _USER, and _PASS environment variables'); -} -elsif (!DBIx::Class::Optional::Dependencies->req_ok_for ('rdbms_oracle')) { - $tester->skip_tests('You need to install ' . DBIx::Class::Optional::Dependencies->req_missing_for ('rdbms_oracle')); -} -else { - $tester->run_tests(); -} END { if (not $ENV{SCHEMA_LOADER_TESTS_NOCLEANUP}) { diff --git a/t/10_06sybase_common.t b/t/10_06sybase_common.t index de2ec39..d19b7b7 100644 --- a/t/10_06sybase_common.t +++ b/t/10_06sybase_common.t @@ -1,10 +1,12 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_rdbms_ase'; + use strict; use warnings; use Test::More; use Test::Exception; use Try::Tiny; use File::Path 'rmtree'; -use DBIx::Class::Optional::Dependencies; use DBIx::Class::Schema::Loader 'make_schema_at'; use DBIx::Class::Schema::Loader::Utils qw/sigwarn_silencer/; use namespace::clean; @@ -25,7 +27,7 @@ BEGIN { $ENV{DBIC_SYBASE_FREETDS_NOWARN} = 1 } my ($schema, $databases_created); # for cleanup in END for extra tests -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'sybase', auto_inc_pk => 'INTEGER IDENTITY NOT NULL PRIMARY KEY', default_function => 'getdate()', @@ -390,17 +392,7 @@ EOF } }, }, -); - -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_SYBASE_DSN, _USER, and _PASS environment variables'); -} -elsif (!DBIx::Class::Optional::Dependencies->req_ok_for ('rdbms_ase')) { - $tester->skip_tests('You need to install ' . DBIx::Class::Optional::Dependencies->req_missing_for ('rdbms_ase')); -} -else { - $tester->run_tests(); -} +)->run_tests(); END { if (not $ENV{SCHEMA_LOADER_TESTS_NOCLEANUP}) { diff --git a/t/10_10informix_common.t b/t/10_10informix_common.t index e8b6b58..3217ef5 100644 --- a/t/10_10informix_common.t +++ b/t/10_10informix_common.t @@ -1,10 +1,12 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_rdbms_informix'; + use strict; use warnings; use Test::More; use Test::Exception; use Try::Tiny; use File::Path 'rmtree'; -use DBIx::Class::Optional::Dependencies; use DBIx::Class::Schema::Loader 'make_schema_at'; use DBIx::Class::Schema::Loader::Utils 'split_name'; use String::ToIdentifier::EN::Unicode 'to_identifier'; @@ -28,7 +30,7 @@ my $password = $ENV{DBICTEST_INFORMIX_PASS} || ''; my ($schema, $extra_schema); # for cleanup in END for extra tests -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'Informix', auto_inc_pk => 'serial primary key', null => '', @@ -331,17 +333,7 @@ EOF } }, }, -); - -if( !$dsn ) { - $tester->skip_tests('You need to set the DBICTEST_INFORMIX_DSN, _USER, and _PASS environment variables'); -} -elsif (!DBIx::Class::Optional::Dependencies->req_ok_for ('rdbms_informix')) { - $tester->skip_tests('You need to install ' . DBIx::Class::Optional::Dependencies->req_missing_for ('rdbms_informix')); -} -else { - $tester->run_tests(); -} +)->run_tests(); sub db_name { my $schema = shift; diff --git a/t/26dump_use_moose.t b/t/26dump_use_moose.t index d247050..b03db06 100644 --- a/t/26dump_use_moose.t +++ b/t/26dump_use_moose.t @@ -1,13 +1,9 @@ -use warnings; +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'use_moose'; + use strict; use Test::More; -use DBIx::Class::Schema::Loader::Optional::Dependencies (); -BEGIN { - use DBIx::Class::Schema::Loader::Optional::Dependencies (); - plan skip_all => 'Tests needs ' . DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose') - unless (DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')); -} use lib qw(t/lib); use dbixcsl_dumper_tests; diff --git a/t/60dbicdump_config.t b/t/60dbicdump_config.t index 48168a6..fb2d067 100644 --- a/t/60dbicdump_config.t +++ b/t/60dbicdump_config.t @@ -1,4 +1,5 @@ -#!perl +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_dbicdump_config'; use strict; use warnings; @@ -8,17 +9,10 @@ use File::Path qw/make_path rmtree/; use DBIx::Class::Schema::Loader::Utils 'slurp_file'; use Try::Tiny; use namespace::clean; -use DBIx::Class::Schema::Loader::Optional::Dependencies (); use lib 't/lib'; use make_dbictest_db (); use dbixcsl_test_dir '$tdir'; -BEGIN { - use DBIx::Class::Schema::Loader::Optional::Dependencies (); - plan skip_all => 'Tests needs ' . DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('test_dbicdump_config') - unless (DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('test_dbicdump_config')); -} - plan tests => 2; my $config_dir = "$tdir/dbicdump_config"; diff --git a/t/backcompat/0.04006/10sqlite_common.t b/t/backcompat/0.04006/10sqlite_common.t index 446614f..c593b55 100644 --- a/t/backcompat/0.04006/10sqlite_common.t +++ b/t/backcompat/0.04006/10sqlite_common.t @@ -1,26 +1,23 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_backcompat'; + use strict; use lib qw(t/backcompat/0.04006/lib); use dbixcsl_common_tests; use dbixcsl_test_dir qw/$tdir/; use Test::More; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; eval { require DBD::SQLite }; my $class = $@ ? 'SQLite2' : 'SQLite'; -{ - my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'SQLite', auto_inc_pk => 'INTEGER NOT NULL PRIMARY KEY', dsn => "dbi:$class:dbname=$tdir/sqlite_test", user => '', password => '', - ); - - $tester->run_tests(); -} +)->run_tests; END { unlink "$tdir/sqlite_test" if $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; diff --git a/t/backcompat/0.04006/11mysql_common.t b/t/backcompat/0.04006/11mysql_common.t index c0ef367..c77d1b4 100644 --- a/t/backcompat/0.04006/11mysql_common.t +++ b/t/backcompat/0.04006/11mysql_common.t @@ -1,10 +1,10 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => qw(test_backcompat test_rdbms_mysql); + use strict; use lib qw(t/backcompat/0.04006/lib); use dbixcsl_common_tests; use Test::More; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - my $dsn = $ENV{DBICTEST_MYSQL_DSN} || ''; my $user = $ENV{DBICTEST_MYSQL_USER} || ''; @@ -13,7 +13,7 @@ my $test_innodb = $ENV{DBICTEST_MYSQL_INNODB} || 0; my $skip_rels_msg = 'You need to set the DBICTEST_MYSQL_INNODB environment variable to test relationships'; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'Mysql', auto_inc_pk => 'INTEGER NOT NULL PRIMARY KEY AUTO_INCREMENT', innodb => $test_innodb ? q{Engine=InnoDB} : 0, @@ -23,11 +23,4 @@ my $tester = dbixcsl_common_tests->new( skip_rels => $test_innodb ? 0 : $skip_rels_msg, no_inline_rels => 1, no_implicit_rels => 1, -); - -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_MYSQL_DSN, _USER, and _PASS environment variables'); -} -else { - $tester->run_tests(); -} +)->run_tests(); diff --git a/t/backcompat/0.04006/12pg_common.t b/t/backcompat/0.04006/12pg_common.t index ec3e991..070dcc1 100644 --- a/t/backcompat/0.04006/12pg_common.t +++ b/t/backcompat/0.04006/12pg_common.t @@ -1,26 +1,21 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => qw(test_backcompat test_rdbms_pg); + use strict; use lib qw(t/backcompat/0.04006/lib); use dbixcsl_common_tests; use Test::More; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; my $dsn = $ENV{DBICTEST_PG_DSN} || ''; my $user = $ENV{DBICTEST_PG_USER} || ''; my $password = $ENV{DBICTEST_PG_PASS} || ''; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'Pg', auto_inc_pk => 'SERIAL NOT NULL PRIMARY KEY', dsn => $dsn, user => $user, password => $password, -); +)->run_tests(); -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_PG_DSN, _USER, and _PASS environment variables'); -} -else { - $tester->run_tests(); -} diff --git a/t/backcompat/0.04006/13db2_common.t b/t/backcompat/0.04006/13db2_common.t index 259b1e3..a886cb0 100644 --- a/t/backcompat/0.04006/13db2_common.t +++ b/t/backcompat/0.04006/13db2_common.t @@ -1,27 +1,20 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => qw(test_backcompat test_rdbms_db2); + use strict; use lib qw(t/backcompat/0.04006/lib); use dbixcsl_common_tests; use Test::More; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - my $dsn = $ENV{DBICTEST_DB2_DSN} || ''; my $user = $ENV{DBICTEST_DB2_USER} || ''; my $password = $ENV{DBICTEST_DB2_PASS} || ''; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'DB2', auto_inc_pk => 'INTEGER GENERATED BY DEFAULT AS IDENTITY NOT NULL PRIMARY KEY', dsn => $dsn, user => $user, password => $password, db_schema => uc $user, -); - -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_DB2_DSN, _USER, and _PASS environment variables'); -} -else { - $tester->run_tests(); -} +)->run_tests(); diff --git a/t/backcompat/0.04006/14ora_common.t b/t/backcompat/0.04006/14ora_common.t index 3d55602..edf1d9a 100644 --- a/t/backcompat/0.04006/14ora_common.t +++ b/t/backcompat/0.04006/14ora_common.t @@ -1,16 +1,16 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => qw(test_backcompat test_rdbms_oracle); + use strict; use lib qw(t/backcompat/0.04006/lib); use dbixcsl_common_tests; use Test::More; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - my $dsn = $ENV{DBICTEST_ORA_DSN} || ''; my $user = $ENV{DBICTEST_ORA_USER} || ''; my $password = $ENV{DBICTEST_ORA_PASS} || ''; -my $tester = dbixcsl_common_tests->new( +dbixcsl_common_tests->new( vendor => 'Oracle', auto_inc_pk => 'INTEGER NOT NULL PRIMARY KEY', auto_inc_cb => sub { @@ -34,11 +34,4 @@ my $tester = dbixcsl_common_tests->new( dsn => $dsn, user => $user, password => $password, -); - -if( !$dsn || !$user ) { - $tester->skip_tests('You need to set the DBICTEST_ORA_DSN, _USER, and _PASS environment variables'); -} -else { - $tester->run_tests(); -} +)->run_tests(); diff --git a/t/backcompat/0.04006/20invocations.t b/t/backcompat/0.04006/20invocations.t index 6060355..1246c70 100644 --- a/t/backcompat/0.04006/20invocations.t +++ b/t/backcompat/0.04006/20invocations.t @@ -1,11 +1,11 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_backcompat'; + use strict; use Test::More; use lib qw(t/backcompat/0.04006/lib); use make_dbictest_db; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - local $SIG{__WARN__} = sub { warn @_ unless $_[0] =~ /Dynamic schema|really_erase_my_files/; }; diff --git a/t/backcompat/0.04006/21misc_fatal.t b/t/backcompat/0.04006/21misc_fatal.t index ac645ad..849e3d4 100644 --- a/t/backcompat/0.04006/21misc_fatal.t +++ b/t/backcompat/0.04006/21misc_fatal.t @@ -1,10 +1,10 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_backcompat'; + use strict; use Test::More; use lib qw(t/backcompat/0.04006/lib); use make_dbictest_db; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - { $INC{'DBIx/Class/Storage/xyzzy.pm'} = 1; diff --git a/t/backcompat/0.04006/22dump.t b/t/backcompat/0.04006/22dump.t index 4279455..62c1a29 100644 --- a/t/backcompat/0.04006/22dump.t +++ b/t/backcompat/0.04006/22dump.t @@ -1,3 +1,6 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_backcompat'; + use strict; use Test::More; use lib qw(t/backcompat/0.04006/lib); @@ -5,9 +8,6 @@ use File::Path; use make_dbictest_db; use dbixcsl_test_dir qw/$tdir/; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - my $dump_path = "$tdir/dump"; local $SIG{__WARN__} = sub { diff --git a/t/backcompat/0.04006/23dumpmore.t b/t/backcompat/0.04006/23dumpmore.t index 8a48d0d..8f87097 100644 --- a/t/backcompat/0.04006/23dumpmore.t +++ b/t/backcompat/0.04006/23dumpmore.t @@ -1,3 +1,6 @@ +use DBIx::Class::Schema::Loader::Optional::Dependencies + -skip_all_without => 'test_backcompat'; + use strict; use Test::More; use lib qw(t/backcompat/0.04006/lib); @@ -8,9 +11,6 @@ use Class::Unload (); require DBIx::Class::Schema::Loader; -plan skip_all => 'set SCHEMA_LOADER_TESTS_BACKCOMPAT to enable these tests' - unless $ENV{SCHEMA_LOADER_TESTS_BACKCOMPAT}; - my $DUMP_PATH = "$tdir/dump"; sub do_dump_test {