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/'
20NETWORK_RESOURCE = 'xyz.openbmc_project.Network.IP.Protocol.IPv4'
21# SNMP
22SNMP_MANAGER_URI = NETWORK_MANAGER + 'snmp/manager/'
23# Sensors base variables.
24SENSORS_URI = OPENBMC_BASE_URI + 'sensors/'
25# Thermal Control base variables
26THERMAL_CONTROL_URI = CONTROL_URI + 'thermal/0'
27
28# State Manager base variables
29BMC_REBOOT_TRANS = 'xyz.openbmc_project.State.BMC.Transition.Reboot'
30
31HOST_POWEROFF_TRANS = 'xyz.openbmc_project.State.Host.Transition.Off'
32HOST_POWERON_TRANS = 'xyz.openbmc_project.State.Host.Transition.On'
33HOST_REBOOT_TRANS = 'xyz.openbmc_project.State.Host.Transition.Reboot'
34HOST_POWEROFF_STATE = 'xyz.openbmc_project.State.Host.HostState.Off'
35HOST_POWERON_STATE = 'xyz.openbmc_project.State.Host.HostState.Running'
36
37CHASSIS_POWEROFF_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.Off'
38CHASSIS_POWERON_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.On'
39CHASSIS_POWEROFF_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.Off'
40CHASSIS_POWERON_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.On'
41
42# State Manager URI variables.
43SYSTEM_STATE_URI = OPENBMC_BASE_URI + 'state/'
44BMC_STATE_URI = OPENBMC_BASE_URI + 'state/bmc0/'
45HOST_STATE_URI = OPENBMC_BASE_URI + 'state/host0/'
46CHASSIS_STATE_URI = OPENBMC_BASE_URI + 'state/chassis0/'
47HOST_WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/host0/'
48
49# Logging URI variables
50BMC_LOGGING_URI = OPENBMC_BASE_URI + 'logging/'
51BMC_LOGGING_ENTRY = BMC_LOGGING_URI + 'entry/'
52
53# Software manager version
54SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + 'software/'
55ACTIVE = 'xyz.openbmc_project.Software.Activation.Activations.Active'
56READY = 'xyz.openbmc_project.Software.Activation.Activations.Ready'
57INVALID = 'xyz.openbmc_project.Software.Activation.Activations.Invalid'
58ACTIVATING = 'xyz.openbmc_project.Software.Activation.Activations.Activating'
59NOTREADY = 'xyz.openbmc_project.Software.Activation.Activations.NotReady'
60FAILED = 'xyz.openbmc_project.Software.Activation.Activations.Failed'
61
62SOFTWARE_ACTIVATION = 'xyz.openbmc_project.Software.Activation'
63REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + '.RequestedActivations'
64REQUESTED_ACTIVE = REQUESTED_ACTIVATION + '.Active'
65REQUESTED_NONE = REQUESTED_ACTIVATION + '.None'
66
67SOFTWARE_PURPOSE = 'xyz.openbmc_project.Software.Version.VersionPurpose'
68VERSION_PURPOSE_HOST = SOFTWARE_PURPOSE + '.Host'
69VERSION_PURPOSE_BMC = SOFTWARE_PURPOSE + '.BMC'
70VERSION_PURPOSE_SYSTEM = SOFTWARE_PURPOSE + '.System'
71
72# Image Upload Directory Path
73IMAGE_UPLOAD_DIR_PATH = '/tmp/images/'
74
75# Inventory URI variables
76HOST_INVENTORY_URI = OPENBMC_BASE_URI + 'inventory/'
77CHASSIS_INVENTORY_URI = HOST_INVENTORY_URI + 'system/chassis/'
78MOTHERBOARD_INVENTORY_URI = CHASSIS_INVENTORY_URI + 'motherboard/'
79
80# Led URI variable
81LED_GROUPS_URI = OPENBMC_BASE_URI + 'led/groups/'
82LED_PHYSICAL_URI = OPENBMC_BASE_URI + 'led/physical/'
83LED_LAMP_TEST_ASSERTED_URI = LED_GROUPS_URI + 'lamp_test/'
84LED_PHYSICAL_PS0_URI = LED_PHYSICAL_URI + 'cffps1_69/'
85LED_PHYSICAL_PS1_URI = LED_PHYSICAL_URI + 'cffps1_68/'
86LED_PHYSICAL_FAN0_URI = LED_PHYSICAL_URI + 'fan0/'
87LED_PHYSICAL_FAN2_URI = LED_PHYSICAL_URI + 'fan2/'
88LED_PHYSICAL_FAN3_URI = LED_PHYSICAL_URI + 'fan3/'
89
90# Host control URI variables.
91CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
92
93# Power restore variables.
94POWER_RESTORE_URI = CONTROL_HOST_URI + 'power_restore_policy'
95CONTROL_DBUS_BASE = 'xyz.openbmc_project.Control.'
96
97RESTORE_LAST_STATE = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.Restore'
98ALWAYS_POWER_ON = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOn'
99ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOff'
100
101# Dump URI variables.
102DUMP_URI = OPENBMC_BASE_URI + 'dump/'
103DUMP_ENTRY_URI = DUMP_URI + 'entry/'
104DUMP_DOWNLOAD_URI = "/download/dump/"
105# The path on the BMC where dumps are stored.
106DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
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'
136
137# Time variables.
138TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
139BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
140HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
141SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
142BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
143NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
144MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
145
146# User manager variable.
147BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
148
149# LDAP User manager variable.
150BMC_LDAP_URI = BMC_USER_URI + 'ldap'
151
152# The path on the BMC where signed keys are stored.
153ACTIVATION_DIR_PATH = "/etc/activationdata/"
154
155# Redfish variables.
156REDFISH_BASE_URI = '/redfish/v1/'
157REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
158REDFISH_SESSION_URI = 'SessionService/Sessions/'
159REDFISH_NW_ETH0 = 'Managers/bmc/EthernetInterfaces/eth0/'
160REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
161REDFISH_NW_ETH_IFACE = REDFISH_BASE_URI + 'Managers/bmc/EthernetInterfaces/'
162REDFISH_NW_PROTOCOL = 'Managers/bmc/NetworkProtocol'
163REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
164REDFISH_ACCOUNTS_SERVICE = 'AccountService/'
165REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
166REDFISH_ACCOUNTS = 'AccountService/Accounts/'
167REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
168REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
169REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
170REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
171REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
172REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
173REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
174REDFISH_CHASSIS_URI = REDFISH_BASE_URI + 'Chassis/'
175REDFISH_CHASSIS_THERMAL = 'chassis/Thermal/'
176REDFISH_CHASSIS_THERMAL_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_THERMAL
177REDFISH_CHASSIS_POWER = 'chassis/Power/'
178REDFISH_CHASSIS_POWER_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_POWER
179REDFISH_CHASSIS_SENSORS = 'chassis/Sensors'
180REDFISH_CHASSIS_SENSORS_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_SENSORS
181
182# Boot options and URI variables.
183POWER_ON = 'On'
184POWER_GRACEFUL_OFF = "GracefulShutdown"
185POWER_GRACEFUL_RESTART = "GracefulRestart"
186POWER_FORCE_OFF = 'ForceOff'
187
188REDFISH_POWER = 'Systems/system/Actions/ComputerSystem.Reset'
189REDFISH_POWER_URI = REDFISH_BASE_URI + REDFISH_POWER
190
191# rsyslog variables.
192REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
193
194# Certificate variables.
195SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
196CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
197CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
198
199# EventLog variables.
200SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
201EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
202
203'''
204  QEMU HTTPS variable:
205
206  By default lib/resource.robot AUTH URI construct is as
207  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
208  ${AUTH_SUFFIX} is populated here by default EMPTY else
209  the port from the OS environment
210'''
211
212AUTH_SUFFIX = ":" + BuiltIn().get_variable_value("${HTTPS_PORT}", os.getenv('HTTPS_PORT', '443'))
213
214# Here contains a list of valid Properties bases on fru_type after a boot.
215INVENTORY_ITEMS = {
216    "CPU": [
217        "Custom Field 1",
218        "Custom Field 2",
219        "Custom Field 3",
220        "Custom Field 4",
221        "Custom Field 5",
222        "Custom Field 6",
223        "Custom Field 7",
224        "Custom Field 8",
225        "FRU File ID",
226        "Manufacturer",
227        "Name",
228        "Part Number",
229        "Serial Number",
230        "fault",
231        "fru_type",
232        "is_fru",
233        "present",
234        "version",
235    ],
236
237    "DIMM": [
238        "Asset Tag",
239        "Custom Field 1",
240        "Custom Field 2",
241        "Custom Field 3",
242        "Custom Field 4",
243        "Custom Field 5",
244        "Custom Field 6",
245        "Custom Field 7",
246        "Custom Field 8",
247        "FRU File ID",
248        "Manufacturer",
249        "Model Number",
250        "Name",
251        "Serial Number",
252        "Version",
253        "fault",
254        "fru_type",
255        "is_fru",
256        "present",
257        "version",
258    ],
259    "MEMORY_BUFFER": [
260        "Custom Field 1",
261        "Custom Field 2",
262        "Custom Field 3",
263        "Custom Field 4",
264        "Custom Field 5",
265        "Custom Field 6",
266        "Custom Field 7",
267        "Custom Field 8",
268        "FRU File ID",
269        "Manufacturer",
270        "Name",
271        "Part Number",
272        "Serial Number",
273        "fault",
274        "fru_type",
275        "is_fru",
276        "present",
277        "version",
278    ],
279    "FAN": [
280        "fault",
281        "fru_type",
282        "is_fru",
283        "present",
284        "version",
285    ],
286    "DAUGHTER_CARD": [
287        "Custom Field 1",
288        "Custom Field 2",
289        "Custom Field 3",
290        "Custom Field 4",
291        "Custom Field 5",
292        "Custom Field 6",
293        "Custom Field 7",
294        "Custom Field 8",
295        "FRU File ID",
296        "Manufacturer",
297        "Name",
298        "Part Number",
299        "Serial Number",
300        "fault",
301        "fru_type",
302        "is_fru",
303        "present",
304        "version",
305    ],
306    "BMC": [
307        "fault",
308        "fru_type",
309        "is_fru",
310        "manufacturer",
311        "present",
312        "version",
313    ],
314    "MAIN_PLANAR": [
315        "Custom Field 1",
316        "Custom Field 2",
317        "Custom Field 3",
318        "Custom Field 4",
319        "Custom Field 5",
320        "Custom Field 6",
321        "Custom Field 7",
322        "Custom Field 8",
323        "Part Number",
324        "Serial Number",
325        "Type",
326        "fault",
327        "fru_type",
328        "is_fru",
329        "present",
330        "version",
331    ],
332    "SYSTEM": [
333        "Custom Field 1",
334        "Custom Field 2",
335        "Custom Field 3",
336        "Custom Field 4",
337        "Custom Field 5",
338        "Custom Field 6",
339        "Custom Field 7",
340        "Custom Field 8",
341        "FRU File ID",
342        "Manufacturer",
343        "Model Number",
344        "Name",
345        "Serial Number",
346        "Version",
347        "fault",
348        "fru_type",
349        "is_fru",
350        "present",
351        "version",
352    ],
353    "CORE": [
354        "fault",
355        "fru_type",
356        "is_fru",
357        "present",
358        "version",
359    ],
360}
361