xref: /openbmc/openbmc-test-automation/data/variables.py (revision 7eea8ed0e85c244a0f166df8a5f9b7d7f83d51c8) 
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/'
146
147# Boot options and URI variables.
148POWER_ON = 'On'
149POWER_GRACEFULL_OFF = "GracefulShutdown"
150POWER_FORCE_OFF = 'ForceOff'
151
152REDFISH_POWER_URI = 'Systems/1/Actions/ComputerSystem.Reset'
153
154# rsyslog variables.
155REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
156
157# Certificate variables.
158SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
159CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
160CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
161
162'''
163  QEMU HTTPS variable:
164
165  By default lib/resource.txt AUTH URI construct is as
166  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
167  ${AUTH_SUFFIX} is populated here by default EMPTY else
168  the port from the OS environment
169'''
170
171
172def get_port_https():
173    # defaulted to empty string
174    l_suffix = ''
175    try:
176        l_https_port = os.getenv('HTTPS_PORT')
177        if l_https_port:
178            l_suffix = ':' + l_https_port
179    except BaseException:
180        print ("Environment variable HTTPS_PORT not set,\
181              using default HTTPS port")
182    return l_suffix
183
184
185AUTH_SUFFIX = {
186    "https_port": [get_port_https()],
187}
188
189# Update the ':Port number' to this variable
190AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
191
192# Here contains a list of valid Properties bases on fru_type after a boot.
193INVENTORY_ITEMS = {
194    "CPU": [
195        "Custom Field 1",
196        "Custom Field 2",
197        "Custom Field 3",
198        "Custom Field 4",
199        "Custom Field 5",
200        "Custom Field 6",
201        "Custom Field 7",
202        "Custom Field 8",
203        "FRU File ID",
204        "Manufacturer",
205        "Name",
206        "Part Number",
207        "Serial Number",
208        "fault",
209        "fru_type",
210        "is_fru",
211        "present",
212        "version",
213    ],
214
215    "DIMM": [
216        "Asset Tag",
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        "Model Number",
228        "Name",
229        "Serial Number",
230        "Version",
231        "fault",
232        "fru_type",
233        "is_fru",
234        "present",
235        "version",
236    ],
237    "MEMORY_BUFFER": [
238        "Custom Field 1",
239        "Custom Field 2",
240        "Custom Field 3",
241        "Custom Field 4",
242        "Custom Field 5",
243        "Custom Field 6",
244        "Custom Field 7",
245        "Custom Field 8",
246        "FRU File ID",
247        "Manufacturer",
248        "Name",
249        "Part Number",
250        "Serial Number",
251        "fault",
252        "fru_type",
253        "is_fru",
254        "present",
255        "version",
256    ],
257    "FAN": [
258        "fault",
259        "fru_type",
260        "is_fru",
261        "present",
262        "version",
263    ],
264    "DAUGHTER_CARD": [
265        "Custom Field 1",
266        "Custom Field 2",
267        "Custom Field 3",
268        "Custom Field 4",
269        "Custom Field 5",
270        "Custom Field 6",
271        "Custom Field 7",
272        "Custom Field 8",
273        "FRU File ID",
274        "Manufacturer",
275        "Name",
276        "Part Number",
277        "Serial Number",
278        "fault",
279        "fru_type",
280        "is_fru",
281        "present",
282        "version",
283    ],
284    "BMC": [
285        "fault",
286        "fru_type",
287        "is_fru",
288        "manufacturer",
289        "present",
290        "version",
291    ],
292    "MAIN_PLANAR": [
293        "Custom Field 1",
294        "Custom Field 2",
295        "Custom Field 3",
296        "Custom Field 4",
297        "Custom Field 5",
298        "Custom Field 6",
299        "Custom Field 7",
300        "Custom Field 8",
301        "Part Number",
302        "Serial Number",
303        "Type",
304        "fault",
305        "fru_type",
306        "is_fru",
307        "present",
308        "version",
309    ],
310    "SYSTEM": [
311        "Custom Field 1",
312        "Custom Field 2",
313        "Custom Field 3",
314        "Custom Field 4",
315        "Custom Field 5",
316        "Custom Field 6",
317        "Custom Field 7",
318        "Custom Field 8",
319        "FRU File ID",
320        "Manufacturer",
321        "Model Number",
322        "Name",
323        "Serial Number",
324        "Version",
325        "fault",
326        "fru_type",
327        "is_fru",
328        "present",
329        "version",
330    ],
331    "CORE": [
332        "fault",
333        "fru_type",
334        "is_fru",
335        "present",
336        "version",
337    ],
338}
339