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