1 package # hide from PAUSE
8 if ($INC{'DBIx/Class.pm'}) {
10 while (@frame = caller($fr++)) {
11 last if $frame[1] !~ m|^t/lib/DBICTest|;
14 die __PACKAGE__ . " must be loaded before DBIx::Class (or modules using DBIx::Class) at $frame[1] line $frame[2]\n";
18 use Path::Class qw/file dir/;
23 _check_author_makefile() unless $ENV{DBICTEST_NO_MAKEFILE_VERIFICATION};
25 # PathTools has a bug where on MSWin32 it will often return / as a tmpdir.
26 # This is *really* stupid and the result of having our lockfiles all over
27 # the place is also rather obnoxious. So we use our own heuristics instead
28 # https://rt.cpan.org/Ticket/Display.html?id=76663
33 # works but not always
34 my $dir = dir(File::Spec->tmpdir);
35 my $reason_dir_unusable;
37 my @parts = File::Spec->splitdir($dir);
38 if (@parts == 2 and $parts[1] =~ /^ [ \\ \/ ]? $/x ) {
39 $reason_dir_unusable =
40 'File::Spec->tmpdir returned a root directory instead of a designated '
41 . 'tempdir (possibly https://rt.cpan.org/Ticket/Display.html?id=76663)';
44 # make sure we can actually create and sysopen a file in this dir
48 $tfh = File::Temp->new(
49 TEMPLATE => '_dbictest_writability_XXXXXX',
54 close $tfh or die "closing $fn failed: $!\n";
55 sysopen (my $tfh2, $fn, O_RDWR) or die "reopening $fn failed: $!\n";
56 print $tfh2 'deadbeef' x 1024 or die "printing to $fn failed: $!\n";
57 close $tfh2 or die "closing $fn failed: $!\n";
60 chomp( my $err = $@ );
61 my @x_tests = map { (defined $_) ? ( $_ ? 1 : 0 ) : 'U' } map {(-e, -d, -f, -r, -w, -x, -o)} ("$dir", "$tfh");
62 $reason_dir_unusable = sprintf <<"EOE", "$tfh"||'', $err, scalar $>, scalar $), (stat($dir))[4,5,2], @x_tests;
63 File::Spec->tmpdir returned a directory which appears to be non-writeable:
64 Error encountered while testing '%s': %s
65 Process EUID/EGID: %s / %s
66 TmpDir UID/GID: %s / %s
68 TmpDir X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s
69 TmpFile X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s
74 if ($reason_dir_unusable) {
75 # Replace with our local project tmpdir. This will make multiple runs
76 # from different runs conflict with each other, but is much better than
77 # polluting the root dir with random crap or failing outright
78 my $local_dir = _find_co_root()->subdir('t')->subdir('var');
81 warn "\n\nUsing '$local_dir' as test scratch-dir instead of '$dir': $reason_dir_unusable\n";
90 # Die if the author did not update his makefile
92 # This is pretty heavy handed, so the check is pretty solid:
94 # 1) Assume that this particular module is loaded from -I <$root>/t/lib
95 # 2) Make sure <$root>/Makefile.PL exists
96 # 3) Make sure we can stat() <$root>/Makefile.PL
98 # If all of the above is satisfied
100 # *) die if <$root>/inc does not exist
101 # *) die if no stat() results for <$root>/Makefile (covers no Makefile)
102 # *) die if Makefile.PL mtime > Makefile mtime
104 sub _check_author_makefile {
106 my $root = _find_co_root()
109 my $optdeps = file('lib/DBIx/Class/Optional/Dependencies.pm');
111 # not using file->stat as it invokes File::stat which in turn breaks stat(_)
112 my ($mf_pl_mtime, $mf_mtime, $optdeps_mtime) = ( map
113 { (stat ($root->file ($_)) )[9] || undef } # stat returns () on nonexistent files
114 (qw|Makefile.PL Makefile|, $optdeps)
117 return unless $mf_pl_mtime; # something went wrong during co_root detection ?
121 if(not -d $root->subdir ('inc')) {
122 push @fail_reasons, "Missing ./inc directory";
126 push @fail_reasons, "Missing ./Makefile";
129 if($mf_mtime < $mf_pl_mtime) {
130 push @fail_reasons, "./Makefile.PL is newer than ./Makefile";
132 if($mf_mtime < $optdeps_mtime) {
133 push @fail_reasons, "./$optdeps is newer than ./Makefile";
138 print STDERR <<'EOE';
140 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
141 ======================== FATAL ERROR ===========================
142 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
144 We have a number of reasons to believe that this is a development
145 checkout and that you, the user, did not run `perl Makefile.PL`
146 before using this code. You absolutely _must_ perform this step,
147 to ensure you have all required dependencies present. Not doing
148 so often results in a lot of wasted time for other contributors
149 trying to assist you with spurious "its broken!" problems.
151 By default DBICs Makefile.PL turns all optional dependencies into
152 *HARD REQUIREMENTS*, in order to make sure that the entire test
153 suite is executed, and no tests are skipped due to missing modules.
154 If you for some reason need to disable this behavior - supply the
155 --skip_author_deps option when running perl Makefile.PL
157 If you are seeing this message unexpectedly (i.e. you are in fact
158 attempting a regular installation be it through CPAN or manually),
159 please report the situation to either the mailing list or to the
160 irc channel as described in
162 http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class.pm#GETTING_HELP/SUPPORT
167 Reasons you received this message:
171 foreach my $r (@fail_reasons) {
172 print STDERR " * $r\n";
174 print STDERR "\n\n\n";
177 Time::HiRes::sleep(0.005);
178 print STDOUT "\nBail out!\n";
183 # Mimic $Module::Install::AUTHOR
186 my $root = _find_co_root()
190 ( not -d $root->subdir ('inc') )
192 ( -e $root->subdir ('inc')->subdir ($^O eq 'VMS' ? '_author' : '.author') )
198 ( ($ENV{TRAVIS}||'') eq 'true' )
200 ( $ENV{AUTOMATED_TESTING} && ! $ENV{PERL5_CPANM_IS_RUNNING} && ! $ENV{RELEASE_TESTING} )
205 return (! __PACKAGE__->is_smoker && ! __PACKAGE__->is_author && ! $ENV{RELEASE_TESTING} )
208 # Try to determine the root of a checkout/untar if possible
212 my @mod_parts = split /::/, (__PACKAGE__ . '.pm');
213 my $rel_path = join ('/', @mod_parts); # %INC stores paths with / regardless of OS
215 return undef unless ($INC{$rel_path});
217 # a bit convoluted, but what we do here essentially is:
218 # - get the file name of this particular module
219 # - do 'cd ..' as many times as necessary to get to t/lib/../..
221 my $root = dir ($INC{$rel_path});
222 for (1 .. @mod_parts + 2) {
223 $root = $root->parent;
226 return (-f $root->file ('Makefile.PL') )