MediaWiki  master
ReleaseNotesTest.php
Go to the documentation of this file.
1 <?php
2 
15  global $wgVersion, $IP;
16 
17  $notesFiles = glob( "$IP/RELEASE-NOTES-*" );
18 
19  $this->assertGreaterThanOrEqual(
20  1,
21  count( $notesFiles ),
22  'Repo has at least one Release Notes file.'
23  );
24 
25  $versionParts = explode( '.', explode( '-', $wgVersion )[0] );
26  $this->assertContains(
27  "$IP/RELEASE-NOTES-$versionParts[0].$versionParts[1]",
28  $notesFiles,
29  'Repo has a Release Notes file for the current $wgVersion.'
30  );
31 
32  foreach ( $notesFiles as $index => $fileName ) {
33  $this->assertFileLength( "Release Notes", $fileName );
34  }
35  }
36 
37  public static function provideFilesAtRoot() {
38  global $IP;
39 
40  $rootFiles = [
41  "COPYING",
42  "FAQ",
43  "HISTORY",
44  "INSTALL",
45  "README",
46  "SECURITY",
47  ];
48 
49  foreach ( $rootFiles as $rootFile ) {
50  yield "$rootFile file" => [ "$IP/$rootFile" ];
51  }
52  }
53 
58  public function testRootFilesHaveProperLineLength( $fileName ) {
59  $this->assertFileLength( "Help", $fileName );
60  }
61 
62  private function assertFileLength( $type, $fileName ) {
63  $lines = file( $fileName, FILE_IGNORE_NEW_LINES );
64 
65  $this->assertNotFalse(
66  $lines,
67  "$type file '$fileName' is inaccessible."
68  );
69 
70  $errors = [];
71  foreach ( $lines as $i => $line ) {
72  $num = $i + 1;
73 
74  // FILE_IGNORE_NEW_LINES drops the \n at the EOL, so max length is 80 not 81.
75  $max_length = 80;
76 
77  $length = mb_strlen( $line );
78  if ( $length <= $max_length ) {
79  continue;
80  }
81  $errors[] = "line $num: length $length > $max_length:\n$line";
82  }
83  # Use assertSame() instead of assertEqual(), to show the full line in the diff
84  $this->assertSame(
85  [],
86  $errors,
87  "$type file '$fileName' lines " .
88  "have at most $max_length characters"
89  );
90  }
91 }
assertFileLength( $type, $fileName)
$wgVersion
MediaWiki version number.
James doesn&#39;t like having to manually fix these things.
$IP
Definition: WebStart.php:41
static provideFilesAtRoot()
testReleaseNotesFilesExistAndAreNotMalformed()
Verify that at least one Release Notes file exists, have content, and aren&#39;t overly long...
testRootFilesHaveProperLineLength( $fileName)
provideFilesAtRoot
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
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
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
$lines
Definition: router.php:61
$line
Definition: cdb.php:59