/**
* Copyright 2012 Riparian Data
* http://www.ripariandata.com
* contact@ripariandata.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.ripariandata.timberwolf.integrated;
import com.microsoft.schemas.exchange.services.x2006.types.DistinguishedFolderIdNameType;
import com.ripariandata.timberwolf.Auth;
import com.ripariandata.timberwolf.mail.MailStore;
import com.ripariandata.timberwolf.mail.MailboxItem;
import com.ripariandata.timberwolf.mail.exchange.ExchangeMailStore;
import com.ripariandata.timberwolf.mail.exchange.ExchangePump;
import com.ripariandata.timberwolf.mail.exchange.ExchangePump.FailedToCreateMessage;
import com.ripariandata.timberwolf.mail.exchange.ExchangePump.FailedToFindMessage;
import com.ripariandata.timberwolf.mail.exchange.ExchangePump.FailedToMoveMessage;
import com.ripariandata.timberwolf.mail.exchange.RequiredFolder;
import com.ripariandata.timberwolf.services.LdapFetcher;
import com.ripariandata.timberwolf.services.PrincipalFetchException;
import com.ripariandata.timberwolf.writer.MailWriter;
import com.ripariandata.timberwolf.writer.UserFolderSyncStateStorage;
import com.ripariandata.timberwolf.writer.console.InMemoryUserFolderSyncStateStorage;
import com.ripariandata.timberwolf.writer.hbase.HBaseMailWriter;
import com.ripariandata.timberwolf.writer.hbase.HBaseUserFolderSyncStateStorage;
import java.io.IOException;
import java.security.PrivilegedAction;
import java.util.Iterator;
import javax.security.auth.login.LoginException;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** Overall integration testing, from exchange server to hbase. */
public class TestIntegration
{
private static final Logger LOG = LoggerFactory.getLogger(TestIntegration.class);
private static final String EXCHANGE_URI_PROPERTY_NAME = "ExchangeURI";
private static final String EXCHANGE_USER1_PROPERTY_NAME = "ExchangeUser1";
private static final String EXCHANGE_USER2_PROPERTY_NAME = "ExchangeUser2";
private static final String EXCHANGE_USER3_PROPERTY_NAME = "ExchangeUser3";
private static final String EXCHANGE_SENDER_PROPERTY_NAME = "ExchangeSender";
private static final String EXCHANGE_IGNORED_USER_PROPERTY_NAME = "ExchangeIgnoredUser";
private static final String LDAP_DOMAIN_PROPERTY_NAME = "LdapDomain";
private static final String LDAP_CONFIG_ENTRY_PROPERTY_NAME = "LdapConfigEntry";
// @junitRule: This prevents checkstyle from complaining about junit rules being public fields.
@Rule
public IntegrationTestProperties properties =
new IntegrationTestProperties(EXCHANGE_URI_PROPERTY_NAME,
EXCHANGE_USER1_PROPERTY_NAME,
EXCHANGE_USER2_PROPERTY_NAME,
EXCHANGE_USER3_PROPERTY_NAME,
EXCHANGE_SENDER_PROPERTY_NAME,
EXCHANGE_IGNORED_USER_PROPERTY_NAME,
LDAP_DOMAIN_PROPERTY_NAME,
LDAP_CONFIG_ENTRY_PROPERTY_NAME);
// @junitRule: This prevents checkstyle from complaining about junit rules being public fields.
@Rule
public HTableResource emailTable1 = new HTableResource();
// @junitRule: This prevents checkstyle from complaining about junit rules being public fields.
@Rule
public HTableResource emailTable2 = new HTableResource();
// @junitRule: This prevents checkstyle from complaining about junit rules being public fields.
@Rule
public HTableResource emailTable3 = new HTableResource();
// @junitRule: This prevents checkstyle from complaining about junit rules being public fields.
@Rule
public HTableResource userTable = new HTableResource("s");
private UserFolderSyncStateStorage inMemorySyncStateStorage = new InMemoryUserFolderSyncStateStorage();
private String exchangeURL;
private String ldapDomain;
private String ldapConfigEntry;
private final String keyHeader = "Item ID";
// The emails of this user are not checked
private String senderUsername;
private String senderEmail;
// The emails of this user are not checked
private String ignoredUsername;
private String ignoredEmail;
private String email1;
private RequiredUser user1;
private RequiredUser user2;
private RequiredUser user3;
private ExchangePump pump;
private String email(final String username)
{
return username + "@" + IntegrationTestProperties.getProperty(LDAP_DOMAIN_PROPERTY_NAME);
}
private void removeUsers(final Iterable<String> users, final String ignoredEmail1, final String ignoredEmail2)
{
Iterator<String> p = users.iterator();
// We are going to skip over the sender username to avoid double
// counting emails
while (p.hasNext())
{
String user = p.next();
if (user.equals(ignoredEmail1))
{
p.remove();
}
else if (user.equals(ignoredEmail2))
{
p.remove();
}
}
}
private void runForEmails(final HTableResource emailTable)
throws ExchangePump.FailedToCreateFolders, ExchangePump.FailedToCreateMessage,
ExchangePump.FailedToFindMessage, ExchangePump.FailedToMoveMessage, LoginException, IOException,
InterruptedException
{
LOG.info("Beginning new run of emails");
final ExpectedEmails expectedEmails;
user1.initialize(pump);
user2.initialize(pump);
user3.initialize(pump);
user1.sendEmail(pump);
user2.sendEmail(pump);
user3.sendEmail(pump);
user1.moveEmails(pump);
user2.moveEmails(pump);
user3.moveEmails(pump);
// We need to close the tables, because HBaseUserSyncStateStorage and
// HBaseMailWriter call CreateTable, so we can't have any
// references to that open
userTable.closeTables();
emailTable.regetTable();
Auth.authenticateAndDo(new PrivilegedAction<Object>()
{
@Override
public Object run()
{
MailStore mailStore = new ExchangeMailStore(exchangeURL, 12, 4);
MailWriter mailWriter = HBaseMailWriter.create(emailTable.getTable(), keyHeader,
emailTable.getFamily());
HBaseUserFolderSyncStateStorage syncStateHandler =
new HBaseUserFolderSyncStateStorage(userTable.getManager(), userTable.getName());
try
{
Iterable<String> users = new LdapFetcher(ldapDomain).getPrincipals();
removeUsers(users, senderEmail, ignoredEmail);
Iterable<MailboxItem> mailboxItems = mailStore.getMail(users, syncStateHandler);
mailWriter.write(mailboxItems);
}
catch (PrincipalFetchException e)
{
e.printStackTrace();
}
return null;
}
}, ldapConfigEntry);
expectedEmails = new ExpectedEmails();
expectedEmails.require(user1, emailTable);
expectedEmails.require(user2, emailTable);
expectedEmails.require(user3, emailTable);
expectedEmails.checkHbase();
}
@Before
public void setupUsers() throws FailedToCreateMessage, FailedToFindMessage, FailedToMoveMessage
{
exchangeURL = IntegrationTestProperties.getProperty(EXCHANGE_URI_PROPERTY_NAME);
ldapDomain = IntegrationTestProperties.getProperty(LDAP_DOMAIN_PROPERTY_NAME);
ldapConfigEntry = IntegrationTestProperties.getProperty(LDAP_CONFIG_ENTRY_PROPERTY_NAME);
senderUsername = IntegrationTestProperties.getProperty(EXCHANGE_SENDER_PROPERTY_NAME);
senderEmail = email(senderUsername);
ignoredUsername = IntegrationTestProperties.getProperty(EXCHANGE_IGNORED_USER_PROPERTY_NAME);
ignoredEmail = email(ignoredUsername);
final String username1 = IntegrationTestProperties.getProperty(EXCHANGE_USER1_PROPERTY_NAME);
email1 = email(username1);
final String username2 = IntegrationTestProperties.getProperty(EXCHANGE_USER2_PROPERTY_NAME);
final String username3 = IntegrationTestProperties.getProperty(EXCHANGE_USER3_PROPERTY_NAME);
user1 = new RequiredUser(username1, ldapDomain);
user2 = new RequiredUser(username2, ldapDomain);
user3 = new RequiredUser(username3, ldapDomain);
pump = new ExchangePump(exchangeURL, senderUsername);
}
@After
public void deleteEmails()
{
if (pump != null)
{
for (RequiredUser user : new RequiredUser[] {user1, user2, user3})
{
if (user != null)
{
String name = user.getUser();
try
{
LOG.info("Deleting test emails for user: {}", name);
user.deleteEmails(pump);
}
catch (Exception e)
{
LOG.warn("An error occured deleting {}'s content: {}",
name,
e.getMessage());
}
}
}
pump = null;
}
user1 = null;
user2 = null;
user3 = null;
}
@Test
public void testIntegrationNoCLI()
throws ExchangePump.FailedToCreateFolders, PrincipalFetchException, LoginException, IOException,
ExchangePump.FailedToCreateMessage, ExchangePump.FailedToFindMessage,
ExchangePump.FailedToMoveMessage, InterruptedException
{
LOG.info("Beginning integration test: testIntegrationNoCLI()");
/*
This test tests getting emails from an exchange server, and the breadth
of what that entails, and then putting it all in Exchange. It depends
on a certain set of users, specified in the testing.properties. The
test than creates a bunch of folders in those user accounts, fills them
with email, runs timberwolf to get the messages into hbase, and then
asserts that all the created messages are in hbase.
After the test it deletes ALL content from the user accounts.
The authenticated user account must be able to impersonate all the
required user accounts specified in the properties.
*/
/////////////
// User #1
/////////////
user1.addToInbox("Leave it be", "Even though you love your inbox clean").from(senderEmail);
user1.addFolderToInbox("child of Inbox")
.add("To the child of inbox", "here is the body of the email in the child of Inbox");
RequiredFolder inboxJr = user1.addFolderToInbox("Inbox Jr");
inboxJr.add("books", "Inbox Jr is getting lonely over here");
inboxJr.add("For Inbox Jr", "some sort of body here");
user1.addDraft(senderEmail, "A draft", "with something I'll never tell you");
user1.addSentItem(senderEmail, "A message to semone else", "you can tell, because of the to field");
user1.addSentItem(ignoredEmail, "To whom", "is this email going").bcc(senderEmail);
user1.addToDeletedItems("Whoops", "This is going in the trash");
user1.addFolder(DistinguishedFolderIdNameType.DELETEDITEMS, "Deleted folder")
.add("Uh oh", "this is going in the recycling bin, which we're throwing out");
RequiredFolder topper = user1.addFolderToRoot("Topper");
topper.add("Hey hey Bobby McGee", "Makes me think of that Janis Joplin song").to(ignoredEmail).cc(email1);
RequiredFolder middler = topper.addFolder("Middler");
middler.add("Move it", "Away this should go into middler, placed neatly there for all to see");
middler.add("Another middler email", "that has a super boring body");
middler.add("Yet another in the middler folder", "oh so many emails");
RequiredFolder middlerJr = middler.addFolder("Middler Jr");
middlerJr.add("organize away to MJ", "this will be moved to middler Jr");
RequiredFolder middlerIII = middlerJr.addFolder("Middler II").addFolder("Middler III");
middlerIII.add("Forward this on to Middler III", "where it shall be left");
RequiredFolder msChild = middlerIII.addFolder("Middler IV").addFolder("Ms child");
msChild.add("Ms child", "is way nicer than MJ");
msChild.add("Super nesting", "The child of Ms child is so deep");
RequiredFolder syncFolderItems = user1.addFolderToRoot("Page SyncFolderItems");
// Page SyncFolderItems (29)
for (int i = 0; i < 29; i++)
{
syncFolderItems.add("Page SyncFolderItems" + (i + 1), "Page SyncFolderItems #" + (i + 1));
}
RequiredFolder getItems = user1.addFolderToRoot("Page GetItems");
// Page GetItems (11)
for (int i = 0; i < 11; i++)
{
getItems.add("Page GetItems" + (i + 1), "Page GetItems #" + (i + 1));
}
/////////////
// User #2
/////////////
user2.addToInbox("Dear Alex", "Leave this bad boy in your inbox");
user2.addFolderToInbox("Rebecca")
.add("About Rebecca", "She did something");
user2.addFolderToRoot("Eduardo")
.add("Concerning Eduardo", "Something happened to him");
/////////////
// User #3
/////////////
user3.addToInbox("Dear Mary", "Don't rearrange this email");
user3.addFolderToInbox("Anthony")
.add("About Anthony", "He did something");
user3.addFolderToRoot("Barbara")
.add("Concerning Barbara", "Something happened to her");
runForEmails(emailTable1);
user1.nextRun();
user2.nextRun();
user3.nextRun();
user1.addToInbox("An email after the first one", "A new email");
middlerJr.add("A new email in the middler Jr", "The body for this new email");
RequiredFolder newFolder = middlerJr.addFolder("New folder");
newFolder.add("this new email is in a new folder", "and it has a new body");
user2.addToInbox("A new email for User #2", "Hey user #2, what's up");
runForEmails(emailTable2);
user1.nextRun();
user2.nextRun();
user3.nextRun();
user2.addFolderToRoot("This is the newest folder")
.add("This email goes in the newest folder", "That's right");
user3.addDraft(email1, "Some sort of draft", "With something non-committal");
runForEmails(emailTable3);
}
}