Changeset 213 for cleverbox/trunk

Timestamp:

01/10/08 12:43:41 (4 years ago)

Author:

trivoallan

Message:

cleverbox : started implementation of a generic input collection framework.

Location:

cleverbox/trunk

Files:

• cleverbox/model/project.py (modified) (11 diffs)
• cleverbox/scripts/admin.py (modified) (4 diffs)
• cleverbox/tests/project_test.py (modified) (1 diff)
• cleverbox/utils/inputcollector.py (added)
• docs/TODO (modified) (1 diff)

cleverbox/trunk/cleverbox/model/project.py

@@ -87 +87 @@
     """
     
+    # Parameters required for project creation
+    required = ('client', 'short_name', 'full_name', 'profile', 'enable')
+
+    # Merging for consistency
+    parameters['client'] = client_name
+    parameters['short_name'] = project_name
+
+    # Sanity checks before project creation
+    for required_param in required:
+        # This will raise a KeyError if a parameter is missing
+        # TODO : it could be better to raise a more specific exception
+        parameters[required_param]
+    
     # Make sure client exists
     from cleverbox.model import client
@@ -97 +110 @@
 
     # Information collection
-    collected_infos = {
-        'client'     : client_name,
-        'short_name' : project_name,
-        'full_name'  : None
-    }
-
-    try:
-        collected_infos['full_name'] = parameters['full_name']
-    except KeyError:
-        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
-
-    try:
-        collected_infos['profile'] = parameters['profile']
-    except KeyError:
-        print
-        print "  What configuration profile should be used ?"
-        print "  Those reside in %s/profiles/" % environment.path
-        print
-    
-        dp = environment.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
+    collected_infos = parameters
 
     try:
         # -- Apache configuration file
-        _write_apache_conf(environment, collected_infos, parameters)
+        _write_apache_conf(environment, parameters)
 
         # -- Create required dirs
-        _create_dirs(environment, collected_infos, parameters)
+        _create_dirs(environment, parameters)
 
         # -- SVN repository creation
-        _create_svn_repos(environment, collected_infos, parameters)
+        _create_svn_repos(environment, parameters)
 
         # -- Trac environment initialisation
-        _trac_initenv(environment, collected_infos, parameters)
+        _trac_initenv(environment, parameters)
 
         # -- Trac initial permissions
-        _trac_setperms(environment, collected_infos, parameters)
+        _trac_setperms(environment, parameters)
 
         # -- Modifies Trac default conf
-        _trac_defaultconf(environment, collected_infos, parameters)
+        _trac_defaultconf(environment, parameters)
         
         # -- Fix perms
-        _fix_perms(environment, collected_infos, parameters)
-
-        try:
-            enable_project = parameters['enable']
-        except KeyError:
-            # -- Enable client ?
-            print "Project has been created. Do you want to enable it ?"
-            print
-            enable_project = raw_input('Enable project ? [y/N]> ').strip() or 'n'
-
-        if str(enable_project).find('y') == 0:
+        _fix_perms(environment, parameters)
+
+        if str(parameters['enable']).find('y') == 0:
             enable(environment, client_name, project_name)
 
@@ -174 +144 @@
 
 
-def _create_dirs(environment, infos, parameters):
+def _create_dirs(environment, infos):
     os.makedirs(os.path.join(environment.config.get('general', 'clients_root'),
                              infos['client'],
@@ -182 +152 @@
     print "  Creating project's directory layout\n"
 
-def _write_apache_conf(environment, infos, parameters):
+def _write_apache_conf(environment, infos):
     """
     TODO : clients may not be stored in 'clients_root', be careful with that.
@@ -201 +171 @@
     print "  Apache configuration written to %s\n" % apache_conf_filepath
 
-def _create_svn_repos(environment, infos, parameters):
+def _create_svn_repos(environment, infos):
     repos_path = os.path.join( environment.config.get('general', 'clients_root'), infos['client'], 'var/svn', infos['short_name'] )
     create_cmd = 'svnadmin create %s' % repos_path
@@ -212 +182 @@
     print "  Subversion repository created in %s\n" % repos_path
 
-def _trac_initenv(environment, infos, parameters):
+def _trac_initenv(environment, infos):
 
     trac_env_path = os.path.join( environment.config.get('general', 'clients_root'),
@@ -242 +212 @@
     print "  Trac project initialized in %s\n" % trac_env_path
 
-def _trac_setperms(environment, infos, parameters):
+def _trac_setperms(environment, infos):
     trac_env_path = os.path.join( environment.config.get('general', 'clients_root'),
                                  infos['client'],
@@ -269 +239 @@
 
     # Remove all anonymous permissions
+    # TODO : instead of using the default_perms array, we should list all anonymous using the permissions list cmd 
     os.system( trac_perms_cmd % {'env_path'   : trac_env_path,
                                  'subcommand' : 'remove',
@@ -283 +254 @@
                                      'perms'      : perms_config.get('trac', profile)} )
 
-    try:
-        admin_login = parameters['profile']
-    except KeyError:
-        # 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
+    admin_login = infos['tracadmin']
 
     os.system( trac_perms_cmd % {'env_path'   : trac_env_path,
@@ -301 +263 @@
     print "  Trac initial permissions set (admin rights given to '%s')\n" % admin_login
 
-def _fix_perms(environment, infos, parameters):
+def _fix_perms(environment, infos):
 
     clients_root = environment.config.get('general', 'clients_root')
@@ -323 +285 @@
     print "  Perms fixed\n"
 
-def _trac_defaultconf(environment, infos, parameters):
+def _trac_defaultconf(environment, infos):
     """
     Overrides project's default trac.ini with values provided in configuration profile.

cleverbox/trunk/cleverbox/scripts/admin.py

@@ -4 +4 @@
 from trac import util
 from trac.scripts.admin import TracAdmin
-from cleverbox.utils import termcolors, styles
+from cleverbox.utils import termcolors, styles, inputcollector
 from cleverbox.model.environment import Environment
 from cleverbox.model import client, project
@@ -45 +45 @@
         # Check if environment needs an upgrade
         try:
-            # TODO : would be better to throw an exception here
             if check_upgrade and self.env.needs_upgrade(cleverbox.version):
                 print
-                logging.warn("  Cleverbox environment needs to be upgraded.\n" \
-                             "  Please run : cleverbox-admin %s upgrade" % self.env.path)
+                logging.error("  Cleverbox environment needs to be upgraded.\n" \
+                              "  Please run : cleverbox-admin %s upgrade" % self.env.path)
                 print
                 sys.exit(1)
@@ -58 +57 @@
         except IOError, e:
             # no VERSION file means user wants to create an environment
-            pass
+            print
+            logging.warn("  Environment at %s has not been initialized yet.\n" \
+                         "  Please run the 'initenv' command." % self.env.path)
+            print
 
         # Set shell prompt
@@ -313 +315 @@
             raise Exception, 'Invalid syntax'
 
+        # Extract parameters from command parameters
         (client_name, project_name) = args
-        project.add(self.env, client_name, project_name)
+        
+        # Create input specification
+        input_spec = {'full_name' : ('Full name', 'This variable is not used anywhere !', project_name.capitalize()),
+                      'profile'   : ('Configuration profile', 'What configuration profile should be used ?', self.env.config.get('general', 'default_profile')),
+                      'enable'    : ('Enable project ?', 'This will make project available on the web.', 'n'),
+                      'tracadmin' : ('Trac administrator', "This user will be granted full privileges on project's Trac instance", project_name + '-admin')}
+        
+        # Collect input
+        collected_input = inputcollector.collect(input_spec)
+        
+        # Create project
+        project.add(self.env, client_name, project_name, collected_input)
 
     def complete_project(self, text, line, begidx, endidx):

cleverbox/trunk/cleverbox/tests/project_test.py

@@ -11 +11 @@
 default_parameters = project_parameters = {'full_name'   : 'Test Project',
                                            'profile'     : 'default',
-                                           'admin_login' : 'admin',
+                                           'tracadmin'   : 'admin',
                                            'enable'      : 'y'}
 class ProjectTestCase(unittest.TestCase):

cleverbox/trunk/docs/TODO

@@ -11 +11 @@
  * apachectl integration (for configtest + reload)
  * by default, files should be owned bu current user, not root : 2.0 !
+ * make code for collecting user input more generic 
+ (and btw, models should not be responsible for collecting data)
+ * normalize exceptions usage
+ * trac permissions definitions could be better. Foreach subject listed in permissions.ini
+   * revoke all permissions (list obtained with 'permissions list'
+   * add permissions listed in permissions.ini