MediaWiki  1.28.1
DbTestPreviewer.php
Go to the documentation of this file.
1 <?php
23  protected $filter; // /< Test name filter callback
24  protected $lb; // /< Database load balancer
25  protected $db; // /< Database connection to the main DB
26  protected $curRun; // /< run ID number for the current run
27  protected $prevRun; // /< run ID number for the previous run, if any
28  protected $results; // /< Result array
29 
33  function __construct( $db, $filter = false ) {
34  $this->db = $db;
35  $this->filter = $filter;
36  }
37 
42  function start() {
43  if ( !$this->db->tableExists( 'testrun', __METHOD__ )
44  || !$this->db->tableExists( 'testitem', __METHOD__ )
45  ) {
46  print "WARNING> `testrun` table not found in database.\n";
47  $this->prevRun = false;
48  } else {
49  // We'll make comparisons against the previous run later...
50  $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
51  }
52 
53  $this->results = [];
54  }
55 
56  function record( $test, ParserTestResult $result ) {
57  $this->results[$test['desc']] = $result->isSuccess() ? 1 : 0;
58  }
59 
60  function report() {
61  if ( $this->prevRun ) {
62  // f = fail, p = pass, n = nonexistent
63  // codes show before then after
64  $table = [
65  'fp' => 'previously failing test(s) now PASSING! :)',
66  'pn' => 'previously PASSING test(s) removed o_O',
67  'np' => 'new PASSING test(s) :)',
68 
69  'pf' => 'previously passing test(s) now FAILING! :(',
70  'fn' => 'previously FAILING test(s) removed O_o',
71  'nf' => 'new FAILING test(s) :(',
72  'ff' => 'still FAILING test(s) :(',
73  ];
74 
75  $prevResults = [];
76 
77  $res = $this->db->select( 'testitem', [ 'ti_name', 'ti_success' ],
78  [ 'ti_run' => $this->prevRun ], __METHOD__ );
80 
81  foreach ( $res as $row ) {
82  if ( !$filter || $filter( $row->ti_name ) ) {
83  $prevResults[$row->ti_name] = $row->ti_success;
84  }
85  }
86 
87  $combined = array_keys( $this->results + $prevResults );
88 
89  # Determine breakdown by change type
90  $breakdown = [];
91  foreach ( $combined as $test ) {
92  if ( !isset( $prevResults[$test] ) ) {
93  $before = 'n';
94  } elseif ( $prevResults[$test] == 1 ) {
95  $before = 'p';
96  } else /* if ( $prevResults[$test] == 0 )*/ {
97  $before = 'f';
98  }
99 
100  if ( !isset( $this->results[$test] ) ) {
101  $after = 'n';
102  } elseif ( $this->results[$test] == 1 ) {
103  $after = 'p';
104  } else /*if ( $this->results[$test] == 0 ) */ {
105  $after = 'f';
106  }
107 
108  $code = $before . $after;
109 
110  if ( isset( $table[$code] ) ) {
111  $breakdown[$code][$test] = $this->getTestStatusInfo( $test, $after );
112  }
113  }
114 
115  # Write out results
116  foreach ( $table as $code => $label ) {
117  if ( !empty( $breakdown[$code] ) ) {
118  $count = count( $breakdown[$code] );
119  printf( "\n%4d %s\n", $count, $label );
120 
121  foreach ( $breakdown[$code] as $differing_test_name => $statusInfo ) {
122  print " * $differing_test_name [$statusInfo]\n";
123  }
124  }
125  }
126  } else {
127  print "No previous test runs to compare against.\n";
128  }
129 
130  print "\n";
131  }
132 
141  private function getTestStatusInfo( $testname, $after ) {
142  // If we're looking at a test that has just been removed, then say when it first appeared.
143  if ( $after == 'n' ) {
144  $changedRun = $this->db->selectField( 'testitem',
145  'MIN(ti_run)',
146  [ 'ti_name' => $testname ],
147  __METHOD__ );
148  $appear = $this->db->selectRow( 'testrun',
149  [ 'tr_date', 'tr_mw_version' ],
150  [ 'tr_id' => $changedRun ],
151  __METHOD__ );
152 
153  return "First recorded appearance: "
154  . date( "d-M-Y H:i:s", strtotime( $appear->tr_date ) )
155  . ", " . $appear->tr_mw_version;
156  }
157 
158  // Otherwise, this test has previous recorded results.
159  // See when this test last had a different result to what we're seeing now.
160  $conds = [
161  'ti_name' => $testname,
162  'ti_success' => ( $after == 'f' ? "1" : "0" ) ];
163 
164  if ( $this->curRun ) {
165  $conds[] = "ti_run != " . $this->db->addQuotes( $this->curRun );
166  }
167 
168  $changedRun = $this->db->selectField( 'testitem', 'MAX(ti_run)', $conds, __METHOD__ );
169 
170  // If no record of ever having had a different result.
171  if ( is_null( $changedRun ) ) {
172  if ( $after == "f" ) {
173  return "Has never passed";
174  } else {
175  return "Has never failed";
176  }
177  }
178 
179  // Otherwise, we're looking at a test whose status has changed.
180  // (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
181  // In this situation, give as much info as we can as to when it changed status.
182  $pre = $this->db->selectRow( 'testrun',
183  [ 'tr_date', 'tr_mw_version' ],
184  [ 'tr_id' => $changedRun ],
185  __METHOD__ );
186  $post = $this->db->selectRow( 'testrun',
187  [ 'tr_date', 'tr_mw_version' ],
188  [ "tr_id > " . $this->db->addQuotes( $changedRun ) ],
189  __METHOD__,
190  [ "LIMIT" => 1, "ORDER BY" => 'tr_id' ]
191  );
192 
193  if ( $post ) {
194  $postDate = date( "d-M-Y H:i:s", strtotime( $post->tr_date ) ) . ", {$post->tr_mw_version}";
195  } else {
196  $postDate = 'now';
197  }
198 
199  return ( $after == "f" ? "Introduced" : "Fixed" ) . " between "
200  . date( "d-M-Y H:i:s", strtotime( $pre->tr_date ) ) . ", " . $pre->tr_mw_version
201  . " and $postDate";
202  }
203 }
204 
__construct($db, $filter=false)
This should be called before the table prefix is changed.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
$res
Definition: database.txt:21
record($test, ParserTestResult $result)
isSuccess()
Whether the test passed.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:802
Interface to record parser test results.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getTestStatusInfo($testname, $after)
Returns a string giving information about when a test last had a status change.
$count
Represent the result of a parser test.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped $pre
Definition: hooks.txt:1442
start()
Set up result recording; insert a record for the run with the date and all that fun stuff...