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