Changeset 193 for cleverbox/trunk/cleverbox

Timestamp:

08/16/07 08:49:44 (5 years ago)

Author:

trivoallan

Message:

cleverbox :

• added logging capabilities
• implemented nicer client and environment command output

Location:

cleverbox/trunk/cleverbox

Files:

• client.py (modified) (9 diffs)
• environment.py (modified) (4 diffs)
• log.py (added)
• project.py (modified) (2 diffs)
• scripts/admin.py (modified) (14 diffs)
• tests/client.py (modified) (3 diffs)
• tests/environment.py (modified) (1 diff)
• utils/styles.py (added)

cleverbox/trunk/cleverbox/client.py

@@ -3 +3 @@
 """
 
-import os
-from cleverbox.utils import filesystem
+import logging, os
+from cleverbox.utils import filesystem, styles
 
 client_dir_layout = ('htdocs', 'logs', 'tmp', 'uploads', 'var/svn', 'var/trac')
@@ -62 +62 @@
     # Client name cannot contain strokes
     if client_name.count('-') != 0:
-        print "** Client's identifier can not contain the '-' character."
-        return
+        raise Exception, "Client's identifier can not contain the '-' character."
 
     # Information collection
@@ -76 +75 @@
     dir_is_ok = os.access(parent_dir, os.W_OK) and not os.access(collected_infos['home_dir'], os.R_OK)
     if not dir_is_ok:
-        print "Directory %s is not writable or already exists, aborting." % collected_infos['home_dir']
-        raise os.error
-
-
-    print
-    print "Creating a new client."
-    print "Let's collect some informations about him : "
-    print
-    print "  Please enter client's full name."
-    print "  This will be used in several interface screens and in emails."
-    print
-
-    dfn = client_name.capitalize()
-    collected_infos['full_name'] = raw_input('Full Name [%s]> ' % dfn).strip() or dfn
-
-    print
-    print "Supplied informations verified."
-    print "Let's proceed with client creation :"
-    print
+        raise os.error, "Directory %s is not writable or already exists, aborting." % collected_infos['home_dir']
 
     # Client creation
@@ -103 +84 @@
     map(os.makedirs, homedir_layout)
 
-    print "  Directory layout created in %s\n" % collected_infos['home_dir']
+    print styles.style.SUCCESSNORESET('')
+    logging.info("  Directory layout created in %s" % collected_infos['home_dir'])
+    print
 
     # -- Apache configuration
@@ -114 +97 @@
 
     # -- Write conf to filesystem
-    apache_conf_filepath = os.path.join( environment.path, 'clients-available', client_name )
+    apache_conf_filepath = os.path.join(environment.path, 'clients-available', client_name)
     f = file(apache_conf_filepath, 'w+')
     f.write(apache_conf)
     f.close()
 
-    print "  Apache configuration written to %s\n" % apache_conf_filepath
+    logging.info("  Apache configuration written to %s\n" % apache_conf_filepath)
 
     # -- Fix permissions
-    """
-    chown -R dev:dev /$CLIENTSROOT/$CLIENTNAME
-    chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/logs
-    chmod g+w /$CLIENTSROOT/$CLIENTNAME/logs
-    chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/uploads
-    chmod g+w /$CLIENTSROOT/$CLIENTNAME/uploads
-    """
     filesystem.chowntree(collected_infos['home_dir'],
                          filesystem.get_uid_from_name(environment.config.get('general', 'ssh_user')),
@@ -145 +121 @@
     os.chmod(os.path.join(collected_infos['home_dir'], 'uploads'), 0775)
 
-    print "  Fixed permissions in %s\n" % collected_infos['home_dir']
+    logging.info("  Fixed permissions in %s" % collected_infos['home_dir'])
 
     #  Final steps
     # -- Enable client ?
-    print "Client has been created. Do you want to enable it ?"
-    print
+    print styles.style.RESET('')
     enable_client = raw_input('Enable client ? [y/N]> ').strip() or False
 
@@ -156 +131 @@
         enable(environment,client_name)
 
+    print styles.style.SUCCESSNORESET('')
+    logging.info("  Client %s was successfully created." % collected_infos['full_name'])
+    print "  Apache configuration need to be reloaded for this to be effective."
     print
-    print "Client %s was successfully created." % collected_infos['full_name']
-    print "Apache configuration need to be reloaded for this to be effective."
-    print
-    print "You may want create some projects now. Try 'help project' for some documentation."
-    print
+    print "  You may want create some projects now. Try 'help project' for some documentation."
+    print styles.style.RESET('')
 
 def remove(environment, client_name):
     """
     Deletes client from supplied environment.
-    """
+    
+    TODO : tunr that into an "archive" command to avoid complete loss of data
+    """
+    
+    raise NotImplementedError, "More work needed on this"
     
     if not exists(environment, client_name):
@@ -217 +196 @@
     os.symlink(target, linkname)
 
-    print "Client '%s' has been enabled" % client_name
-    print "Apache configuration needs to be reloaded for this to be effective."
+    print styles.style.SUCCESSNORESET('')
+    logging.info("  Client '%s' has been enabled" % client_name)
+    print "  Apache configuration needs to be reloaded for this to be effective."
+    print styles.style.RESET('')
 
 def disable(environment, client_name):
     """
     Disables a client in supplied environment.
-    TODO : disable client's projects.
     """
     if not exists(environment, client_name):
@@ -229 +209 @@
 
     if client_name in get(environment, 'disabled'):
-        raise Exception, 'Client "%s" is already enabled.' % client_name
+        raise Exception, 'Client "%s" is already disabled.' % client_name
+
+    import cleverbox.project
+    client_projects = get_projects(environment, client_name, 'enabled')
+    if len(client_projects):
+        print
+        for project_name in client_projects:
+            cleverbox.project.disable(environment, client_name, project_name)
 
     linkname = os.path.join(environment.path, 'clients-enabled', client_name)
     os.unlink(linkname)
     
-    print "Client '%s' has been disabled" % client_name
-    print "Apache configuration needs to be reloaded for this to be effective."
+    print styles.style.SUCCESSNORESET('')
+    logging.info("  Client '%s' has been disabled" % client_name)
+    print "  Apache configuration needs to be reloaded for this to be effective."
+    print styles.style.RESET('')
 
 def get_projects(environment, client_name, status=None):

cleverbox/trunk/cleverbox/environment.py

@@ -1 @@
-import os, shutil, stat
+import logging, os, shutil, stat
 import ConfigParser
 from pkg_resources import parse_version
@@ -44 +44 @@
         try:
             # Create directory structure
-            print "\n\tCreating directory layout\n"
+            print
+            logging.info("  Creating directory layout")
+            print
             env_dirs = []
             for dirname in layout:
@@ -59 +61 @@
 
             # Create default configuration profile
-            print "\n\tCreating default configuration profile\n"
+            print
+            logging.info("  Creating default configuration profile")
+            print
+            
             for filename in profile_files:
                 shutil.copy(
@@ -84 +89 @@
 
         except Exception, exception:
-            print exception
-            print "** Environment couldn't be initialized in %(env_dir)s\n" % {'env_dir' : self.path}
-            print "Rolling back changes"
+            
+            logging.error(exception)
+            logging.error("  Environment couldn't be initialized in %(env_dir)s" % {'env_dir' : self.path})
+            logging.info("Rolling back changes")
+            
             for entry in os.listdir(self.path):
                 path = os.path.join(self.path, entry)

cleverbox/trunk/cleverbox/project.py

@@ -4 +4 @@
 
 import os, re, ConfigParser, traceback
-from cleverbox.utils import filesystem
+from cleverbox.utils import filesystem, styles
 
 def exists(environment, client_name, project_name, project_status = None):
@@ -57 +57 @@
     try:
         os.unlink(os.path.join(environment.get_path('projects-enabled'), '%s-%s' % (client_name, project_name)))
-        print "Project '%s' has been disabled. Apache needs to be reloaded." % project_name
+        print styles.style.SUCCESS("  Project '%s' has been disabled. Apache needs to be reloaded." % project_name)
     except (IOError, os.error), exception:
-            raise Exception, 'Project "%s" is already disabled'
+            raise Exception, 'Project "%s" is already disabled' % project_name
 
 def enable(environment, client_name, project_name):

cleverbox/trunk/cleverbox/scripts/admin.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 
-import cmd, os, shlex, sys
+import cmd, logging, os, shlex, sys
 from trac import util
 from trac.scripts.admin import TracAdmin
-from cleverbox.utils import termcolors
+from cleverbox.utils import termcolors, styles
 from cleverbox.environment import Environment
 from cleverbox import client, project
+import cleverbox.log
 
 _version = '0.5dev'
-
-# Set up the terminal color scheme.
-class dummy: pass
-style = dummy()
-style.ERROR = termcolors.make_style(fg='red', opts=('bold',))
-style.WARN = termcolors.make_style(fg='yellow', opts=('bold',))
-style.SUCCESS = termcolors.make_style(fg='green', opts=('bold',))
-style.H1 = termcolors.make_style(fg='white', opts=('bold', 'underline'))
-style.ENABLED = termcolors.make_style(fg='green')
-style.DISABLED = termcolors.make_style(fg='red')
-del dummy
-
-def disable_termcolors():
-    class dummy:
-        def __getattr__(self, attr):
-            return lambda x: x
-    global style
-    style = dummy()
-
-# Disable terminal coloring on Windows, Pocket PC, or if somebody's piping the output.
-if sys.platform == 'win32' or sys.platform == 'Pocket PC' or not sys.stdout.isatty():
-    disable_termcolors()
 
 class CleverboxAdmin(cmd.Cmd):
@@ -38 +17 @@
                  'Available Commands:\n'
     ruler = ''
-    prompt = style.H1("Cleverbox > ")
+    prompt = styles.style.H1("Cleverbox > ")
     _date_format = '%Y-%m-%d'
     _datetime_format = '%Y-%m-%d %H:%M:%S'
@@ -50 +29 @@
             self.env_set(os.path.abspath(envdir))
         self.interactive = False
+        
+        # Setup logging
+        screen = logging.StreamHandler(sys.stdout)
+        screen.setFormatter(cleverbox.log.TermcolorsFormatter('%(message)s'))
+        logging.getLogger('').setLevel(logging.DEBUG)
+        logging.getLogger('').addHandler(screen)
 
     ##
@@ -59 +44 @@
         # Load environment
         self.env = Environment(env_path)
-        
+
         # Check if environment needs an upgrade
         try:
             if check_upgrade and self.env.needs_upgrade(_version):
-                print style.ERROR("\nCleverbox environment needs to be upgraded. Please run :")
-                print style.ERROR("  cleverbox-admin %s upgrade\n" % self.env.path)
+                print
+                logging.warn("  Cleverbox environment needs to be upgraded.\n" \
+                             "  Please run : cleverbox-admin %s upgrade" % self.env.path)
+                print
                 sys.exit(1)
-            elif not self.env.needs_upgrade(_version):
-                print style.SUCCESS("\nCleverbox environment is up to date.\n")
+            elif not self.env.needs_upgrade(_version):
+                print
+                logging.info(styles.style.SUCCESS("  Cleverbox environment is up to date."))
+                print
         except IOError, e:
             # no VERSION file means user wants to create an environment
@@ -84 +73 @@
             raise
         except Exception, e:
-            print >> sys.stderr, style.ERROR('Command failed: %s' % e)
+            print
+            logging.error('  Command failed: %s' % e)
+            print
             rv = 2
         if not self.interactive:
@@ -91 +82 @@
     def run(self):
         self.interactive = True
-        print style.H1('Welcome to cleverbox-admin\n'                \
-                       'Interactive Cleverbox administration console.\n'       \
-                        "Type:  '?' or 'help' for help on commands.\n")
+        print styles.style.H1('Welcome to cleverbox-admin\n' \
+                              'Interactive Cleverbox administration console.\n' \
+                              "Type:  '?' or 'help' for help on commands.\n")
         self.cmdloop()
 
@@ -99 +90 @@
     _help_initenv = [('initenv', 'Environment initialisation')]
     def do_initenv(self, line=None):
-        print "Environment initialisation in %(env_dir)s" % {'env_dir' : self.env.path}
+        logging.info("Environment initialisation in %(env_dir)s" % {'env_dir' : self.env.path})
 
         # Collect local configuration info
@@ -115 +106 @@
             os.makedirs(collected_infos['general']['clients_root'], 0775)
         except IOError, ioexception :
-            print ioexception
-            print "** Projects storage dir could not be created."
+            logging.error(ioexception)
+            logging.error("Projects storage dir could not be created.")
 
         # Apache user & group
@@ -150 +141 @@
         
         print
-        print "Environment successfully initialized\n"
-        print "You need to add this statement to your apache configuration : \n" \
-            "\t'Include %(env_dir)s/clients-enabled/*'\n" % {'env_dir' : self.env.path}
+        print termcolors.colorize('', fg='green', opts=('noreset',))
+        logging.info("Environment successfully initialized\n" \
+                     "You need to add this statement to your apache configuration : \n" \
+                     "\t'Include %(env_dir)s/clients-enabled/*'\n" % {'env_dir' : self.env.path})
+        print termcolors.colorize('')
 
     _help_upgrade = [('upgrade', 'Executes necessary operation to make environment up to date')]
@@ -167 +160 @@
                 TracAdmin.print_doc(doc)
             except AttributeError:
-                print "No documentation found for %s" % arg[0]
+                logging.error("No documentation found for %s" % arg[0])
         else:
             docs = (self._help_client + self._help_project + self._help_initenv + self._help_upgrade)
@@ -184 +177 @@
     _help_client = [('client list', 'Lists available clients'),
                     ('client add <name>', 'Adds a client'),
-                    ('client remove <name>', 'Deletes a client'),
                     ('client enable <name>', 'Enables a client'),
                     ('client disable <name>', 'Disables a client')]
@@ -227 +219 @@
         '''
         
-        print "Enabled :\n" \
-              "%s\n\n" \
-              "Disabled : \n" \
-              "%s\n" % (client.get(self.env, 'enabled'), client.get(self.env, 'disabled'))
+        all_clients = client.get(self.env)
+        if len(all_clients):
+            print
+            all_clients.sort()
+            en_clients = client.get(self.env, 'enabled')
+            dis_clients = client.get(self.env, 'disabled') 
+            for client_name in all_clients:
+                if client_name in en_clients:
+                    print styles.style.ENABLED('  [E] %s' % client_name)
+                else:
+                    print styles.style.DISABLED('  [D] %s' % client_name)
+            print
 
     def _do_client_add(self, client_name):
         client.add(self.env, client_name)
-
-    def _do_client_remove(self, client_name):
-        client.remove(self.env, client_name)
 
     def _do_client_enable(self, client_name):
@@ -266 +263 @@
             do_func = getattr(self, '_do_project_' + parts[0])
             # Python __call__() signature changed in Python2.4
-            if ( sys.version[:3] == '2.4'):
-                do_func.__call__(parts[1:])
-            else:
-                do_func.__call__(self, parts[1:])
+            do_func.__call__(parts[1:])
         except AttributeError, e:
-            print e
+            logging.error(e)
             self.do_help('project')
 
-    def _do_project_list(self, line=None):
+    def _do_project_list(self, line=None, misc=None):
 
         client_projects = {}
 
         clients = client.get(self.env)
-        clients.sort()
+        clients.sort()
+        
         for client_name in clients:
-            print style.H1("\n%s :" % client_name)
-            enabled_projects = project.get(self.env, client_name, 'enabled')
+            
+            all_projects = project.get(self.env, client_name)
+            if not len(all_projects): continue
+            
+            all_projects.sort()
+                        
+            print styles.style.H1("\n%s :" % client_name)
+            
+            enabled_projects = project.get(self.env, client_name, 'enabled')
             disabled_projects = project.get(self.env, client_name, 'disabled')
-            all_projects = project.get(self.env, client_name)
-            all_projects.sort()
-            for project_name in all_projects:
-                if project_name in enabled_projects:
-                    print style.ENABLED("[E] %s" % project_name)
-                else:
-                    print style.DISABLED("[D] %s" % project_name)
+
+            
+            for project_name in all_projects:
+                if project_name in enabled_projects:
+                    print styles.style.ENABLED("[E] %s" % project_name)
+                else:
+                    print styles.style.DISABLED("[D] %s" % project_name)
 
     def _do_project_disable(self, args):
@@ -310 +312 @@
             
         (client_name, project_name) = args
-        project.enable(environment, client_name, project_name)
+        project.enable(self.env, client_name, project_name)
 
     def _do_project_add(self, args):

cleverbox/trunk/cleverbox/tests/client.py

@@ -1 +1 @@
 import unittest
 
-import shutil
+import logging, os, shutil, tempfile
 from cleverbox.environment import Environment
 from cleverbox.scripts.admin import CleverboxAdmin
+
+logging.basicConfig(stream=open('/dev/null', 'w+'))
 
 class ClientTestCase(unittest.TestCase):
@@ -13 +15 @@
     def setUp(self):
         env_path = os.path.join(tempfile.gettempdir(), 'cleverbox-tempenv')
+        os.mkdir(env_path)
         self.env = Environment(env_path)
-        self.env.create()
-        self.admin = CleverboxAdmin(self.env)
+        parameters = {'general' : 
+                         {'clients_root' : os.path.join(env_path, 'var', 'cleverbox'), 
+                          'assets_dir'   : os.path.join('/home/trivoallan/workspace/cleverbox-trunk/assets'), 
+                          'apache_group' : 'www-data'}}
+        self.env.create('0.5test', parameters)
     
     def tearDown(self):
@@ -22 +28 @@
     # client add
     def test_client_add_generates_expected_apache_configuration(self):
-        self.admin.onecmd('client add cogip')
+        pass
     
     def test_client_add_fails_on_existing_client(self):

cleverbox/trunk/cleverbox/tests/environment.py

@@ -2 +2 @@
 from cleverbox.environment import Environment
 
-# Don't bother with output from scrips
+# Don't bother with output from scripts
 logging.basicConfig(stream=open('/dev/null', 'w+'))