1 package DBICTest::Util;
6 use constant DEBUG_TEST_CONCURRENCY_LOCKS =>
7 ( ($ENV{DBICTEST_DEBUG_CONCURRENCY_LOCKS}||'') =~ /^(\d+)$/ )[0]
13 use Carp qw(cluck confess croak);
15 use Scalar::Util qw(blessed refaddr);
16 use DBIx::Class::_Util qw( scope_guard parent_dir );
21 local_umask find_co_root
24 await_flock DEBUG_TEST_CONCURRENCY_LOCKS
27 if (DEBUG_TEST_CONCURRENCY_LOCKS) {
29 my $oc = DBI->can('connect');
30 no warnings 'redefine';
32 DBICTest::Util::dbg("Connecting to $_[1]");
39 printf STDERR "\n%.06f %5s %-78s %s\n",
40 scalar Time::HiRes::time(),
47 # File locking is hard. Really hard. By far the best lock implementation
48 # I've seen is part of the guts of File::Temp. However it is sadly not
49 # reusable. Since I am not aware of folks doing NFS parallel testing,
50 # nor are we known to work on VMS, I am just going to punt this and
51 # use the portable-ish flock() provided by perl itself. If this does
52 # not work for you - patches more than welcome.
54 # This figure esentially means "how long can a single test hold a
55 # resource before everyone else gives up waiting and aborts" or
56 # in other words "how long does the longest test-group legitimally run?"
57 my $lock_timeout_minutes = 15; # yes, that's long, I know
58 my $wait_step_seconds = 0.25;
60 sub await_flock ($$) {
61 my ($fh, $locktype) = @_;
65 ! ( $res = flock( $fh, $locktype | LOCK_NB ) )
67 ++$tries <= $lock_timeout_minutes * 60 / $wait_step_seconds
69 select( undef, undef, undef, $wait_step_seconds );
71 # "say something" every 10 cycles to work around RT#108390
72 # jesus christ our tooling is such a crock of shit :(
73 print "#\n" if not $tries % 10;
81 return unless defined $Config{d_umask};
83 croak 'Calling local_umask() in void context makes no sense'
84 if ! defined wantarray;
86 my $old_umask = umask($_[0]);
87 die "Setting umask failed: $!" unless defined $old_umask;
93 defined(umask $old_umask) or die "nope";
96 "Unable to reset old umask '$old_umask': " . ($! || 'Unknown error')
101 # Try to determine the root of a checkout/untar if possible
102 # OR throws an exception
104 sub find_co_root () {
108 my @mod_parts = split /::/, (__PACKAGE__ . '.pm');
109 my $inc_key = join ('/', @mod_parts); # %INC stores paths with / regardless of OS
111 # a bit convoluted, but what we do here essentially is:
112 # - get the file name of this particular module
113 # - do 'cd ..' as many times as necessary to get to t/lib/../..
115 my $root = $INC{$inc_key}
116 or croak "\$INC{'$inc_key'} seems to be missing, this can't happen...";
118 $root = parent_dir $root
119 for 1 .. @mod_parts + 2;
121 # do the check twice so that the exception is more informative in the
122 # very unlikely case of realpath returning garbage
123 # (Paththools are in really bad shape - handholding all the way down)
124 for my $call_realpath (0,1) {
126 require Cwd and $root = ( Cwd::realpath($root) . '/' )
129 croak "Unable to find root of DBIC checkout/untar: '${root}Makefile.PL' does not exist"
130 unless -f "${root}Makefile.PL";
143 while (@frame = CORE::caller($frame++)) {
144 push @stack, [@frame[3,1,2]];
147 return undef unless @stack;
150 return join "\tinvoked as ", map { sprintf ("%s at %s line %d\n", @$_ ) } @stack;
153 sub check_customcond_args ($) {
156 confess "Expecting a hashref"
157 unless ref $args eq 'HASH';
159 for (qw(rel_name foreign_relname self_alias foreign_alias)) {
160 confess "Custom condition argument '$_' must be a plain string"
161 if length ref $args->{$_} or ! length $args->{$_};
164 confess "Current and legacy rel_name arguments do not match"
165 if $args->{rel_name} ne $args->{foreign_relname};
167 confess "Custom condition argument 'self_resultsource' must be a rsrc instance"
168 unless defined blessed $args->{self_resultsource} and $args->{self_resultsource}->isa('DBIx::Class::ResultSource');
170 confess "Passed resultsource has no record of the supplied rel_name - likely wrong \$rsrc"
171 unless ref $args->{self_resultsource}->relationship_info($args->{rel_name});
175 if (defined $args->{self_result_object} or defined $args->{self_rowobj} ) {
177 for (qw(self_result_object self_rowobj)) {
178 confess "Custom condition argument '$_' must be a result instance"
179 unless defined blessed $args->{$_} and $args->{$_}->isa('DBIx::Class::Row');
182 confess "Current and legacy self_result_object arguments do not match"
183 if refaddr($args->{self_result_object}) != refaddr($args->{self_rowobj});
186 if (defined $args->{foreign_values}) {
189 confess "Custom condition argument 'foreign_values' must be a hash reference"
190 unless ref $args->{foreign_values} eq 'HASH';
193 confess "Data structures supplied on both ends of a relationship"
199 sub visit_namespaces {
200 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
202 my $visited_count = 1;
204 # A package and a namespace are subtly different things
205 $args->{package} ||= 'main';
206 $args->{package} = 'main' if $args->{package} =~ /^ :: (?: main )? $/x;
207 $args->{package} =~ s/^:://;
209 if ( $args->{action}->($args->{package}) ) {
211 ( ($args->{package} eq 'main') ? '' : $args->{package} )
216 $visited_count += visit_namespaces( %$args, package => $_ ) for
218 # this happens sometimes on %:: traversal
221 { $_ =~ /^(.+?)::$/ ? "$ns$1" : () }
222 do { no strict 'refs'; keys %$ns }
226 return $visited_count;