Add Integration tests (#211)

* Add integration tests

* Update travis CI to include integration tests

Author: satterly

.travis.yml

@@ -13,8 +13,15 @@ install:
   - pip install -r requirements-dev.txt
   - pip install .
 
+
 script:
-  - pip install coveralls
-  - python -m mypy alertaclient/
-  - pytest --cov=alertaclient
-  - coveralls
+  - make test.unit
+  - make test.integration
+
+stages:
+  - lint
+
+jobs:
+  include:
+    - stage: lint
+      script: make lint

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.7
+RUN apt-get update
+
+RUN apt-get install -y \
+    build-essential \
+    python3-dev \
+    libffi-dev \
+    libssl-dev
+
+WORKDIR /usr/src/app
+
+COPY requirements*.txt ./
+RUN pip install --no-cache-dir \
+    -r requirements.txt \
+    -r requirements-dev.txt
+
+COPY . .

Makefile

@@ -1,60 +1,62 @@
 
 PYTHON=python
 VERSION=`cut -d "'" -f 2 alertaclient/version.py`
+.DEFAULT_GOAL:=help
 
 all:	help
 
-help:
-	@echo ""
-	@echo "Usage: make <command>"
-	@echo ""
-	@echo "Commands:"
-	@echo "   init    Initialise environment"
-	@echo "   dev     Initialise dev environment"
-	@echo "   pylint  Lint source code"
-	@echo "   mypy    Type checking"
-	@echo "   hooks   Run pre-commit hooks"
-	@echo "   clean   Clean source"
-	@echo "   test    Run tests"
-	@echo "   run     Run application"
-	@echo "   tag     Git tag with current version"
-	@echo "   upload  Upload package to PyPI"
-	@echo ""
-
+## init			- Initialise environment.
 init:
 	pip install -r requirements.txt --upgrade
 	pip install -e .
 
+## dev			- Initialise dev environment.
 dev:
 	pip install -r requirements-dev.txt --upgrade
 	pre-commit install
 	pre-commit autoupdate
 
-pylint:
+## hooks			- Run pre-commit hooks.
+hooks:
+	pre-commit run --all-files
+
+## lint			- Lint and type checking.
+lint:
 	@pip -q install pylint
 	pylint --rcfile pylintrc alertaclient
-
-mypy:
 	@pip -q install mypy==0.620
 	mypy alertaclient/
 
-hooks:
-	pre-commit run --all-files
-
+## clean			- Clean source.
 clean:
 	find . -name "*.pyc" -exec rm {} \;
 	rm -Rf build dist *.egg-info
 
-test:
-	pytest
+## test.unit		- Run unit tests.
+test.unit:
+	pip install coveralls
+	pytest --cov=alertaclient tests/unit
 
+## test.integration	- Run integration tests.
+test.integration:
+	docker-compose -f docker-compose.ci.yaml build sut
+	docker-compose -f docker-compose.ci.yaml up --exit-code-from sut
+	docker-compose -f docker-compose.ci.yaml rm --stop --force
+
+## run			- Run application.
 run:
 	alerta top
 
+## tag			- Git tag with current version.
 tag:
 	git tag -a v$(VERSION) -m v$(VERSION)
 	git push --tags
 
+## upload			- Upload package to PyPI.
 upload:
 	$(PYTHON) setup.py sdist bdist_wheel
 	twine upload dist/*
+
+## help			- Show this help.
+help: Makefile
+	@sed -n 's/^##//p' $<

alertaclient/__main__.py

@@ -1,3 +1,3 @@
 from alertaclient.cli import cli
 
-cli()
+cli()  # pylint: disable=no-value-for-parameter

alertaclient/auth/token.py

@@ -57,7 +57,7 @@ def get_access_token(self, xsrf_token):
         httpd = HTTPServer(server_address, lambda request, address,
                            server: HTTPServerHandler(request, address, server, xsrf_token))
         httpd.handle_request()
-        return httpd.access_token
+        return httpd.access_token  # pylint: disable=no-member
 
 
 class Jwt:

alertaclient/utils.py

@@ -9,7 +9,7 @@
 
 
 class CustomJsonEncoder(json.JSONEncoder):
-    def default(self, o):
+    def default(self, o):  # pylint: disable=method-hidden
         if isinstance(o, (datetime.date, datetime.datetime)):
             return o.replace(microsecond=0).strftime('%Y-%m-%dT%H:%M:%S') + '.%03dZ' % (o.microsecond // 1000)
         elif isinstance(o, datetime.timedelta):

docker-compose.ci.yaml

@@ -0,0 +1,45 @@
+version: '3.7'
+
+services:
+  api:
+    image: alerta/alerta-web  # use API in "alerta-web" image
+    ports:
+      - "8080:8080"
+    depends_on:
+      - db
+    environment:
+      - DEBUG=1  # remove this line to turn DEBUG off
+      - DATABASE_URL=postgres://postgres:postgres@db:5432/monitoring
+      - AUTH_REQUIRED=True
+      - ADMIN_USERS=admin@alerta.io,devops@alerta.io #default password: alerta
+      - ADMIN_KEY=demo-key  # assigned to first user in ADMIN_USERS list
+      # - PLUGINS=reject,blackout,normalise,enhance
+    networks:
+      net:
+        aliases:
+          - api
+
+  db:
+    image: postgres:9.6
+    environment:
+      - POSTGRES_DB=monitoring
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres
+    restart: always
+    networks:
+      net:
+        aliases:
+          - db
+
+  sut:
+    build: .
+    depends_on:
+      - api
+    command: ["./wait-for-it.sh", "api:8080", "-t", "60", "--", "pytest", "tests/integration/test_sdk.py"]
+    networks:
+      net:
+        aliases:
+          - sut
+
+networks:
+  net: {}

pylintrc

@@ -33,7 +33,8 @@ load-plugins=
 # can either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where
 # it should appear only once).
-disable=C0111,C0301,E1101
+#disable=C0111,C0301,E1101
+disable=W,R,C
 
 
 [REPORTS]

tests/integration/__init__.py

@@ -0,0 +1,74 @@
+import unittest
+
+from alertaclient.api import Client
+
+
+class AlertTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.client = Client(endpoint='http://api:8080/api', 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_blackout(self):
+        blackout = self.client.create_blackout(
+            environment='Production', service=['Web', 'App'], resource='web01', event='node_down', group='Network', tags=['london', 'linux']
+        )
+        self.assertEqual(blackout.environment, 'Production')
+        self.assertEqual(blackout.service, ['Web', 'App'])
+        self.assertIn('london', blackout.tags)
+        self.assertIn('linux', blackout.tags)
+
+    def test_customer(self):
+        customer = self.client.create_customer(customer='ACME Corp.', match='example.com')
+        self.assertEqual(customer.customer, 'ACME Corp.')
+        self.assertEqual(customer.match, 'example.com')
+
+    def test_group(self):
+        group = self.client.create_group(name='myGroup', text='test group')
+        self.assertEqual(group.name, 'myGroup')
+        self.assertEqual(group.text, 'test group')
+
+    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)
+
+    def test_history(self):
+        hist = self.client.get_history()
+        self.assertEqual(hist[0].environment, 'Production')
+        self.assertEqual(hist[0].service, ['Web', 'App'])
+        self.assertEqual(hist[0].resource, 'web01')
+        self.assertIn('london', hist[0].tags)
+        self.assertEqual(hist[0].change_type, 'new')
+
+    def test_key(self):
+        api_key = self.client.create_key(
+            username='johndoe@example.com', scopes=['write:alerts', 'admin:keys'], text='Ops API Key'
+        )
+        self.assertEqual(api_key.user, 'johndoe@example.com')
+        self.assertEqual(sorted(api_key.scopes), sorted(['write:alerts', 'admin:keys']))
+
+    # def test_note(self):
+    #     n = self.client.alert_note(id='e7020428-5dad-4a41-9bfe-78e9d55cda06', note='this is a test note')
+    #     self.assertEqual(n.text, 'this is a test note')
+
+    def test_permission(self):
+        perm = self.client.create_perm(role='websys', scopes=['admin:users', 'admin:keys', 'write'])
+        self.assertEqual(perm.match, 'websys')
+        self.assertEqual(sorted(perm.scopes), sorted(['admin:users', 'admin:keys', 'write']))
+
+    def test_user(self):
+        users = self.client.get_users()
+        self.assertEqual(users[0].name, 'admin@alerta.io')
+        self.assertEqual(sorted(users[0].roles), sorted(['admin']))
+        self.assertEqual(users[0].status, 'active')