[EPIC] Tests refactoring

[jesmrec]

Current status of tests in ownCloud Android app

We're in the process of refactoring some of the tests or the way we test in the app. We have 2 types of tests in code: unit tests and UI tests.

Unit tests

We want to create unit tests for classes that on the one hand check that their methods return the expected result and on the other hand verify that their methods call the corresponding inner methods:

owncloudData module:

• Datasources classes: https://github.com/owncloud/android/issues/4063#issuecomment-1824472339
• Repository classes: https://github.com/owncloud/android/issues/4063#issuecomment-1825738561

Things to discuss

• [ ] Check migration tests and remove them if not useful Answer:
• [x] Check why authentication.datasources.implementation is instrumented Answer: it needs the context, so we need the test to be instrumented to get it
• [x] Move providers to another package called providers? Answer: yes, they will be moved

UI tests

👷🏼‍♂️ (We'll discuss about this and update this section...)

Things to discuss

• [x] Naming of the tests: which format should we follow? testSomethingReturnsFoo or something - ok - returns foo Answer: for the moment, we decided to follow the convention: {name of the method} returns {foo} when {conditions or environment}
• [x] Are tests which expect exceptions necessary? Answer: if they just make a mock throw an exception, without the method being tested catching it and doing something with it, they are not necessary since we're not testing real code

Related issues

• https://github.com/owncloud/android/issues/4070
• https://github.com/owncloud/android/issues/4071
• https://github.com/owncloud/android/issues/4072
• https://github.com/owncloud/android/issues/4073
• https://github.com/owncloud/android/issues/4232
• https://github.com/owncloud/android/issues/4233
• https://github.com/owncloud/android/issues/4234
• https://github.com/owncloud/android/issues/4235

[JuancaG05]

Datasources classes

When they are not like that, we should move the datasources implementations to a package called datasources.implementation, and make the test classes in the same corresponding package.

OCLocalAppRegistryDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteAppRegistryDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCLocalAuthenticationDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteAuthenticationDataSource: This class cannot be tested because we cannot access from the test the objects used inside the methods (they are created internally) (No tests for this class currently)

• Check that every method returns the expected result
• Verify that every method calls the corresponding methods of other classes

OCLocalCapabilitiesDataSource: Only insert method test has a verify and delete method has no tests

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteCapabilitiesDataSource: No verify in the test method

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCLocalFileDataSource: The tests that are currently done check the result and verify the calls, but we don't have tests for getFileByIdAsFlow, getFileByRemoteId, getSearchFolderContent, getSearchAvailableOfflineFolderContent, getSearchSharedByLinkFolderContent, getFolderContentWithSyncInfoAsFlow, getSharedByLinkWithSyncInfoForAccountAsFlow, getFilesWithSyncInfoAvailableOfflineFromAccountAsFlow, getFilesAvailableOfflineFromAccount, getFilesAvailableOfflineFromEveryAccount, moveFile, saveFilesInFolderAndReturnThem, saveFile, saveConflict, cleanConflict, deleteFilesForAccount, renameFile, disableThumbnailsForFile, updateAvailableOfflineStatusForFile, updateDownloadedFilesStorageDirectoryInStoragePath, saveDownloadWorkerUuid, and cleanWorkersUuid

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteFileDataSource: The tests that are currently done check the result and verify the calls, but we don't have tests for copyFile, moveFile, readFile, refreshFolder, deleteFile, and renameFile

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCFolderBackupLocalDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteOAuthDataSource: We check the result but we don't verify the calls to other methods

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCSharedPreferencesProvider: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteServerInfoDataSource:

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteShareeDataSource: We check the result but we don't verify the calls to other methods

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCLocalShareDataSource: Current tests don't have verify, and we don't have tests for insert (receiving a list of shares) and deleteShares

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteShareDataSource: We check the result but we don't verify the calls to other methods

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCLocalSpacesDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteSpacesDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

ScopedStorageProvider: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCLocalTransferDataSource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCLocalUserDataSource: Current tests don't have verify, and we don't have tests for getAllUserQuotas and deleteQuotaForAccount

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteUserDataSource: We check the result but we don't verify the calls to other methods

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCRemoteWebFingerDatasource: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

[JuancaG05]

Repository classes

When they are not like that, we should move the repository implementations to a package called repository, and make the test classes in the same corresponding package.

OCAppRegistryRepository: (No tests for this class currently)

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCAuthenticationRepository: Rename test methods to follow the convention, and place asserts before verify

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCCapabilityRepository: Some tests don't have verify, and they have to be reordered to keep the order of the implementation

• [x] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCFileRepository: We don't have tests for copyFile, getFileByIdAsFlow, getPersonalRootFolderForAccount, getSharesRootFolderForAccount, getSearchFolderContent, getFolderContentWithSyncInfoAsFlow, getSharedByLinkWithSyncInfoForAccountAsFlow, getFilesWithSyncInfoAvailableOfflineFromAccountAsFlow, getFilesAvailableOfflineFromAccount, getFilesAvailableOfflineFromEveryAccount, moveFile, readFile, renameFile, saveConflict, cleanConflict, saveDownloadWorkerUuid, cleanWorkersUuid, disableThumbnailsForFile, updateFileWithNewAvailableOfflineStatus, updateDownloadedFilesStorageDirectoryInStoragePath, and updateFileWithLastUsage

• [ ] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes

OCFolderBackupRepository: (No tests for this class currently)

• [ ] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes

OCOAuthRepository: Some tests don't have asserts

• [ ] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCServerInfoRepository: The current test doesn't explore all the alternatives of the method tested, we need to add some more tests for that method

• [ ] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes

OCShareeRepository: Rename test methods to follow the convention, and add asserts

• [ ] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCShareRepository: Rename test methods to follow the convention, reorder them and add verify

• [x] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes

OCSpacesRepository: (No tests for this class currently)

• [ ] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes

OCTransferRepository: (No tests for this class currently)

• [ ] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes

OCUserRepository: Current tests don't have asserts, and we don't have tests for getAllUserQuotas

• [ ] Check that every method returns the expected result
• [x] Verify that every method calls the corresponding methods of other classes

OCWebFingerRepository: (No tests for this class currently)

• [ ] Check that every method returns the expected result
• [ ] Verify that every method calls the corresponding methods of other classes