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