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