Source code for stepler.horizon.steps.auth

"""
--------------------------------
Horizon steps for authentication
--------------------------------
"""

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from hamcrest import assert_that, less_than  # noqa

from stepler import config
from stepler.horizon.steps import base
from stepler.third_party import steps_checker
from stepler.third_party.utils import Timer


class AuthSteps(base.BaseSteps):
    """Authentication steps."""

    def _page_login(self):
        """Open login page if it's not opened."""
        return self._open(self.app.page_login)

    @steps_checker.step
    def login(self, username, password, check=True):
        """Step to log in user account.

        Arguments:
            - username: string, user name.
            - password: string, user password.
        """
        with self._page_login().form_login as form:
            form.field_username.value = username
            form.field_password.value = password
            form.submit()
            self.app.current_username = username

        if check:
            self.app.page_base.dropdown_menu_account.wait_for_presence(30)

    @steps_checker.step
    def logout(self, check=True):
        """Step to log out user account."""
        with self.app.page_base.dropdown_menu_account as menu:
            menu.click()
            menu.item_exit.click()
            self.app.current_username = None
            self.app.current_project = None

        if check:
            self.app.page_login.form_login.wait_for_presence(30)

    @steps_checker.step
    def check_alert_present(self):
        """Step to check alert message is present."""
        self._page_login().label_alert_message.wait_for_presence()

    @steps_checker.step
    def check_login_time(self):
        """Step to check time authorizing into Horizon."""
        with Timer() as timer:
            self._page_login()
        assert_that(timer.interval, less_than(config.UI_TIMEOUT_OPENING_PAGE))