root/cleverbox/trunk/cleverbox/tests/client_test.py

# This file is part of the "Cleverbox" program.
#
# Cleverbox 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 3 of the License, or
# (at your option) any later version.
#
# Cleverbox 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 Cleverbox.  If not, see <http://www.gnu.org/licenses/>.
#
# Copyright 2008, Tristan Rivoallan

import unittest

import logging, os, shutil, tempfile
from cleverbox.model.environment import Environment
from cleverbox.scripts.admin import CleverboxAdmin
from cleverbox.model import client
import cleverbox.tests

logging.basicConfig(stream=open('/dev/null', 'w+'))

class ClientTestCase(unittest.TestCase):
    """
    Tests related to manipulating clients.
    """
    
    # Fixtures
    def setUp(self):
        self.env = cleverbox.tests.create_environment('0.5test')

    def tearDown(self):
        shutil.rmtree(self.env.path)
        shutil.rmtree(self.env.config.get('general', 'clients_root'))

    # client add
    def test_client_add_generates_expected_layout(self):
        client_name = 'testclient'
        client.add(self.env, client_name, {'enable' : 'y'}) 
        clients_root = self.env.config.get('general', 'clients_root')
        expected = {os.path.join(self.env.path, 'clients-available', client_name)          : ('S_ISREG', '0640', 'root', 'www-data'),
                        os.path.join(clients_root, client_name)                                : ('S_ISDIR', '0750', 'root', 'www-data'),
                    os.path.join(clients_root, client_name, 'htdocs')                      : ('S_ISDIR', '0770', 'root', 'www-data'),
                    os.path.join(clients_root, client_name, 'logs')                        : ('S_ISDIR', '0770', 'root', 'www-data'),
                    os.path.join(clients_root, client_name, 'tmp')                         : ('S_ISDIR', '0770', 'root', 'www-data'),
                    os.path.join(clients_root, client_name, 'var')                         : ('S_ISDIR', '0750', 'root', 'www-data'),
                    os.path.join(clients_root, client_name, 'var', 'svn')                  : ('S_ISDIR', '0750', 'root', 'www-data'),
                    os.path.join(clients_root, client_name, 'var', 'trac')                 : ('S_ISDIR', '0750', 'root', 'www-data')}

        cleverbox.tests.validate_layout(expected)

    def test_client_add_generates_expected_apache_configuration(self):
        client_name = 'testclient'
        client.add(self.env, client_name, {'enable' : 'y'}) 
        expected =  """
# -- Include enabled projects configuration files
Include %(env_dir)s/projects-enabled/testclient-*
""" % {'env_dir' : self.env.path}
        got = file(os.path.join(self.env.path, 'clients-available', client_name)).read()
        
        assert got == expected, "client.add() generates expected apache configuration fragment (expected %s, got %s)" % (expected, got)
    
    def test_client_add_fails_on_existing_client(self):
        """
        client.add() fails when given already existing client.
        """
        client_name = 'testclient'
        client.add(self.env, client_name, {'enable' : 'y'})
        try: 
            client.add(self.env, client_name, {'enable' : 'y'})
        except Exception, e:
            pass
        else:
            self.fail(__doc__)
    
    def test_client_add_fails_on_invalid_client_name(self):
        client_name = 'test-client'
        try:
            client.add(self.env, client_name, {'enable' : 'y'})
        except Exception, e:
            pass
        else:
            self.fail("client.add() fails when given invalid username")
    
    def test_client_enable_generates_symlink(self):
        
        import stat
        
        # Create and enable client
        client_name = 'testclient'
        client.add(self.env, client_name, {'enable' : 'n'})
        client.enable(self.env, client_name)
        
        # Verify that an appropriate symlink is generated 
        link_path = os.path.join(self.env.path, 'clients-enabled', client_name)
        real_path = os.path.join(self.env.path, 'clients-available', client_name)
        st = os.stat(link_path)
        mode = st[stat.ST_MODE]
        
        # TODO : Find out why this assertion is always false
        #assert stat.S_ISLNK(mode), '%s is a symlink' % link_path
        
        # Verify symlink resolve to the right path 
        assert os.path.realpath(link_path) == real_path, '%s resolves to %s' % (link_path, real_path)
                       

    def test_client_disable_removes_symlink(self):
        
        # Create and enable client
        client_name = 'testclient'
        client.add(self.env, client_name, {'enable' : 'y'})
        
        # Disable symlink
        client.disable(self.env, client_name)
        
        # Make sure the symlink was removed
        link_path = os.path.join(self.env.path, 'clients-enabled', client_name)
        try:
            os.stat(link_path)
        except OSError:
            pass
        else:
            self.fail('%s symlink was removed' % link_path)
        
    
    # client remove 
    
def suite():
    return unittest.makeSuite(ClientTestCase,'test')

if __name__ == '__main__':
    unittest.main(defaultTest='suite')