Changeset 201 for cleverbox/trunk/cleverbox

Timestamp:

09/12/07 21:51:47 (5 years ago)

Author:

trivoallan

Message:

cleverbox :

• implemented project unit tests
• stricter permissions for created projects files
• fixed trac.ini string substitution

Location:

cleverbox/trunk/cleverbox

Files:

• environment.py (modified) (1 diff)
• project.py (modified) (4 diffs)
• tests/client.py (modified) (1 diff)
• tests/environment.py (modified) (1 diff)
• tests/project.py (modified) (2 diffs)

cleverbox/trunk/cleverbox/environment.py

@@ -140 +140 @@
         return open(os.path.join(self.path, 'VERSION')).read().strip()
 
-    def get_path(self, filename):
+    def get_path(self, filename = ''):
         """
         Returns path to requested filename.

cleverbox/trunk/cleverbox/project.py

@@ -77 +77 @@
                             '%s-%s' % (client_name, project_name))
     os.symlink(target, linkname)
-    
+
     print styles.style.SUCCESSNORESET('')
     logging.info("  Project '%s' has been enabled. Apache needs to be reloaded." % project_name)
@@ -156 +156 @@
         _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:
+            enable(environment, client_name, project_name)
+
     except Exception, e:
-        print "An error occured :"
+        print "An error occured : "
         print e
         traceback.print_exc()
-
-    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:
-        enable(environment, client_name, project_name)
+        print "TODO : rollback changes"
+
 
 def _create_dirs(environment, infos, parameters):
@@ -300 +302 @@
 
 def _fix_perms(environment, infos, parameters):
-    """
-    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(environment.config.get('general', 'clients_root'),
-                                  infos['client'],
-                                  'var/trac',
-                                  infos['short_name'],
-                                  'db')
-    filesystem.chowntree(trac_db_path, 
-                         filesystem.get_uid_from_name(environment.config.get('general', 'apache_user')),
-                         filesystem.get_gid_from_name(environment.config.get('general', 'ssh_group')))
-
-    # Trac attachments
-    trac_attachments_path = os.path.join( environment.config.get('general', 'clients_root'),
-                                         infos['client'],
-                                         'var/trac',
-                                         infos['short_name'],
-                                         'attachments' )
-
-    filesystem.chowntree(trac_attachments_path ,
-                         filesystem.get_uid_from_name(environment.config.get('general', 'apache_user')),
-                         filesystem.get_gid_from_name(environment.config.get('general', 'ssh_group')))
-
-    # Trac conf
-    trac_ini_path = os.path.join(environment.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( environment.config.get('general', 'clients_root'),
-                                  infos['client'],
-                                  'var/svn',
-                                  infos['short_name'] )
-
-    filesystem.chowntree(svn_repos_path, 
-                         filesystem.get_uid_from_name(environment.config.get('general', 'apache_user')), 
-                         filesystem.get_gid_from_name(environment.config.get('general', 'ssh_group')))
-    
-    os.chmod( svn_repos_path, 0775 )
+
+    clients_root = environment.config.get('general', 'clients_root')
+    client_name = infos['client']
+    project_name = infos['short_name']
+    
+    permissions = {
+        os.path.join(environment.get_path(), 'projects-available', client_name + '-' + project_name)   : (0640, 'root', 'root'),
+        os.path.join(clients_root, client_name, 'htdocs', project_name)                                : (0770, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'svn', project_name)                            : (0750, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'svn', project_name, 'db')                      : (0770, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'trac', project_name)                           : (0750, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'db')                     : (0770, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'db', 'trac.db')          : (0640, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'attachments')            : (0770, 'root', 'www-data'),
+        os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'conf', 'trac.ini')       : (0640, 'root', 'www-data'),
+    }
+
+    filesystem.set_permissions(permissions)
 
     print "  Perms fixed\n"
@@ -372 +344 @@
             # 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'     : environment.config.get('general', 'clients_root'),
-                                                                         'authbackend_pass' : environment.config.get('general', 'authbackend_pass'),
-                                                                         'trac_install_dir' : environment.config.get('trac', 'lib_dir'),
-                                                                         'domain_name'      : environment.config.get('general', 'domain')}
+            default_option = tracdefaults_config.get(section, option)
             tracproject_config.set(section, option, default_option)
-
+            
+    # Add cleverbox section
+    # The variables in this section can be used for string substitution across the file
+    cleverbox_options = {'client_name'      : infos['client'],
+                         'project_name'     : infos['short_name'],
+                         'clients_root'     : environment.config.get('general', 'clients_root'),
+                         'authbackend_pass' : environment.config.get('general', 'authbackend_pass'),
+                         'trac_install_dir' : environment.config.get('trac', 'lib_dir'),
+                         'domain_name'      : environment.config.get('general', 'domain')} 
+    tracproject_config.add_section('cleverbox')
+    for (option, value) in cleverbox_options.items():
+        tracproject_config.set('cleverbox', option, value)
+
+    # Write file to disk
     fp = open(project_config_path, 'w+')
     tracproject_config.write(fp)

cleverbox/trunk/cleverbox/tests/client.py

@@ -23 +23 @@
 
     # client add
-    def test_client_add_generate_expected_layout(self):
+    def test_client_add_generates_expected_layout(self):
         client_name = 'testclient'
         client.add(self.env, client_name, {'enable' : 'y'}) 

cleverbox/trunk/cleverbox/tests/environment.py

@@ -13 +13 @@
 
     def tearDown(self):
+        pass
         shutil.rmtree(self.env.path)
         shutil.rmtree(self.env.config.get('general', 'clients_root'))

cleverbox/trunk/cleverbox/tests/project.py

@@ -9 +9 @@
 logging.basicConfig(stream=open('/dev/null', 'w+'))
 
+default_parameters = project_parameters = {'full_name'   : 'Test Project',
+                                           'profile'     : 'default',
+                                           'admin_login' : 'admin',
+                                           'enable'      : 'y'}
 class ProjectTestCase(unittest.TestCase):
     
@@ -25 +29 @@
         
         project_name = 'testproject'
-        project_parameters = {'full_name'   : 'Test Project',
-                              'profile'     : 'default',
-                              'admin_login' : 'admin',
-                              'enable'      : 'y'}
-        project.add(self.env, client_name, project_name, project_parameters)
+        project.add(self.env, client_name, project_name, default_parameters)
         assert project.exists(self.env, client_name, project_name), 'project.exists() returns true if project already exists'
         
+    def test_add_creates_expected_layout(self):
+
+        # Fixtures
+        client_name = 'testclient'
+        client.add(self.env, client_name, {'enable' : 'y'})
+        project_name = 'testproject' 
+        project.add(self.env, client_name, project_name, default_parameters)
+
+        # Specify expected layout
+        clients_root = self.env.config.get('general', 'clients_root')
+        expected = {
+            os.path.join(self.env.path, 'projects-available', client_name + '-' + project_name)         : ('S_ISREG', '0640', 'root', 'root'),
+            # Control constant should be S_ISLNK, but it does not seem to recognize the generated symlink as such
+            os.path.join(self.env.path, 'projects-enabled', client_name + '-' + project_name)           : ('S_ISREG', '0640', 'root', 'root'),
+            os.path.join(clients_root, client_name, 'htdocs', project_name)                             : ('S_ISDIR', '0770', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'svn', project_name)                         : ('S_ISDIR', '0750', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'svn', project_name, 'db')                   : ('S_ISDIR', '0770', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'trac', project_name)                        : ('S_ISDIR', '0750', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'db')                  : ('S_ISDIR', '0770', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'db', 'trac.db')       : ('S_ISREG', '0640', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'attachments')         : ('S_ISDIR', '0770', 'root', 'www-data'),
+            os.path.join(clients_root, client_name, 'var', 'trac', project_name, 'conf', 'trac.ini')    : ('S_ISREG', '0640', 'root', 'www-data'),
+        }
+        
+        cleverbox.tests.validate_layout(expected)
+    
+    def test_enable_creates_symlink(self):
+        
+        # Fixtures
+        client_name = 'testclient'
+        client.add(self.env, client_name, {'enable' : 'n'})
+        project_name = 'testproject' 
+        default_parameters['enable'] = False
+        project.add(self.env, client_name, project_name, default_parameters)
+        
+        # Enable project
+        project.enable(self.env, client_name, project_name)
+        
+        # Validate
+        open(self.env.get_path(os.path.join('projects-enabled', client_name + '-' + project_name)))
+
+    def test_disable_deletes_symlink(self):
+
+        # Fixtures
+        client_name = 'testclient'
+        client.add(self.env, client_name, {'enable' : 'n'})
+        project_name = 'testproject' 
+        project.add(self.env, client_name, project_name, default_parameters)
+        
+        # Enable project
+        project.disable(self.env, client_name, project_name)
+        
+        # Validate
+        try:
+            open(self.env.get_path(os.path.join('projects-enabled', client_name + '-' + project_name)))
+            self.fail('project.disable() deletes projects-enabled symlink')
+        except:
+            pass