Merge pull request #48049 from nextcloud/refactor/void-tests

refactor: Add void return type to PHPUnit test methods
nextcloud · Sep 15, 2024 · d46f271 · d46f271
2 parents bdb2fdb + e4cf430
commit d46f271
Show file tree

Hide file tree

Showing 671 changed files with 4,752 additions and 4,750 deletions.
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -11,3 +11,5 @@ aa5f037af71c915424c6dcfd5ad2dc82797dc0d6
 af6de04e9e141466dc229e444ff3f146f4a34765
 0bd284cb81b6866338aaaa67aa1d81ef9bfbb2ab
 8af7ecb2576071f170ecbb0aa2311b26581e40e2
+# Automated refactorings
+49dd79eabb2b8902559a7a4e8f8fcad54f46b604
diff --git a/apps/comments/tests/Unit/Activity/ListenerTest.php b/apps/comments/tests/Unit/Activity/ListenerTest.php
@@ -65,7 +65,7 @@ protected function setUp(): void {
 		);
 	}
 
-	public function testCommentEvent() {
+	public function testCommentEvent(): void {
 		$this->appManager->expects($this->any())
 			->method('isInstalled')
 			->with('activity')

diff --git a/apps/comments/tests/Unit/AppInfo/ApplicationTest.php b/apps/comments/tests/Unit/AppInfo/ApplicationTest.php
@@ -30,7 +30,7 @@ protected function tearDown(): void {
 		parent::tearDown();
 	}
 
-	public function test() {
+	public function test(): void {
 		$app = new Application();
 		$c = $app->getContainer();
 

diff --git a/apps/comments/tests/Unit/Collaboration/CommentersSorterTest.php b/apps/comments/tests/Unit/Collaboration/CommentersSorterTest.php
@@ -28,7 +28,7 @@ protected function setUp(): void {
 	 * @dataProvider sortDataProvider
 	 * @param $data
 	 */
-	public function testSort($data) {
+	public function testSort($data): void {
 		$commentMocks = [];
 		foreach ($data['actors'] as $actorType => $actors) {
 			foreach ($actors as $actorId => $noOfComments) {

diff --git a/apps/comments/tests/Unit/Controller/NotificationsTest.php b/apps/comments/tests/Unit/Controller/NotificationsTest.php
@@ -63,7 +63,7 @@ protected function setUp(): void {
 		);
 	}
 
-	public function testViewGuestRedirect() {
+	public function testViewGuestRedirect(): void {
 		$this->commentsManager->expects($this->never())
 			->method('get');
 
@@ -96,7 +96,7 @@ public function testViewGuestRedirect() {
 		$this->assertSame('link-to-login', $response->getRedirectURL());
 	}
 
-	public function testViewSuccess() {
+	public function testViewSuccess(): void {
 		$comment = $this->createMock(IComment::class);
 		$comment->expects($this->any())
 			->method('getObjectType')
@@ -146,7 +146,7 @@ public function testViewSuccess() {
 		$this->assertInstanceOf(RedirectResponse::class, $response);
 	}
 
-	public function testViewInvalidComment() {
+	public function testViewInvalidComment(): void {
 		$this->commentsManager->expects($this->any())
 			->method('get')
 			->with('42')
@@ -174,7 +174,7 @@ public function testViewInvalidComment() {
 		$this->assertInstanceOf(NotFoundResponse::class, $response);
 	}
 
-	public function testViewNoFile() {
+	public function testViewNoFile(): void {
 		$comment = $this->createMock(IComment::class);
 		$comment->expects($this->any())
 			->method('getObjectType')

diff --git a/apps/comments/tests/Unit/EventHandlerTest.php b/apps/comments/tests/Unit/EventHandlerTest.php
@@ -36,7 +36,7 @@ protected function setUp(): void {
 		$this->eventHandler = new CommentsEventListener($this->activityListener, $this->notificationListener);
 	}
 
-	public function testNotFiles() {
+	public function testNotFiles(): void {
 		/** @var IComment|\PHPUnit\Framework\MockObject\MockObject $comment */
 		$comment = $this->getMockBuilder(IComment::class)->getMock();
 		$comment->expects($this->once())
@@ -69,7 +69,7 @@ public function handledProvider() {
 	 * @dataProvider handledProvider
 	 * @param string $eventType
 	 */
-	public function testHandled($eventType) {
+	public function testHandled($eventType): void {
 		/** @var IComment|\PHPUnit\Framework\MockObject\MockObject $comment */
 		$comment = $this->getMockBuilder(IComment::class)->getMock();
 		$comment->expects($this->once())

diff --git a/apps/comments/tests/Unit/Notification/ListenerTest.php b/apps/comments/tests/Unit/Notification/ListenerTest.php
@@ -55,7 +55,7 @@ public function eventProvider() {
 	 * @param string $eventType
 	 * @param string $notificationMethod
 	 */
-	public function testEvaluate($eventType, $notificationMethod) {
+	public function testEvaluate($eventType, $notificationMethod): void {
 		/** @var IComment|\PHPUnit\Framework\MockObject\MockObject $comment */
 		$comment = $this->getMockBuilder(IComment::class)->getMock();
 		$comment->expects($this->any())
@@ -123,7 +123,7 @@ public function testEvaluate($eventType, $notificationMethod) {
 	 * @dataProvider eventProvider
 	 * @param string $eventType
 	 */
-	public function testEvaluateNoMentions($eventType) {
+	public function testEvaluateNoMentions($eventType): void {
 		/** @var IComment|\PHPUnit\Framework\MockObject\MockObject $comment */
 		$comment = $this->getMockBuilder(IComment::class)->getMock();
 		$comment->expects($this->any())
@@ -160,7 +160,7 @@ public function testEvaluateNoMentions($eventType) {
 		$this->listener->evaluate($event);
 	}
 
-	public function testEvaluateUserDoesNotExist() {
+	public function testEvaluateUserDoesNotExist(): void {
 		/** @var IComment|\PHPUnit\Framework\MockObject\MockObject $comment */
 		$comment = $this->getMockBuilder(IComment::class)->getMock();
 		$comment->expects($this->any())

diff --git a/apps/comments/tests/Unit/Notification/NotifierTest.php b/apps/comments/tests/Unit/Notification/NotifierTest.php
@@ -72,7 +72,7 @@ protected function setUp(): void {
 		$this->comment = $this->createMock(IComment::class);
 	}
 
-	public function testPrepareSuccess() {
+	public function testPrepareSuccess(): void {
 		$fileName = 'Gre\'thor.odp';
 		$displayName = 'Huraga';
 		$message = '@Huraga mentioned you in a comment on "Gre\'thor.odp"';
@@ -190,7 +190,7 @@ public function testPrepareSuccess() {
 		$this->notifier->prepare($this->notification, $this->lc);
 	}
 
-	public function testPrepareSuccessDeletedUser() {
+	public function testPrepareSuccessDeletedUser(): void {
 		$fileName = 'Gre\'thor.odp';
 		$message = 'You were mentioned on "Gre\'thor.odp", in a comment by an account that has since been deleted';
 
@@ -305,7 +305,7 @@ public function testPrepareSuccessDeletedUser() {
 	}
 
 
-	public function testPrepareDifferentApp() {
+	public function testPrepareDifferentApp(): void {
 		$this->expectException(UnknownNotificationException::class);
 
 		$this->folder
@@ -342,7 +342,7 @@ public function testPrepareDifferentApp() {
 	}
 
 
-	public function testPrepareNotFound() {
+	public function testPrepareNotFound(): void {
 		$this->expectException(UnknownNotificationException::class);
 
 		$this->folder
@@ -380,7 +380,7 @@ public function testPrepareNotFound() {
 	}
 
 
-	public function testPrepareDifferentSubject() {
+	public function testPrepareDifferentSubject(): void {
 		$this->expectException(UnknownNotificationException::class);
 
 		$displayName = 'Huraga';
@@ -437,7 +437,7 @@ public function testPrepareDifferentSubject() {
 	}
 
 
-	public function testPrepareNotFiles() {
+	public function testPrepareNotFiles(): void {
 		$this->expectException(UnknownNotificationException::class);
 
 		$displayName = 'Huraga';
@@ -495,7 +495,7 @@ public function testPrepareNotFiles() {
 	}
 
 
-	public function testPrepareUnresolvableFileID() {
+	public function testPrepareUnresolvableFileID(): void {
 		$this->expectException(AlreadyProcessedException::class);
 
 		$displayName = 'Huraga';

diff --git a/apps/dav/tests/unit/BackgroundJob/OutOfOfficeEventDispatcherJobTest.php b/apps/dav/tests/unit/BackgroundJob/OutOfOfficeEventDispatcherJobTest.php
@@ -62,7 +62,7 @@ protected function setUp(): void {
 		);
 	}
 
-	public function testDispatchStartEvent() {
+	public function testDispatchStartEvent(): void {
 		$this->timezoneService->method('getUserTimezone')->with('user')->willReturn('Europe/Berlin');
 
 		$absence = new Absence();
@@ -94,7 +94,7 @@ public function testDispatchStartEvent() {
 		]);
 	}
 
-	public function testDispatchStopEvent() {
+	public function testDispatchStopEvent(): void {
 		$this->timezoneService->method('getUserTimezone')->with('user')->willReturn('Europe/Berlin');
 
 		$absence = new Absence();
@@ -126,7 +126,7 @@ public function testDispatchStopEvent() {
 		]);
 	}
 
-	public function testDoesntDispatchUnknownEvent() {
+	public function testDoesntDispatchUnknownEvent(): void {
 		$this->timezoneService->method('getUserTimezone')->with('user')->willReturn('Europe/Berlin');
 
 		$absence = new Absence();

diff --git a/apps/dav/tests/unit/CalDAV/AppCalendar/AppCalendarTest.php b/apps/dav/tests/unit/CalDAV/AppCalendar/AppCalendarTest.php
@@ -52,7 +52,7 @@ public function testDelete(): void {
 		$this->appCalendar->delete();
 	}
 
-	public function testCreateFile() {
+	public function testCreateFile(): void {
 		$this->writeableCalendar->expects($this->exactly(3))
 			->method('createFromString')
 			->withConsecutive(['some-name', 'data'], ['other-name', ''], ['name', 'some data']);
@@ -69,7 +69,7 @@ public function testCreateFile() {
 		fclose($fp);
 	}
 
-	public function testCreateFile_readOnly() {
+	public function testCreateFile_readOnly(): void {
 		// If writing is not supported
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 		$this->expectExceptionMessage('Creating a new entry is not allowed');

diff --git a/apps/dav/tests/unit/CalDAV/AppCalendar/CalendarObjectTest.php b/apps/dav/tests/unit/CalDAV/AppCalendar/CalendarObjectTest.php
@@ -33,15 +33,15 @@ protected function setUp(): void {
 		$this->calendarObject = new CalendarObject($this->calendar, $this->backend, $this->vobject);
 	}
 
-	public function testGetOwner() {
+	public function testGetOwner(): void {
 		$this->assertEquals($this->calendarObject->getOwner(), 'owner');
 	}
 
-	public function testGetGroup() {
+	public function testGetGroup(): void {
 		$this->assertEquals($this->calendarObject->getGroup(), 'group');
 	}
 
-	public function testGetACL() {
+	public function testGetACL(): void {
 		$this->calendar->expects($this->exactly(2))
 			->method('getPermissions')
 			->willReturnOnConsecutiveCalls(Constants::PERMISSION_READ, Constants::PERMISSION_ALL);
@@ -70,17 +70,17 @@ public function testGetACL() {
 		]);
 	}
 
-	public function testSetACL() {
+	public function testSetACL(): void {
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 		$this->calendarObject->setACL([]);
 	}
 
-	public function testPut_readOnlyBackend() {
+	public function testPut_readOnlyBackend(): void {
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 		$this->calendarObject->put('foo');
 	}
 
-	public function testPut_noPermissions() {
+	public function testPut_noPermissions(): void {
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 
 		$backend = $this->createMock(ICreateFromString::class);
@@ -93,7 +93,7 @@ public function testPut_noPermissions() {
 		$calendarObject->put('foo');
 	}
 
-	public function testPut() {
+	public function testPut(): void {
 		$backend = $this->createMock(ICreateFromString::class);
 		$calendarObject = new CalendarObject($this->calendar, $backend, $this->vobject);
 
@@ -110,27 +110,27 @@ public function testPut() {
 		$calendarObject->put('foo');
 	}
 
-	public function testGet() {
+	public function testGet(): void {
 		$this->vobject->expects($this->once())
 			->method('serialize')
 			->willReturn('foo');
 		$this->assertEquals($this->calendarObject->get(), 'foo');
 	}
 
-	public function testDelete_notWriteable() {
+	public function testDelete_notWriteable(): void {
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 		$this->calendarObject->delete();
 	}
 
-	public function testDelete_noPermission() {
+	public function testDelete_noPermission(): void {
 		$backend = $this->createMock(ICreateFromString::class);
 		$calendarObject = new CalendarObject($this->calendar, $backend, $this->vobject);
 
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 		$calendarObject->delete();
 	}
 
-	public function testDelete() {
+	public function testDelete(): void {
 		$backend = $this->createMock(ICreateFromString::class);
 		$calendarObject = new CalendarObject($this->calendar, $backend, $this->vobject);
 
@@ -153,7 +153,7 @@ public function testDelete() {
 		$calendarObject->delete();
 	}
 
-	public function testGetName() {
+	public function testGetName(): void {
 		$this->vobject->expects($this->exactly(2))
 			->method('getBaseComponent')
 			->willReturnOnConsecutiveCalls((object)['UID' => 'someid'], (object)['UID' => 'someid', 'X-FILENAME' => 'real-filename.ics']);
@@ -162,7 +162,7 @@ public function testGetName() {
 		$this->assertEquals($this->calendarObject->getName(), 'real-filename.ics');
 	}
 
-	public function testSetName() {
+	public function testSetName(): void {
 		$this->expectException(\Sabre\DAV\Exception\Forbidden::class);
 		$this->calendarObject->setName('Some name');
 	}

diff --git a/apps/dav/tests/unit/CalDAV/CachedSubscriptionProviderTest.php b/apps/dav/tests/unit/CalDAV/CachedSubscriptionProviderTest.php
@@ -47,7 +47,7 @@ protected function setUp(): void {
 		$this->provider = new CachedSubscriptionProvider($this->backend);
 	}
 
-	public function testGetCalendars() {
+	public function testGetCalendars(): void {
 		$calendars = $this->provider->getCalendars(
 			'user-principal-123',
 			[]
@@ -58,7 +58,7 @@ public function testGetCalendars() {
 		$this->assertInstanceOf(CachedSubscriptionImpl::class, $calendars[1]);
 	}
 
-	public function testGetCalendarsFilterByUri() {
+	public function testGetCalendarsFilterByUri(): void {
 		$calendars = $this->provider->getCalendars(
 			'user-principal-123',
 			['subscription-1']

diff --git a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
@@ -1490,7 +1490,7 @@ public function testPruneOutdatedSyncTokens(): void {
 		self::assertSame(0, $deleted);
 	}
 
-	public function testSearchAndExpandRecurrences() {
+	public function testSearchAndExpandRecurrences(): void {
 		$calendarId = $this->createTestCalendar();
 		$calendarInfo = [
 			'id' => $calendarId,
@@ -1646,7 +1646,7 @@ public function testRestoreChanges(): void {
 		self::assertEquals([$uri2], $changesAfter['deleted']);
 	}
 
-	public function testSearchWithLimitAndTimeRange() {
+	public function testSearchWithLimitAndTimeRange(): void {
 		$calendarId = $this->createTestCalendar();
 		$calendarInfo = [
 			'id' => $calendarId,
@@ -1703,7 +1703,7 @@ public function testSearchWithLimitAndTimeRange() {
 		);
 	}
 
-	public function testSearchWithLimitAndTimeRangeShouldNotReturnMoreObjectsThenLimit() {
+	public function testSearchWithLimitAndTimeRangeShouldNotReturnMoreObjectsThenLimit(): void {
 		$calendarId = $this->createTestCalendar();
 		$calendarInfo = [
 			'id' => $calendarId,
@@ -1753,7 +1753,7 @@ public function testSearchWithLimitAndTimeRangeShouldNotReturnMoreObjectsThenLim
 		);
 	}
 
-	public function testSearchWithLimitAndTimeRangeShouldReturnObjectsInTheSameOrder() {
+	public function testSearchWithLimitAndTimeRangeShouldReturnObjectsInTheSameOrder(): void {
 		$calendarId = $this->createTestCalendar();
 		$calendarInfo = [
 			'id' => $calendarId,
@@ -1810,7 +1810,7 @@ public function testSearchWithLimitAndTimeRangeShouldReturnObjectsInTheSameOrder
 		);
 	}
 
-	public function testSearchShouldReturnObjectsInTheSameOrderMissingDate() {
+	public function testSearchShouldReturnObjectsInTheSameOrderMissingDate(): void {
 		$calendarId = $this->createTestCalendar();
 		$calendarInfo = [
 			'id' => $calendarId,

diff --git a/apps/dav/tests/unit/CalDAV/CalendarTest.php b/apps/dav/tests/unit/CalDAV/CalendarTest.php
@@ -442,7 +442,7 @@ public function providesConfidentialClassificationData() {
 		];
 	}
 
-	public function testRemoveVAlarms() {
+	public function testRemoveVAlarms(): void {
 		$publicObjectData = <<<EOD
 BEGIN:VCALENDAR
 VERSION:2.0