st2/st2reactor/tests/integration/test_sensor_watcher.py at 4399ed416fde3169be2e7a1b2a87118359b52f1d · StackStorm/st2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# Copyright 2020 The StackStorm Authors.
# Copyright 2019 Extreme Networks, Inc.
#
# 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 __future__ import absolute_import

from time import monotonic

from pyrabbit.api import Client

from st2common.util import concurrency
from st2common.services.sensor_watcher import SensorWatcher
from st2tests.base import IntegrationTestCase

__all__ = ["SensorWatcherTestCase"]


class SensorWatcherTestCase(IntegrationTestCase):
    @classmethod
    def setUpClass(cls):
        super(SensorWatcherTestCase, cls).setUpClass()

    def setUp(self):
        super().setUp()
        # pre-condition: Make sure there is no test pollution
        # Delete any leftover queues from previous failed test runs
        self._delete_sensor_watcher_amqp_queues(queue_name="st2.sensor.watch.covfefe")

        # Verify queues are deleted
        sw_queues = self._get_sensor_watcher_amqp_queues(
            queue_name="st2.sensor.watch.covfefe"
        )
        self.assertTrue(len(sw_queues) == 0)

    def test_sensor_watch_queue_gets_deleted_on_stop(self):
        def create_handler(sensor_db):
            pass

        def update_handler(sensor_db):
            pass

        def delete_handler(sensor_db):
            pass

        sensor_watcher = SensorWatcher(
            create_handler, update_handler, delete_handler, queue_suffix="covfefe"
        )
        sensor_watcher.start()
        sw_queues = self._get_sensor_watcher_amqp_queues(
            queue_name="st2.sensor.watch.covfefe"
        )

        start = monotonic()
        done = False
        while not done:
            concurrency.sleep(0.01)
            sw_queues = self._get_sensor_watcher_amqp_queues(
                queue_name="st2.sensor.watch.covfefe"
            )
            done = len(sw_queues) > 0 or ((monotonic() - start) < 5)

        sensor_watcher.stop()
        sw_queues = self._get_sensor_watcher_amqp_queues(
            queue_name="st2.sensor.watch.covfefe"
        )
        self.assertTrue(len(sw_queues) == 0)

    @staticmethod
    def _list_amqp_queues():
        rabbit_client = Client("localhost:15672", "guest", "guest")
        queues = [q["name"] for q in rabbit_client.get_queues()]
        return queues

    def _get_sensor_watcher_amqp_queues(self, queue_name):
        all_queues = self._list_amqp_queues()
        return set([q_name for q_name in all_queues if queue_name in q_name])

    def _delete_sensor_watcher_amqp_queues(self, queue_name):
        """
        Delete all queues containing the specified queue_name pattern.

        :param string queue_name: Pattern to match in queue names
        :returns: None
        """
        # Get all queues matching the pattern
        queues_to_delete = self._get_sensor_watcher_amqp_queues(queue_name=queue_name)

        if not queues_to_delete:
            return

        # Create a rabbit client and delete each queue
        rabbit_client = Client("localhost:15672", "guest", "guest")
        for queue in queues_to_delete:
            # Use default vhost "/"
            rabbit_client.delete_queue("/", queue)