Changeset 4170

Timestamp:

Jan 11, 2007, 2:38:03 PM (18 years ago)

Author:

ole

Message:

Implemented stored revision information for distributions and allowed get_revision_number to get that information from either stored file or svn as per ticket:125

Files:

• anuga_core/source/anuga/abstract_2d_finite_volumes/test_util.py (modified) (2 diffs)
• anuga_core/source/anuga/abstract_2d_finite_volumes/util.py (modified) (1 diff)
• anuga_core/source/anuga/config.py (modified) (1 diff)
• create_distribution.py (modified) (5 diffs)

anuga_core/source/anuga/abstract_2d_finite_volumes/test_util.py

@@ -1153 +1153 @@
         warnings.resetwarnings()
     
-    def test_get_version_info(self):
-        info = get_version_info()
-        
-        fields = info.split(':')
-        assert fields[0].startswith('Revision')
-
-        try:
-            int(fields[1])
-        except:
-            msg = 'Revision number must be an integer. I got %s' %fields[1]
-            msg += 'Chech that the command svn is on the system path' 
-            raise Exception(msg)                
+    def test_get_revision_number(self):
+        """test_get_revision_number(self):
+
+        Test that revision number can be retrieved.
+        """
+        
+        n = get_revision_number()
+        assert n>=0
+
+
         
     def test_add_directories(self):
@@ -1207 +1205 @@
 
         
+    def test_add_directories(self):
+        
+        import tempfile
+        root_dir = tempfile.mkdtemp('_test_util', 'test_util_')
+        directories = ['ja','ne','ke']
+        kens_dir = add_directories(root_dir, directories)
+        assert kens_dir == root_dir + sep + 'ja' + sep + 'ne' + \
+               sep + 'ke'
+        assert access(root_dir,F_OK)
+
+        add_directories(root_dir, directories)
+        assert access(root_dir,F_OK)
+        
+        #clean up!
+        os.rmdir(kens_dir)
+        os.rmdir(root_dir + sep + 'ja' + sep + 'ne')
+        os.rmdir(root_dir + sep + 'ja')
+        os.rmdir(root_dir)
+
+    def test_add_directories_bad(self):
+        
+        import tempfile
+        root_dir = tempfile.mkdtemp('_test_util', 'test_util_')
+        directories = ['/\/!@#@#$%^%&*((*:*:','ne','ke']
+        
+        try:
+            kens_dir = add_directories(root_dir, directories)
+        except OSError:
+            pass
+        else:
+            msg = 'bad dir name should give OSError'
+            raise Exception(msg)    
+            
+        #clean up!
+        os.rmdir(root_dir)
+
+    def test_check_list(self):
+
+        check_list(['stage','xmomentum'])
+
         
 #-------------------------------------------------------------

anuga_core/source/anuga/abstract_2d_finite_volumes/util.py

@@ -534 +534 @@
         fid.write(stuff)
 
-def get_version_info():
-    """gets the version number of the SVN
+def get_revision_number():
+    """Get the version number of the SVN
     NOTE: This requires that the command svn is on the system PATH
     (simply aliasing svn to the binary will not work)
     """
 
+    # Create dummy info 
+    #info = 'Revision: Version info could not be obtained.'
+    #info += 'A command line version of svn must be availbable '
+    #info += 'on the system PATH, access to the subversion '
+    #info += 'repository is necessary and the output must '
+    #info += 'contain a line starting with "Revision:"'
+    
+
     #FIXME (Ole): Change this so that svn info is attempted first.
     # If that fails, try to read a stored file with that same info (this would be created by e.g. the release script). Failing that, throw an exception.
 
-    
-    import os, sys
-
-    # Create dummy info 
-    info = 'Revision: Version info could not be obtained.'
-    info += 'A command line version of svn must be availbable '
-    info += 'on the system PATH, access to the subversion '
-    info += 'repository is necessary and the output must '
-    info += 'contain a line starting with "Revision:"'
+    #FIXME (Ole): Move this and store_version_info to utilities
+
+
+    try:
+        from anuga.stored_version_info import version_info
+    except:
+        
+        # No file available - try using Subversion
+        try:
+            fid = os.popen('svn info')
+        except:
+            msg = 'No version info stored and command "svn" is not '
+            msg += 'recognised on the system PATH. What do you want me to do?'
+            raise Exception(msg)
+        else:
+            #print 'Got version from svn'            
+            version_info = fid.read()
+    else:
+        pass
+        #print 'Got version from file'
+
+            
+    for line in version_info.split('\n'):
+        if line.startswith('Revision:'):
+            break
+
+    fields = line.split(':')
+    msg = 'Keyword "Revision" was not found anywhere in text: %s' %version_info
+    assert fields[0].startswith('Revision'), msg            
+
+    try:
+        revision_number = int(fields[1])
+    except:
+        msg = 'Revision number must be an integer. I got %s' %fields[1]
+        msg += 'Check that the command svn is on the system path' 
+        raise Exception(msg)                
+        
+    return revision_number
+
+
+def store_version_info(destination_path='.', verbose=False):
+    """Obtain current version from Subversion and store it.
+    
+    Title: store_version_info()
+
+    Author: Ole Nielsen (Ole.Nielsen@ga.gov.au)
+
+    CreationDate: January 2006
+
+    Description:
+        This function obtains current version from Subversion and stores it
+        is a Python file named 'stored_version_info.py' for use with
+        get_version_info()
+
+        If svn is not available on the system PATH, an Exception is thrown
+    """
+
+    # Note (Ole): This function should not be unit tested as it will only
+    # work when running out of the sandpit. End users downloading the
+    # ANUGA distribution would see a failure.
+    #
+    # FIXME: This function should really only be used by developers (
+    # (e.g. for creating new ANUGA releases), so maybe it should move
+    # to somewhere else.
+    
+    import config
 
     try:
         fid = os.popen('svn info')
     except:
-        msg = 'svn is not recognised on the system PATH'
-        warn(msg, UserWarning)
+        msg = 'Command "svn" is not recognised on the system PATH'
+        raise Exception(msg)
     else:    
-        lines = fid.readlines()
+        txt = fid.read()
         fid.close()
-        for line in lines:
-            if line.startswith('Revision:'):
-                info = line
-                break
-       
-    return info
+
+
+        # Determine absolute filename
+        if destination_path[-1] != os.sep:
+            destination_path += os.sep
+            
+        filename = destination_path + config.version_filename
+
+        fid = open(filename, 'w')
+
+        docstring = 'Stored version info.\n\n'
+        docstring += 'This file provides the version for distributions '
+        docstring += 'that are not accessing Subversion directly.\n'
+        docstring += 'The file is automatically generated and should not '
+        docstring += 'be modified manually.\n'
+        fid.write('"""%s"""\n\n' %docstring)
+        
+        fid.write('version_info = """\n%s"""' %txt)
+        fid.close()
+
+
+        if verbose is True:
+            print 'Version info stored to %s' %filename
+            
     
 def sww2timeseries(swwfiles,

anuga_core/source/anuga/config.py

@@ -89 +89 @@
 
 pmesh_filename = '.\\pmesh'
+version_filename = 'stored_version_info.py'
 
 

create_distribution.py

@@ -3 +3 @@
    This script is assumed to be run in the root directory of anuga
    from a working sandpit connected to svn
+
+   It will create a distribution of ANUGA from the version which is
+   currently checked out.
+
+   To use the latest version run
+
+     svn up
+
+   before running this script. To use a specific revision (2187, say) run
+
+     svn up -r 2187
+
+   first assuming that create_distribution.py (this script) and anything
+   it depends on still work for that revision.
 
    This script works only on Linux
@@ -11 +25 @@
 from sys import platform
 from anuga.utilities.system_tools import get_user_name, get_host_name
+from anuga.abstract_2d_finite_volumes.util import get_revision_number
+from anuga.abstract_2d_finite_volumes.util import store_version_info
 
 
@@ -23 +39 @@
 
 
-# Refresh sandit and retrieve svn revision number
+# Refresh sandpit and retrieve svn revision number
 # from last line in svn update output
-
-# FIXME (Ole): Change this to use util.get_version_info() and create
+#filename = mktemp() + '.txt'
+#s = 'svn update > %s' %filename
+#print s
+#system(s)
+#
+#fid = open(filename)
+#last_line = fid.readlines()[-1]
+#remove(filename)
+#if not (last_line.startswith('At revision') or\
+#        last_line.startswith('Updated to revision')):
+#    msg = 'Unexpected output from svn up: %s' %last_line
+#    raise Exception, msg    
+#
+#fields = last_line.split()
+#svn_revision = fields[-1][:-1]
+
+# Get revision number and create
 # file with version info for release.
-# This will also mean that the version currently checked out is
+# This will mean that the version currently checked out is
 # the one which will be released.
 
-filename = mktemp() + '.txt'
-
-s = 'svn update > %s' %filename
-print s
-system(s)
-
-fid = open(filename)
-last_line = fid.readlines()[-1]
-remove(filename)
-if not (last_line.startswith('At revision') or\
-        last_line.startswith('Updated to revision')):
-    msg = 'Unexpected output from svn up: %s' %last_line
-    raise Exception, msg    
-
-fields = last_line.split()
-svn_revision = fields[-1][:-1]
-
+svn_revision = get_revision_number()
 revision = '%s_%s' %(major_revision, svn_revision)
-
 print 'Creating ANUGA revision %s' %revision
 
@@ -58 +72 @@
 s = 'mkdir %s' %release_dir
 try:
+    print s    
     system(s)
 except:
@@ -63 +78 @@
 
 
-# Export a clean directory tree from the working copy
+# Export a clean directory tree from the working copy to a temporary dir
 distro_dir = mktemp()
 s = 'mkdir %s' %distro_dir
-print s
-system(s)
-
-s = 'svn export anuga_core/source/anuga %s/anuga' %(distro_dir) 
-print s
-system(s)
+print s    
+system(s)
+
+
+
+s = 'svn export -r %d anuga_core/source/anuga %s/anuga' %(svn_revision,
+                                                          distro_dir) 
+print s
+system(s)
+
+
+# Store file with revision info for use with get_revision_number
+store_version_info(destination_path=distro_dir+'/anuga', verbose=True)
+
+import sys; sys.exit() 
+
+
 
 # Zip it up