wiki.techinc.nl/tests/phpunit/documentation/ReleaseNotesTest.php

<?php

/**
 * James doesn't like having to manually fix these things.
 */
class ReleaseNotesTest extends MediaWikiTestCase {
	/**
	 * Verify that at least one Release Notes file exists, have content, and
	 * aren't overly long.
	 *
	 * @group documentation
	 * @coversNothing
	 */
	public function testReleaseNotesFilesExistAndAreNotMalformed() {
		global $wgVersion, $IP;

		$notesFiles = glob( "$IP/RELEASE-NOTES-*" );

		$this->assertGreaterThanOrEqual(
			1,
			count( $notesFiles ),
			'Repo has at least one Release Notes file.'
		);

		$versionParts = explode( '.', explode( '-', $wgVersion )[0] );
		$this->assertContains(
			"$IP/RELEASE-NOTES-$versionParts[0].$versionParts[1]",
			$notesFiles,
			'Repo has a Release Notes file for the current $wgVersion.'
		);

		foreach ( $notesFiles as $index => $fileName ) {
			$this->assertFileLength( "Release Notes", $fileName );
		}

		// Also test the README and similar files
		$otherFiles = [
			"$IP/COPYING",
			"$IP/FAQ",
			"$IP/HISTORY",
			"$IP/INSTALL",
			"$IP/README",
			"$IP/SECURITY"
		];

		foreach ( $otherFiles as $index => $fileName ) {
			$this->assertFileLength( "Help", $fileName );
		}
	}

	private function assertFileLength( $type, $fileName ) {
		$file = file( $fileName, FILE_IGNORE_NEW_LINES );

		$this->assertFalse(
			!$file,
			"$type file '$fileName' is inaccessible."
		);

		foreach ( $file as $i => $line ) {
			$num = $i + 1;
			$this->assertLessThanOrEqual(
				// FILE_IGNORE_NEW_LINES drops the \n at the EOL, so max length is 80 not 81.
				80,
				mb_strlen( $line ),
				"$type file '$fileName' line $num, is longer than 80 chars:\n\t'$line'"
			);
		}
	}
}