""" A model of a Cloud Provider in CFME
"""
import attr
from navmazing import NavigateToSibling, NavigateToAttribute
from widgetastic.exceptions import MoveTargetOutOfBoundsException
from widgetastic.widget import View
from widgetastic_patternfly import Dropdown
from cfme.base.login import BaseLoggedInPage
from cfme.common import TagPageView
from cfme.common.provider import CloudInfraProvider, provider_types
from cfme.common.provider_views import (
CloudProviderAddView, CloudProviderEditView, CloudProviderDetailsView, CloudProvidersView,
CloudProvidersDiscoverView)
from cfme.common.vm_views import VMToolbar, VMEntities
from cfme.modeling.base import BaseCollection
from cfme.utils.appliance.implementations.ui import navigator, navigate_to, CFMENavigateStep
from cfme.utils.log import logger
from cfme.utils.pretty import Pretty
from cfme.utils.wait import wait_for
from widgetastic_manageiq import TimelinesView, BreadCrumb, ItemsToolBarViewSelector
[docs]class CloudProviderTimelinesView(TimelinesView, BaseLoggedInPage):
breadcrumb = BreadCrumb()
@property
def is_displayed(self):
return (
self.logged_in_as_current_user and
self.navigation.currently_selected == ['Compute', 'Clouds', 'Providers'] and
'{} (Summary)'.format(self.context['object'].name) in self.breadcrumb.locations and
self.is_timelines)
[docs]class CloudProviderInstancesView(BaseLoggedInPage):
"""
The collection page for provider instances
"""
@property
def is_displayed(self):
return (
self.breadcrumb.locations[0] == 'Cloud Providers' and
self.entities.title.text == '{} (All Instances)'.format(self.context['object'].name))
breadcrumb = BreadCrumb()
toolbar = View.nested(VMToolbar)
including_entities = View.include(VMEntities, use_parent=True)
[docs]class CloudProviderImagesView(BaseLoggedInPage):
"""
The collection page for provider images
"""
@property
def is_displayed(self):
return (
self.breadcrumb.locations[0] == 'Cloud Providers' and
self.entities.title.text == '{} (All Images)'.format(self.context['object'].name))
breadcrumb = BreadCrumb()
toolbar = View.nested(CloudProviderImagesToolbar)
including_entities = View.include(VMEntities, use_parent=True)
@attr.s(hash=False)
[docs]class CloudProvider(Pretty, CloudInfraProvider):
"""
Abstract model of a cloud provider in cfme. See EC2Provider or OpenStackProvider.
Args:
name: Name of the provider.
endpoints: one or several provider endpoints like DefaultEndpoint. it should be either dict
in format dict{endpoint.name, endpoint, endpoint_n.name, endpoint_n}, list of endpoints or
mere one endpoint
# TODO: update all provider doc strings when provider conversion is done
Usage:
credentials = Credential(principal='bad', secret='reallybad')
endpoint = DefaultEndpoint(hostname='some_host', region='us-west', credentials=credentials)
myprov = collections.instantiate(prov_class=OpenStackProvider, name='foo',
endpoints=endpoint)
myprov.create()
"""
provider_types = {}
category = "cloud"
pretty_attrs = ['name', 'credentials', 'zone', 'key']
STATS_TO_MATCH = ['num_template', 'num_vm']
string_name = "Cloud"
templates_destination_name = "Images"
vm_name = "Instances"
template_name = "Images"
db_types = ["CloudManager"]
name = attr.ib(default=None)
key = attr.ib(default=None)
zone = attr.ib(default=None)
def __attrs_post_init__(self):
super(CloudProvider, self).__attrs_post_init__()
self.parent = self.appliance.collections.cloud_providers
[docs] def as_fill_value(self):
return self.name
@property
def view_value_mapping(self):
"""Maps values to view attrs"""
return {'name': self.name}
@staticmethod
[docs] def discover_dict(credential):
"""Returns the discovery credentials dictionary, needs overiding"""
raise NotImplementedError("This provider doesn't support discovery")
@attr.s
[docs]class CloudProviderCollection(BaseCollection):
"""Collection object for CloudProvider object
"""
ENTITY = CloudProvider
[docs] def all(self):
view = navigate_to(self, 'All')
provs = view.entities.get_all(surf_pages=True)
# trying to figure out provider type and class
# todo: move to all providers collection later
def _get_class(pid):
prov_type = self.appliance.rest_api.collections.providers.get(id=pid)['type']
for prov_class in provider_types('cloud').values():
if prov_class.db_types[0] in prov_type:
return prov_class
return [self.instantiate(prov_class=_get_class(p.data['id']), name=p.name) for p in provs]
[docs] def instantiate(self, prov_class, *args, **kwargs):
return prov_class.from_collection(self, *args, **kwargs)
[docs] def create(self, prov_class, *args, **kwargs):
# ugly workaround until I move everything to main class
class_attrs = [at.name for at in attr.fields(prov_class)]
init_kwargs = {}
create_kwargs = {}
for name, value in kwargs.items():
if name not in class_attrs:
create_kwargs[name] = value
else:
init_kwargs[name] = value
obj = self.instantiate(prov_class, *args, **init_kwargs)
obj.create(**create_kwargs)
return obj
[docs] def discover(self, credential, discover_cls, cancel=False):
"""
Discover cloud providers. Note: only starts discovery, doesn't
wait for it to finish.
Args:
credential (cfme.base.credential.Credential): Discovery credentials.
cancel (boolean): Whether to cancel out of the discover UI.
discover_cls: class of the discovery item
"""
view = navigate_to(self, 'Discover')
if discover_cls:
view.fill({'discover_type': discover_cls.discover_name})
view.fields.fill(discover_cls.discover_dict(credential))
if cancel:
view.cancel.click()
else:
view.start.click()
# todo: combine with discover ?
[docs] def wait_for_new_provider(self):
view = navigate_to(self, 'All')
logger.info('Waiting for a provider to appear...')
wait_for(lambda: int(view.entities.paginator.items_amount), fail_condition=0,
message="Wait for any provider to appear", num_sec=1000,
fail_func=view.browser.refresh)
# todo: to remove those register statements when all providers are turned into collections
@navigator.register(CloudProvider, 'All')
@navigator.register(CloudProviderCollection, 'All')
[docs]class All(CFMENavigateStep):
VIEW = CloudProvidersView
prerequisite = NavigateToAttribute('appliance.server', 'LoggedIn')
[docs] def step(self):
self.prerequisite_view.navigation.select('Compute', 'Clouds', 'Providers')
[docs] def resetter(self):
self.appliance.browser.widgetastic.browser.refresh()
tb = self.view.toolbar
if 'Grid View' not in tb.view_selector.selected:
tb.view_selector.select('Grid View')
self.view.entities.paginator.reset_selection()
@navigator.register(CloudProvider, 'Add')
@navigator.register(CloudProviderCollection, 'Add')
[docs]class New(CFMENavigateStep):
VIEW = CloudProviderAddView
prerequisite = NavigateToSibling('All')
[docs] def step(self):
self.prerequisite_view.toolbar.configuration.item_select('Add a New Cloud Provider')
@navigator.register(CloudProvider, 'Discover')
@navigator.register(CloudProviderCollection, 'Discover')
[docs]class Discover(CFMENavigateStep):
VIEW = CloudProvidersDiscoverView
prerequisite = NavigateToSibling('All')
[docs] def step(self):
self.prerequisite_view.toolbar.configuration.item_select('Discover Cloud Providers')
@navigator.register(CloudProvider, 'Details')
[docs]class Details(CFMENavigateStep):
VIEW = CloudProviderDetailsView
prerequisite = NavigateToSibling('All')
[docs] def step(self):
self.prerequisite_view.entities.get_entity(name=self.obj.name, surf_pages=True).click()
@navigator.register(CloudProvider, 'Edit')
[docs]class Edit(CFMENavigateStep):
VIEW = CloudProviderEditView
prerequisite = NavigateToSibling('All')
[docs] def step(self):
self.prerequisite_view.entities.get_entity(name=self.obj.name, surf_pages=True).check()
try:
self.prerequisite_view.toolbar.configuration.item_select('Edit Selected Cloud Provider')
except MoveTargetOutOfBoundsException:
# TODO: Remove once fixed 1475303
self.prerequisite_view.toolbar.configuration.item_select('Edit Selected Cloud Provider')
@navigator.register(CloudProvider, 'EditFromDetails')
[docs]class EditFromDetails(CFMENavigateStep):
VIEW = CloudProviderEditView
prerequisite = NavigateToSibling('Details')
[docs] def step(self):
self.prerequisite_view.toolbar.configuration.item_select('Edit this Cloud Provider')
@navigator.register(CloudProvider, 'EditTags')
@navigator.register(CloudProvider, 'Timelines')
[docs]class Timelines(CFMENavigateStep):
VIEW = CloudProviderTimelinesView
prerequisite = NavigateToSibling('Details')
[docs] def step(self):
mon = self.prerequisite_view.toolbar.monitoring
try:
mon.item_select('Timelines')
except MoveTargetOutOfBoundsException:
# TODO: Remove once fixed 1475303
mon.item_select('Timelines')
@navigator.register(CloudProvider, 'Instances')
[docs]class Instances(CFMENavigateStep):
VIEW = CloudProviderInstancesView
prerequisite = NavigateToSibling('Details')
[docs] def step(self, *args, **kwargs):
self.prerequisite_view.entities.summary("Relationships").click_at('Instances')
@navigator.register(CloudProvider, 'Images')
[docs]class Images(CFMENavigateStep):
VIEW = CloudProviderImagesView
prerequisite = NavigateToSibling('Details')
[docs] def step(self, *args, **kwargs):
self.prerequisite_view.entities.summary("Relationships").click_at('Images')