1import os
2
3OPENBMC_BASE_URI = '/xyz/openbmc_project/'
4OPENBMC_BASE_DBUS = 'xyz.openbmc_project.'
5
6# org open power base URI.
7OPENPOWER_BASE_URI = '/org/open_power/'
8OPENPOWER_CONTROL = OPENPOWER_BASE_URI + 'control/'
9OPENPOWER_SENSORS = OPENPOWER_BASE_URI + 'sensors/'
10
11# REST URI base endpoint paths.
12CONTROL_URI = OPENBMC_BASE_URI + 'control/'
13# old vs new code dependencies in many places.
14# TODO: remove when ready.
15SETTINGS_URI = '/org/openbmc/settings/'
16WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/'
17TIME_MANAGER_URI = OPENBMC_BASE_URI + 'time/'
18NETWORK_MANAGER = OPENBMC_BASE_URI + 'network/'
19# SNMP
20SNMP_MANAGER_URI = NETWORK_MANAGER + 'snmp/manager/'
21# Sensors base variables.
22SENSORS_URI = OPENBMC_BASE_URI + 'sensors/'
23
24# State Manager base variables
25BMC_REBOOT_TRANS = 'xyz.openbmc_project.State.BMC.Transition.Reboot'
26
27HOST_POWEROFF_TRANS = 'xyz.openbmc_project.State.Host.Transition.Off'
28HOST_POWERON_TRANS = 'xyz.openbmc_project.State.Host.Transition.On'
29HOST_REBOOT_TRANS = 'xyz.openbmc_project.State.Host.Transition.Reboot'
30HOST_POWEROFF_STATE = 'xyz.openbmc_project.State.Host.HostState.Off'
31HOST_POWERON_STATE = 'xyz.openbmc_project.State.Host.HostState.Running'
32
33CHASSIS_POWEROFF_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.Off'
34CHASSIS_POWERON_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.On'
35CHASSIS_POWEROFF_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.Off'
36CHASSIS_POWERON_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.On'
37
38# State Manager URI variables.
39SYSTEM_STATE_URI = OPENBMC_BASE_URI + 'state/'
40BMC_STATE_URI = OPENBMC_BASE_URI + 'state/bmc0/'
41HOST_STATE_URI = OPENBMC_BASE_URI + 'state/host0/'
42CHASSIS_STATE_URI = OPENBMC_BASE_URI + 'state/chassis0/'
43HOST_WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/host0/'
44
45# Logging URI variables
46BMC_LOGGING_URI = OPENBMC_BASE_URI + 'logging/'
47BMC_LOGGING_ENTRY = BMC_LOGGING_URI + 'entry/'
48
49# Software manager version
50SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + 'software/'
51ACTIVE = 'xyz.openbmc_project.Software.Activation.Activations.Active'
52READY = 'xyz.openbmc_project.Software.Activation.Activations.Ready'
53INVALID = 'xyz.openbmc_project.Software.Activation.Activations.Invalid'
54ACTIVATING = 'xyz.openbmc_project.Software.Activation.Activations.Activating'
55NOTREADY = 'xyz.openbmc_project.Software.Activation.Activations.NotReady'
56FAILED = 'xyz.openbmc_project.Software.Activation.Activations.Failed'
57
58SOFTWARE_ACTIVATION = 'xyz.openbmc_project.Software.Activation'
59REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + '.RequestedActivations'
60REQUESTED_ACTIVE = REQUESTED_ACTIVATION + '.Active'
61REQUESTED_NONE = REQUESTED_ACTIVATION + '.None'
62
63SOFTWARE_PURPOSE = 'xyz.openbmc_project.Software.Version.VersionPurpose'
64VERSION_PURPOSE_HOST = SOFTWARE_PURPOSE + '.Host'
65VERSION_PURPOSE_BMC = SOFTWARE_PURPOSE + '.BMC'
66VERSION_PURPOSE_SYSTEM = SOFTWARE_PURPOSE + '.System'
67
68# Image Upload Directory Path
69IMAGE_UPLOAD_DIR_PATH = '/tmp/images/'
70
71# Inventory URI
72HOST_INVENTORY_URI = OPENBMC_BASE_URI + 'inventory/'
73
74# Led URI variable
75LED_GROUPS_URI = OPENBMC_BASE_URI + 'led/groups/'
76LED_PHYSICAL_URI = OPENBMC_BASE_URI + 'led/physical/'
77
78# Host control URI variables.
79CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
80
81# Power restore variables.
82POWER_RESTORE_URI = CONTROL_HOST_URI + 'power_restore_policy'
83CONTROL_DBUS_BASE = 'xyz.openbmc_project.Control.'
84
85RESTORE_LAST_STATE = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.Restore'
86ALWAYS_POWER_ON = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOn'
87ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOff'
88
89# Dump URI variables.
90DUMP_URI = OPENBMC_BASE_URI + 'dump/'
91DUMP_ENTRY_URI = DUMP_URI + 'entry/'
92# The path on the BMC where dumps are stored.
93DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
94
95# Boot progress variables.
96STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
97OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
98OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
99OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
100OS_BOOT_SECPCI = STATE_DBUS_BASE + \
101    'Boot.Progress.ProgressStages.SecondaryProcInit'
102OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
103OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
104    'Boot.Progress.ProgressStages.MotherboardInit'
105
106# OperatingSystem status variables.
107OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
108    'OperatingSystem.Status.OSStatus.BootComplete'
109OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
110OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
111OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
112OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
113OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
114
115# Boot variables.
116BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
117BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
118BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
119BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
120BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
121BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
122BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
123
124# Time variables.
125TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
126BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
127HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
128SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
129BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
130NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
131MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
132
133# User manager variable.
134BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
135
136# LDAP User manager variable.
137BMC_LDAP_URI = BMC_USER_URI + 'ldap'
138
139# The path on the BMC where signed keys are stored.
140ACTIVATION_DIR_PATH = "/etc/activationdata/"
141
142# Redfish variables.
143REDFISH_BASE_URI = '/redfish/v1/'
144REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
145REDFISH_SESSION_URI = 'SessionService/Sessions/'
146REDFISH_NW_ETH0 = 'Managers/bmc/EthernetInterfaces/eth0/'
147REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
148REDFISH_NW_PROTOCOL = 'Managers/bmc/NetworkProtocol'
149REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
150
151# Boot options and URI variables.
152POWER_ON = 'On'
153POWER_GRACEFUL_OFF = "GracefulShutdown"
154POWER_GRACEFUL_RESTART = "GracefulRestart"
155POWER_FORCE_OFF = 'ForceOff'
156
157REDFISH_POWER_URI = 'Systems/1/Actions/ComputerSystem.Reset'
158
159# rsyslog variables.
160REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
161
162# Certificate variables.
163SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
164CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
165CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
166
167'''
168  QEMU HTTPS variable:
169
170  By default lib/resource.robot AUTH URI construct is as
171  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
172  ${AUTH_SUFFIX} is populated here by default EMPTY else
173  the port from the OS environment
174'''
175
176
177def get_port_https():
178    # defaulted to empty string
179    l_suffix = ''
180    try:
181        l_https_port = os.getenv('HTTPS_PORT')
182        if l_https_port:
183            l_suffix = ':' + l_https_port
184    except BaseException:
185        print ("Environment variable HTTPS_PORT not set,\
186              using default HTTPS port")
187    return l_suffix
188
189
190AUTH_SUFFIX = {
191    "https_port": [get_port_https()],
192}
193
194# Update the ':Port number' to this variable
195AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
196
197# Here contains a list of valid Properties bases on fru_type after a boot.
198INVENTORY_ITEMS = {
199    "CPU": [
200        "Custom Field 1",
201        "Custom Field 2",
202        "Custom Field 3",
203        "Custom Field 4",
204        "Custom Field 5",
205        "Custom Field 6",
206        "Custom Field 7",
207        "Custom Field 8",
208        "FRU File ID",
209        "Manufacturer",
210        "Name",
211        "Part Number",
212        "Serial Number",
213        "fault",
214        "fru_type",
215        "is_fru",
216        "present",
217        "version",
218    ],
219
220    "DIMM": [
221        "Asset Tag",
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        "Model Number",
233        "Name",
234        "Serial Number",
235        "Version",
236        "fault",
237        "fru_type",
238        "is_fru",
239        "present",
240        "version",
241    ],
242    "MEMORY_BUFFER": [
243        "Custom Field 1",
244        "Custom Field 2",
245        "Custom Field 3",
246        "Custom Field 4",
247        "Custom Field 5",
248        "Custom Field 6",
249        "Custom Field 7",
250        "Custom Field 8",
251        "FRU File ID",
252        "Manufacturer",
253        "Name",
254        "Part Number",
255        "Serial Number",
256        "fault",
257        "fru_type",
258        "is_fru",
259        "present",
260        "version",
261    ],
262    "FAN": [
263        "fault",
264        "fru_type",
265        "is_fru",
266        "present",
267        "version",
268    ],
269    "DAUGHTER_CARD": [
270        "Custom Field 1",
271        "Custom Field 2",
272        "Custom Field 3",
273        "Custom Field 4",
274        "Custom Field 5",
275        "Custom Field 6",
276        "Custom Field 7",
277        "Custom Field 8",
278        "FRU File ID",
279        "Manufacturer",
280        "Name",
281        "Part Number",
282        "Serial Number",
283        "fault",
284        "fru_type",
285        "is_fru",
286        "present",
287        "version",
288    ],
289    "BMC": [
290        "fault",
291        "fru_type",
292        "is_fru",
293        "manufacturer",
294        "present",
295        "version",
296    ],
297    "MAIN_PLANAR": [
298        "Custom Field 1",
299        "Custom Field 2",
300        "Custom Field 3",
301        "Custom Field 4",
302        "Custom Field 5",
303        "Custom Field 6",
304        "Custom Field 7",
305        "Custom Field 8",
306        "Part Number",
307        "Serial Number",
308        "Type",
309        "fault",
310        "fru_type",
311        "is_fru",
312        "present",
313        "version",
314    ],
315    "SYSTEM": [
316        "Custom Field 1",
317        "Custom Field 2",
318        "Custom Field 3",
319        "Custom Field 4",
320        "Custom Field 5",
321        "Custom Field 6",
322        "Custom Field 7",
323        "Custom Field 8",
324        "FRU File ID",
325        "Manufacturer",
326        "Model Number",
327        "Name",
328        "Serial Number",
329        "Version",
330        "fault",
331        "fru_type",
332        "is_fru",
333        "present",
334        "version",
335    ],
336    "CORE": [
337        "fault",
338        "fru_type",
339        "is_fru",
340        "present",
341        "version",
342    ],
343}
344