aboutsummaryrefslogtreecommitdiffstats
path: root/laas/tests/test_sensor_laas_api.py
blob: c5181b654e76b6464cfdbe11f7529247251d45c5 (plain)
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
107
108
109
110
111
112
113
114
115
116
117
118
##############################################################################
# Copyright 2018 Parker Berberian and Others                                 #
#                                                                            #
# 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 st2tests.base import BaseSensorTestCase
import laas
import responses
import json


class LaaSSensorTest(BaseSensorTestCase):
    sensor_cls = laas.LaaS_Sensor

    def setUp(self):
        super(LaaSSensorTest, self).setUp()
        self.sensor = self.get_sensor_instance(config={
            "dashboard": {
                "address": "http://my.dashboard.com",
                "lab_name": "my_lab"
            }
        })
        self.jobs_url = "http://my.dashboard.com/api/labs/my_lab/jobs/new"
        self.sensor.sensor_service.set_value("jobs", "[]", local=False)
        self.sensor.sensor_service.set_value("lab_auth_token", "my_auth_token", local=False)
        self.sensor.setup()

    def clean(self, sensor):
        # Removes all existing bookings from the keystore
        kvps = sensor.sensor_service.list_values(local=False, prefix="job_")
        for kvp in kvps:
            sensor.sensor_service.delete_value(local=False, name=kvp.name)

    def get_job(self, job_id):
        return {
            "id": job_id,
            "payload": {
                "hardware": "stuff",
                "network": "stuff",
                "access": "stuff",
            }
        }

    def assertJobCreated(self, job_id):
        self.assertTriggerDispatched(
            trigger="laas.start_job_trigger",
            payload={"job_id": job_id}
        )
        self.assertTrue(json.loads(
            self.sensor.sensor_service.get_value("job_" + str(job_id), local=False)
        ))
        # TODO: solve concurrency issues in job stop / start
        # started_jobs = json.loads(self.sensor.sensor_service.get_value("jobs", local=False))
        # self.assertTrue(job_id in started_jobs)

    # Testing Methods

    @responses.activate
    def test_empty_throws_no_triggers(self):
        responses.add(responses.GET, self.jobs_url, json=[])
        self.sensor.poll()
        self.assertEqual(len(responses.calls), 1)
        self.assertEqual(responses.calls[0].request.headers['auth-token'], 'my_auth_token')
        self.assertEqual(self.get_dispatched_triggers(), [])

    @responses.activate
    def test_new_job_throws_trigger(self):
        responses.add(responses.GET, self.jobs_url, json=[self.get_job(1)])
        self.sensor.poll()
        self.assertEqual(len(responses.calls), 1)
        self.assertEqual(responses.calls[0].request.headers['auth-token'], 'my_auth_token')
        self.assertJobCreated(1)

    @responses.activate
    def test_job_not_restarted(self):
        self.sensor.sensor_service.set_value("jobs", "[1]", local=False)
        responses.add(responses.GET, self.jobs_url, json=[self.get_job(1)])
        self.sensor.poll()
        self.assertEqual(len(responses.calls), 1)
        self.assertEqual(responses.calls[0].request.headers['auth-token'], 'my_auth_token')
        self.assertEqual(self.get_dispatched_triggers(), [])

    @responses.activate
    def test_sensor_does_not_die(self):
        # no endpoint added to responses - will throw an error to the sensor
        self.sensor.poll()  # shouldn't throw, should still work next time
        self.assertEqual(len(responses.calls), 1)
        self.assertEqual(responses.calls[0].request.headers['auth-token'], 'my_auth_token')

        responses.add(responses.GET, self.jobs_url, json=[self.get_job(1)])
        self.sensor.poll()
        self.assertEqual(len(responses.calls), 2)
        self.assertEqual(responses.calls[1].request.headers['auth-token'], 'my_auth_token')
        self.assertJobCreated(1)

    @responses.activate
    def test_multiple_jobs_started(self):
        responses.add(responses.GET, self.jobs_url, json=[
            self.get_job(1),
            self.get_job(2),
            self.get_job(3)
        ])
        self.sensor.poll()
        self.assertEqual(len(responses.calls), 1)
        self.assertEqual(responses.calls[0].request.headers['auth-token'], 'my_auth_token')
        self.assertJobCreated(1)
        self.assertJobCreated(2)
        self.assertJobCreated(3)