# -*- coding: utf-8 -*-

# Copyright (C) 2006-2020 CS GROUP - France

# License: GNU GPL v2 <http://www.gnu.org/licenses/gpl-2.0.html>

"""

Functional test suite for the root controller.

This is an example of how functional tests can be written for controllers.

As opposed to a unit-test, which test a small unit of functionality,

functional tests exercise the whole application and its WSGI stack.

Please read http://pythonpaste.org/webtest/ for more information.

"""

from nose.tools import assert_true, assert_false, assert_equal

from datetime import datetime

from calendar import timegm

import transaction

from vigilo.models.session import DBSession

from vigilo.models.demo import functions

from vigilo.models.tables import EventHistory, CorrEvent, User, \

                            Permission, Host, UserGroup, DataPermission

from vigiboard.tests import TestController

from tg import config

def populate_DB():

    """ Peuple la base de données. """

    # On ajoute un groupe d'hôtes et un groupe de services.

    supitemmanagers = functions.add_supitemgroup(u'managersgroup')

    usergroup = UserGroup.by_group_name(u'users_with_access')

    DBSession.add(DataPermission(

        group=supitemmanagers,

        usergroup=usergroup,

        access=u'w',

    ))

    DBSession.flush()

    # On crée un 2 hôtes, et on les ajoute au groupe d'hôtes.

    host1 = functions.add_host(u'host1')

    host2 = functions.add_host(u'host2')

    supitemmanagers.supitems.append(host1)

    supitemmanagers.supitems.append(host2)

    DBSession.flush()

    # On crée 2 services de bas niveau, et on les ajoute au groupe de services.

    service1 = functions.add_lowlevelservice(host1, u'service1')

    service2 = functions.add_lowlevelservice(host2, u'service2')

    supitemmanagers.supitems.append(service1)

    supitemmanagers.supitems.append(service2)

    DBSession.flush()

    return ([host1, host2], [service1, service2])

def add_correvent_caused_by(supitem, timestamp,

        correvent_status=CorrEvent.ACK_NONE, event_status=u"WARNING"):

    """

    Ajoute dans la base de données un évènement corrélé causé

    par un incident survenu sur l'item passé en paramètre.

    Génère un historique pour les tests.

    """

    # Ajout d'un événement brut et d'un événement corrélé.

    event = functions.add_event(supitem, event_status, u'foo')

    aggregate = functions.add_correvent([event], status=correvent_status)

    return aggregate.idcorrevent

class TestRootController(TestController):

    """ Classe de test du root controller """

    def setUp(self):

        super(TestRootController, self).setUp()

        perm = Permission.by_permission_name(u'vigiboard-access')

        perm2 = Permission.by_permission_name(u'vigiboard-update')

        user = User(

            user_name=u'access',

            fullname=u'',

            email=u'user.has@access',

        )

        usergroup = UserGroup(group_name=u'users_with_access')

        usergroup.permissions.append(perm)

        usergroup.permissions.append(perm2)

        user.usergroups.append(usergroup)

        DBSession.add(user)

        DBSession.add(usergroup)

        DBSession.flush()

        user = User(

            user_name=u'limited_access',

            fullname=u'',

            email=u'user.has.no@access',

        )

        usergroup = UserGroup(group_name=u'users_with_limited_access')

        usergroup.permissions.append(perm)

        usergroup.permissions.append(perm2)

        user.usergroups.append(usergroup)

        DBSession.add(user)

        DBSession.add(usergroup)

        DBSession.flush()

    def test_index(self):

        """Test that access to the root webpage is restricted."""

        response = self.app.get('/', status=401)

        msg = 'Unauthorized'

        assert_true(msg in response)

    def test_update_host_correvents_status(self):

        """Màj du statut d'évènements corrélés causés par des hôtes"""

        # On peuple la BDD avec 2 hôtes, 2 services de bas niveau,

        # et un groupe d'hôtes et de services associés à ces items.

        (hosts, _services) = populate_DB()

        # On ajoute 2 évènements corrélés causés par ces hôtes

        timestamp = datetime.utcnow()

        correvent1_id = add_correvent_caused_by(hosts[0], timestamp)

        correvent2_id = add_correvent_caused_by(hosts[1], timestamp)

        transaction.commit()

        ### 1er cas : L'utilisateur n'est pas connecté.

        # On vérifie que le plugin retourne bien une erreur 401.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : u"foo",

                "ack" : u'NoChange',

            }, status = 401)

        ### 2ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'limited_access'.

        environ = {'REMOTE_USER': 'limited_access'}

        # On s'attend à ce qu'une erreur 302 soit renvoyée, et à

        # ce qu'un message d'erreur précise à l'utilisateur qu'il

        # n'a pas la permission de modifier ces évènements.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "ack" : u'NoChange',

                "trouble_ticket" : u"foo",

                "last_modification": timegm(timestamp.utctimetuple()),

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        ### 3ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'access'.

        environ = {'REMOTE_USER': 'access'}

        # On s'attend à ce que le statut de la requête soit 302,

        # et à ce qu'un message informe l'utilisateur que les

        # évènements corrélés sélectionnées ont bien été mis à jour.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : u"foo",

                "ack" : u'NoChange',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_false(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="ok"]'))

        # On s'assure que le ticket de l'évènement corrélé

        # a bien été mis à jour dans la base de données.

        correvents = DBSession.query(

            CorrEvent.trouble_ticket

            ).filter(CorrEvent.idcorrevent.in_([correvent1_id, correvent2_id])

            ).all()

        assert_equal(correvents[0].trouble_ticket, u"foo")

        assert_equal(correvents[1].trouble_ticket, u"foo")

    def test_update_service_correvents_status(self):

        """Màj du statut d'évènements corrélés causés par des SBN"""

        # On peuple la BDD avec 2 hôtes, 2 services de bas niveau,

        # et un groupe d'hôtes et de services associés à ces items.

        (_hosts, services) = populate_DB()

        # On ajoute 2 évènements corrélés causés par ces hôtes

        timestamp = datetime.utcnow()

        correvent1_id = add_correvent_caused_by(services[0], timestamp)

        correvent2_id = add_correvent_caused_by(services[1], timestamp)

        transaction.commit()

        ### 1er cas : L'utilisateur n'est pas connecté.

        # On vérifie que le plugin retourne bien une erreur 401.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : u"foo",

                "ack" : u'NoChange',

            }, status = 401)

        ### 2ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'limited_access'.

        environ = {'REMOTE_USER': 'limited_access'}

        # On s'attend à ce qu'une erreur 302 soit renvoyée, et à

        # ce qu'un message d'erreur précise à l'utilisateur qu'il

        # n'a pas la permission de modifier ces évènements.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : u"foo",

                "ack" : u'NoChange',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        ### 3ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'access'.

        environ = {'REMOTE_USER': 'access'}

        # On s'attend à ce que le statut de la requête soit 302,

        # et à ce qu'un message informe l'utilisateur que les

        # évènements corrélés sélectionnées ont bien été mis à jour.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : u"foo",

                "ack" : u'NoChange',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_false(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="ok"]'))

        # On s'assure que le ticket de l'évènement corrélé

        # a bien été mis à jour dans la base de données.

        correvents = DBSession.query(

            CorrEvent.trouble_ticket

            ).filter(CorrEvent.idcorrevent.in_([correvent1_id, correvent2_id])

            ).all()

        assert_equal(correvents[0].trouble_ticket, u"foo")

        assert_equal(correvents[1].trouble_ticket, u"foo")

    def test_update_host_correvents_tickets(self):

        """Màj de tickets d'évènements corrélés causés par des hôtes"""

        # On peuple la BDD avec 2 hôtes, 2 services de bas niveau,

        # et un groupe d'hôtes et de services associés à ces items.

        (hosts, _services) = populate_DB()

        # On ajoute 2 évènements corrélés causés par ces hôtes

        timestamp = datetime.utcnow()

        correvent1_id = add_correvent_caused_by(hosts[0], timestamp)

        correvent2_id = add_correvent_caused_by(hosts[1], timestamp)

        transaction.commit()

        ### 1er cas : L'utilisateur n'est pas connecté.

        # On vérifie que le plugin retourne bien une erreur 401.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 401)

        ### 2ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'limited_access'.

        environ = {'REMOTE_USER': 'limited_access'}

        # On s'attend à ce qu'une erreur 302 soit renvoyée, et à

        # ce qu'un message d'erreur précise à l'utilisateur qu'il

        # n'a pas la permission de modifier ces évènements.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        ### 3ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'access'.

        environ = {'REMOTE_USER': 'access'}

        # On s'attend à ce que le statut de la requête soit 302,

        # et à ce qu'un message informe l'utilisateur que les

        # évènements corrélés sélectionnées ont bien été mis à jour.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_false(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="ok"]'))

        # On s'assure que le statut de l'évènement corrélé

        # a bien été mis à jour dans la base de données.

        correvents = DBSession.query(

            CorrEvent.ack

            ).filter(CorrEvent.idcorrevent.in_([correvent1_id, correvent2_id])

            ).all()

        assert_equal(correvents[0].ack, CorrEvent.ACK_KNOWN)

        assert_equal(correvents[1].ack, CorrEvent.ACK_KNOWN)

    def test_update_service_correvents_tickets(self):

        """Màj de tickets d'évènements corrélés causés par des SBN"""

        # On peuple la BDD avec 2 hôtes, 2 services de bas niveau,

        # et un groupe d'hôtes et de services associés à ces items.

        (_hosts, services) = populate_DB()

        # On ajoute 2 évènements corrélés causés par ces hôtes

        timestamp = datetime.utcnow()

        correvent1_id = add_correvent_caused_by(services[0], timestamp)

        correvent2_id = add_correvent_caused_by(services[1], timestamp)

        transaction.commit()

        ### 1er cas : L'utilisateur n'est pas connecté.

        # On vérifie que le plugin retourne bien une erreur 401.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 401)

        ### 2ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'limited_access'.

        environ = {'REMOTE_USER': 'limited_access'}

        # On s'attend à ce qu'une erreur 302 soit renvoyée, et à

        # ce qu'un message d'erreur précise à l'utilisateur qu'il

        # n'a pas la permission de modifier ces évènements.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        ### 3ème cas : L'utilisateur utilisé pour

        # se connecter à Vigiboard est 'access'.

        environ = {'REMOTE_USER': 'access'}

        # On s'attend à ce que le statut de la requête soit 302,

        # et à ce qu'un message informe l'utilisateur que les

        # évènements corrélés sélectionnées ont bien été mis à jour.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id) + "," + str(correvent2_id),

                "last_modification": timegm(timestamp.utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_false(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="ok"]'))

        # On s'assure que le statut de l'évènement corrélé

        # a bien été mis à jour dans la base de données.

        correvents = DBSession.query(

            CorrEvent.ack

            ).filter(CorrEvent.idcorrevent.in_([correvent1_id, correvent2_id])

            ).all()

        assert_equal(correvents[0].ack, CorrEvent.ACK_KNOWN)

        assert_equal(correvents[1].ack, CorrEvent.ACK_KNOWN)

    def test_update_while_data_have_changed(self):

        """Màj d'un évènement corrélé modifié entre temps."""

        # On peuple la BDD avec 2 hôtes, 2 services de bas niveau,

        # et un groupe d'hôtes et de services associés à ces items.

        (_hosts, services) = populate_DB()

        # On ajoute 2 évènements corrélés causés par ces hôtes

        timestamp = datetime.utcnow()

        correvent1_id = add_correvent_caused_by(services[0], timestamp)

        add_correvent_caused_by(services[1], timestamp)

        # Date de modification du premier évènement corrélé

        later_date = datetime.utcnow()

        # Date du chargement de la page

        date = timegm(later_date.utctimetuple()) - 42

        # On ajoute une entrée dans l'historique de l'évènement brut

        # causant le premier évènement corrélé, portant pour timestamp

        # une date postérieure à celle du chargement de la page.

        correvent1 = DBSession.query(

            CorrEvent.idcause

            ).filter(CorrEvent.idcorrevent == correvent1_id).one()

        DBSession.add(EventHistory(

            type_action = u'Nagios update state',

            idevent = correvent1.idcause,

            timestamp = later_date))

        DBSession.flush()

        transaction.commit()

        # L'utilisateur utilisé pour se connecter à Vigiboard est 'access'.

        environ = {'REMOTE_USER': 'access'}

        # On s'attend à ce que le statut de la requête soit 302, et

        # à ce qu'un message d'erreur avise l'utilisateur que des

        # changements sont intervenus depuis le chargement de la page.

        response = self.app.post(

            '/update', {

                "id" : str(correvent1_id),

                "last_modification" : date,

                "trouble_ticket" : "",

                "ack" : u'Acknowledged',

            }, status = 302, extra_environ = environ)

        response = response.follow(status=200, extra_environ = environ)

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="warning"]'))

        # On s'assure que le statut de l'évènement corrélé

        # n'a pas été modifié dans la base de données.

        status = DBSession.query(

            CorrEvent.ack

            ).filter(CorrEvent.idcorrevent == correvent1_id

            ).scalar()

        assert_equal(status, CorrEvent.ACK_NONE)

    def test_close_last_page(self):

        """

        Suppression de tous les événements de la dernière page.

        Lorsqu'on supprime tous les événements de la page, on doit

        implicitement afficher le contenu de la page d'avant.

        """

        # On crée autant d'événements qu'on peut en afficher par page + 1,

        # afin d'avoir 2 pages dans le bac à événements.

        items_per_page = int(config['vigiboard_items_per_page'])

        for i in xrange(items_per_page + 1):

            host = Host(

                name = u'host%d' % (i + 1),

                snmpcommunity = u'public',

                hosttpl = u'/dev/null',

                address = u'192.168.1.%d' % i,

                snmpport = 42,

            )

            DBSession.add(host)

            DBSession.flush()

            add_correvent_caused_by(host, datetime.utcnow())

        transaction.commit()

        environ = {'REMOTE_USER': 'manager'}

        # On vérifie qu'on a 2 pages et que sur la 2ème page,

        # il n'y a qu'un seul événement.

        response = self.app.get('/?page=2', extra_environ=environ)

        current_page = response.lxml.xpath(

            '//span[@class="pager_curpage"]/text()')

        assert_equal(2, int(current_page[0]))

        assert_equal(len(self.get_rows(response)), 1)

        assert_true(len(self.get_cells(response)) > 1)

        # On force l'état de l'événement sur la 2ème page à 'OK'.

        # - Tout d'abord, on récupère l'identifiant de l'événement en question.

        idcorrevent = response.lxml.xpath(

            'string(//table[contains(concat(" ", @class, " "), " vigitable ")]'

            '/tbody/tr/td[@class="plugin_details"]/a/@href)')

        idcorrevent = int(idcorrevent.lstrip('#'))

        # - Puis, on met à jour son état (en le forçant à OK).

        # On s'attend à ce que le statut de la requête soit 302,

        # et à ce qu'un message informe l'utilisateur que les

        # évènements corrélés sélectionnées ont bien été mis à jour.

        response = self.app.post(

            '/update', {

                "id" : str(idcorrevent),

                "last_modification": timegm(datetime.utcnow().utctimetuple()),

                "trouble_ticket" : "",

                "ack" : u'Forced',

            }, status=302, extra_environ=environ)

        # - On s'assure que la mise à jour a fonctionné.

        response = response.follow(status=200, extra_environ=environ)

        assert_false(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="error"]'))

        assert_true(response.lxml.xpath(

            '//div[@id="flash"]/div[@class="ok"]'))

        # - On vérifie qu'on se trouve à présent sur la 1ère page, et que

        # l'on y dénombre autant d'évènements qu'on peut en afficher par page

        current_page = response.lxml.xpath(

            '//span[@class="pager_curpage"]/text()')

        assert_equal(1, int(current_page[0]))

        assert_equal(len(self.get_rows(response)), items_per_page)

        assert_true(len(self.get_cells(response)) > 1)

        # Une requête sur la 2ème page doit désormais

        # afficher le contenu de la 1ère page.

        response = self.app.get('/?page=2', extra_environ=environ)

        current_page = response.lxml.xpath(

            '//span[@class="pager_curpage"]/text()')

        assert_equal(1, int(current_page[0]))

        assert_equal(len(self.get_rows(response)), items_per_page)