xref: /openbmc/openbmc-test-automation/data/variables.py (revision c636aa06bb71bf06c44ca88c487911fed1b6944f) 
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# The path on the BMC where signed keys are stored.
137ACTIVATION_DIR_PATH = "/etc/activationdata/"
138
139'''
140  QEMU HTTPS variable:
141
142  By default lib/resource.txt AUTH URI construct is as
143  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
144  ${AUTH_SUFFIX} is populated here by default EMPTY else
145  the port from the OS environment
146'''
147
148
149def get_port_https():
150    # defaulted to empty string
151    l_suffix = ''
152    try:
153        l_https_port = os.getenv('HTTPS_PORT')
154        if l_https_port:
155            l_suffix = ':' + l_https_port
156    except BaseException:
157        print "Environment variable HTTPS_PORT not set,\
158              using default HTTPS port"
159    return l_suffix
160
161
162AUTH_SUFFIX = {
163    "https_port": [get_port_https()],
164}
165
166# Update the ':Port number' to this variable
167AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
168
169# Here contains a list of valid Properties bases on fru_type after a boot.
170INVENTORY_ITEMS = {
171    "CPU": [
172        "Custom Field 1",
173        "Custom Field 2",
174        "Custom Field 3",
175        "Custom Field 4",
176        "Custom Field 5",
177        "Custom Field 6",
178        "Custom Field 7",
179        "Custom Field 8",
180        "FRU File ID",
181        "Manufacturer",
182        "Name",
183        "Part Number",
184        "Serial Number",
185        "fault",
186        "fru_type",
187        "is_fru",
188        "present",
189        "version",
190    ],
191
192    "DIMM": [
193        "Asset Tag",
194        "Custom Field 1",
195        "Custom Field 2",
196        "Custom Field 3",
197        "Custom Field 4",
198        "Custom Field 5",
199        "Custom Field 6",
200        "Custom Field 7",
201        "Custom Field 8",
202        "FRU File ID",
203        "Manufacturer",
204        "Model Number",
205        "Name",
206        "Serial Number",
207        "Version",
208        "fault",
209        "fru_type",
210        "is_fru",
211        "present",
212        "version",
213    ],
214    "MEMORY_BUFFER": [
215        "Custom Field 1",
216        "Custom Field 2",
217        "Custom Field 3",
218        "Custom Field 4",
219        "Custom Field 5",
220        "Custom Field 6",
221        "Custom Field 7",
222        "Custom Field 8",
223        "FRU File ID",
224        "Manufacturer",
225        "Name",
226        "Part Number",
227        "Serial Number",
228        "fault",
229        "fru_type",
230        "is_fru",
231        "present",
232        "version",
233    ],
234    "FAN": [
235        "fault",
236        "fru_type",
237        "is_fru",
238        "present",
239        "version",
240    ],
241    "DAUGHTER_CARD": [
242        "Custom Field 1",
243        "Custom Field 2",
244        "Custom Field 3",
245        "Custom Field 4",
246        "Custom Field 5",
247        "Custom Field 6",
248        "Custom Field 7",
249        "Custom Field 8",
250        "FRU File ID",
251        "Manufacturer",
252        "Name",
253        "Part Number",
254        "Serial Number",
255        "fault",
256        "fru_type",
257        "is_fru",
258        "present",
259        "version",
260    ],
261    "BMC": [
262        "fault",
263        "fru_type",
264        "is_fru",
265        "manufacturer",
266        "present",
267        "version",
268    ],
269    "MAIN_PLANAR": [
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        "Part Number",
279        "Serial Number",
280        "Type",
281        "fault",
282        "fru_type",
283        "is_fru",
284        "present",
285        "version",
286    ],
287    "SYSTEM": [
288        "Custom Field 1",
289        "Custom Field 2",
290        "Custom Field 3",
291        "Custom Field 4",
292        "Custom Field 5",
293        "Custom Field 6",
294        "Custom Field 7",
295        "Custom Field 8",
296        "FRU File ID",
297        "Manufacturer",
298        "Model Number",
299        "Name",
300        "Serial Number",
301        "Version",
302        "fault",
303        "fru_type",
304        "is_fru",
305        "present",
306        "version",
307    ],
308    "CORE": [
309        "fault",
310        "fru_type",
311        "is_fru",
312        "present",
313        "version",
314    ],
315}
316