Changeset 189 for cleverbox/trunk

Timestamp:

08/14/07 19:02:31 (5 years ago)

Author:

trivoallan

Message:

cleverbox :

• added more filesystem helpers
• implemented environment test case
• fixed bug occuring when launching commands in non interactive mode
• implemented better permissions when creating environment
• fixed bug with default shell answers in project.py

Location:

cleverbox/trunk/cleverbox

Files:

• environment.py (modified) (4 diffs)
• project.py (modified) (1 diff)
• scripts/admin.py (modified) (8 diffs)
• tests/environment.py (modified) (2 diffs)
• utils/filesystem.py (modified) (2 diffs)

cleverbox/trunk/cleverbox/environment.py

@@ -2 +2 @@
 import ConfigParser
 from pkg_resources import parse_version
+from cleverbox.utils import filesystem
 
 layout = ('clients-available', 'clients-enabled',
@@ -23 +24 @@
         """
 
+        #Parameters sanity check
+        try:
+           parameters['general']['assets_dir']
+           parameters['general']['apache_group']
+        except KeyError, e:
+           raise Exception, "Supplied parameters are not complete."
+
         # Do not do anything if base directories is not empty
         if (len(os.listdir(self.path))):
-            raise IOError, '"%s" directory is not empty' % self.path
-
-        if (len(os.listdir(parameters['general']['clients_root']))):
             raise IOError, '"%s" directory is not empty' % self.path
 
@@ -43 +48 @@
             for dirname in layout:
                 env_dirs.append(self.get_path(dirname))
-            map( os.makedirs, env_dirs )
+            map(os.makedirs, env_dirs)
 
             # Create VERSION file
             try:
-                print "\n\tCreating VERSION file\n"
+                #print "\n\tCreating VERSION file\n"
                 fd = open(self.get_path('VERSION'), 'w')
                 fd.write(version)
@@ -63 +68 @@
             self.config.write(open(self.get_path('cleverbox.ini'), 'w+'))
 
+            # Setting permissions
+            for entry in os.listdir(self.path):
+                entry_path = self.get_path(entry)
+                if filesystem.is_file(entry_path):
+                    os.chmod(entry_path, 0640)
+                else:
+                    os.chmod(entry_path, 0750)
+          
+            profile_path = os.path.join(self.get_path('profiles'), 'default')
+            os.chmod(profile_path, 0750)
+            for entry in os.listdir(profile_path):
+                os.chmod(os.path.join(profile_path, entry), 0640)
+
+            filesystem.chowntree(self.path, 0, filesystem.get_gid_from_name(parameters['general']['apache_group']))
+
         except Exception, exception:
             print exception
-            print "** Environment couldn't be initialized in %(env_dir)s\n" % {'env_dir' : self.env.path}
+            print "** Environment couldn't be initialized in %(env_dir)s\n" % {'env_dir' : self.path}
             print "Rolling back changes"
             for entry in os.listdir(self.path):
                 path = os.path.join(self.path, entry)
-                stats = os.stat(path)
-                if (stat.S_ISDIR(stats[stat.ST_MODE])):
-                    os.rmdir(path)
+                if filesystem.is_directory(path):
+                    shutil.rmtree(path)
                 else:
                     os.remove(path)
-
-
-    
-    def check(self):
-        """
-        Checks environment directory is usable or not.
-        """
-        pass
     
     def needs_upgrade(self, target_version):

cleverbox/trunk/cleverbox/project.py

@@ -153 +153 @@
     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 or enable_project.find('y') == 0:
+    enable_project = raw_input('Enable project ? [y/N]> ').strip() or 'n'
+
+    if str(enable_project).find('y') == 0:
         enable(environment, client_name, project_name)
 

cleverbox/trunk/cleverbox/scripts/admin.py

@@ -14 +14 @@
 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'))
@@ -37 +38 @@
                  'Available Commands:\n'
     ruler = ''
-    prompt = "Cleverbox > "
+    prompt = style.H1("Cleverbox > ")
     _date_format = '%Y-%m-%d'
     _datetime_format = '%Y-%m-%d %H:%M:%S'
@@ -54 +55 @@
     ##
 
-    def env_set(self, env_path):
+    def env_set(self, env_path, check_upgrade=True):
         
         # Load environment
@@ -61 +62 @@
         # Check if environment needs an upgrade
         try:
-            if self.env.needs_upgrade(_version):
-                print "\nCleverbox environment needs to be upgraded. Please run :"
-                print "  cleverbox-admin %s upgrade\n" % self.env.path
+            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)
                 sys.exit(1)
+            elif not self.env.needs_upgrade(_version):
+                print style.SUCCESS("\nCleverbox environment is up to date.\n")
         except IOError, e:
             # no VERSION file means user wants to create an environment
@@ -88 +91 @@
     def run(self):
         self.interactive = True
-        print 'Welcome to cleverbox-admin\n'                \
-              'Interactive Cleverbox administration console.\n'       \
-              "Type:  '?' or 'help' for help on commands.\n"
+        print style.H1('Welcome to cleverbox-admin\n'                \
+                       'Interactive Cleverbox administration console.\n'       \
+                        "Type:  '?' or 'help' for help on commands.\n")
         self.cmdloop()
 
@@ -278 +281 @@
         clients.sort()
         for client_name in clients:
-            print style.H1("%s :" % client_name)
+            print style.H1("\n%s :" % client_name)
             enabled_projects = project.get(self.env, client_name, 'enabled')
             disabled_projects = project.get(self.env, client_name, 'disabled')
-           
-            if enabled_projects:
-                enabled_projects.sort()
-                print "  Enabled :"
-                for project_name in enabled_projects:
-                    print style.ENABLED("    - %s" % project_name)
-
-            if disabled_projects:
-                disabled_projects.sort()
-                print "  Disabled :"
-                for project_name in disabled_projects:
-                    print style.DISABLED("    - %s" % project_name)
-
-
+            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)
 
     def _do_project_disable(self, args):
@@ -409 +405 @@
 
 def run(args):
-    """Main entry point."""
+    """
+    Main entry point.
+    """
+
     admin = CleverboxAdmin()
-
     if len(args) > 0:
+        if len(args) == 1:
+            while True:
+                admin.env_set(os.path.abspath(args[0]))
+                admin.run()
         if len(args) > 1:
             if args[1] in ('-h', '--help', 'help'):
@@ -419 +421 @@
                 return admin.onecmd("about")
             elif args[1] in ('-u', '--upgrade', 'upgrade'):
-                admin.envname = args[0]
+                admin.env_set(args[0], False)
                 return admin.onecmd("upgrade")
-        else:
-            admin.env_set(os.path.abspath(args[0]))
-            if len(args) > 1:
-                s_args = ' '.join(["'%s'" % command_parts for command_parts in args[2:]])
-                command = args[1] + ' ' +s_args
-                return admin.onecmd(command)
             else:
-                while True:
-                    admin.run()
+                admin.env_set(os.path.abspath(args[0]))
+                if len(args) > 1:
+                    s_args = ' '.join(["'%s'" % command_parts for command_parts in args[2:]])
+                    command = args[1] + ' ' +s_args
+                    return admin.onecmd(command)
     else:
         return admin.onecmd("help")

cleverbox/trunk/cleverbox/tests/environment.py

@@ -1 @@
-import unittest
+import grp, logging, os, pwd, shutil, stat, tempfile, unittest
+from cleverbox.environment import Environment
+
+# Don't bother with output from scrips
+logging.basicConfig(stream=open('/dev/null', 'w+'))
 
 class EnvironmentTestCase(unittest.TestCase):
@@ -5 +9 @@
     # Fixtures
     def setUp(self):
-        pass
+        env_path = os.path.join(tempfile.gettempdir(), 'cleverbox-tempenv')
+        os.mkdir(env_path)
+        self.env = Environment(env_path)
+        parameters = {'general' : 
+                         {'clients_root' : os.path.join(env_path, 'var', 'cleverbox'), 
+                          'assets_dir'   : os.path.join('/root/tmp/cleverbox-trunk/assets'),
+                          'apache_group' : 'www-data'}}
+        self.env.create('0.5test', parameters)
+ 
+    def tearDown(self):
+        shutil.rmtree(self.env.path)
     
-    def tearDown(self):
-        pass
-    
-    def test_initenv_creates_expected_layout(self):
-        pass
-    
+    def test_create(self):
+        """Environment.create() generates a correct directory layout."""
+
+        expected = {'VERSION'                               : ('S_ISREG', '0640', 'root', 'www-data'),
+                    'cleverbox.ini'                         : ('S_ISREG', '0640', 'root', 'www-data'),
+                    'clients-available'                     : ('S_ISDIR', '0750', 'root', 'www-data'),
+                    'clients-enabled'                       : ('S_ISDIR', '0750', 'root', 'www-data'),
+                    'projects-available'                    : ('S_ISDIR', '0750', 'root', 'www-data'),
+                    'projects-enabled'                      : ('S_ISDIR', '0750', 'root', 'www-data'),
+                    'profiles'                              : ('S_ISDIR', '0750', 'root', 'www-data'),
+                    'profiles/default'                      : ('S_ISDIR', '0750', 'root', 'www-data'),
+                    'profiles/default/trac-defaults.ini'    : ('S_ISREG', '0640', 'root', 'www-data'),
+                    'profiles/default/project.apache.conf'  : ('S_ISREG', '0640', 'root', 'www-data'),
+                    'profiles/default/permissions.ini'      : ('S_ISREG', '0640', 'root', 'www-data')}
+
+        for (entry, spec) in expected.items():
+            st = os.stat(self.env.get_path(entry))
+            mode = st[stat.ST_MODE]
+
+            # Validate file type
+            func = getattr(stat, spec[0])
+            assert func.__call__(mode), '"%s" type is correct (%s)' % (entry, spec[0])
+
+            # Validate file mode
+            assert oct(stat.S_IMODE(mode)) == spec[1], '"%s" mode is correct (expected %s, got %s)' % (entry, spec[1], oct(stat.S_IMODE(mode)))
+
+            # Validate ownership
+            uid = st[stat.ST_UID]
+            gid = st[stat.ST_GID]
+            expected_uid = pwd.getpwnam(spec[2])[2]
+            expected_gid = grp.getgrnam(spec[3])[2]
+            assert uid == expected_uid, '"%s" owner is correct (expected %s, got %s)' % (entry, pwd.getpwuid(uid)[0], spec[2])
+            assert gid == expected_gid, '"%s" group is correct (expected %s, got %s)' % (entry, grp.getgrgid(uid)[0], spec[3])
+            
+
+    def test_create_creates_enough_elements(self):
+        """Environment.create() creates the right number of elements on filesystem."""
+        assert len(os.listdir(self.env.path)) == 7
+        assert len(os.listdir(os.path.join(self.env.path, 'profiles'))) == 1
+        assert len(os.listdir(os.path.join(self.env.path, 'profiles', 'default'))) == 3
+
+    def test_needs_upgrade_triggers_when_needs(self):
+        """Environment.needs_upgrade() returns true if environment needs an upgrade."""
+        assert self.env.needs_upgrade('0.6')
+
+    def test_needs_upgrade_does_not_trigger_when_unneeded(self):
+        """Environment.needs_upgrade() returns false if environment does not need an upgrade."""
+        assert self.env.needs_upgrade('0.4') == False
+
+    def test_get_version(self):
+        """Environment.get_version() returns the right version number."""
+        assert self.env.get_version() == '0.5test'
+
+    def test_get_path(self):
+        """Environment.get_path() returns the right path."""
+        assert self.env.get_path('TEST') == os.path.join(self.env.path, 'TEST')
+
+            
 def suite():
     return unittest.makeSuite(EnvironmentTestCase,'test')

cleverbox/trunk/cleverbox/utils/filesystem.py

@@ -3 +3 @@
 """
 
-import pwd, grp, os
+import pwd, grp, os, stat
 
 def chowntree(directory, uid, gid):
@@ -37 +37 @@
     """
     return grp.getgrnam(groupname)[2]
+
+def is_file(path):
+   """
+   Returns true if path points to a regular file (stat.S_ISREG).
+   """
+   mode = os.stat(path)[stat.ST_MODE]
+   return stat.S_ISREG(mode)
+
+def is_directory(path):
+   """
+   Returns true if path points to a directory (stat.S_ISDIR).
+   """
+   mode = os.stat(path)[stat.ST_MODE]
+   return stat.S_ISDIR(mode)
+
+def is_symlink(path):
+   """
+   Returns true if path points to a symlink (stat.S_ISLNK).
+   """
+   mode = os.stat(path)[stat.ST_MODE]
+   return stat.S_ISLNK(mode)
+