##
## test_root.py
## Login : <uli@pu.smp.net>
## Started on  Thu Jan 20 09:26:54 2011 Uli Fouquet
## $Id$
## 
## Copyright (C) 2011 Uli Fouquet
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
## 
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
## 
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##
"""
Test applicants root.
"""
import logging
import unittest
from StringIO import StringIO
from zope.component.hooks import setSite, clearSite
from zope.interface.verify import verifyClass, verifyObject
from zope.site import LocalSiteManager
from waeup.sirp.app import University
from waeup.sirp.applicants import (
    interfaces, application_exists, get_applicant_data, Applicant,
    ApplicantsContainer,
    )
from waeup.sirp.applicants.root import (
    ApplicantsRoot, ApplicantsPlugin,
    )
from waeup.sirp.testing import WAeUPSIRPUnitTestLayer


class FakeSite(dict):
    pass

class ApplicantsRootTestCase(unittest.TestCase):

    def test_interfaces(self):
        # Make sure the correct interfaces are implemented.
        self.assertTrue(
            verifyClass(
                interfaces.IApplicantsRoot, ApplicantsRoot)
            )
        self.assertTrue(
            verifyObject(
                interfaces.IApplicantsRoot, ApplicantsRoot())
            )
        return

class ApplicantsRootPluginTestCase(unittest.TestCase):
    def create_logger(self):
        # create a logger suitable for local tests.
        test_logger = logging.getLogger('waeup.sirp.applicants.testlogger')
        log = StringIO()
        handler = logging.StreamHandler(log)
        handler.setLevel(logging.DEBUG)
        test_logger.addHandler(handler)
        test_logger.setLevel(logging.DEBUG)
        self.logger = test_logger
        self.log = log
        self.handler = handler
        return self.logger

    def remove_logger(self):
        del self.handler
        del self.logger
        del self.log
        pass

    def get_log(self):
        self.log.seek(0)
        return self.log.read()

    def setUp(self):
        self.create_logger()
        return

    def tearDown(self):
        self.remove_logger()
        return

    # Real tests start here...
    def test_pluginsetup(self):
        # Make sure we can add ApplicantsRoot to sites.
        site = FakeSite()
        plugin = ApplicantsPlugin()
        plugin.setup(site, 'blah', self.logger)
        self.assertTrue('applicants' in site.keys())
        log = self.get_log()
        self.assertTrue('Installed applicants root.' in log)
        return

    def test_update_new(self):
        # Run update on a site without applicants root.
        site = FakeSite()
        plugin = ApplicantsPlugin()
        plugin.update(site, 'blah', self.logger)
        self.assertTrue('applicants' in site.keys())
        log = self.get_log()
        self.assertTrue('Updating site at <Unnamed Site>' in log)
        self.assertTrue('Installed applicants root.' in log)
        return

    def test_update_outdated(self):
        # Run update on a site with outdated applicants root.
        site = FakeSite()
        root = object() # # This is not a proper applicants root
        site['applicants'] = root
        plugin = ApplicantsPlugin()
        plugin.update(site, 'blah', self.logger)
        self.assertTrue(site['applicants'] is not root)
        self.assertTrue(isinstance(site['applicants'], ApplicantsRoot))
        log = self.get_log()
        self.assertTrue('Outdated applicants folder detected' in log)
        self.assertTrue('Updating site at <Unnamed Site>' in log)
        self.assertTrue('Installed applicants root.' in log)
        return

    def test_update_uptodate(self):
        # Run update on a site with proper applicants root.
        site = FakeSite()
        root = ApplicantsRoot()
        site['applicants'] = root
        plugin = ApplicantsPlugin()
        plugin.update(site, 'blah', self.logger)
        self.assertTrue(site['applicants'] is root)
        log = self.get_log()
        self.assertTrue('Updating site at <Unnamed Site>' in log)
        self.assertTrue('Nothing to do' in log)
        return

    def test_update_log(self):
        # Check that sitename is used in log messages on updates.
        site = FakeSite()
        site.__name__ = 'my_site'
        plugin = ApplicantsPlugin()
        plugin.update(site, 'blah', self.logger)
        log = self.get_log()
        self.assertTrue('Updating site at my_site.' in log)
        return

applicant = Applicant()
fake_apps = {
    'cest10' : ApplicantsContainer(),
    'cest11' : ApplicantsContainer(),
    }

fake_apps['cest10']['APP-99999'] = applicant

class HelperToolsTest(unittest.TestCase):

    layer = WAeUPSIRPUnitTestLayer
    
    def setUp(self):
        self.app = University()
        # Insert some applicants...
        for container, data in fake_apps.items():
            self.app['applicants'][container] = data
        self.app.setSiteManager(LocalSiteManager(self.app))
        setSite(self.app)
        return

    def tearDown(self):
        clearSite()
        return

    def test_application_exists(self):
        result = application_exists('APP-99999')
        assert result is True

        result = application_exists('APP-44444')
        assert result is False
        return

    def test_get_applicant_data(self):
        result = get_applicant_data('APP-99999')
        self.assertEqual(result, applicant)
        return

    def test_get_applicant_data_none(self):
        result = get_applicant_data('NOT-EXISTIING')
        assert result is None
        return
    
def suite():
    suite = unittest.TestSuite()
    for testcase in [
            ApplicantsRootTestCase,
            ApplicantsRootPluginTestCase,
            HelperToolsTest,
            ]:
        suite.addTests(unittest.makeSuite(testcase))
    return suite

test_suite = suite