BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# This file contain unit test for Test [Binary] section part of InfParser\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
from __future__ import print_function\r
import os\r
#import Object.Parser.InfObject as InfObject\r
from Object.Parser.InfCommonObject import CurrentLine\r
from Object.Parser.InfCommonObject import InfLineCommentObject\r
from Object.Parser.InfBinaryObject import InfBinariesObject\r
import Logger.Log as Logger\r
import Library.GlobalData as Global\r
##\r
# Test Common binary item\r
#\r
\r
#-------------start of common binary item test input--------------------------#\r
\r
#\r
# Only has 1 element, binary item Type\r
#\r
SectionStringsCommonItem1 = \\r
"""\r
GUID\r
"""\r
#\r
# Have 2 elements, binary item Type and FileName\r
#\r
SectionStringsCommonItem2 = \\r
"""\r
GUID | Test/Test.guid\r
"""\r
\r
#\r
# Have 3 elements, Type | FileName | Target | Family | TagName | FeatureFlagExp\r
#\r
SectionStringsCommonItem3 = \\r
"""\r
GUID | Test/Test.guid | DEBUG\r
"""\r
\r
#\r
# Have 3 elements, Type | FileName | Target\r
# Target with MACRO defined in [Define] section\r
#\r
SectionStringsCommonItem4 = \\r
"""\r
GUID | Test/Test.guid | $(TARGET)\r
"""\r
\r
#\r
# Have 3 elements, Type | FileName | Target\r
# FileName with MACRO defined in [Binary] section\r
#\r
SectionStringsCommonItem5 = \\r
"""\r
DEFINE BINARY_FILE_PATH = Test\r
GUID | $(BINARY_FILE_PATH)/Test.guid | $(TARGET)\r
"""\r
\r
#\r
# Have 4 elements, Type | FileName | Target | Family\r
#\r
SectionStringsCommonItem6 = \\r
"""\r
GUID | Test/Test.guid | DEBUG | *\r
"""\r
\r
#\r
# Have 4 elements, Type | FileName | Target | Family\r
#\r
SectionStringsCommonItem7 = \\r
"""\r
GUID | Test/Test.guid | DEBUG | MSFT\r
"""\r
\r
#\r
# Have 5 elements, Type | FileName | Target | Family | TagName\r
#\r
SectionStringsCommonItem8 = \\r
"""\r
GUID | Test/Test.guid | DEBUG | MSFT | TEST\r
"""\r
\r
#\r
# Have 6 elements, Type | FileName | Target | Family | TagName | FFE\r
#\r
SectionStringsCommonItem9 = \\r
"""\r
GUID | Test/Test.guid | DEBUG | MSFT | TEST | TRUE\r
"""\r
\r
#\r
# Have 7 elements, Type | FileName | Target | Family | TagName | FFE | Overflow\r
# Test wrong format\r
#\r
SectionStringsCommonItem10 = \\r
"""\r
GUID | Test/Test.guid | DEBUG | MSFT | TEST | TRUE | OVERFLOW\r
"""\r
\r
#-------------end of common binary item test input----------------------------#\r
\r
\r
\r
#-------------start of VER type binary item test input------------------------#\r
\r
#\r
# Has 1 element, error format\r
#\r
SectionStringsVerItem1 = \\r
"""\r
VER\r
"""\r
#\r
# Have 5 elements, error format(Maximum elements amount is 4)\r
#\r
SectionStringsVerItem2 = \\r
"""\r
VER | Test/Test.ver | * | TRUE | OverFlow\r
"""\r
\r
#\r
# Have 2 elements, Type | FileName\r
#\r
SectionStringsVerItem3 = \\r
"""\r
VER | Test/Test.ver\r
"""\r
\r
#\r
# Have 3 elements, Type | FileName | Target\r
#\r
SectionStringsVerItem4 = \\r
"""\r
VER | Test/Test.ver | DEBUG\r
"""\r
\r
#\r
# Have 4 elements, Type | FileName | Target | FeatureFlagExp\r
#\r
SectionStringsVerItem5 = \\r
"""\r
VER | Test/Test.ver | DEBUG | TRUE\r
"""\r
\r
#\r
# Exist 2 VER items, both opened.\r
#\r
SectionStringsVerItem6 = \\r
"""\r
VER | Test/Test.ver | * | TRUE\r
VER | Test/Test2.ver | * | TRUE\r
"""\r
\r
\r
#\r
# Exist 2 VER items, only 1 opened.\r
#\r
SectionStringsVerItem7 = \\r
"""\r
VER | Test/Test.ver | * | TRUE\r
VER | Test/Test2.ver | * | FALSE\r
"""\r
\r
#-------------end of VER type binary item test input--------------------------#\r
\r
\r
#-------------start of UI type binary item test input-------------------------#\r
\r
#\r
# Test only one UI section can exist\r
#\r
SectionStringsUiItem1 = \\r
"""\r
UI | Test/Test.ui | * | TRUE\r
UI | Test/Test2.ui | * | TRUE\r
"""\r
\r
SectionStringsUiItem2 = \\r
"""\r
UI | Test/Test.ui | * | TRUE\r
SEC_UI | Test/Test2.ui | * | TRUE\r
"""\r
\r
SectionStringsUiItem3 = \\r
"""\r
UI | Test/Test.ui | * | TRUE\r
UI | Test/Test2.ui | * | FALSE\r
"""\r
\r
#\r
# Has 1 element, error format\r
#\r
SectionStringsUiItem4 = \\r
"""\r
UI\r
"""\r
#\r
# Have 5 elements, error format(Maximum elements amount is 4)\r
#\r
SectionStringsUiItem5 = \\r
"""\r
UI | Test/Test.ui | * | TRUE | OverFlow\r
"""\r
\r
#\r
# Have 2 elements, Type | FileName\r
#\r
SectionStringsUiItem6 = \\r
"""\r
UI | Test/Test.ui\r
"""\r
\r
#\r
# Have 3 elements, Type | FileName | Target\r
#\r
SectionStringsUiItem7 = \\r
"""\r
UI | Test/Test.ui | DEBUG\r
"""\r
\r
#\r
# Have 4 elements, Type | FileName | Target | FeatureFlagExp\r
#\r
SectionStringsUiItem8 = \\r
"""\r
UI | Test/Test.ui | DEBUG | TRUE\r
"""\r
#---------------end of UI type binary item test input-------------------------#\r
\r
\r
gFileName = "BinarySectionTest.inf"\r
\r
##\r
# Construct SectionString for call section parser usage.\r
#\r
def StringToSectionString(String):\r
    Lines = String.split('\n')\r
    LineNo = 0\r
    SectionString = []\r
    for Line in Lines:\r
        if Line.strip() == '':\r
            continue\r
        SectionString.append((Line, LineNo, ''))\r
        LineNo = LineNo + 1\r
\r
    return SectionString\r
\r
def PrepareTest(String):\r
    SectionString = StringToSectionString(String)\r
    ItemList = []\r
    for Item in SectionString:\r
        ValueList = Item[0].split('|')\r
        for count in range(len(ValueList)):\r
            ValueList[count] = ValueList[count].strip()\r
        if len(ValueList) >= 2:\r
            #\r
            # Create a temp file for test.\r
            #\r
            FileName = os.path.normpath(os.path.realpath(ValueList[1].strip()))\r
            try:\r
                TempFile  = open (FileName, "w")\r
                TempFile.close()\r
            except:\r
                print("File Create Error")\r
        CurrentLine = CurrentLine()\r
        CurrentLine.SetFileName("Test")\r
        CurrentLine.SetLineString(Item[0])\r
        CurrentLine.SetLineNo(Item[1])\r
        InfLineCommentObject = InfLineCommentObject()\r
\r
        ItemList.append((ValueList, InfLineCommentObject, CurrentLine))\r
\r
    return ItemList\r
\r
if __name__ == '__main__':\r
    Logger.Initialize()\r
\r
    InfBinariesInstance = InfBinariesObject()\r
    ArchList = ['COMMON']\r
    Global.gINF_MODULE_DIR = os.getcwd()\r
\r
    AllPassedFlag = True\r
\r
    #\r
    # For All Ui test\r
    #\r
    UiStringList = [\r
                    SectionStringsUiItem1,\r
                    SectionStringsUiItem2,\r
                    SectionStringsUiItem3,\r
                    SectionStringsUiItem4,\r
                    SectionStringsUiItem5,\r
                    SectionStringsUiItem6,\r
                    SectionStringsUiItem7,\r
                    SectionStringsUiItem8\r
                    ]\r
\r
    for Item in UiStringList:\r
        Ui = PrepareTest(Item)\r
        if Item == SectionStringsUiItem4 or Item == SectionStringsUiItem5:\r
            try:\r
                InfBinariesInstance.SetBinary(Ui = Ui, ArchList = ArchList)\r
            except Logger.FatalError:\r
                pass\r
        else:\r
            try:\r
                InfBinariesInstance.SetBinary(Ui = Ui, ArchList = ArchList)\r
            except:\r
                AllPassedFlag = False\r
\r
    #\r
    # For All Ver Test\r
    #\r
    VerStringList = [\r
                     SectionStringsVerItem1,\r
                     SectionStringsVerItem2,\r
                     SectionStringsVerItem3,\r
                     SectionStringsVerItem4,\r
                     SectionStringsVerItem5,\r
                     SectionStringsVerItem6,\r
                     SectionStringsVerItem7\r
                     ]\r
    for Item in VerStringList:\r
        Ver = PrepareTest(Item)\r
        if Item == SectionStringsVerItem1 or \\r
           Item == SectionStringsVerItem2:\r
\r
            try:\r
                InfBinariesInstance.SetBinary(Ver = Ver, ArchList = ArchList)\r
            except:\r
                pass\r
\r
        else:\r
            try:\r
                InfBinariesInstance.SetBinary(Ver = Ver, ArchList = ArchList)\r
            except:\r
                AllPassedFlag = False\r
\r
    #\r
    # For All Common Test\r
    #\r
    CommonStringList = [\r
                     SectionStringsCommonItem1,\r
                     SectionStringsCommonItem2,\r
                     SectionStringsCommonItem3,\r
                     SectionStringsCommonItem4,\r
                     SectionStringsCommonItem5,\r
                     SectionStringsCommonItem6,\r
                     SectionStringsCommonItem7,\r
                     SectionStringsCommonItem8,\r
                     SectionStringsCommonItem9,\r
                     SectionStringsCommonItem10\r
                     ]\r
\r
    for Item in CommonStringList:\r
        CommonBin = PrepareTest(Item)\r
        if Item == SectionStringsCommonItem10 or \\r
           Item == SectionStringsCommonItem1:\r
\r
            try:\r
                InfBinariesInstance.SetBinary(CommonBinary = CommonBin, ArchList = ArchList)\r
            except:\r
                pass\r
\r
        else:\r
            try:\r
                InfBinariesInstance.SetBinary(Ver = Ver, ArchList = ArchList)\r
            except:\r
                print("Test Failed!")\r
                AllPassedFlag = False\r
\r
    if AllPassedFlag :\r
        print('All tests passed...')\r
    else:\r
        print('Some unit test failed!')\r
\r