Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 29dc3dd0 authored by cketti's avatar cketti Committed by GitHub
Browse files

Merge pull request #1808 from philipwhiuk/testingSettingsImportExport 

Testing for settings import and export
parents 708b79d8 f03a01f6

k9mail/src/main/java/com/fsck/k9/preferences/SettingsImporter.java

+12 −6
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ import org.xmlpull.v1.XmlPullParserFactory; 


import android.content.Context;

import android.content.SharedPreferences;

import android.support.annotation.VisibleForTesting;

import android.util.Log;



import com.fsck.k9.Account;
@@ -661,7 +662,8 @@ public class SettingsImporter { 
        editor.putString(key, value);

    }



    private static Imported parseSettings(InputStream inputStream, boolean globalSettings,

    @VisibleForTesting

    static Imported parseSettings(InputStream inputStream, boolean globalSettings,

                                  List<String> accountUuids, boolean overview)

    throws SettingsImportExportException {
@@ -1138,7 +1140,8 @@ public class SettingsImporter { 
        }

    }



    private static class Imported {

    @VisibleForTesting

    static class Imported {

        public int contentVersion;

        public ImportedSettings globalSettings;

        public Map<String, ImportedAccount> accounts;
@@ -1148,7 +1151,8 @@ public class SettingsImporter { 
        public Map<String, String> settings = new HashMap<String, String>();

    }



    private static class ImportedAccount {

    @VisibleForTesting

    static class ImportedAccount {

        public String uuid;

        public String name;

        public ImportedServer incoming;
@@ -1158,7 +1162,8 @@ public class SettingsImporter { 
        public List<ImportedFolder> folders;

    }



    private static class ImportedServer {

    @VisibleForTesting

    static class ImportedServer {

        public String type;

        public String host;

        public String port;
@@ -1170,7 +1175,8 @@ public class SettingsImporter { 
        public ImportedSettings extras;

    }



    private static class ImportedIdentity {

    @VisibleForTesting

    static class ImportedIdentity {

        public String name;

        public String email;

        public String description;

k9mail/src/test/java/com/fsck/k9/preferences/SettingsExporterTest.java

0 → 100644
+74 −0
Original line number Diff line number Diff line 
package com.fsck.k9.preferences;



import org.jdom2.Document;

import org.jdom2.input.SAXBuilder;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.robolectric.RobolectricTestRunner;

import org.robolectric.RuntimeEnvironment;

import org.robolectric.annotation.Config;



import java.io.ByteArrayInputStream;

import java.io.ByteArrayOutputStream;

import java.io.InputStream;

import java.util.Collections;

import java.util.Set;



import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertNull;



@RunWith(RobolectricTestRunner.class)

@Config(manifest = "src/main/AndroidManifest.xml", sdk = 21)

public class SettingsExporterTest {



    @Test

    public void exportPreferences_producesXML() throws Exception {

        Document document = exportPreferences(false, Collections.<String>emptySet());



        assertEquals("k9settings", document.getRootElement().getName());

    }



    @Test

    public void exportPreferences_setsVersionTo43() throws Exception {

        Document document = exportPreferences(false, Collections.<String>emptySet());



        assertEquals("43", document.getRootElement().getAttributeValue("version"));

    }



    @Test

    public void exportPreferences_setsFormatTo1() throws Exception {

        Document document = exportPreferences(false, Collections.<String>emptySet());



        assertEquals("1", document.getRootElement().getAttributeValue("format"));

    }



    @Test

    public void exportPreferences_exportsGlobalSettingsWhenRequested() throws Exception {

        Document document = exportPreferences(true, Collections.<String>emptySet());



        assertNotNull(document.getRootElement().getChild("global"));

    }



    @Test

    public void exportPreferences_ignoresGlobalSettingsWhenRequested() throws Exception {

        Document document = exportPreferences(false, Collections.<String>emptySet());



        assertNull(document.getRootElement().getChild("global"));

    }



    private Document exportPreferences(boolean globalSettings, Set<String> accounts) throws Exception {

        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();

        SettingsExporter.exportPreferences(RuntimeEnvironment.application, outputStream,

                globalSettings, accounts);

        Document document = parseXML(outputStream.toByteArray());

        outputStream.close();

        return document;

    }



    private Document parseXML(byte[] xml) throws Exception {

        SAXBuilder builder = new SAXBuilder();

        InputStream stream = new ByteArrayInputStream(xml);

        return builder.build(stream);

    }

}

k9mail/src/test/java/com/fsck/k9/preferences/SettingsImporterTest.java

0 → 100644
+167 −0
Original line number Diff line number Diff line 
package com.fsck.k9.preferences;



import com.fsck.k9.Account;

import com.fsck.k9.Preferences;

import com.fsck.k9.mail.AuthType;



import org.apache.tools.ant.filters.StringInputStream;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.robolectric.RobolectricTestRunner;

import org.robolectric.RuntimeEnvironment;

import org.robolectric.annotation.Config;



import java.io.InputStream;

import java.util.ArrayList;

import java.util.Collection;

import java.util.List;

import java.util.UUID;



import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertFalse;



@SuppressWarnings("unchecked")

@RunWith(RobolectricTestRunner.class)

@Config(manifest = "src/main/AndroidManifest.xml", sdk = 21)

public class SettingsImporterTest {



    @Before

    public void before() {

        deletePreExistingAccounts();

    }



    private void deletePreExistingAccounts() {

        Preferences preferences = Preferences.getPreferences(RuntimeEnvironment.application);

        Collection<Account> availableAccounts =

                preferences.getAvailableAccounts();

        for(Account account: availableAccounts) {

            preferences.deleteAccount(account);

        }

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnBlankFile() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnMissingFormat() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("<k9settings version=\"1\"></k9settings>");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnInvalidFormat() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("<k9settings version=\"1\" format=\"A\"></k9settings>");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnNonPositiveFormat() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("<k9settings version=\"1\" format=\"0\"></k9settings>");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnMissingVersion() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("<k9settings format=\"1\"></k9settings>");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnInvalidVersion() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("<k9settings format=\"1\" version=\"A\"></k9settings>");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test(expected = SettingsImportExportException.class)

    public void importSettings_throwsExceptionOnNonPositiveVersion() throws SettingsImportExportException {

        InputStream inputStream = new StringInputStream("<k9settings format=\"1\" version=\"0\"></k9settings>");

        List<String> accountUuids = new ArrayList<>();



        SettingsImporter.importSettings(RuntimeEnvironment.application, inputStream, true, accountUuids, true);

    }



    @Test

    public void parseSettings_account() throws SettingsImportExportException {

        String validUUID = UUID.randomUUID().toString();

        InputStream inputStream = new StringInputStream("<k9settings format=\"1\" version=\"1\">" +

                "<accounts><account uuid=\""+validUUID+"\"><name>Account</name></account></accounts></k9settings>");

        List<String> accountUuids = new ArrayList<>();

        accountUuids.add("1");



        SettingsImporter.Imported results = SettingsImporter.parseSettings(inputStream, true, accountUuids, true);



        assertEquals(1, results.accounts.size());

        assertEquals("Account", results.accounts.get(validUUID).name);

        assertEquals(validUUID, results.accounts.get(validUUID).uuid);

    }



    @Test

    public void parseSettings_account_cram_md5() throws SettingsImportExportException {



        String validUUID = UUID.randomUUID().toString();

        InputStream inputStream = new StringInputStream("<k9settings format=\"1\" version=\"1\">" +

                "<accounts><account uuid=\""+validUUID+"\"><name>Account</name>" +

                "<incoming-server><authentication-type>CRAM_MD5</authentication-type></incoming-server>" +

                "</account></accounts></k9settings>");

        List<String> accountUuids = new ArrayList<>();

        accountUuids.add(validUUID);



        SettingsImporter.Imported results = SettingsImporter.parseSettings(inputStream, true, accountUuids, false);



        assertEquals("Account", results.accounts.get(validUUID).name);

        assertEquals(validUUID, results.accounts.get(validUUID).uuid);

        assertEquals(AuthType.CRAM_MD5, results.accounts.get(validUUID).incoming.authenticationType);

    }



    @Test

    public void importSettings_disablesAccountsNeedingPasswords() throws SettingsImportExportException {

        String validUUID = UUID.randomUUID().toString();

        InputStream inputStream = new StringInputStream("<k9settings format=\"1\" version=\"1\">" +

                "<accounts><account uuid=\""+validUUID+"\"><name>Account</name>" +

                "<incoming-server type=\"IMAP\">" +

                    "<connection-security>SSL_TLS_REQUIRED</connection-security>" +

                    "<username>user@gmail.com</username>" +

                    "<authentication-type>CRAM_MD5</authentication-type>" +

                    "<host>googlemail.com</host>" +

                "</incoming-server>" +

                "<outgoing-server type=\"SMTP\">" +

                    "<connection-security>SSL_TLS_REQUIRED</connection-security>" +

                    "<username>user@googlemail.com</username>" +

                    "<authentication-type>CRAM_MD5</authentication-type>" +

                    "<host>googlemail.com</host>" +

                "</outgoing-server>" +

                "<settings><value key=\"a\">b</value></settings>" +

                "<identities><identity><email>user@gmail.com</email></identity></identities>" +

                "</account></accounts></k9settings>");

        List<String> accountUuids = new ArrayList<>();

        accountUuids.add(validUUID);

        

        SettingsImporter.ImportResults results = SettingsImporter.importSettings(

                RuntimeEnvironment.application, inputStream, true, accountUuids, false);



        assertEquals(0, results.errorneousAccounts.size());

        assertEquals(1, results.importedAccounts.size());

        assertEquals("Account", results.importedAccounts.get(0).imported.name);

        assertEquals(validUUID, results.importedAccounts.get(0).imported.uuid);



        assertFalse(Preferences.getPreferences(RuntimeEnvironment.application)

                .getAccount(validUUID).isEnabled());

    }



}