… | |
… | |
21 | =cut |
21 | =cut |
22 | |
22 | |
23 | package Canary::Stability; |
23 | package Canary::Stability; |
24 | |
24 | |
25 | BEGIN { |
25 | BEGIN { |
26 | $VERSION = 2006; |
26 | $VERSION = 2013; |
27 | } |
27 | } |
28 | |
28 | |
29 | sub sgr { |
29 | sub sgr { |
30 | # we just assume ANSI almost everywhere |
30 | # we just assume ANSI almost everywhere |
31 | # red 31, yellow 33, green 32 |
31 | # red 31, yellow 33, green 32 |
… | |
… | |
42 | $ENV{PERL_CANARY_STABILITY_DISABLE} |
42 | $ENV{PERL_CANARY_STABILITY_DISABLE} |
43 | and return; |
43 | and return; |
44 | |
44 | |
45 | $minperl ||= 5.008002; |
45 | $minperl ||= 5.008002; |
46 | |
46 | |
|
|
47 | print <<EOF; |
|
|
48 | |
|
|
49 | *** |
|
|
50 | *** Canary::Stability COMPATIBILITY AND SUPPORT CHECK |
|
|
51 | *** ================================================= |
|
|
52 | *** |
|
|
53 | *** Hi! |
|
|
54 | *** |
|
|
55 | *** I do my best to provide predictable and reliable software. |
|
|
56 | *** |
|
|
57 | *** However, in recent releases, P5P (who maintain perl) have been |
|
|
58 | *** introducing regressions that are sometimes subtle and at other times |
|
|
59 | *** catastrophic, often for personal preferences with little or no concern |
|
|
60 | *** for existing code, most notably CPAN. |
|
|
61 | *** |
|
|
62 | *** For this reason, it has become very hard for me to maintain the level |
|
|
63 | *** of reliability and support I have committed myself to in the past, at |
|
|
64 | *** least with some perl versions: I simply can't keep up working around new |
|
|
65 | *** bugs or gratituous incompatibilities, and in turn you might suffer from |
|
|
66 | *** unanticipated problems. |
|
|
67 | *** |
|
|
68 | *** Therefore I have introduced a support and compatibility check, the results |
|
|
69 | *** of which follow below, together with a FAQ and some recommendations. |
|
|
70 | *** |
|
|
71 | *** This check is just to let you know that there might be a risk, so you can |
|
|
72 | *** make judgement calls on how to proceed - it will not keep the module from |
|
|
73 | *** installing or working. |
|
|
74 | *** |
|
|
75 | EOF |
|
|
76 | |
47 | if ($minvers > $VERSION) { |
77 | if ($minvers > $VERSION) { |
48 | sgr 33; |
78 | sgr 33; |
49 | print <<EOF; |
79 | print <<EOF; |
50 | |
|
|
51 | *** |
|
|
52 | *** The stability canary says: (nothing, it died of old age). |
80 | *** The stability canary says: (nothing, it died of old age). |
53 | *** |
81 | *** |
54 | *** Your Canary::Stability module (used by $distname) is too old. |
82 | *** Your Canary::Stability module (used by $distname) is too old. |
55 | *** This is not a fatal problem - while you might want to upgrade to version |
83 | *** This is not a fatal problem - while you might want to upgrade to version |
56 | *** $minvers (currently installed version: $VERSION) to get better support |
84 | *** $minvers (currently installed version: $VERSION) to get better support |
57 | *** status testing, you might also not want to care at all, and all will |
85 | *** status testing, you might also not want to care at all, and all will |
58 | *** be well as long $distname works well enough for you, as the stability |
86 | *** be well as long $distname works well enough for you, as the stability |
59 | *** canary is only used when installing the distribution. |
87 | *** canary is only used when installing the distribution. |
60 | *** |
88 | *** |
61 | |
|
|
62 | EOF |
89 | EOF |
63 | } elsif ($] < $minperl) { |
90 | } elsif ($] < $minperl) { |
64 | |
91 | |
65 | sgr 33; |
92 | sgr 33; |
66 | print <<EOF; |
93 | print <<EOF; |
67 | |
|
|
68 | *** |
|
|
69 | *** The stability canary says: chirp (it seems concerned about something). |
94 | *** The stability canary says: chirp (it seems concerned about something). |
70 | *** |
95 | *** |
71 | *** Your perl version ($]) is older than the $distname distribution |
96 | *** Your perl version ($]) is older than the $distname distribution |
72 | *** likes ($minperl). This is not a fatal problem - the module might work |
97 | *** likes ($minperl). This is not a fatal problem - the module might work |
73 | *** well with your version of perl, but it does mean the author likely |
98 | *** well with your version of perl, but it does mean the author likely |
74 | *** won't do anything to make it work if it breaks. |
99 | *** won't do anything to make it work if it breaks. |
75 | *** |
100 | *** |
76 | |
|
|
77 | EOF |
101 | EOF |
|
|
102 | |
|
|
103 | if ($ENV{AUTOMATED_TESTING}) { |
|
|
104 | print <<EOF; |
|
|
105 | *** Since this is an AUTOMATED_TESTING environment, the stability canary |
|
|
106 | *** decided to fail cleanly here, rather than to generate a false test |
|
|
107 | *** result. |
|
|
108 | *** |
|
|
109 | EOF |
|
|
110 | exit 0; |
|
|
111 | } |
|
|
112 | |
78 | } elsif (defined $Internals::StabilityBranchVersion) { |
113 | } elsif (defined $Internals::StabilityBranchVersion) { |
79 | # note to people studying this modules sources: |
114 | # note to people studying this modules sources: |
80 | # the above test is not considered a clean or stable way to |
115 | # the above test is not considered a clean or stable way to |
81 | # test for the stability branch. |
116 | # test for the stability branch. |
82 | |
117 | |
83 | sgr 32; |
118 | sgr 32; |
84 | print <<EOF; |
119 | print <<EOF; |
85 | |
|
|
86 | *** |
|
|
87 | *** The stability canary says: chirp! chirp! (it seems to be quite excited) |
120 | *** The stability canary says: chirp! chirp! (it seems to be quite excited) |
88 | *** |
121 | *** |
89 | *** It seems you are running schmorp's stability branch of perl. |
122 | *** It seems you are running schmorp's stability branch of perl. |
90 | *** All should be well, and if it isn't, you should report this as a bug |
123 | *** All should be well, and if it isn't, you should report this as a bug |
91 | *** to the $distname author. |
124 | *** to the $distname author. |
92 | *** |
125 | *** |
93 | |
|
|
94 | EOF |
126 | EOF |
95 | } elsif ($] < 5.021) { |
127 | } elsif ($] < 5.021) { |
96 | #sgr 32; |
128 | #sgr 32; |
97 | print <<EOF; |
129 | print <<EOF; |
98 | |
|
|
99 | *** |
|
|
100 | *** The stability canary says: chirp! chirp! (it seems to be quite happy) |
130 | *** The stability canary says: chirp! chirp! (it seems to be quite happy) |
101 | *** |
131 | *** |
102 | *** Your version of perl ($]) is quite supported by $distname, nothing |
132 | *** Your version of perl ($]) is quite supported by $distname, nothing |
103 | *** else to be said, hope it comes in handy. |
133 | *** else to be said, hope it comes in handy. |
104 | *** |
134 | *** |
105 | |
|
|
106 | EOF |
135 | EOF |
107 | } else { |
136 | } else { |
108 | sgr 31; |
137 | sgr 31; |
109 | print <<EOF; |
138 | print <<EOF; |
110 | |
|
|
111 | *** |
|
|
112 | *** The stability canary says: (nothing, it was driven away by harsh weather) |
139 | *** The stability canary says: (nothing, it was driven away by harsh weather) |
113 | *** |
140 | *** |
114 | *** It seems you are running perl version $], likely the "official" or |
141 | *** It seems you are running perl version $], likely the "official" or |
115 | *** "standard" version. While there is nothing wrong with doing that, |
142 | *** "standard" version. While there is nothing wrong with doing that, |
116 | *** standard perl versions 5.022 and up are not supported by $distname. |
143 | *** standard perl versions 5.022 and up are not supported by $distname. |
… | |
… | |
121 | *** If everything works fine, you can ignore this message. |
148 | *** If everything works fine, you can ignore this message. |
122 | *** |
149 | *** |
123 | EOF |
150 | EOF |
124 | sgr 0; |
151 | sgr 0; |
125 | print <<EOF; |
152 | print <<EOF; |
|
|
153 | *** |
126 | *** Stability canary mini-FAQ: |
154 | *** Stability canary mini-FAQ: |
127 | *** |
155 | *** |
128 | *** Do I need to do anything? |
156 | *** Do I need to do anything? |
129 | *** With luck, no. While some distributions are known to fail |
157 | *** With luck, no. While some distributions are known to fail |
130 | *** already, most should probably work. This message is here |
158 | *** already, most should probably work. This message is here |
… | |
… | |
180 | |
208 | |
181 | =item C<PERL_CANARY_STABILITY_DISABLE=1> |
209 | =item C<PERL_CANARY_STABILITY_DISABLE=1> |
182 | |
210 | |
183 | Disable this modules functionality completely. |
211 | Disable this modules functionality completely. |
184 | |
212 | |
|
|
213 | =item C<AUTOMATED_TESTING=1> |
|
|
214 | |
|
|
215 | When this variable is set to a true value and the perl minimum version |
|
|
216 | requirement is not met, the module will exit, which should skip testing |
|
|
217 | under automated testing environments. |
|
|
218 | |
|
|
219 | This is done to avoid false failure or success reports when the chances of |
|
|
220 | success are already quite low and the failures are not supported by the |
|
|
221 | author. |
|
|
222 | |
185 | =back |
223 | =back |
186 | |
224 | |
187 | =head1 AUTHOR |
225 | =head1 AUTHOR |
188 | |
226 | |
189 | Marc Lehmann <schmorp@schmorp.de> |
227 | Marc Lehmann <schmorp@schmorp.de> |