[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 - 2021, 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
                "StandaloneMmPkg",\r
                "FatPkg",\r
                "CryptoPkg",\r
                "UnitTestFrameworkPkg",\r
                "OvmfPkg",\r
                "RedfishPkg"\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
d8d1f666	5	# Copyright (c) 2020 - 2021, 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
d8d1f666	55	"StandaloneMmPkg",\r
4eb2baba	56	"FatPkg",\r
61364ab9	57	"CryptoPkg",\r
0358c0bf	58	"UnitTestFrameworkPkg",\r
c4add64f AC	59	"OvmfPkg",\r
c4add64f AC	60	"RedfishPkg"\r
4eb2baba SB	61	)\r
	62	\r
	63	def GetArchitecturesSupported(self):\r
	64	''' return iterable of edk2 architectures supported by this build '''\r
e6956d00 AC	65	return (\r
e6956d00 AC	66	"IA32",\r
4eb2baba SB	67	"X64",\r
4eb2baba SB	68	"ARM",\r
e6956d00 AC	69	"AARCH64",\r
e6956d00 AC	70	"RISCV64")\r
4eb2baba SB	71	\r
	72	def GetTargetsSupported(self):\r
	73	''' return iterable of edk2 target tags supported by this build '''\r
	74	return ("DEBUG", "RELEASE", "NO-TARGET", "NOOPT")\r
	75	\r
	76	# ####################################################################################### #\r
	77	# Verify and Save requested Ci Build Config #\r
	78	# ####################################################################################### #\r
	79	\r
	80	def SetPackages(self, list_of_requested_packages):\r
	81	''' Confirm the requested package list is valid and configure SettingsManager\r
	82	to build the requested packages.\r
	83	\r
	84	Raise UnsupportedException if a requested_package is not supported\r
	85	'''\r
	86	unsupported = set(list_of_requested_packages) - \\r
	87	set(self.GetPackagesSupported())\r
	88	if(len(unsupported) > 0):\r
	89	logging.critical(\r
	90	"Unsupported Package Requested: " + " ".join(unsupported))\r
	91	raise Exception("Unsupported Package Requested: " +\r
	92	" ".join(unsupported))\r
	93	self.ActualPackages = list_of_requested_packages\r
	94	\r
	95	def SetArchitectures(self, list_of_requested_architectures):\r
	96	''' Confirm the requests architecture list is valid and configure SettingsManager\r
	97	to run only the requested architectures.\r
	98	\r
	99	Raise Exception if a list_of_requested_architectures is not supported\r
	100	'''\r
	101	unsupported = set(list_of_requested_architectures) - \\r
	102	set(self.GetArchitecturesSupported())\r
	103	if(len(unsupported) > 0):\r
	104	logging.critical(\r
	105	"Unsupported Architecture Requested: " + " ".join(unsupported))\r
	106	raise Exception(\r
	107	"Unsupported Architecture Requested: " + " ".join(unsupported))\r
	108	self.ActualArchitectures = list_of_requested_architectures\r
	109	\r
	110	def SetTargets(self, list_of_requested_target):\r
	111	''' Confirm the request target list is valid and configure SettingsManager\r
	112	to run only the requested targets.\r
	113	\r
	114	Raise UnsupportedException if a requested_target is not supported\r
	115	'''\r
	116	unsupported = set(list_of_requested_target) - \\r
	117	set(self.GetTargetsSupported())\r
	118	if(len(unsupported) > 0):\r
	119	logging.critical(\r
	120	"Unsupported Targets Requested: " + " ".join(unsupported))\r
	121	raise Exception("Unsupported Targets Requested: " +\r
	122	" ".join(unsupported))\r
	123	self.ActualTargets = list_of_requested_target\r
	124	\r
	125	# ####################################################################################### #\r
	126	# Actual Configuration for Ci Build #\r
	127	# ####################################################################################### #\r
	128	\r
	129	def GetActiveScopes(self):\r
	130	''' return tuple containing scopes that should be active for this process '''\r
61364ab9	131	scopes = ("cibuild", "edk2-build", "host-based-test")\r
4eb2baba SB	132	\r
	133	self.ActualToolChainTag = shell_environment.GetBuildVars().GetValue("TOOL_CHAIN_TAG", "")\r
	134	\r
	135	if GetHostInfo().os.upper() == "LINUX" and self.ActualToolChainTag.upper().startswith("GCC"):\r
	136	if "AARCH64" in self.ActualArchitectures:\r
	137	scopes += ("gcc_aarch64_linux",)\r
	138	if "ARM" in self.ActualArchitectures:\r
	139	scopes += ("gcc_arm_linux",)\r
e6956d00 AC	140	if "RISCV64" in self.ActualArchitectures:\r
e6956d00 AC	141	scopes += ("gcc_riscv64_unknown",)\r
4eb2baba SB	142	\r
	143	return scopes\r
	144	\r
	145	def GetRequiredSubmodules(self):\r
	146	''' return iterable containing RequiredSubmodule objects.\r
	147	If no RequiredSubmodules return an empty iterable\r
	148	'''\r
61364ab9	149	rs = []\r
4eb2baba SB	150	rs.append(RequiredSubmodule(\r
	151	"ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3", False))\r
	152	rs.append(RequiredSubmodule(\r
	153	"CryptoPkg/Library/OpensslLib/openssl", False))\r
61364ab9 MK	154	rs.append(RequiredSubmodule(\r
61364ab9 MK	155	"UnitTestFrameworkPkg/Library/CmockaLib/cmocka", False))\r
48b6c60c SZ	156	rs.append(RequiredSubmodule(\r
48b6c60c SZ	157	"MdeModulePkg/Universal/RegularExpressionDxe/oniguruma", False))\r
58802e02 SZ	158	rs.append(RequiredSubmodule(\r
58802e02 SZ	159	"MdeModulePkg/Library/BrotliCustomDecompressLib/brotli", False))\r
06033f5a SZ	160	rs.append(RequiredSubmodule(\r
06033f5a SZ	161	"BaseTools/Source/C/BrotliCompress/brotli", False))\r
4eb2baba SB	162	return rs\r
	163	\r
	164	def GetName(self):\r
	165	return "Edk2"\r
	166	\r
	167	def GetDependencies(self):\r
61364ab9 MK	168	return [\r
61364ab9 MK	169	]\r
4eb2baba SB	170	\r
	171	def GetPackagesPath(self):\r
	172	return ()\r
	173	\r
	174	def GetWorkspaceRoot(self):\r
	175	''' get WorkspacePath '''\r
	176	return os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\r
	177	\r
	178	def FilterPackagesToTest(self, changedFilesList: list, potentialPackagesList: list) -> list:\r
	179	''' Filter potential packages to test based on changed files. '''\r
61364ab9 MK	180	build_these_packages = []\r
61364ab9 MK	181	possible_packages = potentialPackagesList.copy()\r
4eb2baba	182	for f in changedFilesList:\r
61364ab9 MK	183	# split each part of path for comparison later\r
61364ab9 MK	184	nodes = f.split("/")\r
4eb2baba SB	185	\r
	186	# python file change in .pytool folder causes building all\r
	187	if f.endswith(".py") and ".pytool" in nodes:\r
	188	build_these_packages = possible_packages\r
	189	break\r
	190	\r
	191	# BaseTools files that might change the build\r
	192	if "BaseTools" in nodes:\r
	193	if os.path.splitext(f) not in [".txt", ".md"]:\r
	194	build_these_packages = possible_packages\r
	195	break\r
	196	return build_these_packages\r