Changeset 184 for cleverbox/trunk

Timestamp:

08/13/07 22:18:30 (5 years ago)

Author:

trivoallan

Message:

cleverbox :

• fixed typo in trac-defaults.ini
• removed automatic setuptools installation (because it's buggy !)
• factored projects to their own module

Location:

cleverbox/trunk

Files:

• assets/trac-defaults.ini (modified) (1 diff)
• cleverbox/client.py (modified) (6 diffs)
• cleverbox/project.py (added)
• cleverbox/scripts/admin.py (modified) (9 diffs)
• cleverbox/utils/filesystem.py (modified) (1 diff)
• ez_setup.py (deleted)
• setup.py (modified) (1 diff)

cleverbox/trunk/assets/trac-defaults.ini

@@ -5 +5 @@
 webadmin.* = enabled
 themeengine.* = enabled
-svnhooks.svnhooks
+svnhooks.svnhooks = enabled

cleverbox/trunk/cleverbox/client.py

@@ -4 +4 @@
 
 import os
-from cleverbox import project
 from cleverbox.utils import filesystem
 
@@ -155 +154 @@
 
     if enable_client == 'y':
-        self._do_client_enable(client_name)
+        enable(environment,client_name)
 
     print
@@ -184 +183 @@
     # Client is enabled, propose disabling it
     client_disabled = True
-    if client_name in self._get_clients('enabled'):
+    if client_name in get(environment, 'enabled'):
         client_disabled = False
         print "You can not remove an enabled client. Disabling it."
@@ -197 +196 @@
 
     # Disable client
-    client_apacheconf = os.path.join( self.env.path, 'clients-available', client_name )
+    client_apacheconf = os.path.join(environment.path, 'clients-available', client_name)
     os.unlink(client_apacheconf)
     
@@ -214 +213 @@
         raise Exception, 'Client "%s" is already enabled.' % client_name
 
-    target = os.path.join(self.env.path, 'clients-available', client_name)
-    linkname = os.path.join(self.env.path, 'clients-enabled', client_name)
+    target = os.path.join(environment.path, 'clients-available', client_name)
+    linkname = os.path.join(environment.path, 'clients-enabled', client_name)
     os.symlink(target, linkname)
 
@@ -232 +231 @@
         raise Exception, 'Client "%s" is already enabled.' % client_name
 
-    linkname = os.path.join(self.env.path, 'clients-enabled', client_name)
+    linkname = os.path.join(environment.path, 'clients-enabled', client_name)
     os.unlink(linkname)
     

cleverbox/trunk/cleverbox/scripts/admin.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 
-import shutil, cmd, os, shlex, sys, traceback, re
-import ConfigParser, posix
-from pkg_resources import parse_version
+import cmd, os, shlex, sys
 from trac import util
 from trac.scripts.admin import TracAdmin
 from cleverbox.utils import termcolors
 from cleverbox.environment import Environment
-from cleverbox import client
+from cleverbox import client, project
 
 _version = '0.5dev'
@@ -69 +67 @@
         # Set shell prompt
         self.prompt = "Cleverbox [%s] > " % self.env.path
-        
-        # Read configuration
-        # TODO : move to environment.py ?
-        self._config = ConfigParser.SafeConfigParser()
-        self._config.read(self.env.get_path('cleverbox.ini'))
 
     def emptyline(self):
@@ -233 +226 @@
 
     def _do_client_add(self, client_name):
-        client.create(self.env, client_name)
+        client.add(self.env, client_name)
 
     def _do_client_remove(self, client_name):
@@ -259 +252 @@
     _help_project = [('project list', 'Lists available projects'),
                     ('project add <client> <name>', 'Adds a project'),
-                    ('project remove <client> <name>', 'Deletes a project'),
                     ('project enable <client> <name>', 'Enables a project'),
                     ('project disable <client> <name>', 'Disables a project')]
@@ -288 +280 @@
         clients = client.get()
         for client_name in clients:
-            client_projects[client_name] = project.get(environment, client_name)
+            client_projects[client_name] = project.get(self.env, client_name)
 
         print client_projects
 
 
-    def _project_exists(self, client_name, project_name, project_status = None):
-        return project_name in self._get_projects(client_name, project_status)
-
-    def _get_projects(self, client_name = None, status = None):
-        """
-        TODO : Extend command options in order to provide better filtering (client, enabled / disabled)
-        """
-        list_projects = []
-
-        # -- List of requested projects
-        enabled_projects_dir = 'projects-enabled'
-        all_projects_dir     = 'projects-available'
-
-        list_enabled_projects = os.listdir(os.path.join(self.env.path, enabled_projects_dir))
-        list_all_projects = os.listdir(os.path.join(self.env.path, all_projects_dir))
-
-        list_projects = []
-        if (status == None):
-            list_projects = list_all_projects
-        if (status == 'enabled'):
-            list_projects = list_enabled_projects
-        if (status == 'disabled'):
-            for p in list_all_projects:
-                if p not in list_enabled_projects:
-                    list_projects.append(p)
-
-        # Restrict to requested client
-        pattern = re.compile('(\w+)-(.*)')
-        if (client_name):
-            client_projects = []
-            for project_name in list_projects:
-                matches = pattern.findall(project_name)
-                if (client_name == matches[0][0]):
-                    client_projects.append(matches[0][1])
-            list_projects = client_projects
-
-        return list_projects
-
     def _do_project_disable(self, args):
-        if len(args) == 2:
-            (client_name, project_name) = args
-            if (self._project_exists(client_name, project_name)):
-                try:
-                    os.unlink( os.path.join(self.env.path, 'projects-enabled', '%s-%s' % (client_name, project_name)) )
-                    print "Project '%s' has been disabled. Apache needs to be reloaded." % project_name
-                except (IOError, os.error), exception:
-                        print "** Project '%s' is already disabled." % project_name
-
-            else:
-                print "** Client '%s' has no project '%s'" % (client_name, project_name)
-        else:
-            print "** Invalid syntax"
+        
+        # Check syntax
+        if not len(args) == 2:
             self.do_help('project')
+            raise Exception, 'Invalid syntax'
+        
+        # Disable project
+        (client_name, project_name) = args
+        project.disable(environment, client_name, project_name)
+
 
     def _do_project_enable(self, args):
-        if len(args) == 2:
-            (client_name, project_name) = args
-            if self._project_exists(client_name, project_name):
-                try:
-                    target = os.path.join( self.env.path,
-                                          'projects-available',
-                                          '%s-%s' % (client_name, project_name) )
-                    linkname = os.path.join( self.env.path,
-                                          'projects-enabled',
-                                          '%s-%s' % (client_name, project_name) )
-                    os.symlink( target, linkname )
-                    print "Project '%s' has been enabled. Apache needs to be reloaded." % project_name
-                except Exception, e:
-                    print e
-
-            else:
-                print "** Client '%s' has no project '%s'" % (client_name, project_name)
-        else:
-            print "** Invalid syntax"
+        if not len(args) == 2:
             self.do_help('project')
-
-    def _do_project_remove(self, args):
-        print "** TODO : This command has yet to be implemented."
-
+            raise Exception, 'Invalid syntax'
+            
         (client_name, project_name) = args
-
-        # Confirm deletion
-        continue_removal = False
-        print "You are about to remove project '%s'." % project_name
-        confirm_removal = raw_input('Remove project ? [y/N]> ').strip() or False
-        if confirm_removal == 'y':
-            continue_removal = True
-
-        if not continue_removal:
-            print "Project '%s' was *not* removed\n" % project_name
-            return
-
-        # Disable project
-        if self._project_exists(client_name, project_name, 'enabled'):
-            print "You cannot remove an enabled project. Disabling it."
-            self._do_project_disable(args)
-
-        # Delete apache config file
-        try:
-            linkname = os.path.join( self.env.path, 'projects-available', '%s-%s'% (client_name, project_name) )
-            os.unlink( linkname )
-            print "Project '%s' has been removed" % project_name
-            print "Apache configuration needs to be reloaded for this to be effective."
-        except (IOError, os.error), exception:
-            print "** An error occured. Project was NOT removed. Report the following message to the sysadmin."
-            print exception
-
-    def _do_project_add(self, args):
-        if len(args) == 2:
-            client_name = args[0]
-            project_name = args[1]
-
-            # Make sure client exists
-            if not self._client_exists(client_name):
-                print "Client '%s' does not exist !" % client_name
-                return
-            # Make sure project does not already exists
-            if self._project_exists(client_name, project_name):
-                print "Client '%s' already has a project named '%s'" % (client_name, project_name)
-                return
-
-            # Information collection
-            collected_infos = {
-                'client'     : client_name,
-                'short_name' : project_name,
-                'full_name'  : None
-                }
-
-            print
-            print "Creating a new project for client '%s'" % client_name
-            print "Let's collect some informations about the project :"
-            print
-            print "  Please enter project's full name."
-            print "  This will be displayed in various places and emails."
-            print
-
-            dfn = project_name.capitalize()
-            collected_infos['full_name'] = raw_input('Full Name [%s]> ' % dfn).strip() or dfn
-
-            print
-            print "  What configuration profile should be used ?"
-            print "  Those reside in %s/profiles/" % self.env.path
-            print
-
-            dp = self.env.config.get('general', 'default_profile')
-            collected_infos['profile'] = raw_input('Configuration profile [%s]> ' % dp).strip() or dp
-
-            # Project creation
-            print
-            print "Supplied informations verified."
-            print "Let's proceed with project creation :"
-            print
-
-            try:
-                # -- Apache configuration file
-                self._project_write_apache_conf( collected_infos )
-
-                # -- Create required dirs
-                self._project_create_dirs( collected_infos )
-
-                # -- SVN repository creation
-                self._project_create_svn_repos( collected_infos )
-
-                # -- Trac environment initialisation
-                self._project_trac_initenv( collected_infos )
-
-                # -- Trac initial permissions
-                self._project_trac_setperms( collected_infos )
-
-                # -- Modifies Trac default conf
-                self._project_trac_defaultconf( collected_infos )
-                
-                # -- Fix perms
-                self._project_fix_perms( collected_infos )
-
-            except Exception, e:
-                print "An error occured :"
-                print e
-                traceback.print_exc()
-
-            # -- Enable client ?
-            print "Project has been created. Do you want to enable it ?"
-            print
-            enable_project = raw_input('Enable project ? [y/N]> ').strip() or False
-
-            if enable_project.find('y') == 0:
-                self._do_project_enable((client_name, project_name))
-
-        else:
+        project.enable(environment, client_name, project_name)
+
+    def _do_project_add(self, args, t):
+        if not len(args) == 2:
             self.do_help('project')
-
-    def _project_create_dirs(self, infos):
-        os.makedirs(os.path.join(self.self.env.config.get('general', 'clients_root'),
-                                 infos['client'],
-                                 'htdocs',
-                                 infos['short_name']), 0775)
-
-        print "  Creating project's directory layout\n"
-
-    def _project_write_apache_conf(self, infos):
-        """
-        TODO : clients may not be stored in 'clients_root', be careful with that.
-        """
-        conf_template = open(os.path.join(self.env.path, 'profiles', infos['profile'], 'project.apache.conf'))
-        conf_data = conf_template.read() % {'client_name'      : infos['client'],
-                                            'project_name'     : infos['short_name'],
-                                            'clients_root'     : self.env.config.get('general', 'clients_root'),
-                                            'authbackend_pass' : self.env.config.get('general', 'authbackend_pass'),
-                                            'trac_install_dir' : self.env.config.get('trac', 'lib_dir'),
-                                            'domain_name'      : self.env.config.get('general', 'domain')}
-
-        apache_conf_filepath = os.path.join( self.env.path, 'projects-available', '%s-%s' % (infos['client'], infos['short_name']) )
-        f = file(apache_conf_filepath, 'w+')
-        f.write(conf_data)
-        f.close()
-
-        print "  Apache configuration written to %s\n" % apache_conf_filepath
-
-    def _project_create_svn_repos(self, infos):
-        repos_path = os.path.join( self.env.config.get('general', 'clients_root'), infos['client'], 'var/svn', infos['short_name'] )
-        create_cmd = 'svnadmin create %s' % repos_path
-        (stdin, stdout, stderr) = os.popen3( create_cmd )
-
-        err = stderr.read()
-        if err:
-            raise Exception( err )
-
-        print "  Subversion repository created in %s\n" % repos_path
-
-    def _project_trac_initenv(self, infos):
-
-        trac_env_path = os.path.join( self.env.config.get('general', 'clients_root'),
-                                     infos['client'],
-                                     'var/trac',
-                                     infos['short_name'] )
-
-        svn_path = os.path.join( self.env.config.get('general', 'clients_root'),
-                                infos['client'],
-                                'var/svn',
-                                infos['short_name'] )
-        
-        cmd_data = { 'env_path'         : trac_env_path,
-                     'title'            : '"%s - %s - Trac"' % (infos['client'], infos['short_name']),
-                     'db_dsn'           : 'sqlite:db/trac.db',
-                     'svn_path'         : svn_path,
-                     'templates_path'   : '%s/templates' % self.env.config.get('trac', 'assets_dir'),
-                     'trac_install_dir' : self.env.config.get('trac', 'lib_dir')}
-
-        trac_cmd = '/usr/bin/trac-admin %(env_path)s initenv %(title)s %(db_dsn)s svn %(svn_path)s %(templates_path)s' % cmd_data
-        
-        (stdin, stdout, stderr) = os.popen3( trac_cmd )
-
-        err = stderr.read()
-        if err:
-            err = stdout.read()
-            raise Exception( err )
-
-        print "  Trac project initialized in %s\n" % trac_env_path
-
-    def _project_trac_setperms(self, infos):
-        trac_env_path = os.path.join( self.env.config.get('general', 'clients_root'),
-                                     infos['client'],
-                                     'var/trac',
-                                     infos['short_name'] )
-
-        # Perms for authenticated users
-        default_perms = ( 'BROWSER_VIEW',
-                          'CHANGESET_VIEW',
-                          'FILE_VIEW',
-                          'LOG_VIEW',
-                          'MILESTONE_VIEW',
-                          'REPORT_SQL_VIEW',
-                          'REPORT_VIEW',
-                          'ROADMAP_VIEW',
-                          'SEARCH_VIEW',
-                          'TICKET_CREATE',
-                          'TICKET_MODIFY',
-                          'TICKET_VIEW',
-                          'TIMELINE_VIEW',
-                          'WIKI_CREATE',
-                          'WIKI_MODIFY',
-                          'WIKI_VIEW' )
-
-        trac_perms_cmd = 'trac-admin %(env_path)s permission %(subcommand)s %(subject)s %(perms)s'
-
-        # Remove all anonymous permissions
-        os.system( trac_perms_cmd % {'env_path'   : trac_env_path,
-                                     'subcommand' : 'remove',
-                                     'subject'    : 'anonymous',
-                                     'perms'      : ' '.join(default_perms)} )
-
-        # Grant default permissions
-        perms_config = ConfigParser.SafeConfigParser()
-        perms_config.read(os.path.join(self.env.path, 'profiles', infos['profile'], 'permissions.ini'))
-        for profile in perms_config.options('trac'):
-            os.system( trac_perms_cmd % {'env_path'   : trac_env_path,
-                                         'subcommand' : 'add',
-                                         'subject'    : profile,
-                                         'perms'      : perms_config.get('trac', profile)} )
-
-        # Let user choose who gets admin rights
-        print "  Please enter trac administrator username."
-        print "  This user will be granted full privileges on project's Trac instance."
-        print
-
-        dan = infos['short_name'] + '-admin'
-        admin_login = raw_input('Admin Login [%s]> ' % dan).strip() or dan
-
-        os.system( trac_perms_cmd % {'env_path'   : trac_env_path,
-                                     'subcommand' : 'add',
-                                     'subject'    : admin_login,
-                                     'perms'      : 'TRAC_ADMIN'} )
-        print
-        print "  Trac initial permissions set (admin rights given to '%s')\n" % admin_login
-
-    def _project_fix_perms(self, infos):
-        """
-        chown -R dev:www-data /$CLIENTSROOT/$CLIENTNAME/var/svn/$PROJECTNAME
-        chmod g+w /$CLIENTSROOT/$CLIENTNAME/var/svn/$PROJECTNAME
-        chown -R www-data:dev /$CLIENTSROOT/$CLIENTNAME/var/trac/$PROJECTNAME/db
-            chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/var/trac/conf/trac.ini
-            chmod g+w /$CLIENTSROOT/$CLIENTNAME/var/trac/conf/trac.ini
-        """
-
-        # Trac DB
-        trac_db_path   = os.path.join(self.env.config.get('general', 'clients_root'),
-                                      infos['client'],
-                                      'var/trac',
-                                      infos['short_name'],
-                                      'db')
-        self._rchown(trac_db_path, 
-                     get_uid_from_name(self.env.config.get('general', 'apache_user')),
-                     get_gid_from_name(self.env.config.get('general', 'ssh_group')))
-
-        # Trac attachments
-        trac_attachments_path = os.path.join( self.env.config.get('general', 'clients_root'),
-                                             infos['client'],
-                                             'var/trac',
-                                             infos['short_name'],
-                                             'attachments' )
-
-        self._rchown(trac_attachments_path ,
-                     get_uid_from_name(self.env.config.get('general', 'apache_user')),
-                     get_gid_from_name(self.env.config.get('general', 'ssh_group')))
-
-        # Trac conf
-        trac_ini_path   = os.path.join( self.env.config.get('general', 'clients_root'),
-                                       infos['client'],
-                                       'var','trac',
-                                       infos['short_name'],
-                                       'conf','trac.ini' )
-        os.chmod( trac_ini_path, 0777 ) 
-
-        # Subversion repository
-        svn_repos_path = os.path.join( self.env.config.get('general', 'clients_root'),
-                                      infos['client'],
-                                      'var/svn',
-                                      infos['short_name'] )
-
-        self._rchown(svn_repos_path, 
-                     get_uid_from_name(self.env.config.get('general', 'apache_user')), 
-                     get_gid_from_name(self.env.config.get('general', 'ssh_group')))
-        
-        os.chmod( svn_repos_path, 0775 )
-
-        print "  Perms fixed\n"
-
-    def _project_trac_defaultconf(self, infos):
-        """
-        Overrides project's default trac.ini with values provided in configuration profile.
-        """
-        
-        # New defaults
-        tracdefaults_config = ConfigParser.SafeConfigParser()
-        tracdefaults_config.read(os.path.join(self.env.path, 'profiles', infos['profile'], 'trac-defaults.ini'))
-        
-        # Trac base config file
-        project_config_path = os.path.join(self.env.config.get('general', 'clients_root', infos['client'], 'var', 'trac', infos['short_name'], 'conf', 'trac.ini'))
-        tracproject_config = ConfigParser.SafeConfigParser()
-        tracproject_config.read(project_config_path)
-
-        # Overriding
-        for section in tracdefaults_config.sections():
-            if not tracproject_config.has_section(section):
-                tracproject_config.add_section(section)
-            for option in tracdefaults_config.options(section):
-                # Perform variable substituion in each default option
-                # It is probably not very good in term of performances, but we'll wait until someone complains to fix it
-                default_option = tracdefaults_config.get(section, option) % {'client_name'      : infos['client'],
-                                                                             'project_name'     : infos['short_name'],
-                                                                             'clients_root'     : self.env.config.get('general', 'clients_root'),
-                                                                             'authbackend_pass' : self.env.config.get('general', 'authbackend_pass'),
-                                                                             'trac_install_dir' : self.env.config.get('trac', 'lib_dir'),
-                                                                             'domain_name'      : self.env.config.get('general', 'domain')}
-                tracproject_config.set(section, option, default_option)
-
-        fp = open(project_config_path, 'w+')
-        tracproject_config.write(fp)
+            raise Exception, 'Invalid syntax'
+
+        (client_name, project_name) = args
+        project.add(self.env, client_name, project_name)
 
     def complete_project(self, text, line, begidx, endidx):
@@ -707 +328 @@
     def _complete_project_add(self, args):
         comp = []
-
         # "add" subcommand's first argument is client's name
-        if not args or (len(args) <= 1 and args[0] not in self._get_clients()):
-            comp = self._get_clients()
+        if not args or (len(args) <= 1 and args[0] not in client.get(self.env, args[0])):
+            comp = client.get(self.env)
 
         return comp
@@ -718 +338 @@
 
         # "enable" subcommand's first argument is client's name
-        if not args or (len(args) <= 1 and args[0] not in self._get_clients()):
-            comp = self._get_clients()
+        if not args or (len(args) <= 1 and args[0] not in client.get(self.env)):
+            comp = client.get(self.env)
         # "enable" subcommand second argument is project's name
         else :
-            comp = self._get_projects(args[0], 'disabled')
+            comp = project.get(self.env, args[0], 'disabled')
 
         return comp
@@ -730 +350 @@
 
         # "disable" subcommand's first argument is client's name
-        if not args or (len(args) <= 1 and args[0] not in self._get_clients()):
-            comp = self._get_clients()
+        if not args or (len(args) <= 1 and args[0] not in client.get(self.env)):
+            comp = client.get(self.env)
         # "disable" subcommand second argument is project's name
         else :
-            comp = self._get_projects(args[0], 'enabled')
+            comp = project.get(self.env, args[0], 'enabled')
 
         return comp
@@ -742 +362 @@
 
         # "remove" subcommand's first argument is client's name
-        if not args or (len(args) <= 1 and args[0] not in self._get_clients()):
-            comp = self._get_clients()
+        if not args or (len(args) <= 1 and args[0] not in client.get(self.env)):
+            comp = client.get(self.env)
         # "remove" subcommand second argument is project's name
         else :
-            comp = self._get_projects(args[0])
+            comp = project.get(self.env, args[0])
 
         return comp

cleverbox/trunk/cleverbox/utils/filesystem.py

@@ -18 +18 @@
                     os.chown(direntry, uid, gid)
                     os.chdir(direntry)
-                    self._rchown(direntry, uid, gid)
+                    chowntree(direntry, uid, gid)
                 else:
                     os.chown(direntry, uid, gid)

cleverbox/trunk/setup.py

@@ -6 +6 @@
 It provides an interactive shell for deploying and maintaining instances of both projects.
 """
-
-# Automatically install setuptools if needed.
-# User must have internet access
-# See http://peak.telecommunity.com/DevCenter/setuptools#using-setuptools-without-bundling-it
-import ez_setup
-ez_setup.use_setuptools()
 
 from glob import glob