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