/
README
179 lines (127 loc) · 6.39 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
NAME
CPANPLUS::YACSmoke - Yet Another CPANPLUS Smoke Tester
SYNOPSIS
perl -MCPANPLUS::YACSmoke -e test
DESCRIPTION
CPANPLUS::YACSmoke is an enhancement of the venerable CPAN::YACSmoke
that uses the API backend of CPANPLUS to run tests on CPAN modules and
post results to the CPAN Testers list.
CPANPLUS::Dist::YACSmoke is loaded into the CPANPLUS configuration
before any modules are tested.
It will create a database file in the .cpanplus directory, which it uses
to track tested distributions. This information will be used to keep
from posting multiple reports for the same module, and to keep from
testing modules that use non-passing modules as prerequisites.
If "prereqs" have been tested previously and have resulted in a "pass"
grade then the tests for those "prereqs" will be skipped, speeding up
smoke testing.
By default it uses CPANPLUS configuration settings.
CONFIGURATION FILE
CPANPLUS::YACSmoke only honours the "exclude_dists" in CPAN::YACSmoke
style "ini" files.
The "exclude_dists" setting, which is laid out as:
[CONFIG]
exclude_dists=<<HERE
mod_perl
HERE
The above would then ignore any distribution that include the string
'mod_perl' in its name. This is useful for distributions which use
external C libraries, which are not installed, or for which testing is
problematic.
See Config::IniFiles for more information on the INI file format.
PROCEDURAL INTERFACE
EXPORTS
The following routines are exported by default. They are intended to be
called from the command-line, though they could be used from a script.
test( [ $dist [, $dist .... ] ] )
perl -MCPANPLUS::YACSmoke -e test
perl -MCPANPLUS::YACSmoke -e test('R/RR/RRWO/Some-Dist-0.01.tar.gz')
Runs tests on CPAN distributions. Arguments should be paths of
individual distributions in the author directories. If no arguments
are given, it will download the RECENT file from CPAN and use that.
By default it uses CPANPLUS configuration settings. If CPANPLUS is
set not to send test reports, then it will not send test reports.
mark( $dist [, $grade ] ] )
perl -MCPANPLUS::YACSmoke -e mark('Some-Dist-0.01')
perl -MCPANPLUS::YACSmoke -e mark('Some-Dist-0.01', 'fail')
Retrieves the test result in the database, or changes the test
result.
It can be useful to update the status of a distribution that once
failed or was untestable but now works, so as to test modules which
make use of it.
Grades can be one of (case insensitive):
aborted = tests aborted (uninstallable prereqs or other failure in test)
pass = passed tests
fail = failed tests
unknown = no tests available
na = not applicable to platform or installed libraries
ungraded = no grade (test possibly aborted by user)
none = undefines a grade
ignored = package was ignored (a newer version was tested)
excluded( [ $dist [, $dist ... ] ] )
perl -MCPANPLUS::YACSmoke -e excluded('Some-Dist-0.01')
perl -MCPANPLUS::YACSmoke -e excluded()
Given a list of distributions, indicates which ones would be
excluded from testing, based on the exclude_dist list that is
created.
purge( [ \%config, ] [ $dist [, $dist ... ] ] )
perl -MCPANPLUS::YACSmoke -e purge()
perl -MCPANPLUS::YACSmoke -e purge('Some-Dist-0.01')
Purges the entries from the local cpansmoke database. The criteria
for purging is that a distribution must have a more recent version,
which has previously been marked as a PASS. However, if one or more
distributions are passed as a parameter list, those specific
distributions will be purged.
If the flush_flag is set, via the config hashref, to a true value,
the directory path created for each older copy of a distribution is
deleted.
flush( [ 'all' | 'old' ] )
perl -MCPAN::YACSmoke -e flush()
perl -MCPAN::YACSmoke -e flush('all')
perl -MCPAN::YACSmoke -e flush('old')
Removes unrequired build directories from the designated CPANPLUS
build directory. Note that this deletes directories regardless of
whether the associated distribution was tested.
Default flush is 'all'. The 'old' option will only delete the older
distributions, of multiple instances of a distribution.
Note that this cannot be done reliably using last access or modify
time, as the intention is for this distribution to be used on any OS
that CPANPLUS is installed on. In this case not all OSs support the
full range of return values from the stat function.
OBJECT INTERFACE
Each of the procedural interface functions are available as methods of a
CPANPLUS::YACSmoke object.
"new"
The object interface is created normally through the test() or
mark() functions of the procedural interface.
ENVIRONMENT VARIABLES
Several environment variables get set by the module:
"AUTOMATED_TESTING"
Set to 1 to indicate that we are currently running in an automated
testing environment
"PERL_MM_USE_DEFAULT"
Set to 1 MakeMaker and Module::Build's prompt functions will always
return the default without waiting for user input.
"PERL5_CPANPLUS_VERBOSE"
Set to 1 so CPANPLUS will run in "verbose" mode.
"MAILDOMAIN"
Test::Reporter uses this. YACSmoke will set this if it isn't already
set. It will try to determine the domain from the "email" setting in
CPANPLUS. If this is "cpan.org" it will default to "cpantesters.org"
( the perl.org MX doesn't like people trying to impersonate it, for
obvious reasons ).
AUTHOR
Chris "BinGOs" Williams <chris@bingosnet.co.uk>
Based on CPAN::YACSmoke by Robert Rothenberg and Barbie.
Contributions and patience from Jos Boumans the CPANPLUS guy!
LICENSE
Copyright "(c)" Chris Williams, Jos Boumans, Robert Rothenberg and
Barbie.
This module may be used, modified, and distributed under the same terms
as Perl itself. Please see the license that came with your Perl
distribution for details.
SEE ALSO
CPANPLUS
CPANPLUS::Dist::YACSmoke
CPAN::YACSmoke
Test::Reporter