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.
101REST_DUMP_URI = OPENBMC_BASE_URI + 'dump/bmc/'
102DUMP_ENTRY_URI = REST_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/"
106DUMP_HB_DIR_PATH = "/var/lib/phosphor-debug-collector/hostbootdump/"
107
108# Boot progress variables.
109STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
110OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
111OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
112OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
113OS_BOOT_SECPCI = STATE_DBUS_BASE + \
114    'Boot.Progress.ProgressStages.SecondaryProcInit'
115OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
116OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
117    'Boot.Progress.ProgressStages.MotherboardInit'
118
119# OperatingSystem status variables.
120OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
121    'OperatingSystem.Status.OSStatus.BootComplete'
122OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
123OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
124OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
125OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
126OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
127
128# Boot variables.
129BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
130BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
131BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
132BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
133BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
134BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
135BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
136BOOT_TYPE_LEGACY = 'xyz.openbmc_project.Control.Boot.Type.Types.Legacy'
137BOOT_TYPE_EFI = 'xyz.openbmc_project.Control.Boot.Type.Types.EFI'
138
139# Time variables.
140TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
141BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
142HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
143SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
144BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
145NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
146MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
147
148# User manager variable.
149BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
150
151# LDAP User manager variable.
152BMC_LDAP_URI = BMC_USER_URI + 'ldap'
153
154# The path on the BMC where signed keys are stored.
155ACTIVATION_DIR_PATH = "/etc/activationdata/"
156
157# Redfish variables.
158REDFISH_BASE_URI = '/redfish/v1/'
159REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
160REDFISH_SESSION_URI = 'SessionService/Sessions/'
161REDFISH_NW_ETH0 = 'Managers/bmc/EthernetInterfaces/eth0/'
162REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
163REDFISH_NW_ETH_IFACE = REDFISH_BASE_URI + 'Managers/bmc/EthernetInterfaces/'
164REDFISH_NW_PROTOCOL = 'Managers/bmc/NetworkProtocol'
165REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
166REDFISH_ACCOUNTS_SERVICE = 'AccountService/'
167REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
168REDFISH_ACCOUNTS = 'AccountService/Accounts/'
169REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
170REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
171REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
172REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
173REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
174REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
175REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
176REDFISH_CHASSIS_URI = REDFISH_BASE_URI + 'Chassis/'
177REDFISH_CHASSIS_THERMAL = 'chassis/Thermal/'
178REDFISH_CHASSIS_THERMAL_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_THERMAL
179REDFISH_CHASSIS_POWER = 'chassis/Power/'
180REDFISH_CHASSIS_POWER_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_POWER
181REDFISH_CHASSIS_SENSORS = 'chassis/Sensors'
182REDFISH_CHASSIS_SENSORS_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_SENSORS
183
184# Boot options and URI variables.
185POWER_ON = 'On'
186POWER_GRACEFUL_OFF = "GracefulShutdown"
187POWER_GRACEFUL_RESTART = "GracefulRestart"
188POWER_FORCE_OFF = 'ForceOff'
189
190REDFISH_POWER = 'Systems/system/Actions/ComputerSystem.Reset'
191REDFISH_POWER_URI = REDFISH_BASE_URI + REDFISH_POWER
192
193# rsyslog variables.
194REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
195
196# Certificate variables.
197SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
198CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
199CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
200
201# EventLog variables.
202SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
203EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
204DUMP_URI = SYSTEM_BASE_URI + 'LogServices/Dump/'
205
206BIOS_ATTR_URI = SYSTEM_BASE_URI + 'Bios'
207BIOS_ATTR_SETTINGS_URI = BIOS_ATTR_URI + '/Settings'
208
209'''
210  QEMU HTTPS variable:
211
212  By default lib/resource.robot AUTH URI construct is as
213  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
214  ${AUTH_SUFFIX} is populated here by default EMPTY else
215  the port from the OS environment
216'''
217
218AUTH_SUFFIX = ":" + BuiltIn().get_variable_value("${HTTPS_PORT}", os.getenv('HTTPS_PORT', '443'))
219
220# Here contains a list of valid Properties bases on fru_type after a boot.
221INVENTORY_ITEMS = {
222    "CPU": [
223        "Custom Field 1",
224        "Custom Field 2",
225        "Custom Field 3",
226        "Custom Field 4",
227        "Custom Field 5",
228        "Custom Field 6",
229        "Custom Field 7",
230        "Custom Field 8",
231        "FRU File ID",
232        "Manufacturer",
233        "Name",
234        "Part Number",
235        "Serial Number",
236        "fault",
237        "fru_type",
238        "is_fru",
239        "present",
240        "version",
241    ],
242
243    "DIMM": [
244        "Asset Tag",
245        "Custom Field 1",
246        "Custom Field 2",
247        "Custom Field 3",
248        "Custom Field 4",
249        "Custom Field 5",
250        "Custom Field 6",
251        "Custom Field 7",
252        "Custom Field 8",
253        "FRU File ID",
254        "Manufacturer",
255        "Model Number",
256        "Name",
257        "Serial Number",
258        "Version",
259        "fault",
260        "fru_type",
261        "is_fru",
262        "present",
263        "version",
264    ],
265    "MEMORY_BUFFER": [
266        "Custom Field 1",
267        "Custom Field 2",
268        "Custom Field 3",
269        "Custom Field 4",
270        "Custom Field 5",
271        "Custom Field 6",
272        "Custom Field 7",
273        "Custom Field 8",
274        "FRU File ID",
275        "Manufacturer",
276        "Name",
277        "Part Number",
278        "Serial Number",
279        "fault",
280        "fru_type",
281        "is_fru",
282        "present",
283        "version",
284    ],
285    "FAN": [
286        "fault",
287        "fru_type",
288        "is_fru",
289        "present",
290        "version",
291    ],
292    "DAUGHTER_CARD": [
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        "Name",
304        "Part Number",
305        "Serial Number",
306        "fault",
307        "fru_type",
308        "is_fru",
309        "present",
310        "version",
311    ],
312    "BMC": [
313        "fault",
314        "fru_type",
315        "is_fru",
316        "manufacturer",
317        "present",
318        "version",
319    ],
320    "MAIN_PLANAR": [
321        "Custom Field 1",
322        "Custom Field 2",
323        "Custom Field 3",
324        "Custom Field 4",
325        "Custom Field 5",
326        "Custom Field 6",
327        "Custom Field 7",
328        "Custom Field 8",
329        "Part Number",
330        "Serial Number",
331        "Type",
332        "fault",
333        "fru_type",
334        "is_fru",
335        "present",
336        "version",
337    ],
338    "SYSTEM": [
339        "Custom Field 1",
340        "Custom Field 2",
341        "Custom Field 3",
342        "Custom Field 4",
343        "Custom Field 5",
344        "Custom Field 6",
345        "Custom Field 7",
346        "Custom Field 8",
347        "FRU File ID",
348        "Manufacturer",
349        "Model Number",
350        "Name",
351        "Serial Number",
352        "Version",
353        "fault",
354        "fru_type",
355        "is_fru",
356        "present",
357        "version",
358    ],
359    "CORE": [
360        "fault",
361        "fru_type",
362        "is_fru",
363        "present",
364        "version",
365    ],
366}
367