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

## @file\r
# This file contain unit test for CommentParsing\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
import unittest\r
\r
import Logger.Log as Logger\r
from Library.CommentParsing import ParseHeaderCommentSection, \\r
                                   ParseGenericComment, \\r
                                   ParseDecPcdGenericComment, \\r
                                   ParseDecPcdTailComment\r
from Library.CommentParsing import _IsCopyrightLine\r
from Library.StringUtils import GetSplitValueList\r
from Library.DataType import TAB_SPACE_SPLIT\r
from Library.DataType import TAB_LANGUAGE_EN_US\r
\r
#\r
# Test ParseHeaderCommentSection\r
#\r
class ParseHeaderCommentSectionTest(unittest.TestCase):\r
    def setUp(self):\r
        pass\r
\r
    def tearDown(self):\r
        pass\r
\r
    #\r
    # Normal case1: have license/copyright/license above @file\r
    #\r
    def testNormalCase1(self):\r
        TestCommentLines1 = \\r
        '''# License1\r
        # License2\r
        #\r
        ## @file\r
        # example abstract\r
        #\r
        # example description\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        #\r
        # License3\r
        #'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines1, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = 'example abstract'\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = 'example description'\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2010,'\\r
            ' Intel Corporation. All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = 'License1\nLicense2\n\nLicense3'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Normal case2: have license/copyright above @file, but no copyright after\r
    #\r
    def testNormalCase2(self):\r
        TestCommentLines2 = \\r
        ''' # License1\r
        # License2\r
        #\r
        ## @file\r
        # example abstract\r
        #\r
        # example description\r
        #\r
        #Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines2, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = 'example abstract'\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = 'example description'\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = 'License1\nLicense2'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
\r
    #\r
    # Normal case2: have license/copyright/license above @file,\r
    # but no abstract/description\r
    #\r
    def testNormalCase3(self):\r
        TestCommentLines3 = \\r
        ''' # License1\r
        # License2\r
        #\r
        ## @file\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        #\r
        # License3 Line1\r
        # License3 Line2\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines3, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = ''\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = ''\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2010,'\\r
            ' Intel Corporation. All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = \\r
            'License1\n' \\r
            'License2\n\n' \\r
            'License3 Line1\n' \\r
            'License3 Line2'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Normal case4: format example in spec\r
    #\r
    def testNormalCase4(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        # Abstract\r
        #\r
        # Description\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        #\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = 'Abstract'\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = 'Description'\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = \\r
            'License'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Normal case5: other line between copyright\r
    #\r
    def testNormalCase5(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        # Abstract\r
        #\r
        # Description\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        # other line\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        #\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = 'Abstract'\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = 'Description'\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>\n'\\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = \\r
            'License'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Normal case6: multiple lines of copyright\r
    #\r
    def testNormalCase6(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        # Abstract\r
        #\r
        # Description\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        # Copyright (c) 2007 - 2010, FOO1 Corporation. All rights reserved.<BR>\r
        # Copyright (c) 2007 - 2010, FOO2 Corporation. All rights reserved.<BR>\r
        #\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = 'Abstract'\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = 'Description'\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>\n'\\r
            'Copyright (c) 2007 - 2010, FOO1 Corporation.'\\r
            ' All rights reserved.<BR>\n'\\r
            'Copyright (c) 2007 - 2010, FOO2 Corporation.'\\r
            ' All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = \\r
            'License'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Normal case7: Abstract not present\r
    #\r
    def testNormalCase7(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        #\r
        # Description\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        # Copyright (c) 2007 - 2010, FOO1 Corporation. All rights reserved.<BR>\r
        # Copyright (c) 2007 - 2010, FOO2 Corporation. All rights reserved.<BR>\r
        #\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = ''\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = 'Description'\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>\n'\\r
            'Copyright (c) 2007 - 2010, FOO1 Corporation.'\\r
            ' All rights reserved.<BR>\n'\\r
            'Copyright (c) 2007 - 2010, FOO2 Corporation.'\\r
            ' All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = \\r
            'License'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Normal case8: Description not present\r
    #\r
    def testNormalCase8(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        # Abstact\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        #\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(TestCommentLinesList, "PhonyFile")\r
\r
        ExpectedAbstract = 'Abstact'\r
        self.assertEqual(Abstract, ExpectedAbstract)\r
\r
        ExpectedDescription = ''\r
        self.assertEqual(Description, ExpectedDescription)\r
\r
        ExpectedCopyright = \\r
            'Copyright (c) 2007 - 2018, Intel Corporation.'\\r
            ' All rights reserved.<BR>'\r
        self.assertEqual(Copyright, ExpectedCopyright)\r
\r
        ExpectedLicense = \\r
            'License'\r
        self.assertEqual(License, ExpectedLicense)\r
\r
    #\r
    # Error case1: No copyright found\r
    #\r
    def testErrorCase1(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        # Abstract\r
        #\r
        # Description\r
        #\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        self.assertRaises(Logger.FatalError,\r
                          ParseHeaderCommentSection,\r
                          TestCommentLinesList,\r
                          "PhonyFile")\r
\r
    #\r
    # Error case2: non-empty non-comment lines passed in\r
    #\r
    def testErrorCase2(self):\r
        TestCommentLines = \\r
        '''\r
        ## @file\r
        # Abstract\r
        #\r
        this is invalid line\r
        # Description\r
        #\r
        # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
        # License\r
        #\r
        ##'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        self.assertRaises(Logger.FatalError,\r
                          ParseHeaderCommentSection,\r
                          TestCommentLinesList,\r
                          "PhonyFile")\r
\r
#\r
# Test ParseGenericComment\r
#\r
class ParseGenericCommentTest(unittest.TestCase):\r
    def setUp(self):\r
        pass\r
\r
    def tearDown(self):\r
        pass\r
\r
    #\r
    # Normal case1: one line of comment\r
    #\r
    def testNormalCase1(self):\r
        TestCommentLines = \\r
        '''# hello world'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        HelptxtObj = ParseGenericComment(TestCommentLinesList, 'testNormalCase1')\r
        self.failIf(not HelptxtObj)\r
        self.assertEqual(HelptxtObj.GetString(), 'hello world')\r
        self.assertEqual(HelptxtObj.GetLang(), TAB_LANGUAGE_EN_US)\r
\r
    #\r
    # Normal case2: multiple lines of comment\r
    #\r
    def testNormalCase2(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        # second line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        HelptxtObj = ParseGenericComment(TestCommentLinesList, 'testNormalCase2')\r
        self.failIf(not HelptxtObj)\r
        self.assertEqual(HelptxtObj.GetString(),\r
                         'hello world\n' + 'second line')\r
        self.assertEqual(HelptxtObj.GetLang(), TAB_LANGUAGE_EN_US)\r
\r
    #\r
    # Normal case3: multiple lines of comment, non comment lines will be skipped\r
    #\r
    def testNormalCase3(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        This is not comment line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        HelptxtObj = ParseGenericComment(TestCommentLinesList, 'testNormalCase3')\r
        self.failIf(not HelptxtObj)\r
        self.assertEqual(HelptxtObj.GetString(),\r
                         'hello world\n\n')\r
        self.assertEqual(HelptxtObj.GetLang(), TAB_LANGUAGE_EN_US)\r
\r
#\r
# Test ParseDecPcdGenericComment\r
#\r
class ParseDecPcdGenericCommentTest(unittest.TestCase):\r
    def setUp(self):\r
        pass\r
\r
    def tearDown(self):\r
        pass\r
\r
    #\r
    # Normal case1: comments with no special comment\r
    #\r
    def testNormalCase1(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        # second line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (HelpTxt, PcdErr) = \\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'testNormalCase1')\r
        self.failIf(not HelpTxt)\r
        self.failIf(PcdErr)\r
        self.assertEqual(HelpTxt,\r
                         'hello world\n' + 'second line')\r
\r
\r
    #\r
    # Normal case2: comments with valid list\r
    #\r
    def testNormalCase2(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        # second line\r
        # @ValidList 1, 2, 3\r
        # other line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (HelpTxt, PcdErr) = \\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpTxt)\r
        self.failIf(not PcdErr)\r
        self.assertEqual(HelpTxt,\r
                         'hello world\n' + 'second line\n' + 'other line')\r
        ExpectedList = GetSplitValueList('1 2 3', TAB_SPACE_SPLIT)\r
        ActualList = [item for item in \\r
            GetSplitValueList(PcdErr.GetValidValue(), TAB_SPACE_SPLIT) if item]\r
        self.assertEqual(ExpectedList, ActualList)\r
        self.failIf(PcdErr.GetExpression())\r
        self.failIf(PcdErr.GetValidValueRange())\r
\r
    #\r
    # Normal case3: comments with valid range\r
    #\r
    def testNormalCase3(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        # second line\r
        # @ValidRange LT 1 AND GT 2\r
        # other line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (HelpTxt, PcdErr) = \\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpTxt)\r
        self.failIf(not PcdErr)\r
        self.assertEqual(HelpTxt,\r
                         'hello world\n' + 'second line\n' + 'other line')\r
        self.assertEqual(PcdErr.GetValidValueRange().strip(), 'LT 1 AND GT 2')\r
        self.failIf(PcdErr.GetExpression())\r
        self.failIf(PcdErr.GetValidValue())\r
\r
    #\r
    # Normal case4: comments with valid expression\r
    #\r
    def testNormalCase4(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        # second line\r
        # @Expression LT 1 AND GT 2\r
        # other line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (HelpTxt, PcdErr) = \\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpTxt)\r
        self.failIf(not PcdErr)\r
        self.assertEqual(HelpTxt,\r
                         'hello world\n' + 'second line\n' + 'other line')\r
        self.assertEqual(PcdErr.GetExpression().strip(), 'LT 1 AND GT 2')\r
        self.failIf(PcdErr.GetValidValueRange())\r
        self.failIf(PcdErr.GetValidValue())\r
\r
    #\r
    # Normal case5: comments with valid expression and no generic comment\r
    #\r
    def testNormalCase5(self):\r
        TestCommentLines = \\r
        '''# @Expression LT 1 AND GT 2'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (HelpTxt, PcdErr) = \\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(HelpTxt)\r
        self.failIf(not PcdErr)\r
        self.assertEqual(PcdErr.GetExpression().strip(), 'LT 1 AND GT 2')\r
        self.failIf(PcdErr.GetValidValueRange())\r
        self.failIf(PcdErr.GetValidValue())\r
\r
    #\r
    # Normal case6: comments with only generic help text\r
    #\r
    def testNormalCase6(self):\r
        TestCommentLines = \\r
        '''#'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (HelpTxt, PcdErr) = \\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'UnitTest')\r
        self.assertEqual(HelpTxt, '\n')\r
        self.failIf(PcdErr)\r
\r
\r
\r
    #\r
    # Error case1: comments with both expression and valid list, use later\r
    # ignore the former and with a warning message\r
    #\r
    def testErrorCase1(self):\r
        TestCommentLines = \\r
        '''## hello world\r
        # second line\r
        # @ValidList 1, 2, 3\r
        # @Expression LT 1 AND GT 2\r
        # other line'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        try:\r
            ParseDecPcdGenericComment(TestCommentLinesList, 'UnitTest')\r
        except Logger.FatalError:\r
            pass\r
\r
#\r
# Test ParseDecPcdTailComment\r
#\r
class ParseDecPcdTailCommentTest(unittest.TestCase):\r
    def setUp(self):\r
        pass\r
\r
    def tearDown(self):\r
        pass\r
\r
    #\r
    # Normal case1: comments with no SupModeList\r
    #\r
    def testNormalCase1(self):\r
        TestCommentLines = \\r
        '''## #hello world'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (SupModeList, HelpStr) = \\r
            ParseDecPcdTailComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpStr)\r
        self.failIf(SupModeList)\r
        self.assertEqual(HelpStr,\r
                         'hello world')\r
\r
    #\r
    # Normal case2: comments with one SupMode\r
    #\r
    def testNormalCase2(self):\r
        TestCommentLines = \\r
        '''## BASE #hello world'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (SupModeList, HelpStr) = \\r
            ParseDecPcdTailComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpStr)\r
        self.failIf(not SupModeList)\r
        self.assertEqual(HelpStr,\r
                         'hello world')\r
        self.assertEqual(SupModeList,\r
                         ['BASE'])\r
\r
    #\r
    # Normal case3: comments with more than one SupMode\r
    #\r
    def testNormalCase3(self):\r
        TestCommentLines = \\r
        '''## BASE  UEFI_APPLICATION #hello world'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (SupModeList, HelpStr) = \\r
            ParseDecPcdTailComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpStr)\r
        self.failIf(not SupModeList)\r
        self.assertEqual(HelpStr,\r
                         'hello world')\r
        self.assertEqual(SupModeList,\r
                         ['BASE', 'UEFI_APPLICATION'])\r
\r
    #\r
    # Normal case4: comments with more than one SupMode, no help text\r
    #\r
    def testNormalCase4(self):\r
        TestCommentLines = \\r
        '''## BASE  UEFI_APPLICATION'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (SupModeList, HelpStr) = \\r
            ParseDecPcdTailComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(HelpStr)\r
        self.failIf(not SupModeList)\r
        self.assertEqual(SupModeList,\r
                         ['BASE', 'UEFI_APPLICATION'])\r
\r
    #\r
    # Normal case5: general comments with no supModList, extract from real case\r
    #\r
    def testNormalCase5(self):\r
        TestCommentLines = \\r
        ''' # 1 = 128MB, 2 = 256MB, 3 = MAX'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        (SupModeList, HelpStr) = \\r
            ParseDecPcdTailComment(TestCommentLinesList, 'UnitTest')\r
        self.failIf(not HelpStr)\r
        self.assertEqual(HelpStr,\r
                         '1 = 128MB, 2 = 256MB, 3 = MAX')\r
        self.failIf(SupModeList)\r
\r
\r
    #\r
    # Error case2: comments with supModList contains valid and invalid\r
    # module type\r
    #\r
    def testErrorCase2(self):\r
        TestCommentLines = \\r
        '''## BASE INVALID_MODULE_TYPE #hello world'''\r
\r
        CommentList = GetSplitValueList(TestCommentLines, "\n")\r
        LineNum = 0\r
        TestCommentLinesList = []\r
        for Comment in CommentList:\r
            LineNum += 1\r
            TestCommentLinesList.append((Comment, LineNum))\r
\r
        try:\r
            ParseDecPcdTailComment(TestCommentLinesList, 'UnitTest')\r
        except Logger.FatalError:\r
            pass\r
\r
\r
#\r
# Test _IsCopyrightLine\r
#\r
class _IsCopyrightLineTest(unittest.TestCase):\r
    def setUp(self):\r
        pass\r
\r
    def tearDown(self):\r
        pass\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase1(self):\r
        Line = 'this is a copyright ( line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(not Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase2(self):\r
        Line = 'this is a Copyright ( line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(not Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase3(self):\r
        Line = 'this is not aCopyright ( line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase4(self):\r
        Line = 'this is Copyright( line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(not Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase5(self):\r
        Line = 'this is Copyright         (line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(not Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase6(self):\r
        Line = 'this is not Copyright line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase7(self):\r
        Line = 'Copyright (c) line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(not Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase8(self):\r
        Line = ' Copyright (c) line'\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(not Result)\r
\r
    #\r
    # Normal case\r
    #\r
    def testCase9(self):\r
        Line = 'not a Copyright '\r
        Result = _IsCopyrightLine(Line)\r
        self.failIf(Result)\r
\r
if __name__ == '__main__':\r
    Logger.Initialize()\r
    unittest.main()\r