Expand testing of update endpoints (#217)

Author: satterly

.env

@@ -1,2 +1,2 @@
 PROJECT=alertaclient
-COMPOSE_PROJECT_NAME=sdk
+COMPOSE_PROJECT_NAME=client

Dockerfile

@@ -12,5 +12,5 @@ COPY . /app
 WORKDIR /app
 
 RUN pip install -r requirements.txt
-RUN pip install -r requirements-dev.txt
+RUN pip install pytest
 RUN pip install .

alertaclient/api.py

@@ -189,8 +189,22 @@ def get_blackouts(self, query=None):
         r = self.http.get('/blackouts', query)
         return [Blackout.parse(b) for b in r['blackouts']]
 
-    def update_blackout(self, id, blackout):
-        self.http.put('/blackout/%s' % id, blackout)
+    def update_blackout(self, id, **kwargs):
+        data = {
+            'customer': kwargs.get('customer'),
+            'environment': kwargs.get('environment'),
+            'service': kwargs.get('service'),
+            'resource': kwargs.get('resource'),
+            'event': kwargs.get('event'),
+            'group': kwargs.get('group'),
+            'tags': kwargs.get('tags'),
+            'startTime': kwargs.get('startTime'),
+            'endTime': kwargs.get('endTime'),
+            'text': kwargs.get('text'),
+        }
+
+        r = self.http.put('/blackout/{}'.format(id), data)
+        return Blackout.parse(r['blackout'])
 
     def delete_blackout(self, id):
         return self.http.delete('/blackout/%s' % id)
@@ -211,8 +225,13 @@ def get_customers(self, query=None):
         r = self.http.get('/customers', query)
         return [Customer.parse(c) for c in r['customers']]
 
-    def update_customer(self, id, customer):
-        self.http.put('/customer/%s' % id, customer)
+    def update_customer(self, id, **kwargs):
+        data = {
+            'match': kwargs.get('match'),
+            'customer': kwargs.get('customer')
+        }
+        r = self.http.put('/customer/{}'.format(id), data)
+        return Customer.parse(r['customer'])
 
     def delete_customer(self, id):
         return self.http.delete('/customer/%s' % id)
@@ -267,7 +286,8 @@ def update_key(self, id, **kwargs):
             'expireTime': kwargs.get('expireTime'),
             'customer': kwargs.get('customer')
         }
-        return self.http.put('/key/{}'.format(id), data)
+        r = self.http.put('/key/{}'.format(id), data)
+        return ApiKey.parse(r['key'])
 
     def delete_key(self, id):
         return self.http.delete('/key/%s' % id)
@@ -293,7 +313,8 @@ def update_perm(self, id, **kwargs):
             'match': kwargs.get('match'),  # role
             'scopes': kwargs.get('scopes')
         }
-        return self.http.put('/perm/{}'.format(id), data)
+        r = self.http.put('/perm/{}'.format(id), data)
+        return Permission.parse(r['permission'])
 
     def delete_perm(self, id):
         return self.http.delete('/perm/%s' % id)
@@ -356,7 +377,8 @@ def update_user(self, id, **kwargs):
             'text': kwargs.get('text'),
             'email_verified': kwargs.get('email_verified')
         }
-        return self.http.put('/user/{}'.format(id), data)
+        r = self.http.put('/user/{}'.format(id), data)
+        return User.parse(r['user'])
 
     def update_me(self, **kwargs):
         data = {
@@ -367,7 +389,8 @@ def update_me(self, **kwargs):
             'attributes': kwargs.get('attributes', None) or dict(),
             'text': kwargs.get('text')
         }
-        return self.http.put('/user/me', data)
+        r = self.http.put('/user/me', data)
+        return User.parse(r['user'])
 
     def update_user_attributes(self, id, attributes):
         data = {
@@ -435,7 +458,8 @@ def update_group(self, id, **kwargs):
             'name': kwargs.get('name'),
             'text': kwargs.get('text')
         }
-        return self.http.put('/group/{}'.format(id), data)
+        r = self.http.put('/group/{}'.format(id), data)
+        return Group.parse(r['group'])
 
     def add_user_to_group(self, group_id, user_id):
         return self.http.put('/group/{}/user/{}'.format(group_id, user_id))

alertaclient/models/enums.py

@@ -57,3 +57,38 @@ def from_str(action: str, resource: str = None):
             return Scope('{}:{}'.format(action, resource))
         else:
             return Scope(action)
+
+
+ADMIN_SCOPES = [Scope.admin, Scope.read, Scope.write]
+
+
+class ChangeType(str, Enum):
+
+    open = 'open'
+    assign = 'assign'
+    ack = 'ack'
+    unack = 'unack'
+    shelve = 'shelve'
+    unshelve = 'unshelve'
+    close = 'close'
+
+    new = 'new'
+    action = 'action'
+    status = 'status'
+    value = 'value'
+    severity = 'severity'
+    note = 'note'
+    timeout = 'timeout'
+    expired = 'expired'
+
+
+class NoteType(str, Enum):
+
+    alert = 'alert'
+    blackout = 'blackout'
+    customer = 'customer'
+    group = 'group'
+    heartbeat = 'heartbeat'
+    key = 'api-key'
+    perm = 'permission'
+    user = 'user'

docker-compose.ci.yaml

@@ -37,7 +37,7 @@ services:
     build: .
     depends_on:
       - api
-    command: ["./wait-for-it.sh", "api:8080", "-t", "60", "--", "pytest", "tests/integration/test_sdk.py"]
+    command: ["./wait-for-it.sh", "api:8080", "-t", "60", "--", "pytest", "tests/integration/"]
     networks:
       net:
         aliases:

tests/integration/test_alerts.py

@@ -0,0 +1,38 @@
+import unittest
+
+from alertaclient.api import Client
+
+
+class AlertTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.client = Client(endpoint='http://api:8080', key='demo-key')
+
+    def test_alert(self):
+        id, alert, message = self.client.send_alert(
+            environment='Production', resource='web01', event='node_down', correlated=['node_up', 'node_down'],
+            service=['Web', 'App'], severity='critical', tags=['london', 'linux'], value=4
+        )
+        self.assertEqual(alert.value, '4')  # values cast to string
+        self.assertEqual(alert.timeout, 86400)  # timeout returned as int
+        self.assertIn('london', alert.tags)
+
+    def test_alert_notes(self):
+        alert_id, alert, message = self.client.send_alert(
+            environment='Production', resource='web02', event='node_down', correlated=['node_up', 'node_down'],
+            service=['Web', 'App'], severity='critical', tags=['london', 'linux'], value=4
+        )
+        note = self.client.alert_note(alert_id, text='this is a test note')
+        self.assertEqual(note.text, 'this is a test note')
+
+        notes = self.client.get_alert_notes(alert_id)
+        self.assertEqual(notes[0].text, 'this is a test note')
+        self.assertEqual(notes[0].user, 'admin@alerta.io')
+
+        note = self.client.update_alert_note(alert_id, notes[0].id, text='updated note text')
+        self.assertEqual(note.text, 'updated note text')
+
+        self.client.delete_alert_note(alert_id, notes[0].id)
+
+        notes = self.client.get_alert_notes(alert_id)
+        self.assertEqual(notes, [])

tests/integration/test_blackouts.py

@@ -0,0 +1,37 @@
+import unittest
+
+from alertaclient.api import Client
+
+
+class AlertTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.client = Client(endpoint='http://api:8080', key='demo-key')
+
+    def test_blackout(self):
+        blackout = self.client.create_blackout(
+            environment='Production', service=['Web', 'App'], resource='web01', event='node_down', group='Network', tags=['london', 'linux']
+        )
+        blackout_id = blackout.id
+
+        self.assertEqual(blackout.environment, 'Production')
+        self.assertEqual(blackout.service, ['Web', 'App'])
+        self.assertIn('london', blackout.tags)
+        self.assertIn('linux', blackout.tags)
+
+        blackout = self.client.update_blackout(blackout_id, environment='Development', group='Network', text='updated blackout')
+        self.assertEqual(blackout.environment, 'Development')
+        self.assertEqual(blackout.group, 'Network')
+        self.assertEqual(blackout.text, 'updated blackout')
+
+        blackout = self.client.create_blackout(
+            environment='Production', service=['Core'], group='Network'
+        )
+
+        blackouts = self.client.get_blackouts()
+        self.assertEqual(len(blackouts), 2)
+
+        self.client.delete_blackout(blackout_id)
+
+        blackouts = self.client.get_blackouts()
+        self.assertEqual(len(blackouts), 1)

tests/integration/test_customers.py

@@ -0,0 +1,32 @@
+import unittest
+
+from alertaclient.api import Client
+
+
+class AlertTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.client = Client(endpoint='http://api:8080', key='demo-key')
+
+    def test_customer(self):
+        customer = self.client.create_customer(customer='ACME Corp.', match='example.com')
+
+        customer_id = customer.id
+
+        self.assertEqual(customer.customer, 'ACME Corp.')
+        self.assertEqual(customer.match, 'example.com')
+
+        customer = self.client.update_customer(customer_id, customer='Foo Corp.', match='foo.com')
+
+        self.assertEqual(customer.customer, 'Foo Corp.')
+        self.assertEqual(customer.match, 'foo.com')
+
+        customer = self.client.create_customer(customer='Quetzal Inc.', match='quetzal.io')
+
+        customers = self.client.get_customers()
+        self.assertEqual(len(customers), 2)
+
+        self.client.delete_customer(customer_id)
+
+        customers = self.client.get_customers()
+        self.assertEqual(len(customers), 1)

tests/integration/test_groups.py

@@ -0,0 +1,31 @@
+import unittest
+
+from alertaclient.api import Client
+
+
+class AlertTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.client = Client(endpoint='http://api:8080', key='demo-key')
+
+    def test_group(self):
+        group = self.client.create_group(name='myGroup', text='test group')
+
+        group_id = group.id
+
+        self.assertEqual(group.name, 'myGroup')
+        self.assertEqual(group.text, 'test group')
+
+        group = self.client.update_group(group_id, name='newGroup', text='updated group text')
+        self.assertEqual(group.name, 'newGroup')
+        self.assertEqual(group.text, 'updated group text')
+
+        group = self.client.create_group(name='myGroup2', text='test group2')
+
+        groups = self.client.get_users_groups()
+        self.assertEqual(len(groups), 2, groups)
+
+        self.client.delete_group(group_id)
+
+        groups = self.client.get_users_groups()
+        self.assertEqual(len(groups), 1)

tests/integration/test_heartbeats.py

@@ -0,0 +1,16 @@
+import unittest
+
+from alertaclient.api import Client
+
+
+class AlertTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.client = Client(endpoint='http://api:8080', key='demo-key')
+
+    def test_heartbeat(self):
+        hb = self.client.heartbeat(origin='app/web01', timeout=10, tags=['london', 'linux'])
+        self.assertEqual(hb.origin, 'app/web01')
+        self.assertEqual(hb.event_type, 'Heartbeat')
+        self.assertEqual(hb.timeout, 10)
+        self.assertIn('linux', hb.tags)