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/'
92DUMP_DOWNLOAD_URI = "/download/dump/"
93# The path on the BMC where dumps are stored.
94DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
95
96# Boot progress variables.
97STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
98OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
99OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
100OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
101OS_BOOT_SECPCI = STATE_DBUS_BASE + \
102    'Boot.Progress.ProgressStages.SecondaryProcInit'
103OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
104OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
105    'Boot.Progress.ProgressStages.MotherboardInit'
106
107# OperatingSystem status variables.
108OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
109    'OperatingSystem.Status.OSStatus.BootComplete'
110OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
111OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
112OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
113OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
114OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
115
116# Boot variables.
117BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
118BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
119BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
120BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
121BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
122BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
123BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
124
125# Time variables.
126TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
127BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
128HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
129SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
130BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
131NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
132MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
133
134# User manager variable.
135BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
136
137# LDAP User manager variable.
138BMC_LDAP_URI = BMC_USER_URI + 'ldap'
139
140# The path on the BMC where signed keys are stored.
141ACTIVATION_DIR_PATH = "/etc/activationdata/"
142
143# Redfish variables.
144REDFISH_BASE_URI = '/redfish/v1/'
145REDFISH_SESSION = REDFISH_BASE_URI + 'SessionService/Sessions'
146REDFISH_SESSION_URI = 'SessionService/Sessions/'
147REDFISH_NW_ETH0 = 'Managers/bmc/EthernetInterfaces/eth0/'
148REDFISH_NW_ETH0_URI = REDFISH_BASE_URI + REDFISH_NW_ETH0
149REDFISH_NW_PROTOCOL = 'Managers/bmc/NetworkProtocol'
150REDFISH_NW_PROTOCOL_URI = REDFISH_BASE_URI + REDFISH_NW_PROTOCOL
151REDFISH_ACCOUNTS_SERVICE = 'AccountService/'
152REDFISH_ACCOUNTS_SERVICE_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS_SERVICE
153REDFISH_ACCOUNTS = 'AccountService/Accounts/'
154REDFISH_ACCOUNTS_URI = REDFISH_BASE_URI + REDFISH_ACCOUNTS
155REDFISH_HTTPS_CERTIFICATE = 'Managers/bmc/NetworkProtocol/HTTPS/Certificates'
156REDFISH_HTTPS_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_HTTPS_CERTIFICATE
157REDFISH_LDAP_CERTIFICATE = 'AccountService/LDAP/Certificates'
158REDFISH_LDAP_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_LDAP_CERTIFICATE
159REDFISH_CA_CERTIFICATE = 'Managers/bmc/Truststore/Certificates'
160REDFISH_CA_CERTIFICATE_URI = REDFISH_BASE_URI + REDFISH_CA_CERTIFICATE
161REDFISH_CHASSIS_URI = REDFISH_BASE_URI + 'Chassis/'
162REDFISH_CHASSIS_THERMAL = 'chassis/Thermal/'
163REDFISH_CHASSIS_THERMAL_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_THERMAL
164REDFISH_CHASSIS_POWER = 'chassis/Power/'
165REDFISH_CHASSIS_POWER_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_POWER
166REDFISH_CHASSIS_PSUPPLY0 = 'powersupply0/Power/'
167REDFISH_CHASSIS_PSUPPLY1 = 'powersupply1/Power/'
168REDFISH_CHASSIS_PSUPPLY0_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_PSUPPLY0
169REDFISH_CHASSIS_PSUPPLY1_URI = REDFISH_CHASSIS_URI + REDFISH_CHASSIS_PSUPPLY1
170
171# Boot options and URI variables.
172POWER_ON = 'On'
173POWER_GRACEFUL_OFF = "GracefulShutdown"
174POWER_GRACEFUL_RESTART = "GracefulRestart"
175POWER_FORCE_OFF = 'ForceOff'
176
177REDFISH_POWER = 'Systems/system/Actions/ComputerSystem.Reset'
178REDFISH_POWER_URI = REDFISH_BASE_URI + REDFISH_POWER
179
180# rsyslog variables.
181REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
182
183# Certificate variables.
184SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
185CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
186CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
187
188# EventLog variables.
189SYSTEM_BASE_URI = REDFISH_BASE_URI + 'Systems/system/'
190EVENT_LOG_URI = SYSTEM_BASE_URI + 'LogServices/EventLog/'
191
192
193'''
194  QEMU HTTPS variable:
195
196  By default lib/resource.robot AUTH URI construct is as
197  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
198  ${AUTH_SUFFIX} is populated here by default EMPTY else
199  the port from the OS environment
200'''
201
202
203def get_port_https():
204    # defaulted to empty string
205    l_suffix = ''
206    try:
207        l_https_port = os.getenv('HTTPS_PORT')
208        if l_https_port:
209            l_suffix = ':' + l_https_port
210    except BaseException:
211        print ("Environment variable HTTPS_PORT not set,\
212              using default HTTPS port")
213    return l_suffix
214
215
216AUTH_SUFFIX = {
217    "https_port": [get_port_https()],
218}
219
220# Update the ':Port number' to this variable
221AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
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