stream_test.py

#!/usr/bin/env python3

# Copyright 2017 The Kubernetes Authors.
#
# 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.

# pylint: disable=missing-docstring, line-too-long

import unittest

from parameterized import parameterized

import stream
import make_db_test
import model

class FakePullResponse:
    def __init__(self, messages):
        self.received_messages = messages

class FakeReceivedMessage:
    def __init__(self, ack_id, message):
        self.ack_id = ack_id
        self.message = message

class FakePubSubMessage:
    def __init__(self, data, attributes):
        self.data = data
        self.attributes = attributes

class FakeSub:
    def __init__(self, fake_pr):
        self.fake_pr = fake_pr
        self.trace = []

    def pull(self, subscription, return_immediately=False, **_kwargs):
        self.trace.append(['pull', subscription, return_immediately])
        return self.fake_pr.pop(0)

    def acknowledge(self, subscription, ack_ids):
        self.trace.append(['ack', subscription, ack_ids])

    def modify_ack_deadline(self, subscription, ack_ids, ack_deadline_seconds):
        self.trace.append(['modify-ack', subscription, ack_ids, ack_deadline_seconds])

class FakeClient:
    def __init__(self, trace=None):
        self.trace = [] if trace is None else trace

    def insert_rows(self, _, *args, **kwargs):
        self.trace.append(['insert-rows', args, kwargs])
        return []

class FakeTable:
    def __init__(self, name, schema):
        self.full_table_id = f'bq.table.{name}'
        self.schema = schema

class FakeSchemaField:
    def __init__(self, **kwargs):
        self.__dict__ = kwargs

class HelperTest(unittest.TestCase):

    @parameterized.expand([
        (
            "No BucketID match",
            "NA",
            "IDontExist",
            {'Bucket':{}, 'OtherBucekt':{}},
            False,
        ),
        (
            "No excluded jobs",
            "pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164A/finished.json",
            "Bucket",
            {'Bucket':{}, 'OtherBucekt':{}},
            False,
        ),
        (
            "No excluded jobs match",
            "pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164A/finished.json",
            "Bucket",
            {'Bucket':{'exclude_jobs':['foo', 'bar']}, 'OtherBucekt':{}},
            False,
        ),
        (
            "No excluded jobs partial match",
            "pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164A/finished.json",
            "Bucket",
            {'Bucket':{'exclude_jobs':['foo', 'bar', 'pull-kubernetes']}, 'OtherBucekt':{}},
            False,
        ),
        (
            "Excluded jobs match",
            "pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164A/finished.json",
            "Bucket",
            {'Bucket':{'exclude_jobs':['foo', 'bar', 'pull-kubernetes-bazel-test']}, 'OtherBucekt':{}},
            True,
        ),
    ])
    def test_should_exclude(self, _, object_id, bucket_id, buckets, expected):
        got = stream.should_exclude(object_id, bucket_id, buckets)
        self.assertEqual(got, expected)


class StreamTest(unittest.TestCase):

    fake_buckets = {'kubernetes-jenkins':
                        {'contact': 'bentheelder',
                         'prefix': '',
                         'sequential': False,
                         'exclude_jobs': ['ci-test-infra-benchmark-demo',
                                          'ci-kubernetes-coverage-unit']
                        }
                    }

    @parameterized.expand([
        (
            "No retsults",
            [],
            ([], []),
        ),
        (
            "Base results",
            [
                FakeReceivedMessage(
                    'a', FakePubSubMessage(
                        'no_data', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164A/finished.json',
                            'bucketId': 'kubernetes-jenkins'})),
                FakeReceivedMessage(
                    'b', FakePubSubMessage(
                        'no_data2', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164B/finished.json',
                            'bucketId': 'kubernetes-jenkins'}))
            ],
            ([], [
                ('a', "gs://kubernetes-jenkins/pr-logs/pull/100038/pull-kubernetes-bazel-test", "136941941204137164A"),
                ('b', "gs://kubernetes-jenkins/pr-logs/pull/100038/pull-kubernetes-bazel-test", "136941941204137164B"),
            ])
        ),
        (
            "Object not finsihed",
            [
                FakeReceivedMessage(
                    'a', FakePubSubMessage(
                        'no_data', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164A/started.json',
                            'bucketId': 'kubernetes-jenkins'})),
                FakeReceivedMessage(
                    'b', FakePubSubMessage(
                        'no_data2', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'pr-logs/pull/100038/pull-kubernetes-bazel-test/136941941204137164B/finished.json',
                            'bucketId': 'kubernetes-jenkins'}))
            ],
            (['a'], [
                ('b', "gs://kubernetes-jenkins/pr-logs/pull/100038/pull-kubernetes-bazel-test", "136941941204137164B"),
            ])
        ),
        (
            "Excluded Job",
            [
                FakeReceivedMessage(
                    'a', FakePubSubMessage(
                        'no_data', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'pr-logs/pull/100038/ci-test-infra-benchmark-demo/136941941204137164A/started.json',
                            'bucketId': 'kubernetes-jenkins'})),
                FakeReceivedMessage(
                    'b', FakePubSubMessage(
                        'no_data2', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'pr-logs/pull/100038/ci-test-infra-benchmark-demo/136941941204137164B/finished.json',
                            'bucketId': 'kubernetes-jenkins'}))
            ],
            (['a', 'b'], [])
        ),
    ])
    def test_process_changes(self, _, results, expected):
        result = stream.process_changes(results, self.fake_buckets)
        self.assertEqual(result, expected)

    def test_main(self):
        # It's easier to run a full integration test with stubbed-out
        # external interfaces and validate the trace than it is to test
        # each individual piece.
        # The components are mostly tested in make_*_test.py.

        db = model.Database(':memory:')
        fake_sub = FakeSub(
            [
                FakePullResponse(
                    [FakeReceivedMessage(
                        'b',
                        FakePubSubMessage(
                            'no_data', {
                                'eventType': 'OBJECT_FINALIZE',
                                'objectId': 'logs/fake/123/finished.json',
                                'bucketId': 'kubernetes-jenkins'})
                    )]
                ),
                FakePullResponse([]),
                FakePullResponse(
                    [FakeReceivedMessage(
                        'c',
                        FakePubSubMessage('no_data', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'logs/fake/123/finished.json',
                            'bucketId': 'kubernetes-jenkins'})
                    )]
                ),
                FakePullResponse([]),
                FakePullResponse(
                    [FakeReceivedMessage(
                        'd',
                        FakePubSubMessage('no_data', {
                            'eventType': 'OBJECT_FINALIZE',
                            'objectId': 'logs/fake/124/started.json',
                            'bucketId': 'kubernetes-jenkins'})
                    )]
                ),
                FakePullResponse([]),
            ]
        )
        fake_client = FakeClient()
        fake_table = FakeTable('day', stream.load_schema(FakeSchemaField))
        fake_sub_path = 'projects/{project_id}/subscriptions/{sub}'
        tables = {'day': (fake_table, 'incr')}
        stream.main(
            db,
            fake_sub, fake_sub_path,
            fake_client, tables, self.fake_buckets,
            make_db_test.MockedClient, [1, 0, 0, 0].pop)

        # uncomment if the trace changes
        # import pprint; pprint.pprint(fake_sub.trace)
        # import pprint; pprint.pprint(fake_client.trace)
        # self.maxDiff = 3000

        now = make_db_test.MockedClient.NOW

        self.assertEqual(
            fake_sub.trace,
            [['pull', fake_sub_path, False],
             ['pull', fake_sub_path, True],
             ['modify-ack', fake_sub_path, ['b'], 180],
             ['ack', fake_sub_path, ['b']],
             ['pull', fake_sub_path, False],
             ['pull', fake_sub_path, True],
             ['modify-ack', fake_sub_path, ['c'], 180],
             ['ack', fake_sub_path, ['c']],
             ['pull', fake_sub_path, False],
             ['pull', fake_sub_path, True],
             ['ack', fake_sub_path, ['d']]])

        self.assertEqual(
            fake_client.trace,
            [['insert-rows',
              ([{'elapsed': 5,
                 'finished': now,
                 'job': 'fake',
                 'number': 123,
                 'passed': True,
                 'path': 'gs://kubernetes-jenkins/logs/fake/123',
                 'result': 'SUCCESS',
                 'started': now - 5,
                 'test': [{'name': 'Foo', 'time': 3.0},
                          {'failed': True,
                           'failure_text': 'stacktrace',
                           'name': 'Bad',
                           'time': 4.0}],
                 'tests_failed': 1,
                 'tests_run': 2}],),
              {'skip_invalid_rows': True}]])


if __name__ == '__main__':
    unittest.main()