cfme.dashboard module

class cfme.dashboard.Dashboard(parent, name)[source]

Bases: cfme.modeling.base.BaseEntity

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

dashboard_view

Returns a view pointed at a particular dashboard.

drag_and_drop(dragged_widget_or_name, dropped_widget_or_name)[source]

Drags and drops widgets onto each other.

name = Attribute(name='name', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
class cfme.dashboard.DashboardCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection

Represents the Dashboard page and can jump around various dashboards present.

ENTITY

alias of Dashboard

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

all()[source]
close_zoom()[source]

Closes any zoomed widget.

default

Returns an instance of the Default Dashboard

refresh()[source]

Refreshes the dashboard view by forcibly clicking the navigation again.

zoomed_name

Grabs the name of the currently zoomed widget.

class cfme.dashboard.DashboardDetails(obj, navigate_obj)[source]

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ParticularDashboardView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()[source]
class cfme.dashboard.DashboardView(*args, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

View that represents the Intelligence/Dashboard.

add_widget

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

dashboards

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

ensure_zoom_closed(*args, **kwargs)[source]
is_displayed
reset_button

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reset_widgets(*args, **kwargs)[source]

Clicks the reset button to reset widgets and handles the alert.

zoomed

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.dashboard.DashboardWidget(parent, name)[source]

Bases: cfme.modeling.base.BaseEntity

Represents a single UI dashboard widget.

Parameters:
  • name – Name of the widget as displayed in the title.
  • widget_collection – The widget collection linked to a dashboard
__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

blank

Returns whether the widget has not been generated before.

can_zoom

Returns whether this widget can be zoomed.

close_zoom()[source]

Close zoom. Works theoretically for any widget, it is just exposed here.

content_type

Returns the type of content of this widget

contents

Returns the WT widget with contents of this dashboard widget.

dashboard
footer

Return parsed footer value

is_zoomed

Returns whether this widget is zoomed now.

last_in_column

Returns whether this widget is the last in its column

minimize()[source]

Minimize this widget.

minimized

Returns whether the widget is minimized or not.

name = Attribute(name='name', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
remove()[source]

Remove this widget.

restore()[source]

Maximize this widget.

time_next

Returns a datetime when the widget will be updated.

time_updated

Returns a datetime when the widget was last updated.

widget_view

Returns a view of the particular widget.

zoom()[source]

Zoom this widget in.

class cfme.dashboard.DashboardWidgetCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection

ENTITY

alias of DashboardWidget

__eq__(other)

Automatically created by attrs.

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Automatically created by attrs.

__repr__()

Automatically created by attrs.

all(content_type=None)[source]
dashboard_view
reset(cancel=False)[source]

Clicks the Reset widgets button.

class cfme.dashboard.Kebab(*args, **kwargs)[source]

Bases: widgetastic.widget.Widget

The so-called “kebab” widget of Patternfly.

<http://www.patternfly.org/pattern-library/widgets/#kebabs>

Parameters:button_id – id of the button tag inside the kebab. If not specified, first kebab available will be used
BUTTON = './button'
ITEM = './ul/li/a[normalize-space(.)={}]'
ITEMS = './ul/li/a'
ROOT
UL = './ul[contains(@class, "dropdown-menu")]'
close(*args, **kwargs)[source]

Close the kebab

is_opened

Returns opened state of the kebab.

items

Lists all items in the kebab.

Returns:list of str
open(*args, **kwargs)[source]

Open the kebab

select(*args, **kwargs)[source]

Select a specific item from the kebab.

Parameters:
  • item – Item to be selected.
  • close – Whether to close the kebab after selection. If the item is a link, you may want to set this to False
class cfme.dashboard.ParticularDashboardView(*args, **kwargs)[source]

Bases: cfme.dashboard.DashboardView

is_displayed