cfme.containers.provider package

Submodules

• cfme.containers.provider.kubernetes module
• cfme.containers.provider.openshift module

Module contents

class cfme.containers.provider.AdHocMain(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of AdHocMetricsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.AdHocMetricsView(parent, logger=None, **kwargs)

Bases: cfme.base.login.BaseLoggedInPage

apply_btn

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.

apply_filter()

filter_dropdown

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.

filter_result_header

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.

get_random_filter()

get_total_results_count()

is_displayed

selected_filter = None

set_filter(desired_filter)

wait_for_filter_option_to_load()

wait_for_results_to_load()

class cfme.containers.provider.Add(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainersProviderAddView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.All(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainersProvidersView

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.

resetter()

step()

class cfme.containers.provider.ContainerObjectAllBaseView(parent, logger=None, **kwargs)

Bases: cfme.common.provider_views.ProvidersView

Base class for container object All view. TITLE_TEXT should be defined in child.

download

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.

entities

is_displayed

policy

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.

table

title()

class cfme.containers.provider.ContainersProvider(name=None, key=None, zone=None, endpoints=None, provider_data=None, appliance=None)

Bases: cfme.common.provider.BaseProvider, utils.pretty.Pretty

PLURAL = 'Providers'

STATS_TO_MATCH = ['num_project', 'num_service', 'num_replication_controller', 'num_pod', 'num_node', 'num_image_registry', 'num_container']

category = 'container'

db_types = ['ContainerManager']

detail_page_suffix = 'provider_detail'

edit_page_suffix = 'provider_edit_detail'

endpoints_form

alias of ContainersProviderEndpointsForm

get_detail(*ident)

Gets details from the details infoblock

Parameters:*ident – An InfoBlock title, followed by the Key name, e.g. “Relationships”, “Images”

Returns: A string representing the contents of the InfoBlock’s value.

in_version = ('5.5', Version('master'))

load_details(refresh=False)

num_container(*args, **kwargs)

num_container_group(*args, **kwargs)

num_container_group_ui = None

num_container_ui = None

num_image(*args, **kwargs)

num_image_registry(*args, **kwargs)

num_image_registry_ui = None

num_image_ui = None

num_node(*args, **kwargs)

num_node_ui = None

num_pod(*args, **kwargs)

num_pod_ui = None

num_project(*args, **kwargs)

num_project_ui = None

num_replication_controller(*args, **kwargs)

num_replication_controller_ui = None

num_service(*args, **kwargs)

num_service_ui = None

page_name = 'containers'

pods_per_ready_status()

Grabing the Container Statuses Summary of the pods from API

pretty_attrs = ['name', 'key', 'zone']

provider_types = {}

quad_name = None

string_name = 'Containers'

view_value_mapping

class cfme.containers.provider.ContainersProviderDefaultEndpoint(**kwargs)

Bases: cfme.common.provider.DefaultEndpoint

Represents Containers Provider default endpoint

credential_class

alias of TokenCredential

view_value_mapping

class cfme.containers.provider.ContainersProviderEndpointsForm(parent, logger=None, **kwargs)

Bases: widgetastic.widget.View

represents default Containers Provider endpoint form in UI (Add/Edit dialogs)

default

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.

hawkular

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.containers.provider.ContainersTestItem(obj, polarion_id, **additional_attrs)

Bases: object

This is a generic test item. Especially used for parametrized functions

classmethod get_pretty_id(obj)

Since sometimes the test object is wrapped within markers, it’s difficult to find get it inside the args tree. hence we use this to get the object and all pretty_id function.

Parameters:obj (*) – Either a ContainersTestItem or a marker that include it Returns:str pretty id

pretty_id()

class cfme.containers.provider.Details(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProviderDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter()

step()

class cfme.containers.provider.Edit(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ContainersProviderEditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.EditFromDetails(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.EditTags(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.EditTagsFromDetails(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.Labelable

Bases: object

Provide the functionality to set labels

get_labels()

List labels

remove_label(name, silent_failure=False)

Remove label by name. :param name: name of label :param silent_failure: whether to raise an error or not in case of failure.

Returns: bool pass or fail

Raises:LabelNotFoundException.

set_label(name, value)

Sets a label to the object instance

:param : var name: the name of the label :param : var value: the value of the label

Returns:self.mgmt.set_label return value.

class cfme.containers.provider.LoggingableView(parent, logger=None, **kwargs)

Bases: widgetastic.widget.View

get_logging_url()

monitor

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.containers.provider.ProviderDetailsView(parent, logger=None, **kwargs)

Bases: cfme.base.login.BaseLoggedInPage, cfme.containers.provider.LoggingableView

is_displayed

class cfme.containers.provider.TimelinesFromDetails(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

class cfme.containers.provider.TopologyFromDetails(obj, navigate_obj)

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that 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 NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step()

cfme.containers.provider.navigate_and_get_rows(provider, obj, count, silent_failure=False)

Get <count> random rows from the obj list table, if <count> is greater that the number of rows, return number of rows.

Parameters:

• provider – containers provider
• obj – the containers object
• table – the object’s Table object
• count – number of random rows to return
• silent_failure – If True and no records found for obj, it’ll return None instead of raise exception

return: list of rows