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