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