|
From: Doug H. <dou...@us...> - 2002-02-02 14:58:45
|
Update of /cvsroot/happydoc/HappyDoc/happydoclib/formatter
In directory usw-pr-cvs1:/tmp/cvs-serv21733/happydoclib/formatter
Modified Files:
fileformatterbase.py
Log Message:
Added new test methods to demonstrate the expected values from the
fileformatterbase methods.
Index: fileformatterbase.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc/happydoclib/formatter/fileformatterbase.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** fileformatterbase.py 2002/02/02 13:46:27 1.5
--- fileformatterbase.py 2002/02/02 14:58:42 1.6
***************
*** 59,62 ****
--- 59,63 ----
#
import happydoclib
+ import happydoclib.StreamFlushTest as StreamFlushTest
#
***************
*** 277,278 ****
--- 278,468 ----
"Return the filename prefix value for this formatter instance."
return self._filename_prefix
+
+
+ class FileFormatterBaseTest(StreamFlushTest.StreamFlushTest):
+
+ output_base_dir = os.sep + os.path.join('tmp', 'fakedocset', 'output')
+
+ def setUp(self):
+
+ class FakeDocset:
+ def getOutputBaseDirectory(self):
+ return FileFormatterBaseTest.output_base_dir
+
+ def getDocsetBaseDirectory(self):
+ return os.sep + os.path.join('docset', 'base', 'directory')
+
+ class TestFormatter(FileBasedFormatter):
+ def getFilenameExtension(self):
+ return 'test'
+ def getRootNodeName(self):
+ return 'index.test'
+
+ self.formatter = TestFormatter(FakeDocset())
+ return
+
+ def testFixUpOutputFilenameFromRoot(self):
+ expected = os.sep + os.path.join('fix', 'up', 'filename')
+ actual = self.formatter.fixUpOutputFilename(
+ os.sep + os.path.join('fix', 'up', 'filename')
+ )
+ assert expected == actual, \
+ 'Fixed filenames do not match ("%s" vs. "%s").' % (expected, actual)
+ return
+
+ def testFixUpOutputFilenameParentDir(self):
+ expected = os.path.join('fix', 'up', 'filename')
+ actual = self.formatter.fixUpOutputFilename(
+ os.path.join(os.pardir, 'fix', 'up', 'filename')
+ )
+ assert expected == actual, \
+ 'Fixed filenames do not match ("%s" vs. "%s").' % (expected, actual)
+ return
+
+ def testFixUpOutputFilenameCurrentDir(self):
+ expected = os.path.join('fix', 'up', 'filename')
+ actual = self.formatter.fixUpOutputFilename(
+ os.path.join(os.curdir, 'fix', 'up', 'filename')
+ )
+ assert expected == actual, \
+ 'Fixed filenames do not match ("%s" vs. "%s").' % (expected, actual)
+ return
+
+ def testGetOutputNameForFileAtRoot(self):
+ filename = 'filename.py'
+ expected = '%s.%s' % (filename, 'test')
+ actual = self.formatter.getOutputNameForFile(filename)
+ assert expected == actual, \
+ 'Filenames do not match ("%s" vs. "%s").' % (expected, actual)
+ return
+
+ def testGetOutputNameForObjectNone(self):
+ info_obj = None
+ expected = 'index.test'
+ actual = self.formatter.getOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetOutputNameForObjectString(self):
+ info_obj = 'filename.test'
+ expected = 'filename.test'
+ actual = self.formatter.getOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetOutputNameForObjectFile(self):
+ info_obj = open('tmpfile.test', 'wt')
+ expected = 'tmpfile.test'
+ actual = self.formatter.getOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetOutputNameForObjectFullyQualifiedNameRoot(self):
+ import happydoclib.happydom
+ class FakeInfoObj(happydoclib.happydom.HappyDOM):
+ pass
+ info_obj = FakeInfoObj('myfake', None, 'filename.py', [])
+ expected = 'filename.py.test'
+ actual = self.formatter.getOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetOutputNameForObjectFullyQualifiedNameOneParent(self):
+ import happydoclib.happydom
+ class FakeInfoObj(happydoclib.happydom.HappyDOM):
+ pass
+ parent_obj = FakeInfoObj('myfakeparent', None, 'parent', [])
+ info_obj = FakeInfoObj('myfake', parent_obj, 'filename.py', [])
+ expected = 'parent_myfake.test'
+ actual = self.formatter.getOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetLocalOutputNameForObjectFullyQualifiedNameRoot(self):
+ import happydoclib.happydom
+ class FakeInfoObj(happydoclib.happydom.HappyDOM):
+ pass
+ info_obj = FakeInfoObj('myfake', None, 'filename.py', [])
+ expected = 'filename.py.test'
+ actual = self.formatter.getLocalOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetLocalOutputNameForObjectFullyQualifiedNameOneParent(self):
+ import happydoclib.happydom
+ class FakeInfoObj(happydoclib.happydom.HappyDOM):
+ pass
+ parent_obj = FakeInfoObj('myfakeparent', None, 'parent', [])
+ info_obj = FakeInfoObj('myfake', parent_obj, 'filename.py', [])
+ expected = 'parent_myfake.test'
+ actual = self.formatter.getLocalOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetFullOutputNameForObjectFullyQualifiedNameRoot(self):
+ import happydoclib.happydom
+ class FakeInfoObj(happydoclib.happydom.HappyDOM):
+ pass
+ info_obj = FakeInfoObj('myfake', None, 'filename.py', [])
+ expected = os.sep + os.path.join('tmp', 'fakedocset', 'output',
+ 'filename.py.test'
+ )
+ actual = self.formatter.getFullOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetFullOutputNameForObjectFullyQualifiedNameOneParent(self):
+ import happydoclib.happydom
+ class FakeInfoObj(happydoclib.happydom.HappyDOM):
+ pass
+ parent_obj = FakeInfoObj('myfakeparent', None, 'parent', [])
+ info_obj = FakeInfoObj('myfake', parent_obj, 'filename.py', [])
+ expected = os.sep + os.path.join('tmp', 'fakedocset', 'output',
+ 'parent_myfake.test'
+ )
+ actual = self.formatter.getFullOutputNameForObject(info_obj)
+ assert expected == actual, \
+ 'Output name for object does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetFullOutputNameForFileFullyQualifiedNameRoot(self):
+ filename = 'filename.py'
+ expected = os.sep + os.path.join('tmp', 'fakedocset', 'output',
+ 'filename.py.test'
+ )
+ actual = self.formatter.getFullOutputNameForFile(filename)
+ assert expected == actual, \
+ 'Output name for file does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+ def testGetFullOutputNameForFileFullyQualifiedNameOneParent(self):
+ filename = os.path.join('parentdir', 'filename.py')
+ expected = os.sep + os.path.join('tmp', 'fakedocset', 'output',
+ 'parentdir',
+ 'filename.py.test'
+ )
+ actual = self.formatter.getFullOutputNameForFile(filename)
+ assert expected == actual, \
+ 'Output name for file does not match ("%s" vs "%s")' % \
+ (expected, actual)
+ return
+
+
|
