IOS-1542 Comments on TestDataBase. IOS-1542
authorDirk Zimmermann <dz@pep.security>
Wed, 08 May 2019 15:52:44 +0200
branchIOS-1542
changeset 8532f125044bbfae
parent 8531 cbba14b01dea
child 8533 906cca3f17bc
IOS-1542 Comments on TestDataBase.
pEpForiOSTests/TestUtils/TestDataBase.swift
     1.1 --- a/pEpForiOSTests/TestUtils/TestDataBase.swift	Wed May 08 15:52:44 2019 +0200
     1.2 +++ b/pEpForiOSTests/TestUtils/TestDataBase.swift	Wed May 08 15:52:44 2019 +0200
     1.3 @@ -13,6 +13,12 @@
     1.4  import PEPObjCAdapterFramework
     1.5  import PantomimeFramework
     1.6  
     1.7 +/// Base class for test data.
     1.8 +/// Make sure that, in your SecretTestData, you override:
     1.9 +///  * `populateAccounts` if you don't use the greenmail local server for testing,
    1.10 +///    or you want to test against other servers for various reasons.
    1.11 +///  * `populateVerifiableAccounts` in order to provide verifiable servers, to test
    1.12 +///    the verification parts.
    1.13  class TestDataBase {
    1.14      struct AccountSettings {
    1.15          var accountName: String?
    1.16 @@ -239,6 +245,7 @@
    1.17      /**
    1.18       Accounts needed for testing LAS, that is they need to be registered
    1.19       in the LAS DB or provide (correct) DNS SRV for IMAP and SMTP.
    1.20 +     - Note: Override this in your SecretTestData to something that's working.
    1.21       */
    1.22      func populateVerifiableAccounts() {
    1.23          append(verifiableAccountSettings: AccountSettings(