xref: /openbmc/openbmc-test-automation/data/variables.py (revision d5a41a1ab15032ea8def81cd7bc813246b921257) 
1import os
2
3from robot.libraries.BuiltIn import BuiltIn
4
5OPENBMC_BASE_URI = "/xyz/openbmc_project/"
6OPENBMC_BASE_DBUS = "xyz.openbmc_project."
7
8# Generic Dbus commands.
9OPENBMC_DBUS_GET_PROPERTY = "busctl get-property "
10OPENBMC_DBUS_SET_PROPERTY = "busctl set-property "
11
12# org open power base URI.
13OPENPOWER_BASE_URI = "/org/open_power/"
14OPENPOWER_CONTROL = OPENPOWER_BASE_URI + "control/"
15OPENPOWER_SENSORS = OPENPOWER_BASE_URI + "sensors/"
16
17# REST URI base endpoint paths.
18CONTROL_URI = OPENBMC_BASE_URI + "control/"
19# Continue to keep to support legacy code.
20SETTINGS_URI = "/org/openbmc/settings/"
21WATCHDOG_URI = OPENBMC_BASE_URI + "watchdog/"
22TIME_MANAGER_URI = OPENBMC_BASE_URI + "time/"
23NETWORK_MANAGER = OPENBMC_BASE_URI + "network/"
24NETWORK_RESOURCE = "xyz.openbmc_project.Network.IP.Protocol.IPv4"
25# SNMP
26SNMP_MANAGER_URI = NETWORK_MANAGER + "snmp/manager/"
27# Sensors base variables.
28SENSORS_URI = OPENBMC_BASE_URI + "sensors/"
29# Thermal Control base variables
30THERMAL_CONTROL_URI = CONTROL_URI + "thermal/0"
31THERMAL_METRICS = "ThermalSubsystem/ThermalMetrics"
32
33COMPONENT_NAME_OF_POWER_SUPPLY = "powersupply"
34
35# State Manager base variables
36BMC_REBOOT_TRANS = "xyz.openbmc_project.State.BMC.Transition.Reboot"
37
38HOST_POWEROFF_TRANS = "xyz.openbmc_project.State.Host.Transition.Off"
39HOST_POWERON_TRANS = "xyz.openbmc_project.State.Host.Transition.On"
40HOST_REBOOT_TRANS = "xyz.openbmc_project.State.Host.Transition.Reboot"
41HOST_POWEROFF_STATE = "xyz.openbmc_project.State.Host.HostState.Off"
42HOST_POWERON_STATE = "xyz.openbmc_project.State.Host.HostState.Running"
43
44CHASSIS_POWEROFF_TRANS = "xyz.openbmc_project.State.Chassis.Transition.Off"
45CHASSIS_POWERON_TRANS = "xyz.openbmc_project.State.Chassis.Transition.On"
46CHASSIS_POWEROFF_STATE = "xyz.openbmc_project.State.Chassis.PowerState.Off"
47CHASSIS_POWERON_STATE = "xyz.openbmc_project.State.Chassis.PowerState.On"
48
49# State Manager URI variables.
50SYSTEM_STATE_URI = OPENBMC_BASE_URI + "state/"
51BMC_STATE_URI = OPENBMC_BASE_URI + "state/bmc0/"
52HOST_STATE_URI = OPENBMC_BASE_URI + "state/host0/"
53CHASSIS_STATE_URI = OPENBMC_BASE_URI + "state/chassis0/"
54HOST_WATCHDOG_URI = OPENBMC_BASE_URI + "watchdog/host0/"
55
56# OS state for x86 architecture
57OS_STATE_URI = OPENBMC_BASE_URI + "state/os/"
58
59# Logging URI variables
60BMC_LOGGING_URI = OPENBMC_BASE_URI + "logging/"
61BMC_LOGGING_ENTRY = BMC_LOGGING_URI + "entry/"
62REDFISH_BMC_LOGGING_ENTRY = (
63    "/redfish/v1/Systems/system/LogServices/EventLog/Entries/"
64)
65
66
67# Software manager version
68SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + "software/"
69ACTIVE = "xyz.openbmc_project.Software.Activation.Activations.Active"
70READY = "xyz.openbmc_project.Software.Activation.Activations.Ready"
71INVALID = "xyz.openbmc_project.Software.Activation.Activations.Invalid"
72ACTIVATING = "xyz.openbmc_project.Software.Activation.Activations.Activating"
73NOTREADY = "xyz.openbmc_project.Software.Activation.Activations.NotReady"
74FAILED = "xyz.openbmc_project.Software.Activation.Activations.Failed"
75
76SOFTWARE_ACTIVATION = "xyz.openbmc_project.Software.Activation"
77REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + ".RequestedActivations"
78REQUESTED_ACTIVE = REQUESTED_ACTIVATION + ".Active"
79REQUESTED_NONE = REQUESTED_ACTIVATION + ".None"
80
81SOFTWARE_PURPOSE = "xyz.openbmc_project.Software.Version.VersionPurpose"
82VERSION_PURPOSE_HOST = SOFTWARE_PURPOSE + ".Host"
83VERSION_PURPOSE_BMC = SOFTWARE_PURPOSE + ".BMC"
84VERSION_PURPOSE_SYSTEM = SOFTWARE_PURPOSE + ".System"
85
86# Image Upload Directory Path
87IMAGE_UPLOAD_DIR_PATH = "/tmp/images/"
88
89# Inventory URI variables
90HOST_INVENTORY_URI = OPENBMC_BASE_URI + "inventory/"
91CHASSIS_INVENTORY_URI = HOST_INVENTORY_URI + "system/chassis/"
92MOTHERBOARD_INVENTORY_URI = CHASSIS_INVENTORY_URI + "motherboard/"
93
94# Led URI variable
95LED_GROUPS_URI = OPENBMC_BASE_URI + "led/groups/"
96LED_PHYSICAL_URI = OPENBMC_BASE_URI + "led/physical/"
97LED_LAMP_TEST_ASSERTED_URI = LED_GROUPS_URI + "lamp_test/"
98LED_PHYSICAL_PS0_URI = LED_PHYSICAL_URI + "cffps1_69/"
99LED_PHYSICAL_PS1_URI = LED_PHYSICAL_URI + "cffps1_68/"
100LED_PHYSICAL_FAN0_URI = LED_PHYSICAL_URI + "fan0/"
101LED_PHYSICAL_FAN2_URI = LED_PHYSICAL_URI + "fan2/"
102LED_PHYSICAL_FAN3_URI = LED_PHYSICAL_URI + "fan3/"
103
104# Host control URI variables.
105CONTROL_HOST_URI = OPENBMC_BASE_URI + "control/host0/"
106
107# Power restore variables.
108POWER_RESTORE_URI = CONTROL_HOST_URI + "power_restore_policy"
109CONTROL_DBUS_BASE = "xyz.openbmc_project.Control."
110
111RESTORE_LAST_STATE = CONTROL_DBUS_BASE + "Power.RestorePolicy.Policy.Restore"
112ALWAYS_POWER_ON = CONTROL_DBUS_BASE + "Power.RestorePolicy.Policy.AlwaysOn"
113ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + "Power.RestorePolicy.Policy.AlwaysOff"
114
115# Dump URI variables.
116REST_DUMP_URI = OPENBMC_BASE_URI + "dump/bmc/"
117DUMP_ENTRY_URI = REST_DUMP_URI + "entry/"
118DUMP_DOWNLOAD_URI = "/download/dump/"
119# The path on the BMC where dumps are stored.
120DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/"
121
122# Boot progress variables.
123STATE_DBUS_BASE = "xyz.openbmc_project.State."
124OS_BOOT_START = STATE_DBUS_BASE + "Boot.Progress.ProgressStages.OSStart"
125OS_BOOT_OFF = STATE_DBUS_BASE + "Boot.Progress.ProgressStages.Unspecified"
126OS_BOOT_PCI = STATE_DBUS_BASE + "Boot.Progress.ProgressStages.PCIInit"
127OS_BOOT_SECPCI = (
128    STATE_DBUS_BASE + "Boot.Progress.ProgressStages.SecondaryProcInit"
129)
130OS_BOOT_MEM = STATE_DBUS_BASE + "Boot.Progress.ProgressStages.MemoryInit"
131OS_BOOT_MOTHERBOARD = (
132    STATE_DBUS_BASE + "Boot.Progress.ProgressStages.MotherboardInit"
133)
134OPENBMC_DBUS_BMC_STATE = STATE_DBUS_BASE + "BMC"
135
136# OperatingSystem status variables.
137OS_BOOT_COMPLETE = (
138    STATE_DBUS_BASE + "OperatingSystem.Status.OSStatus.BootComplete"
139)
140OS_BOOT_CDROM = STATE_DBUS_BASE + "OperatingSystem.Status.OSStatus.CDROMBoot"
141OS_BOOT_ROM = STATE_DBUS_BASE + "OperatingSystem.Status.OSStatus.ROMBoot"
142OS_BOOT_PXE = STATE_DBUS_BASE + "OperatingSystem.Status.OSStatus.PXEBoot"
143OS_BOOT_CBoot = STATE_DBUS_BASE + "OperatingSystem.Status.OSStatus.CBoot"
144OS_BOOT_DiagBoot = STATE_DBUS_BASE + "OperatingSystem.Status.OSStatus.DiagBoot"
145
146# Boot variables.
147BOOT_SOURCE_DEFAULT = "xyz.openbmc_project.Control.Boot.Source.Sources.Default"
148BOOT_SOURCE_NETWORK = "xyz.openbmc_project.Control.Boot.Source.Sources.Network"
149BOOT_SOURCE_DISK = "xyz.openbmc_project.Control.Boot.Source.Sources.Disk"
150BOOT_SOURCE_CDROM = (
151    "xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia"
152)
153BOOT_MODE_SAFE = "xyz.openbmc_project.Control.Boot.Mode.Modes.Safe"
154BOOT_MODE_SETUP = "xyz.openbmc_project.Control.Boot.Mode.Modes.Setup"
155BOOT_MODE_REGULAR = "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
156BOOT_TYPE_LEGACY = "xyz.openbmc_project.Control.Boot.Type.Types.Legacy"
157BOOT_TYPE_EFI = "xyz.openbmc_project.Control.Boot.Type.Types.EFI"
158
159# Time variables.
160TIME_DBUS_BASE = "xyz.openbmc_project.Time."
161BMC_OWNER = TIME_DBUS_BASE + "Owner.Owners.BMC"
162HOST_OWNER = TIME_DBUS_BASE + "Owner.Owners.Host"
163SPLIT_OWNER = TIME_DBUS_BASE + "Owner.Owners.Split"
164BOTH_OWNER = TIME_DBUS_BASE + "Owner.Owners.Both"
165NTP_MODE = TIME_DBUS_BASE + "Synchronization.Method.NTP"
166MANUAL_MODE = TIME_DBUS_BASE + "Synchronization.Method.Manual"
167
168# User manager variable.
169BMC_USER_URI = OPENBMC_BASE_URI + "user/"
170
171# LDAP User manager variable.
172BMC_LDAP_URI = BMC_USER_URI + "ldap"
173
174# The path on the BMC where signed keys are stored.
175ACTIVATION_DIR_PATH = "/etc/activationdata/"
176
177# Redfish variables.
178REDFISH_BASE_URI = "/redfish/v1/"
179REDFISH_SESSION = REDFISH_BASE_URI + "SessionService/Sessions"
180REDFISH_SESSION_URI = "SessionService/Sessions/"
181REDFISH_NW_ETH0 = "Managers/bmc/EthernetInterfaces/eth0/"
182REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
183REDFISH_NW_ETH_IFACE = REDFISH_BASE_URI + "Managers/bmc/EthernetInterfaces/"
184REDFISH_NW_PROTOCOL = "Managers/bmc/NetworkProtocol"
185REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
186REDFISH_ACCOUNTS_SERVICE = "AccountService/"
187REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
188REDFISH_ACCOUNTS = "AccountService/Accounts/"
189REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
190REDFISH_HTTPS_CERTIFICATE = "Managers/bmc/NetworkProtocol/HTTPS/Certificates"
191REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
192REDFISH_LDAP_CERTIFICATE = "AccountService/LDAP/Certificates"
193REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
194REDFISH_CA_CERTIFICATE = "Managers/bmc/Truststore/Certificates"
195REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
196REDFISH_CHASSIS_URI = REDFISH_BASE_URI + "Chassis/"
197REDFISH_CHASSIS_THERMAL = "chassis/Thermal/"
198REDFISH_CHASSIS_THERMAL_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_THERMAL
199REDFISH_CHASSIS_POWER = "chassis/Power/"
200REDFISH_CHASSIS_POWER_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_POWER
201REDFISH_CHASSIS_SENSORS = "chassis/Sensors"
202REDFISH_CHASSIS_SENSORS_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_SENSORS
203REDFISH_BMC_DUMP = "Managers/bmc/LogServices/Dump/Entries"
204REDFISH_DUMP_URI = REDFISH_BASE_URI + REDFISH_BMC_DUMP
205
206# Boot options and URI variables.
207POWER_ON = "On"
208POWER_GRACEFUL_OFF = "GracefulShutdown"
209POWER_GRACEFUL_RESTART = "GracefulRestart"
210POWER_FORCE_OFF = "ForceOff"
211
212REDFISH_POWER = "Systems/system/Actions/ComputerSystem.Reset"
213REDFISH_POWER_URI = REDFISH_BASE_URI + REDFISH_POWER
214
215# rsyslog variables.
216REMOTE_LOGGING_URI = OPENBMC_BASE_URI + "logging/config/remote/"
217
218# Certificate variables.
219SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + "certs/server/https"
220CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + "certs/client/ldap"
221CA_CERTIFICATE_URI = OPENBMC_BASE_URI + "certs/authority/ldap"
222
223# EventLog variables.
224SYSTEM_BASE_URI = REDFISH_BASE_URI + "Systems/system/"
225EVENT_LOG_URI = SYSTEM_BASE_URI + "LogServices/EventLog/"
226DUMP_URI = SYSTEM_BASE_URI + "LogServices/Dump/"
227
228BIOS_ATTR_URI = SYSTEM_BASE_URI + "Bios"
229BIOS_ATTR_SETTINGS_URI = BIOS_ATTR_URI + "/Settings"
230
231"""
232  QEMU HTTPS variable:
233
234  By default lib/resource.robot AUTH URI construct is as
235  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
236  ${AUTH_SUFFIX} is populated here by default EMPTY else
237  the port from the OS environment
238"""
239
240AUTH_SUFFIX = ":" + BuiltIn().get_variable_value(
241    "${HTTPS_PORT}", os.getenv("HTTPS_PORT", "443")
242)
243
244# Here contains a list of valid Properties bases on fru_type after a boot.
245INVENTORY_ITEMS = {
246    "CPU": [
247        "Custom Field 1",
248        "Custom Field 2",
249        "Custom Field 3",
250        "Custom Field 4",
251        "Custom Field 5",
252        "Custom Field 6",
253        "Custom Field 7",
254        "Custom Field 8",
255        "FRU File ID",
256        "Manufacturer",
257        "Name",
258        "Part Number",
259        "Serial Number",
260        "fault",
261        "fru_type",
262        "is_fru",
263        "present",
264        "version",
265    ],
266    "DIMM": [
267        "Asset Tag",
268        "Custom Field 1",
269        "Custom Field 2",
270        "Custom Field 3",
271        "Custom Field 4",
272        "Custom Field 5",
273        "Custom Field 6",
274        "Custom Field 7",
275        "Custom Field 8",
276        "FRU File ID",
277        "Manufacturer",
278        "Model Number",
279        "Name",
280        "Serial Number",
281        "Version",
282        "fault",
283        "fru_type",
284        "is_fru",
285        "present",
286        "version",
287    ],
288    "MEMORY_BUFFER": [
289        "Custom Field 1",
290        "Custom Field 2",
291        "Custom Field 3",
292        "Custom Field 4",
293        "Custom Field 5",
294        "Custom Field 6",
295        "Custom Field 7",
296        "Custom Field 8",
297        "FRU File ID",
298        "Manufacturer",
299        "Name",
300        "Part Number",
301        "Serial Number",
302        "fault",
303        "fru_type",
304        "is_fru",
305        "present",
306        "version",
307    ],
308    "FAN": [
309        "fault",
310        "fru_type",
311        "is_fru",
312        "present",
313        "version",
314    ],
315    "DAUGHTER_CARD": [
316        "Custom Field 1",
317        "Custom Field 2",
318        "Custom Field 3",
319        "Custom Field 4",
320        "Custom Field 5",
321        "Custom Field 6",
322        "Custom Field 7",
323        "Custom Field 8",
324        "FRU File ID",
325        "Manufacturer",
326        "Name",
327        "Part Number",
328        "Serial Number",
329        "fault",
330        "fru_type",
331        "is_fru",
332        "present",
333        "version",
334    ],
335    "BMC": [
336        "fault",
337        "fru_type",
338        "is_fru",
339        "manufacturer",
340        "present",
341        "version",
342    ],
343    "MAIN_PLANAR": [
344        "Custom Field 1",
345        "Custom Field 2",
346        "Custom Field 3",
347        "Custom Field 4",
348        "Custom Field 5",
349        "Custom Field 6",
350        "Custom Field 7",
351        "Custom Field 8",
352        "Part Number",
353        "Serial Number",
354        "Type",
355        "fault",
356        "fru_type",
357        "is_fru",
358        "present",
359        "version",
360    ],
361    "SYSTEM": [
362        "Custom Field 1",
363        "Custom Field 2",
364        "Custom Field 3",
365        "Custom Field 4",
366        "Custom Field 5",
367        "Custom Field 6",
368        "Custom Field 7",
369        "Custom Field 8",
370        "FRU File ID",
371        "Manufacturer",
372        "Model Number",
373        "Name",
374        "Serial Number",
375        "Version",
376        "fault",
377        "fru_type",
378        "is_fru",
379        "present",
380        "version",
381    ],
382    "CORE": [
383        "fault",
384        "fru_type",
385        "is_fru",
386        "present",
387        "version",
388    ],
389}
390