#!/usr/bin/env python
#
# Copyright (c) 2013 IBM Corp.
#
# 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.

"""
Test the ability to convert files into wsgi generators
"""


from os_loganalyze import filter as flt
from os_loganalyze.tests import base


class TestSupportsSevRegex(base.TestCase):
    def test_matching(self):
        def yes(fname):
            self.assertIsNotNone(flt.SUPPORTS_SEV.match(fname),
                                 "%s should have matched" % fname)

        def no(fname):
            self.assertIsNone(flt.SUPPORTS_SEV.match(fname),
                              "%s should not have matched" % fname)

        yes("n-api.txt.gz")
        yes("c-vol.txt.gz")
        yes("tempest.txt")
        yes("devstack@c-api.service.log.txt")
        # this specific bug was hit previously
        no("check/gate-horizon-python27/1dba20d/console.html")
        no("check/gate-tempest-dsvm-trove/c5950fc/console.html")
        no("check/neutron-tempest-plugin-dvr-multinode-scenario"
           "/42fb158/job-output.txt.gz")
        # NOTE(sdague): if we ever get edge conditions in the future,
        # please add checks in here.


class TestFilters(base.TestCase):

    def test_consolidated_filters(self):
        gen = self.get_generator('screen-q-svc.txt.gz', level='DEBUG')
        # we don't need the header, we just don't want to deal with it
        header = gen.next()
        self.assertIn("Display level: ", header)

        # first line is INFO
        line = gen.next()
        self.assertIn("class='INFO", line)
        self.assertIn("href='#_2013-09-27_18_22_11_248'", line)

        # second line is an ERROR
        line = gen.next()
        self.assertIn("class='ERROR", line)
        self.assertIn("href='#_2013-09-27_18_22_11_249'", line)

        # third is a DEBUG
        line = gen.next()
        self.assertIn("class='DEBUG", line)
        self.assertIn("href='#_2013-09-27_18_22_11_249'", line)

        # fourth is a CRITICAL
        line = gen.next()
        self.assertIn("class='CRITICAL", line)
        self.assertIn("href='#_2013-09-27_18_22_11_249'", line)

    def test_systemd_filters(self):
        gen = self.get_generator('devstack@c-api.service.log.txt')
        # dump the header
        gen.next()
        # dump the systemd line
        gen.next()

        # first line
        line = gen.next()
        self.assertIn("NONE", line)
        self.assertIn("href='#_Mar_28_12_20_42_377230'", line)

        # second line
        line = gen.next()
        self.assertIn("WARNING", line)
        self.assertIn("href='#_Mar_28_12_20_43_570064", line)
        # third line
        line = gen.next()
        self.assertIn("DEBUG", line)
        self.assertIn("href='#_Mar_28_12_20_44_172534'", line)

    def test_no_sev_matches_last_sev(self):
        gen = self.get_generator('devstack@c-vol.service.log.txt')
        # dump the header
        gen.next()

        # first line
        line = gen.next()
        self.assertIn("INFO", line)
        self.assertIn("href='#_May_26_20_44_32_276580'", line)

        # second line
        line = gen.next()
        self.assertIn("INFO", line)
        self.assertIn("Traceback", line)

        for x in range(9):
            # Skip ahead to first DEBUG line.
            line = gen.next()

        # First DEBUG line
        self.assertIn("DEBUG", line)
        self.assertIn("href='#_May_26_20_44_39_837651'", line)

        # Second DEBUG line
        self.assertIn("DEBUG", line)
        self.assertIn("cinder-rootwrap", line)

    def test_devstack_filters(self):
        gen = self.get_generator('devstacklog.txt.gz')
        # dump the header
        gen.next()

        # first line
        line = gen.next()
        self.assertIn("href='#_2014-03-17_16_11_24_173'", line)

    def test_devstack_filters_nodrop(self):
        gen = self.get_generator('devstacklog.txt.gz', level='INFO')

        header = gen.next()
        self.assertNotIn("Display level: ", header)

        # we shouldn't be dropping anything with the first line
        line = gen.next()
        self.assertIn("href='#_2014-03-17_16_11_24_173'", line)

    def test_html_file_filters(self):
        # do we avoid double escaping html files
        gen = self.get_generator('console.html.gz')

        header = gen.next()
        self.assertNotIn("Display level: ", header)

        # we shouldn't be dropping anything with the first line
        line = gen.next()
        self.assertIn(
            "<span class='NONE _2013-09-27_18_07_11_860'>"
            "<a name='_2013-09-27_18_07_11_860' class='date' "
            "href='#_2013-09-27_18_07_11_860'>2013-09-27 18:07:11.860</a> | "
            "Started by user <a href='https://jenkins02.openstack.org/user"
            "/null' class='model-link'>anonymous</a>\n</span>",
            line)

        line = gen.next()
        self.assertIn("<a name='_2013-09-27_18_07_11_884' "
                      "class='date' href='#_2013-09-27_18_07_11_884'>", line)

        line = gen.next()
        self.assertIn("<a name='_2013-09-27_18_09_18_784' "
                      "class='date' href='#_2013-09-27_18_09_18_784'>", line)

        # We've snuck some high-precision microsecond timestamps as
        # produced by zuul-runner in the end of this file; make sure
        # they are recognised.
        found = False
        for line in gen:
            look_for = "<span class='NONE _2013-09-27_18_47_33_342999'>" \
                       "<a name='_2013-09-27_18_47_33_342999' class='date' " \
                       "href='#_2013-09-27_18_47_33_342999'>" \
                       "2013-09-27 18:47:33.342999</a>"
            if line.startswith(look_for):
                found = True

        self.assertTrue(found)

    def test_html_escape(self):
        gen = self.get_generator('screen-n-api-2.txt.gz')
        # throw away header
        gen.next()

        line = gen.next()
        self.assertIn(
            "Calling method &lt;bound method Versions.index of "
            "&lt;nova.api.openstack.compute.versions.Versions object at "
            "0x371dad0&gt;&gt; _process_stack",
            line)

    def test_syslog_file_filter(self):
        gen = self.get_generator('syslog.txt')
        header = gen.next()
        self.assertIn("Display level: ", header)

        line = gen.next()
        self.assertIn("<span class='INFO", line)
        self.assertIn("object-replicator: Object replication complete.", line)
        line = gen.next()
        self.assertIn("<span class='INFO", line)
        self.assertIn("object-server: Started child 32090", line)
        line = gen.next()
        self.assertIn("<span class='DEBUG", line)
        self.assertIn('proxy-server: Pipeline is "catch_errors', line)

    def test_syslog_file_filter_nodebug(self):
        gen = self.get_generator('syslog.txt', level='INFO')
        header = gen.next()
        self.assertIn("Display level: ", header)

        line = gen.next()
        self.assertIn("<span class='INFO", line)
        self.assertIn("object-replicator: Object replication complete.", line)
        line = gen.next()
        self.assertIn("<span class='INFO", line)
        self.assertIn("object-server: Started child 32090", line)
        line = gen.next()
        self.assertIn("<span class='INFO", line)
        self.assertIn('object-server: SIGTERM received', line)

    def test_limit_filters(self):
        gen = self.get_generator('devstacklog.txt.gz', limit=10)

        lines = 0
        for line in gen:
            lines += 1

        # the lines should actually be 2 + the limit we've asked for
        # given the header and footer
        self.assertEqual(12, lines)