[mirror_edk2.git] / .pytool / CISettings.py

# @file\r
#\r
# Copyright (c) Microsoft Corporation.\r
# Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
##\r
import os\r
import logging\r
from edk2toolext.environment import shell_environment\r
from edk2toolext.invocables.edk2_ci_build import CiBuildSettingsManager\r
from edk2toolext.invocables.edk2_setup import SetupSettingsManager, RequiredSubmodule\r
from edk2toolext.invocables.edk2_update import UpdateSettingsManager\r
from edk2toolext.invocables.edk2_pr_eval import PrEvalSettingsManager\r
from edk2toollib.utility_functions import GetHostInfo\r
\r
\r
class Settings(CiBuildSettingsManager, UpdateSettingsManager, SetupSettingsManager, PrEvalSettingsManager):\r
\r
    def __init__(self):\r
        self.ActualPackages = []\r
        self.ActualTargets = []\r
        self.ActualArchitectures = []\r
        self.ActualToolChainTag = ""\r
\r
    # ####################################################################################### #\r
    #                             Extra CmdLine configuration                                 #\r
    # ####################################################################################### #\r
\r
    def AddCommandLineOptions(self, parserObj):\r
        pass\r
\r
    def RetrieveCommandLineOptions(self, args):\r
        pass\r
\r
    # ####################################################################################### #\r
    #                        Default Support for this Ci Build                                #\r
    # ####################################################################################### #\r
\r
    def GetPackagesSupported(self):\r
        ''' return iterable of edk2 packages supported by this build.\r
        These should be edk2 workspace relative paths '''\r
\r
        return ("ArmVirtPkg",\r
                "EmulatorPkg",\r
                "MdePkg",\r
                "MdeModulePkg",\r
                "NetworkPkg",\r
                "PcAtChipsetPkg",\r
                "SecurityPkg",\r
                "UefiCpuPkg",\r
                "FmpDevicePkg",\r
                "ShellPkg",\r
                "FatPkg",\r
                "CryptoPkg",\r
                "UnitTestFrameworkPkg",\r
                "OvmfPkg"\r
                )\r
\r
    def GetArchitecturesSupported(self):\r
        ''' return iterable of edk2 architectures supported by this build '''\r
        return (\r
                "IA32",\r
                "X64",\r
                "ARM",\r
                "AARCH64",\r
                "RISCV64")\r
\r
    def GetTargetsSupported(self):\r
        ''' return iterable of edk2 target tags supported by this build '''\r
        return ("DEBUG", "RELEASE", "NO-TARGET", "NOOPT")\r
\r
    # ####################################################################################### #\r
    #                     Verify and Save requested Ci Build Config                           #\r
    # ####################################################################################### #\r
\r
    def SetPackages(self, list_of_requested_packages):\r
        ''' Confirm the requested package list is valid and configure SettingsManager\r
        to build the requested packages.\r
\r
        Raise UnsupportedException if a requested_package is not supported\r
        '''\r
        unsupported = set(list_of_requested_packages) - \\r
            set(self.GetPackagesSupported())\r
        if(len(unsupported) > 0):\r
            logging.critical(\r
                "Unsupported Package Requested: " + " ".join(unsupported))\r
            raise Exception("Unsupported Package Requested: " +\r
                            " ".join(unsupported))\r
        self.ActualPackages = list_of_requested_packages\r
\r
    def SetArchitectures(self, list_of_requested_architectures):\r
        ''' Confirm the requests architecture list is valid and configure SettingsManager\r
        to run only the requested architectures.\r
\r
        Raise Exception if a list_of_requested_architectures is not supported\r
        '''\r
        unsupported = set(list_of_requested_architectures) - \\r
            set(self.GetArchitecturesSupported())\r
        if(len(unsupported) > 0):\r
            logging.critical(\r
                "Unsupported Architecture Requested: " + " ".join(unsupported))\r
            raise Exception(\r
                "Unsupported Architecture Requested: " + " ".join(unsupported))\r
        self.ActualArchitectures = list_of_requested_architectures\r
\r
    def SetTargets(self, list_of_requested_target):\r
        ''' Confirm the request target list is valid and configure SettingsManager\r
        to run only the requested targets.\r
\r
        Raise UnsupportedException if a requested_target is not supported\r
        '''\r
        unsupported = set(list_of_requested_target) - \\r
            set(self.GetTargetsSupported())\r
        if(len(unsupported) > 0):\r
            logging.critical(\r
                "Unsupported Targets Requested: " + " ".join(unsupported))\r
            raise Exception("Unsupported Targets Requested: " +\r
                            " ".join(unsupported))\r
        self.ActualTargets = list_of_requested_target\r
\r
    # ####################################################################################### #\r
    #                         Actual Configuration for Ci Build                               #\r
    # ####################################################################################### #\r
\r
    def GetActiveScopes(self):\r
        ''' return tuple containing scopes that should be active for this process '''\r
        scopes = ("cibuild", "edk2-build", "host-based-test")\r
\r
        self.ActualToolChainTag = shell_environment.GetBuildVars().GetValue("TOOL_CHAIN_TAG", "")\r
\r
        if GetHostInfo().os.upper() == "WINDOWS":\r
            scopes += ('host-test-win',)\r
\r
        if GetHostInfo().os.upper() == "LINUX" and self.ActualToolChainTag.upper().startswith("GCC"):\r
            if "AARCH64" in self.ActualArchitectures:\r
                scopes += ("gcc_aarch64_linux",)\r
            if "ARM" in self.ActualArchitectures:\r
                scopes += ("gcc_arm_linux",)\r
            if "RISCV64" in self.ActualArchitectures:\r
                scopes += ("gcc_riscv64_unknown",)\r
\r
        return scopes\r
\r
    def GetRequiredSubmodules(self):\r
        ''' return iterable containing RequiredSubmodule objects.\r
        If no RequiredSubmodules return an empty iterable\r
        '''\r
        rs = []\r
        rs.append(RequiredSubmodule(\r
            "ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3", False))\r
        rs.append(RequiredSubmodule(\r
            "CryptoPkg/Library/OpensslLib/openssl", False))\r
        rs.append(RequiredSubmodule(\r
            "UnitTestFrameworkPkg/Library/CmockaLib/cmocka", False))\r
        rs.append(RequiredSubmodule(\r
            "MdeModulePkg/Universal/RegularExpressionDxe/oniguruma", False))\r
        rs.append(RequiredSubmodule(\r
            "MdeModulePkg/Library/BrotliCustomDecompressLib/brotli", False))\r
        rs.append(RequiredSubmodule(\r
            "BaseTools/Source/C/BrotliCompress/brotli", False))\r
        return rs\r
\r
    def GetName(self):\r
        return "Edk2"\r
\r
    def GetDependencies(self):\r
        return [\r
        ]\r
\r
    def GetPackagesPath(self):\r
        return ()\r
\r
    def GetWorkspaceRoot(self):\r
        ''' get WorkspacePath '''\r
        return os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\r
\r
    def FilterPackagesToTest(self, changedFilesList: list, potentialPackagesList: list) -> list:\r
        ''' Filter potential packages to test based on changed files. '''\r
        build_these_packages = []\r
        possible_packages = potentialPackagesList.copy()\r
        for f in changedFilesList:\r
            # split each part of path for comparison later\r
            nodes = f.split("/")\r
\r
            # python file change in .pytool folder causes building all\r
            if f.endswith(".py") and ".pytool" in nodes:\r
                build_these_packages = possible_packages\r
                break\r
\r
            # BaseTools files that might change the build\r
            if "BaseTools" in nodes:\r
                if os.path.splitext(f) not in [".txt", ".md"]:\r
                    build_these_packages = possible_packages\r
                    break\r
        return build_these_packages\r
Commit	Line	Data
4eb2baba SB	1	# @file\r
	2	#\r
	3	# Copyright (c) Microsoft Corporation.\r
e6956d00	4	# Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
4eb2baba SB	5	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
	6	##\r
	7	import os\r
	8	import logging\r
	9	from edk2toolext.environment import shell_environment\r
	10	from edk2toolext.invocables.edk2_ci_build import CiBuildSettingsManager\r
	11	from edk2toolext.invocables.edk2_setup import SetupSettingsManager, RequiredSubmodule\r
	12	from edk2toolext.invocables.edk2_update import UpdateSettingsManager\r
	13	from edk2toolext.invocables.edk2_pr_eval import PrEvalSettingsManager\r
	14	from edk2toollib.utility_functions import GetHostInfo\r
	15	\r
	16	\r
	17	class Settings(CiBuildSettingsManager, UpdateSettingsManager, SetupSettingsManager, PrEvalSettingsManager):\r
	18	\r
	19	def __init__(self):\r
	20	self.ActualPackages = []\r
	21	self.ActualTargets = []\r
	22	self.ActualArchitectures = []\r
	23	self.ActualToolChainTag = ""\r
	24	\r
	25	# ####################################################################################### #\r
	26	# Extra CmdLine configuration #\r
	27	# ####################################################################################### #\r
	28	\r
	29	def AddCommandLineOptions(self, parserObj):\r
	30	pass\r
	31	\r
	32	def RetrieveCommandLineOptions(self, args):\r
	33	pass\r
	34	\r
	35	# ####################################################################################### #\r
	36	# Default Support for this Ci Build #\r
	37	# ####################################################################################### #\r
	38	\r
	39	def GetPackagesSupported(self):\r
	40	''' return iterable of edk2 packages supported by this build.\r
	41	These should be edk2 workspace relative paths '''\r
	42	\r
0358c0bf SB	43	return ("ArmVirtPkg",\r
	44	"EmulatorPkg",\r
	45	"MdePkg",\r
4eb2baba SB	46	"MdeModulePkg",\r
	47	"NetworkPkg",\r
	48	"PcAtChipsetPkg",\r
	49	"SecurityPkg",\r
	50	"UefiCpuPkg",\r
	51	"FmpDevicePkg",\r
	52	"ShellPkg",\r
	53	"FatPkg",\r
61364ab9	54	"CryptoPkg",\r
0358c0bf SB	55	"UnitTestFrameworkPkg",\r
0358c0bf SB	56	"OvmfPkg"\r
4eb2baba SB	57	)\r
	58	\r
	59	def GetArchitecturesSupported(self):\r
	60	''' return iterable of edk2 architectures supported by this build '''\r
e6956d00 AC	61	return (\r
e6956d00 AC	62	"IA32",\r
4eb2baba SB	63	"X64",\r
4eb2baba SB	64	"ARM",\r
e6956d00 AC	65	"AARCH64",\r
e6956d00 AC	66	"RISCV64")\r
4eb2baba SB	67	\r
	68	def GetTargetsSupported(self):\r
	69	''' return iterable of edk2 target tags supported by this build '''\r
	70	return ("DEBUG", "RELEASE", "NO-TARGET", "NOOPT")\r
	71	\r
	72	# ####################################################################################### #\r
	73	# Verify and Save requested Ci Build Config #\r
	74	# ####################################################################################### #\r
	75	\r
	76	def SetPackages(self, list_of_requested_packages):\r
	77	''' Confirm the requested package list is valid and configure SettingsManager\r
	78	to build the requested packages.\r
	79	\r
	80	Raise UnsupportedException if a requested_package is not supported\r
	81	'''\r
	82	unsupported = set(list_of_requested_packages) - \\r
	83	set(self.GetPackagesSupported())\r
	84	if(len(unsupported) > 0):\r
	85	logging.critical(\r
	86	"Unsupported Package Requested: " + " ".join(unsupported))\r
	87	raise Exception("Unsupported Package Requested: " +\r
	88	" ".join(unsupported))\r
	89	self.ActualPackages = list_of_requested_packages\r
	90	\r
	91	def SetArchitectures(self, list_of_requested_architectures):\r
	92	''' Confirm the requests architecture list is valid and configure SettingsManager\r
	93	to run only the requested architectures.\r
	94	\r
	95	Raise Exception if a list_of_requested_architectures is not supported\r
	96	'''\r
	97	unsupported = set(list_of_requested_architectures) - \\r
	98	set(self.GetArchitecturesSupported())\r
	99	if(len(unsupported) > 0):\r
	100	logging.critical(\r
	101	"Unsupported Architecture Requested: " + " ".join(unsupported))\r
	102	raise Exception(\r
	103	"Unsupported Architecture Requested: " + " ".join(unsupported))\r
	104	self.ActualArchitectures = list_of_requested_architectures\r
	105	\r
	106	def SetTargets(self, list_of_requested_target):\r
	107	''' Confirm the request target list is valid and configure SettingsManager\r
	108	to run only the requested targets.\r
	109	\r
	110	Raise UnsupportedException if a requested_target is not supported\r
	111	'''\r
	112	unsupported = set(list_of_requested_target) - \\r
	113	set(self.GetTargetsSupported())\r
	114	if(len(unsupported) > 0):\r
	115	logging.critical(\r
	116	"Unsupported Targets Requested: " + " ".join(unsupported))\r
	117	raise Exception("Unsupported Targets Requested: " +\r
	118	" ".join(unsupported))\r
	119	self.ActualTargets = list_of_requested_target\r
	120	\r
	121	# ####################################################################################### #\r
	122	# Actual Configuration for Ci Build #\r
	123	# ####################################################################################### #\r
	124	\r
	125	def GetActiveScopes(self):\r
	126	''' return tuple containing scopes that should be active for this process '''\r
61364ab9	127	scopes = ("cibuild", "edk2-build", "host-based-test")\r
4eb2baba SB	128	\r
	129	self.ActualToolChainTag = shell_environment.GetBuildVars().GetValue("TOOL_CHAIN_TAG", "")\r
	130	\r
61364ab9 MK	131	if GetHostInfo().os.upper() == "WINDOWS":\r
	132	scopes += ('host-test-win',)\r
	133	\r
4eb2baba SB	134	if GetHostInfo().os.upper() == "LINUX" and self.ActualToolChainTag.upper().startswith("GCC"):\r
	135	if "AARCH64" in self.ActualArchitectures:\r
	136	scopes += ("gcc_aarch64_linux",)\r
	137	if "ARM" in self.ActualArchitectures:\r
	138	scopes += ("gcc_arm_linux",)\r
e6956d00 AC	139	if "RISCV64" in self.ActualArchitectures:\r
e6956d00 AC	140	scopes += ("gcc_riscv64_unknown",)\r
4eb2baba SB	141	\r
	142	return scopes\r
	143	\r
	144	def GetRequiredSubmodules(self):\r
	145	''' return iterable containing RequiredSubmodule objects.\r
	146	If no RequiredSubmodules return an empty iterable\r
	147	'''\r
61364ab9	148	rs = []\r
4eb2baba SB	149	rs.append(RequiredSubmodule(\r
	150	"ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3", False))\r
	151	rs.append(RequiredSubmodule(\r
	152	"CryptoPkg/Library/OpensslLib/openssl", False))\r
61364ab9 MK	153	rs.append(RequiredSubmodule(\r
61364ab9 MK	154	"UnitTestFrameworkPkg/Library/CmockaLib/cmocka", False))\r
48b6c60c SZ	155	rs.append(RequiredSubmodule(\r
48b6c60c SZ	156	"MdeModulePkg/Universal/RegularExpressionDxe/oniguruma", False))\r
58802e02 SZ	157	rs.append(RequiredSubmodule(\r
58802e02 SZ	158	"MdeModulePkg/Library/BrotliCustomDecompressLib/brotli", False))\r
06033f5a SZ	159	rs.append(RequiredSubmodule(\r
06033f5a SZ	160	"BaseTools/Source/C/BrotliCompress/brotli", False))\r
4eb2baba SB	161	return rs\r
	162	\r
	163	def GetName(self):\r
	164	return "Edk2"\r
	165	\r
	166	def GetDependencies(self):\r
61364ab9 MK	167	return [\r
61364ab9 MK	168	]\r
4eb2baba SB	169	\r
	170	def GetPackagesPath(self):\r
	171	return ()\r
	172	\r
	173	def GetWorkspaceRoot(self):\r
	174	''' get WorkspacePath '''\r
	175	return os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\r
	176	\r
	177	def FilterPackagesToTest(self, changedFilesList: list, potentialPackagesList: list) -> list:\r
	178	''' Filter potential packages to test based on changed files. '''\r
61364ab9 MK	179	build_these_packages = []\r
61364ab9 MK	180	possible_packages = potentialPackagesList.copy()\r
4eb2baba	181	for f in changedFilesList:\r
61364ab9 MK	182	# split each part of path for comparison later\r
61364ab9 MK	183	nodes = f.split("/")\r
4eb2baba SB	184	\r
	185	# python file change in .pytool folder causes building all\r
	186	if f.endswith(".py") and ".pytool" in nodes:\r
	187	build_these_packages = possible_packages\r
	188	break\r
	189	\r
	190	# BaseTools files that might change the build\r
	191	if "BaseTools" in nodes:\r
	192	if os.path.splitext(f) not in [".txt", ".md"]:\r
	193	build_these_packages = possible_packages\r
	194	break\r
	195	return build_these_packages\r