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# old vs new code dependencies in many places.
15# TODO: remove when ready.
16SETTINGS_URI = '/org/openbmc/settings/'
17WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/'
18TIME_MANAGER_URI = OPENBMC_BASE_URI + 'time/'
19NETWORK_MANAGER = OPENBMC_BASE_URI + 'network/'
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/'
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_PROTOCOL = 'Managers/bmc/NetworkProtocol'
161REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
162REDFISH_ACCOUNTS_SERVICE = 'AccountService/'
163REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
164REDFISH_ACCOUNTS = 'AccountService/Accounts/'
165REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
166REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
167REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
168REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
169REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
170REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
171REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
172REDFISH_CHASSIS_URI = REDFISH_BASE_URI + 'Chassis/'
173REDFISH_CHASSIS_THERMAL = 'chassis/Thermal/'
174REDFISH_CHASSIS_THERMAL_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_THERMAL
175REDFISH_CHASSIS_POWER = 'chassis/Power/'
176REDFISH_CHASSIS_POWER_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_POWER
177REDFISH_CHASSIS_SENSORS = 'chassis/Sensors'
178REDFISH_CHASSIS_SENSORS_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_SENSORS
179
180# Boot options and URI variables.
181POWER_ON = 'On'
182POWER_GRACEFUL_OFF = "GracefulShutdown"
183POWER_GRACEFUL_RESTART = "GracefulRestart"
184POWER_FORCE_OFF = 'ForceOff'
185
186REDFISH_POWER = 'Systems/system/Actions/ComputerSystem.Reset'
187REDFISH_POWER_URI = REDFISH_BASE_URI + REDFISH_POWER
188
189# rsyslog variables.
190REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
191
192# Certificate variables.
193SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
194CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
195CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
196
197# EventLog variables.
198SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
199EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
200
201'''
202  QEMU HTTPS variable:
203
204  By default lib/resource.robot AUTH URI construct is as
205  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
206  ${AUTH_SUFFIX} is populated here by default EMPTY else
207  the port from the OS environment
208'''
209
210AUTH_SUFFIX = ":" + BuiltIn().get_variable_value("${HTTPS_PORT}", os.getenv('HTTPS_PORT', '443'))
211
212# Here contains a list of valid Properties bases on fru_type after a boot.
213INVENTORY_ITEMS = {
214    "CPU": [
215        "Custom Field 1",
216        "Custom Field 2",
217        "Custom Field 3",
218        "Custom Field 4",
219        "Custom Field 5",
220        "Custom Field 6",
221        "Custom Field 7",
222        "Custom Field 8",
223        "FRU File ID",
224        "Manufacturer",
225        "Name",
226        "Part Number",
227        "Serial Number",
228        "fault",
229        "fru_type",
230        "is_fru",
231        "present",
232        "version",
233    ],
234
235    "DIMM": [
236        "Asset Tag",
237        "Custom Field 1",
238        "Custom Field 2",
239        "Custom Field 3",
240        "Custom Field 4",
241        "Custom Field 5",
242        "Custom Field 6",
243        "Custom Field 7",
244        "Custom Field 8",
245        "FRU File ID",
246        "Manufacturer",
247        "Model Number",
248        "Name",
249        "Serial Number",
250        "Version",
251        "fault",
252        "fru_type",
253        "is_fru",
254        "present",
255        "version",
256    ],
257    "MEMORY_BUFFER": [
258        "Custom Field 1",
259        "Custom Field 2",
260        "Custom Field 3",
261        "Custom Field 4",
262        "Custom Field 5",
263        "Custom Field 6",
264        "Custom Field 7",
265        "Custom Field 8",
266        "FRU File ID",
267        "Manufacturer",
268        "Name",
269        "Part Number",
270        "Serial Number",
271        "fault",
272        "fru_type",
273        "is_fru",
274        "present",
275        "version",
276    ],
277    "FAN": [
278        "fault",
279        "fru_type",
280        "is_fru",
281        "present",
282        "version",
283    ],
284    "DAUGHTER_CARD": [
285        "Custom Field 1",
286        "Custom Field 2",
287        "Custom Field 3",
288        "Custom Field 4",
289        "Custom Field 5",
290        "Custom Field 6",
291        "Custom Field 7",
292        "Custom Field 8",
293        "FRU File ID",
294        "Manufacturer",
295        "Name",
296        "Part Number",
297        "Serial Number",
298        "fault",
299        "fru_type",
300        "is_fru",
301        "present",
302        "version",
303    ],
304    "BMC": [
305        "fault",
306        "fru_type",
307        "is_fru",
308        "manufacturer",
309        "present",
310        "version",
311    ],
312    "MAIN_PLANAR": [
313        "Custom Field 1",
314        "Custom Field 2",
315        "Custom Field 3",
316        "Custom Field 4",
317        "Custom Field 5",
318        "Custom Field 6",
319        "Custom Field 7",
320        "Custom Field 8",
321        "Part Number",
322        "Serial Number",
323        "Type",
324        "fault",
325        "fru_type",
326        "is_fru",
327        "present",
328        "version",
329    ],
330    "SYSTEM": [
331        "Custom Field 1",
332        "Custom Field 2",
333        "Custom Field 3",
334        "Custom Field 4",
335        "Custom Field 5",
336        "Custom Field 6",
337        "Custom Field 7",
338        "Custom Field 8",
339        "FRU File ID",
340        "Manufacturer",
341        "Model Number",
342        "Name",
343        "Serial Number",
344        "Version",
345        "fault",
346        "fru_type",
347        "is_fru",
348        "present",
349        "version",
350    ],
351    "CORE": [
352        "fault",
353        "fru_type",
354        "is_fru",
355        "present",
356        "version",
357    ],
358}
359