BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / UPT / UnitTest / DecParserUnitTest.py

## @file\r
# This file contain unit test for DecParser\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
import os\r
import unittest\r
from Logger.Log import FatalError\r
\r
from Parser.DecParser import \\r
    Dec, \\r
    _DecDefine, \\r
    _DecLibraryclass, \\r
    _DecPcd, \\r
    _DecGuid, \\r
    FileContent, \\r
    _DecBase, \\r
    CleanString\r
\r
from Object.Parser.DecObject import _DecComments\r
\r
#\r
# Test CleanString\r
#\r
class CleanStringTestCase(unittest.TestCase):\r
    def testCleanString(self):\r
        Line, Comment = CleanString('')\r
        self.assertEqual(Line, '')\r
        self.assertEqual(Comment, '')\r
\r
        Line, Comment = CleanString('line without comment')\r
        self.assertEqual(Line, 'line without comment')\r
        self.assertEqual(Comment, '')\r
\r
        Line, Comment = CleanString('# pure comment')\r
        self.assertEqual(Line, '')\r
        self.assertEqual(Comment, '# pure comment')\r
\r
        Line, Comment = CleanString('line # and comment')\r
        self.assertEqual(Line, 'line')\r
        self.assertEqual(Comment, '# and comment')\r
\r
    def testCleanStringCpp(self):\r
        Line, Comment = CleanString('line // and comment', AllowCppStyleComment = True)\r
        self.assertEqual(Line, 'line')\r
        self.assertEqual(Comment, '# and comment')\r
\r
#\r
# Test _DecBase._MacroParser function\r
#\r
class MacroParserTestCase(unittest.TestCase):\r
    def setUp(self):\r
        self.dec = _DecBase(FileContent('dummy', []))\r
\r
    def testCorrectMacro(self):\r
        self.dec._MacroParser('DEFINE MACRO1 = test1')\r
        self.failIf('MACRO1' not in self.dec._LocalMacro)\r
        self.assertEqual(self.dec._LocalMacro['MACRO1'], 'test1')\r
\r
    def testErrorMacro1(self):\r
        # Raise fatal error, macro name must be upper case letter\r
        self.assertRaises(FatalError, self.dec._MacroParser, 'DEFINE not_upper_case = test2')\r
\r
    def testErrorMacro2(self):\r
        # No macro name given\r
        self.assertRaises(FatalError, self.dec._MacroParser, 'DEFINE ')\r
\r
#\r
# Test _DecBase._TryBackSlash function\r
#\r
class TryBackSlashTestCase(unittest.TestCase):\r
    def setUp(self):\r
        Content = [\r
            # Right case\r
            'test no backslash',\r
\r
            'test with backslash \\',\r
            'continue second line',\r
\r
            # Do not precede with whitespace\r
            '\\',\r
\r
            # Empty line after backlash is not allowed\r
            'line with backslash \\',\r
            ''\r
        ]\r
        self.dec = _DecBase(FileContent('dummy', Content))\r
\r
    def testBackSlash(self):\r
        #\r
        # Right case, assert return values\r
        #\r
        ConcatLine, CommentList = self.dec._TryBackSlash(self.dec._RawData.GetNextLine(), [])\r
        self.assertEqual(ConcatLine, 'test no backslash')\r
        self.assertEqual(CommentList, [])\r
\r
        ConcatLine, CommentList = self.dec._TryBackSlash(self.dec._RawData.GetNextLine(), [])\r
        self.assertEqual(CommentList, [])\r
        self.assertEqual(ConcatLine, 'test with backslash continue second line')\r
\r
        #\r
        # Error cases, assert raise exception\r
        #\r
        self.assertRaises(FatalError, self.dec._TryBackSlash, self.dec._RawData.GetNextLine(), [])\r
        self.assertRaises(FatalError, self.dec._TryBackSlash, self.dec._RawData.GetNextLine(), [])\r
\r
#\r
# Test _DecBase.Parse function\r
#\r
class DataItem(_DecComments):\r
    def __init__(self):\r
        _DecComments.__init__(self)\r
        self.String = ''\r
\r
class Data(_DecComments):\r
    def __init__(self):\r
        _DecComments.__init__(self)\r
        # List of DataItem\r
        self.ItemList = []\r
\r
class TestInner(_DecBase):\r
    def __init__(self, RawData):\r
        _DecBase.__init__(self, RawData)\r
        self.ItemObject = Data()\r
\r
    def _StopCurrentParsing(self, Line):\r
        return Line == '[TOP]'\r
\r
    def _ParseItem(self):\r
        Item = DataItem()\r
        Item.String = self._RawData.CurrentLine\r
        self.ItemObject.ItemList.append(Item)\r
        return Item\r
\r
    def _TailCommentStrategy(self, Comment):\r
        return Comment.find('@comment') != -1\r
\r
class TestTop(_DecBase):\r
    def __init__(self, RawData):\r
        _DecBase.__init__(self, RawData)\r
        # List of Data\r
        self.ItemObject = []\r
\r
    # Top parser\r
    def _StopCurrentParsing(self, Line):\r
        return False\r
\r
    def _ParseItem(self):\r
        TestParser = TestInner(self._RawData)\r
        TestParser.Parse()\r
        self.ItemObject.append(TestParser.ItemObject)\r
        return TestParser.ItemObject\r
\r
class ParseTestCase(unittest.TestCase):\r
    def setUp(self):\r
        pass\r
\r
    def testParse(self):\r
        Content = \\r
        '''# Top comment\r
        [TOP]\r
          # sub1 head comment\r
          (test item has both head and tail comment) # sub1 tail comment\r
          # sub2 head comment\r
          (test item has head and special tail comment)\r
          # @comment test TailCommentStrategy branch\r
\r
          (test item has no comment)\r
\r
        # test NextLine branch\r
        [TOP]\r
          sub-item\r
        '''\r
        dec = TestTop(FileContent('dummy', Content.splitlines()))\r
        dec.Parse()\r
\r
        # Two sections\r
        self.assertEqual(len(dec.ItemObject), 2)\r
\r
        data = dec.ItemObject[0]\r
        self.assertEqual(data._HeadComment[0][0], '# Top comment')\r
        self.assertEqual(data._HeadComment[0][1], 1)\r
\r
        # 3 subitems\r
        self.assertEqual(len(data.ItemList), 3)\r
\r
        dataitem = data.ItemList[0]\r
        self.assertEqual(dataitem.String, '(test item has both head and tail comment)')\r
        # Comment content\r
        self.assertEqual(dataitem._HeadComment[0][0], '# sub1 head comment')\r
        self.assertEqual(dataitem._TailComment[0][0], '# sub1 tail comment')\r
        # Comment line number\r
        self.assertEqual(dataitem._HeadComment[0][1], 3)\r
        self.assertEqual(dataitem._TailComment[0][1], 4)\r
\r
        dataitem = data.ItemList[1]\r
        self.assertEqual(dataitem.String, '(test item has head and special tail comment)')\r
        # Comment content\r
        self.assertEqual(dataitem._HeadComment[0][0], '# sub2 head comment')\r
        self.assertEqual(dataitem._TailComment[0][0], '# @comment test TailCommentStrategy branch')\r
        # Comment line number\r
        self.assertEqual(dataitem._HeadComment[0][1], 5)\r
        self.assertEqual(dataitem._TailComment[0][1], 7)\r
\r
        dataitem = data.ItemList[2]\r
        self.assertEqual(dataitem.String, '(test item has no comment)')\r
        # Comment content\r
        self.assertEqual(dataitem._HeadComment, [])\r
        self.assertEqual(dataitem._TailComment, [])\r
\r
        data = dec.ItemObject[1]\r
        self.assertEqual(data._HeadComment[0][0], '# test NextLine branch')\r
        self.assertEqual(data._HeadComment[0][1], 11)\r
\r
        # 1 subitems\r
        self.assertEqual(len(data.ItemList), 1)\r
\r
        dataitem = data.ItemList[0]\r
        self.assertEqual(dataitem.String, 'sub-item')\r
        self.assertEqual(dataitem._HeadComment, [])\r
        self.assertEqual(dataitem._TailComment, [])\r
\r
#\r
# Test _DecDefine._ParseItem\r
#\r
class DecDefineTestCase(unittest.TestCase):\r
    def GetObj(self, Content):\r
        Obj = _DecDefine(FileContent('dummy', Content.splitlines()))\r
        Obj._RawData.CurrentLine = Obj._RawData.GetNextLine()\r
        return Obj\r
\r
    def testDecDefine(self):\r
        item = self.GetObj('PACKAGE_NAME = MdePkg')._ParseItem()\r
        self.assertEqual(item.Key, 'PACKAGE_NAME')\r
        self.assertEqual(item.Value, 'MdePkg')\r
\r
    def testDecDefine1(self):\r
        obj = self.GetObj('PACKAGE_NAME')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testDecDefine2(self):\r
        obj = self.GetObj('unknown_key = ')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testDecDefine3(self):\r
        obj = self.GetObj('PACKAGE_NAME = ')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
#\r
# Test _DecLibraryclass._ParseItem\r
#\r
class DecLibraryTestCase(unittest.TestCase):\r
    def GetObj(self, Content):\r
        Obj = _DecLibraryclass(FileContent('dummy', Content.splitlines()))\r
        Obj._RawData.CurrentLine = Obj._RawData.GetNextLine()\r
        return Obj\r
\r
    def testNoInc(self):\r
        obj = self.GetObj('UefiRuntimeLib')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testEmpty(self):\r
        obj = self.GetObj(' | ')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testLibclassNaming(self):\r
        obj = self.GetObj('lowercase_efiRuntimeLib|Include/Library/UefiRuntimeLib.h')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testLibclassExt(self):\r
        obj = self.GetObj('RuntimeLib|Include/Library/UefiRuntimeLib.no_h')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testLibclassRelative(self):\r
        obj = self.GetObj('RuntimeLib|Include/../UefiRuntimeLib.h')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
#\r
# Test _DecPcd._ParseItem\r
#\r
class DecPcdTestCase(unittest.TestCase):\r
    def GetObj(self, Content):\r
        Obj = _DecPcd(FileContent('dummy', Content.splitlines()))\r
        Obj._RawData.CurrentLine = Obj._RawData.GetNextLine()\r
        Obj._RawData.CurrentScope = [('PcdsFeatureFlag'.upper(), 'COMMON')]\r
        return Obj\r
\r
    def testOK(self):\r
        item = self.GetObj('gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable|FALSE|BOOLEAN|0x0000000d')._ParseItem()\r
        self.assertEqual(item.TokenSpaceGuidCName, 'gEfiMdePkgTokenSpaceGuid')\r
        self.assertEqual(item.TokenCName, 'PcdComponentNameDisable')\r
        self.assertEqual(item.DefaultValue, 'FALSE')\r
        self.assertEqual(item.DatumType, 'BOOLEAN')\r
        self.assertEqual(item.TokenValue, '0x0000000d')\r
\r
    def testNoCvar(self):\r
        obj = self.GetObj('123ai.PcdComponentNameDisable|FALSE|BOOLEAN|0x0000000d')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testSplit(self):\r
        obj = self.GetObj('gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable FALSE|BOOLEAN|0x0000000d')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
        obj = self.GetObj('gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable|FALSE|BOOLEAN|0x0000000d | abc')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testUnknownType(self):\r
        obj = self.GetObj('gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable|FALSE|unknown|0x0000000d')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testVoid(self):\r
        obj = self.GetObj('gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable|abc|VOID*|0x0000000d')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testUINT(self):\r
        obj = self.GetObj('gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable|0xabc|UINT8|0x0000000d')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
#\r
# Test _DecInclude._ParseItem\r
#\r
class DecIncludeTestCase(unittest.TestCase):\r
    #\r
    # Test code to be added\r
    #\r
    pass\r
\r
#\r
# Test _DecGuid._ParseItem\r
#\r
class DecGuidTestCase(unittest.TestCase):\r
    def GetObj(self, Content):\r
        Obj = _DecGuid(FileContent('dummy', Content.splitlines()))\r
        Obj._RawData.CurrentLine = Obj._RawData.GetNextLine()\r
        Obj._RawData.CurrentScope = [('guids'.upper(), 'COMMON')]\r
        return Obj\r
\r
    def testCValue(self):\r
        item = self.GetObj('gEfiIpSecProtocolGuid={ 0xdfb386f7, 0xe100, 0x43ad,'\r
                           ' {0x9c, 0x9a, 0xed, 0x90, 0xd0, 0x8a, 0x5e, 0x12 }}')._ParseItem()\r
        self.assertEqual(item.GuidCName, 'gEfiIpSecProtocolGuid')\r
        self.assertEqual(item.GuidCValue, '{ 0xdfb386f7, 0xe100, 0x43ad, {0x9c, 0x9a, 0xed, 0x90, 0xd0, 0x8a, 0x5e, 0x12 }}')\r
\r
    def testGuidString(self):\r
        item = self.GetObj('gEfiIpSecProtocolGuid=1E73767F-8F52-4603-AEB4-F29B510B6766')._ParseItem()\r
        self.assertEqual(item.GuidCName, 'gEfiIpSecProtocolGuid')\r
        self.assertEqual(item.GuidCValue, '1E73767F-8F52-4603-AEB4-F29B510B6766')\r
\r
    def testNoValue1(self):\r
        obj = self.GetObj('gEfiIpSecProtocolGuid')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testNoValue2(self):\r
        obj = self.GetObj('gEfiIpSecProtocolGuid=')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
    def testNoName(self):\r
        obj = self.GetObj('=')\r
        self.assertRaises(FatalError, obj._ParseItem)\r
\r
#\r
# Test Dec.__init__\r
#\r
class DecDecInitTestCase(unittest.TestCase):\r
    def testNoDecFile(self):\r
        self.assertRaises(FatalError, Dec, 'No_Such_File')\r
\r
class TmpFile:\r
    def __init__(self, File):\r
        self.File = File\r
\r
    def Write(self, Content):\r
        try:\r
            FileObj = open(self.File, 'w')\r
            FileObj.write(Content)\r
            FileObj.close()\r
        except:\r
            pass\r
\r
    def Remove(self):\r
        try:\r
            os.remove(self.File)\r
        except:\r
            pass\r
\r
#\r
# Test Dec._UserExtentionSectionParser\r
#\r
class DecUESectionTestCase(unittest.TestCase):\r
    def setUp(self):\r
        self.File = TmpFile('test.dec')\r
        self.File.Write(\r
'''[userextensions.intel."myid"]\r
[userextensions.intel."myid".IA32]\r
[userextensions.intel."myid".IA32,]\r
[userextensions.intel."myid]\r
'''\r
        )\r
\r
    def tearDown(self):\r
        self.File.Remove()\r
\r
    def testUserExtentionHeader(self):\r
        dec = Dec('test.dec', False)\r
\r
        # OK: [userextensions.intel."myid"]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        dec._UserExtentionSectionParser()\r
        self.assertEqual(len(dec._RawData.CurrentScope), 1)\r
        self.assertEqual(dec._RawData.CurrentScope[0][0], 'userextensions'.upper())\r
        self.assertEqual(dec._RawData.CurrentScope[0][1], 'intel')\r
        self.assertEqual(dec._RawData.CurrentScope[0][2], '"myid"')\r
        self.assertEqual(dec._RawData.CurrentScope[0][3], 'COMMON')\r
\r
        # OK: [userextensions.intel."myid".IA32]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        dec._UserExtentionSectionParser()\r
        self.assertEqual(len(dec._RawData.CurrentScope), 1)\r
        self.assertEqual(dec._RawData.CurrentScope[0][0], 'userextensions'.upper())\r
        self.assertEqual(dec._RawData.CurrentScope[0][1], 'intel')\r
        self.assertEqual(dec._RawData.CurrentScope[0][2], '"myid"')\r
        self.assertEqual(dec._RawData.CurrentScope[0][3], 'IA32')\r
\r
        # Fail: [userextensions.intel."myid".IA32,]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._UserExtentionSectionParser)\r
\r
        # Fail: [userextensions.intel."myid]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._UserExtentionSectionParser)\r
\r
#\r
# Test Dec._SectionHeaderParser\r
#\r
class DecSectionTestCase(unittest.TestCase):\r
    def setUp(self):\r
        self.File = TmpFile('test.dec')\r
        self.File.Write(\r
'''[no section start or end\r
[,] # empty sub-section\r
[unknow_section_name]\r
[Includes.IA32.other] # no third one\r
[PcdsFeatureFlag, PcdsFixedAtBuild] # feature flag PCD must not be in the same section of other types of PCD\r
[Includes.IA32, Includes.IA32]\r
[Includes, Includes.IA32] # common cannot be with other arch\r
[Includes.IA32, PcdsFeatureFlag] # different section name\r
'''     )\r
\r
    def tearDown(self):\r
        self.File.Remove()\r
\r
    def testSectionHeader(self):\r
        dec = Dec('test.dec', False)\r
        # [no section start or end\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
        #[,] # empty sub-section\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
        # [unknow_section_name]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
        # [Includes.IA32.other] # no third one\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
        # [PcdsFeatureFlag, PcdsFixedAtBuild]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
        # [Includes.IA32, Includes.IA32]\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        dec._SectionHeaderParser()\r
        self.assertEqual(len(dec._RawData.CurrentScope), 1)\r
        self.assertEqual(dec._RawData.CurrentScope[0][0], 'Includes'.upper())\r
        self.assertEqual(dec._RawData.CurrentScope[0][1], 'IA32')\r
\r
        # [Includes, Includes.IA32] # common cannot be with other arch\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
        # [Includes.IA32, PcdsFeatureFlag] # different section name not allowed\r
        dec._RawData.CurrentLine = CleanString(dec._RawData.GetNextLine())[0]\r
        self.assertRaises(FatalError, dec._SectionHeaderParser)\r
\r
#\r
# Test Dec._ParseDecComment\r
#\r
class DecDecCommentTestCase(unittest.TestCase):\r
    def testDecHeadComment(self):\r
        File = TmpFile('test.dec')\r
        File.Write(\r
       '''# abc\r
          ##''')\r
        dec = Dec('test.dec', False)\r
        dec.ParseDecComment()\r
        self.assertEqual(len(dec._HeadComment), 2)\r
        self.assertEqual(dec._HeadComment[0][0], '# abc')\r
        self.assertEqual(dec._HeadComment[0][1], 1)\r
        self.assertEqual(dec._HeadComment[1][0], '##')\r
        self.assertEqual(dec._HeadComment[1][1], 2)\r
        File.Remove()\r
\r
    def testNoDoubleComment(self):\r
        File = TmpFile('test.dec')\r
        File.Write(\r
       '''# abc\r
          #\r
          [section_start]''')\r
        dec = Dec('test.dec', False)\r
        dec.ParseDecComment()\r
        self.assertEqual(len(dec._HeadComment), 2)\r
        self.assertEqual(dec._HeadComment[0][0], '# abc')\r
        self.assertEqual(dec._HeadComment[0][1], 1)\r
        self.assertEqual(dec._HeadComment[1][0], '#')\r
        self.assertEqual(dec._HeadComment[1][1], 2)\r
        File.Remove()\r
\r
if __name__ == '__main__':\r
    import Logger.Logger\r
    Logger.Logger.Initialize()\r
    unittest.main()\r
\r