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