sl@0: # Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: # All rights reserved. sl@0: # This component and the accompanying materials are made available sl@0: # under the terms of "Eclipse Public License v1.0" sl@0: # which accompanies this distribution, and is available sl@0: # at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: # sl@0: # Initial Contributors: sl@0: # Nokia Corporation - initial contribution. sl@0: # sl@0: # Contributors: sl@0: # sl@0: # Description: sl@0: # Test code for MbcUtils sl@0: # sl@0: sl@0: from MbcUtils import * sl@0: import testDataMbcUtils as testdata sl@0: import unittest sl@0: import tempfile sl@0: import StringIO sl@0: sl@0: class TestParent(unittest.TestCase): sl@0: """Potential parent test""" sl@0: sl@0: def TempFile(self, str): sl@0: """Create a temp file. Write given string and return filename. sl@0: Note caller is responsible for deleting the file""" sl@0: tfile = tempfile.mkstemp() sl@0: file = os.fdopen(tfile[0],"w") sl@0: print >> file, str sl@0: file.close() # close the file - we just want the filename then sl@0: return tfile[1] # return filename. Note client expected to delete sl@0: sl@0: def fixupDirsInExpectedList(self, expectedToFixUp): sl@0: """Convert relative filenames to absolute. sl@0: The returned list returns absolute filenames. Need to convert relelative sl@0: names to absolute so can easily compare.""" sl@0: sl@0: for tupEle in expectedToFixUp: sl@0: mbcFile = tupEle[0] sl@0: baseDir = os.path.dirname(mbcFile) sl@0: for i in range(1,3): sl@0: # tupEle[1] is list of required folders sl@0: # tupEle[2] is list of optional folders sl@0: for j in range(0, len(tupEle[i])): sl@0: absDir = os.path.abspath(os.path.join(baseDir, tupEle[i][j])) sl@0: tupEle[i][j] = absDir sl@0: # tupEle[3] is list of tuples of dir and command sl@0: for j in range(0, len(tupEle[3])): sl@0: # note need to tuple to list and back to do this sl@0: lst = list(tupEle[3][j]) sl@0: absDir = os.path.abspath(os.path.join(baseDir, lst[0])) sl@0: lst[0] = absDir sl@0: tupEle[3][j] = tuple(lst) sl@0: return expectedToFixUp sl@0: sl@0: class SimpleTest(TestParent): sl@0: """Open and return basic case""" sl@0: sl@0: def __init__(self, sample, expected): sl@0: super(SimpleTest,self).__init__() sl@0: self.sample = sample sl@0: self.expected = expected sl@0: self.tfileName = None sl@0: sl@0: def fixExpected(self, fname): sl@0: """change the filename slot in self.expected""" sl@0: # expected is a tuple. Need to convert to list and back. sl@0: # then turn into a single element list so can run through sl@0: # fixupDirsInExpectedList() sl@0: tempList = list(self.expected) sl@0: tempList[0] = fname sl@0: newTuple = tuple(tempList) sl@0: fixedList = self.fixupDirsInExpectedList([newTuple]) sl@0: self.expected = fixedList[0] sl@0: sl@0: def runTest(self): sl@0: """SimpleTest.runTest sl@0: sl@0: Create temp file with known content. Run parser and compare result sl@0: """ sl@0: self.tfileName = self.TempFile(self.sample) sl@0: parser = MbcParser(self.tfileName) sl@0: parser.execute() sl@0: self.fixExpected(self.tfileName) sl@0: result = parser() sl@0: self.assertEquals(result, self.expected, sl@0: "Result(%s) not same as Expected(%s)"%(result,self.expected)) sl@0: sl@0: def tearDown(self): sl@0: if self.tfileName: sl@0: os.unlink(self.tfileName) sl@0: sl@0: class BadDataTest(SimpleTest): sl@0: """Bad data so should get an exception""" sl@0: sl@0: def __init__(self, sample, testName): sl@0: super(BadDataTest,self).__init__(sample, []) sl@0: self.__testName = testName sl@0: sl@0: def runTest(self): sl@0: """BadDataTest.runTest sl@0: sl@0: Use SimpleTest.runTest. Should throw an exception""" sl@0: self.assertRaises(InvalidInput, SimpleTest.runTest, self) sl@0: sl@0: def shortDescription(self): sl@0: "One line description - additionally giving test name" sl@0: parentStr = super(BadDataTest, self).shortDescription() sl@0: return "%s-%s" % (parentStr, self.__testName) sl@0: sl@0: class ListTest(TestParent): sl@0: """Open and return basic case, but with list input""" sl@0: sl@0: def __init__(self, samples, expected, secondStageExpected=None, filenameToLookFor=None): sl@0: super(ListTest,self).__init__() sl@0: self.samples = samples sl@0: self.expected = expected sl@0: self.secondStageExpected = secondStageExpected sl@0: self.filenameToLookFor = filenameToLookFor sl@0: self.tfileNames = [] sl@0: sl@0: def fixExpected(self, indx, fname): sl@0: """change the filename slot in self.expected""" sl@0: # expected is a tuple. Need to convert to list and back sl@0: tempList = list(self.expected[indx]) sl@0: tempList[0] = fname sl@0: self.expected[indx] = tuple(tempList) sl@0: sl@0: def runTest(self): sl@0: """ListTest.runTest sl@0: sl@0: Create temp files with known content, one per list element. Run parser and compare result sl@0: """ sl@0: for indx in range(0, len(self.samples)): sl@0: tfileName = self.TempFile(self.samples[indx]) sl@0: self.tfileNames.append(tfileName) sl@0: self.fixExpected(indx, tfileName) sl@0: self.expected = self.fixupDirsInExpectedList(self.expected) sl@0: parser = MbcParser(self.tfileNames) sl@0: parser.execute() sl@0: result = parser() sl@0: self.assertEquals(result, self.expected, sl@0: "Result(%s) not same as Expected(%s)"%(result,self.expected)) sl@0: if self.secondStageExpected: sl@0: getFolderList = GetFolderList(result) sl@0: getFolderList.execute() sl@0: folderList = getFolderList() sl@0: self.assertEquals(folderList, self.secondStageExpected, sl@0: "Result2(%s) not same as Expected2(%s)"%(folderList,self.secondStageExpected)) sl@0: sl@0: def tearDown(self): sl@0: if self.tfileNames: sl@0: for fname in self.tfileNames: sl@0: os.unlink(fname) sl@0: sl@0: class FolderListUnitTest(TestParent): sl@0: """Test GetFolderList with on-the-fly generated data. sl@0: sl@0: Create a list on fly with folder of one temp file and a non-existant one. Treatement of second sl@0: is optional.""" sl@0: sl@0: def __init__(self, fussyOnNonExist): sl@0: super(FolderListUnitTest,self).__init__() sl@0: self.__fussyOnNonExist = fussyOnNonExist sl@0: self.__tempFile = None sl@0: sl@0: def shortDescription(self): sl@0: """One line description - additionally giving option""" sl@0: parentStr = super(FolderListUnitTest, self).shortDescription() sl@0: return "%s-%s" % (parentStr, str(self.__fussyOnNonExist)) sl@0: sl@0: def __realTest(self): sl@0: "real test run - separate so can be trapped if required" sl@0: sl@0: self.__tempFile = tempfile.NamedTemporaryFile() # used to create list and check sl@0: sl@0: (input,tempFileName,expected) = self.__createDataLists() sl@0: getFolderList = GetFolderList(input, nameToCheck=tempFileName) sl@0: getFolderList.execute() sl@0: result = getFolderList() sl@0: self.assertEquals(result, expected, sl@0: "Result2(%s) not same as Expected2(%s)(filename=%s)"%(result,expected,tempFileName)) sl@0: sl@0: def runTest(self): sl@0: "FolderListUnitTest.runTest" sl@0: if not self.__fussyOnNonExist: sl@0: self.__realTest() sl@0: else: sl@0: # should fail sl@0: self.assertRaises(MissingFile, self.__realTest) sl@0: sl@0: def tearDown(self): sl@0: "Stop using temp file, so will be deleted" sl@0: self.__tempFile = None sl@0: sl@0: def __createDataLists(self): sl@0: """Create input and output for test run as lists. sl@0: sl@0: input will be one element with and second with "nonexistant", sl@0: but which element is used depends on fussyOnNonExist""" sl@0: input = [] sl@0: tempFileName = None sl@0: expected = [] sl@0: sl@0: (tempDir,tempFileName) = os.path.split(self.__tempFile.name) # the dir and name of the temporary file we are using sl@0: input += [("f1", [tempDir], [], [])] # the existing file sl@0: expected += [(True, tempDir, 'From f1')] sl@0: if self.__fussyOnNonExist: sl@0: input += [("f2", ["nonexistant"], [], [])] sl@0: else: sl@0: input += [("f2", [], ["nonexistant"], [])] sl@0: expected += [(True, None, 'Skip "nonexistant" from f2')] # always return the non-fussy version, as with fussy we expect exception raised sl@0: sl@0: return (input,tempFileName,expected) sl@0: sl@0: class FolderListIntTest(TestParent): sl@0: """Integration test combining MbcParser and FolderList sl@0: sl@0: Create a temporary folder. Add the following contents: sl@0: sl@0: x/bld.inf sl@0: y/bld.inf sl@0: z/bld.inf sl@0: mbc containing "./x, ./y, [optional] ./z" sl@0: sl@0: z/bld.inf and y.bld are optional sl@0: option="x" no z or y. Should raise exception. sl@0: option="xy" no z but y. Should get list of ../x and ../y sl@0: option="xz" no y but z. Should raise exception. sl@0: option="xyz" both y and z. Should get list of ../x, ../y and ../z sl@0: sl@0: """ sl@0: sl@0: def __init__(self, option): sl@0: super(FolderListIntTest,self).__init__() sl@0: self.__option = option sl@0: self.__testDir = None sl@0: self.__testDirs = [] # list of dirs we create, so we can delete them sl@0: self.__testFiles = [] # list of files we create, so we can delete them sl@0: self.__fullMbcFileName = None sl@0: self.__expectedResult = [] sl@0: sl@0: def shortDescription(self): sl@0: "One line description - additionally giving option" sl@0: parentStr = super(FolderListIntTest, self).shortDescription() sl@0: return "%s-%s" % (parentStr, str(self.__option)) sl@0: sl@0: def tearDown(self): sl@0: for fle in self.__testFiles: sl@0: try: sl@0: os.unlink(fle) sl@0: except: sl@0: pass # ignore any error. assume means we didn't create the file in the end sl@0: # delete folders in reverse, so child directories deleted after parent sl@0: for dir in self.__testDirs[len(self.__testDirs)-1::-1]: sl@0: try: sl@0: os.rmdir(dir) sl@0: except: sl@0: pass # ignore any error. assume means we didn't create the file in the end sl@0: sl@0: def runTest(self): sl@0: "FolderListIntTest.runTest" sl@0: self.__setup() sl@0: if "y" in self.__option: sl@0: self.__realTest() sl@0: else: sl@0: # expected to raise exception as y/bld.inf does not exist sl@0: self.assertRaises(MissingFile, self.__realTest) sl@0: sl@0: def __realTest(self): sl@0: parser = MbcParser(self.__fullMbcFileName) sl@0: parser.execute() sl@0: folderList = GetFolderList(parser()) sl@0: folderList.execute() sl@0: result = folderList() sl@0: self.assertEquals(result, self.__expectedResult, sl@0: "Result (%s) not that expected (%s)" % (str(result), str(self.__expectedResult))) sl@0: sl@0: def __setup(self): sl@0: self.__testDir = tempfile.mkdtemp() # __testDir is name of temp folder sl@0: self.__testDirs.append(self.__testDir) sl@0: self.__fullMbcFileName = os.path.join(self.__testDir, "test.mbc") sl@0: sl@0: for name in ["x","y","z"]: sl@0: fullpath = os.path.join(self.__testDir, name) sl@0: if name in self.__option: sl@0: os.mkdir(fullpath) sl@0: self.__testDirs.append(fullpath) sl@0: filepath = os.path.join(fullpath, "bld.inf") sl@0: fileToWrite = file(filepath, "w") sl@0: self.__testFiles.append(filepath) sl@0: print >>fileToWrite, "//generated" # 9.5 syntax sl@0: fileToWrite.close() sl@0: expected = (True, fullpath, "From %s" % self.__fullMbcFileName) sl@0: self.__expectedResult.append(expected) sl@0: else: sl@0: expected = (True, None, """Skip "%s" from %s""" % (fullpath, self.__fullMbcFileName)) sl@0: self.__expectedResult.append(expected) sl@0: mbcFile = file(self.__fullMbcFileName, "w") sl@0: self.__testFiles.append(self.__fullMbcFileName) sl@0: print >>mbcFile, testdata.intTestMbcFile sl@0: mbcFile.close() sl@0: sl@0: class ConfigFileUnitTest(unittest.TestCase): sl@0: """ConfigFile UnitTest""" sl@0: sl@0: def __init__(self, inputData, expected): sl@0: super(ConfigFileUnitTest,self).__init__() sl@0: self.__inputData = inputData sl@0: self.__expected = expected sl@0: sl@0: def runTest(self): sl@0: """ConfigFileUnitTest.runTest sl@0: sl@0: Take dummy folder list and generate XML file. Output goes to string. Compare with expected sl@0: """ sl@0: sl@0: outputStream = StringIO.StringIO() sl@0: generator = ConfigFileGenerator(self.__inputData, outputStream) sl@0: generator.write() sl@0: outputString = outputStream.getvalue() sl@0: ## print ("output=%s" % str(outputString)) sl@0: ## print ("expected=%s" % str(self.__expected)) sl@0: self.assertEquals(outputString, self.__expected, sl@0: "Generated output (%s) not same as expected (%s)" % (outputString, self.__expected)) sl@0: sl@0: def suite(): sl@0: """TestSuite""" sl@0: sl@0: tests = [ sl@0: SimpleTest(testdata.import1, testdata.result1), sl@0: ListTest(testdata.import2, testdata.result2), sl@0: BadDataTest(testdata.badImport1, "bad1"), sl@0: BadDataTest(testdata.badImport2, "bad2"), sl@0: FolderListUnitTest(False), sl@0: FolderListUnitTest(True), sl@0: FolderListIntTest("x"), sl@0: FolderListIntTest("xy"), sl@0: FolderListIntTest("xz"), sl@0: FolderListIntTest("xyz"), sl@0: ConfigFileUnitTest(testdata.testFolderList1, testdata.testXmlFile1), sl@0: ] sl@0: sl@0: return unittest.TestSuite(tests) sl@0: sl@0: sl@0: if __name__ == "__main__": sl@0: unittest.TextTestRunner(verbosity=2).run(suite())