Merge pull request #184 from idealista/develop

Release 2.5.5

.github/CONTRIBUTING.md

@@ -76,7 +76,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com
 ### Pull Requests
 
 * Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
-* Any pull request should has **idealista:develop** as base branch.
+* Any pull request should have **idealista:develop** as base branch.
 
 ### Changelog
 

CHANGELOG.md

@@ -4,6 +4,16 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a ch
 
 ## [Unreleased](https://github.com/idealista/prom2teams/tree/develop)
 
+## [2.5.5](https://github.com/idealista/prom2teams/tree/2.5.5)
+[Full Changelog](https://github.com/idealista/prom2teams/compare/2.5.4...2.5.5)
+## Changed
+- *[#175](https://github.com/idealista/prom2teams/issues/175) Building docker image using multi-stage build feature* @dortegau
+
+## Fixed
+- *[#158](https://github.com/idealista/prom2teams/issues/158) Fixing Travis Badge (pointing to master branch) and reordering TOC* @dortegau
+- *[#177](https://github.com/idealista/prom2teams/issues/177) Fixing unit tests when using Python <= 3.6* @dortegau
+- *[#182](https://github.com/idealista/prom2teams/issues/182) Fix dependances versions; yaml-dev in docker container; updated pyyaml package* @ftsao
+
 ## [2.5.4](https://github.com/idealista/prom2teams/tree/2.5.4)
 [Full Changelog](https://github.com/idealista/prom2teams/compare/2.5.3...2.5.4)
 ## Fixed

Dockerfile

@@ -1,32 +1,29 @@
-FROM python:3.5-alpine
-
-LABEL maintainer="labs@idealista.com"
-
-EXPOSE 8089
-
-RUN apk add gcc libc-dev linux-headers --no-cache
-
-WORKDIR /opt/prom2teams
-
-COPY ./docker/ \
-        LICENSE \
+FROM python:3.5-alpine AS builder
+WORKDIR /prom2teams
+COPY LICENSE \
         MANIFEST.in \
         README.md \
         requirements.txt \
         setup.py \
         ./
+COPY prom2teams/ prom2teams
+COPY bin/ bin
+RUN apk add gcc libc-dev yaml-dev linux-headers --no-cache \
+        && python setup.py bdist_wheel
 
-COPY ./bin bin
-COPY ./prom2teams prom2teams
-
-RUN python setup.py install
-
+FROM python:3.5-alpine
+LABEL maintainer="labs@idealista.com"
+EXPOSE 8089
+WORKDIR /opt/prom2teams
+COPY docker/rootfs .
+COPY --from=builder /prom2teams/dist .
+RUN apk add gcc libc-dev yaml-dev linux-headers --no-cache \
+	&& pip install prom2teams*.whl
 ENV PROM2TEAMS_PORT="8089" \
         PROM2TEAMS_HOST="0.0.0.0" \
         PROM2TEAMS_LOGLEVEL="INFO" \
         PROM2TEAMS_CONNECTOR="" \
         PROM2TEAMS_GROUP_ALERTS_BY="" \
         APP_CONFIG_FILE="/opt/prom2teams/config.ini" \
         PROM2TEAMS_PROMETHEUS_METRICS="true"
-
 ENTRYPOINT ["sh", "prom2teams_start.sh"]

README.md

@@ -1,9 +1,9 @@
 ![Logo](https://raw.githubusercontent.com/idealista/prom2teams/master/logo.gif)
 
-[![Build Status](https://travis-ci.org/idealista/prom2teams.png)](https://travis-ci.org/idealista/prom2teams) 
+[![Build Status](https://travis-ci.org/idealista/prom2teams.svg?branch=master)](https://travis-ci.org/idealista/prom2teams)
 [![Docker Build Status](https://img.shields.io/docker/build/idealista/prom2teams.svg)](https://hub.docker.com/r/idealista/prom2teams/) 
+[![Docker Hub Pulls](https://img.shields.io/docker/pulls/idealista/prom2teams.svg)](https://hub.docker.com/r/idealista/prom2teams/)
 [![Docker Automated build](https://img.shields.io/docker/automated/idealista/prom2teams.svg)](https://hub.docker.com/r/idealista/prom2teams/)
-
 # prom2teams
 
 <img src="https://raw.githubusercontent.com/idealista/prom2teams/master/assets/example.png" alt="Alert example" style="width: 600px;"/>
@@ -14,9 +14,13 @@
 	- [Prerequisities](#prerequisites)
 	- [Installing](#installing)
 - [Usage](#usage)
+  - [Docker Image](#docker-image)
+  - [Helm Chart](#helm-chart)
   - [Config file](#config-file)
 	- [Configuring Prometheus](#configuring-prometheus)
 	- [Templating](#templating)
+- [Documentation](#documentation)
+  - [Swagger UI](#swagger-ui)
 - [Testing](#testing)
 - [Built With](#built-with)
 - [Versioning](#versioning)
@@ -61,12 +65,29 @@ $ prom2teams
 ```
 **Note:** Grouping alerts works since v2.2.1
 
-### Prom2teams Prometheus metrics
+### Docker image
 
-Prom2teams uses Flask and, to have the service monitored, we use @rycus66's [Prometheus Flask Exporter](https://github.com/rycus86/prometheus_flask_exporter). This will enable an endpoint in `/metrics` where you could find interesting metrics to monitor such as number of responses with a certain status. To enable this endpoint, just either:
+Every new Prom2teams release, a new Docker image is built in our [Dockerhub](https://hub.docker.com/r/idealista/prom2teams). We strongly recommend you to use the images with the version tag, though it will be possible to use them without it.
 
-- Use the `--enablemetrics` or `-m` flag when launching prom2teams.
-- Set the environment variable `PROM2TEAMS_PROMETHEUS_METRICS=true`.
+There are two things you need to bear in mind when creating a Prom2teams container:
+
+- The connector URL must be passed as the environment variable `PROM2TEAMS_CONNECTOR`
+- In case you want to group alerts, you need to pass the field as the environment variable `PROM2TEAMS_GROUP_ALERTS_BY`
+- You need to map container's Prom2teams port to one on your host.
+
+So a sample Docker run command would be:
+
+```bash
+$ docker run -it -d -e PROM2TEAMS_GROUP_ALERTS_BY=FIELD_YOU_WANT_TO_GROUP_BY -e PROM2TEAMS_CONNECTOR="CONNECTOR_URL" -p 8089:8089 idealista/prom2teams:VERSION
+```
+
+#### Provide custom config file
+
+If you prefer to use your own config file, you just need to provide it as a Docker volume to the container and map it to `/opt/prom2teams/config.ini`. Sample:
+
+```bash
+$ docker run -it -d -v pathToTheLocalConfigFile:/opt/prom2teams/config.ini -p 8089:8089 idealista/prom2teams:VERSION
+```
 
 ### Helm chart
 
@@ -116,30 +137,6 @@ The following table lists the configurable parameters of the Prom2teams chart an
 | `prom2teams.templatepath`                       | Custom Template path (files/teams.j2)                                                                              | `/opt/prom2teams/helmconfig/teams.j2`
 | `prom2teams.config`                             | Config (specific to Helm)                                                                                          | `/opt/prom2teams/helmconfig/config.ini`
 
-### Docker image
-
-Every new Prom2teams release, a new Docker image is built in our [Dockerhub](https://hub.docker.com/r/idealista/prom2teams). We strongly recommend you to use the images with the version tag, though it will be possible to use them without it.
-
-There are two things you need to bear in mind when creating a Prom2teams container:
-
-- The connector URL must be passed as the environment variable `PROM2TEAMS_CONNECTOR`
-- In case you want to group alerts, you need to pass the field as the environment variable `PROM2TEAMS_GROUP_ALERTS_BY`
-- You need to map container's Prom2teams port to one on your host.
-
-So a sample Docker run command would be:
-
-```bash
-$ docker run -it -d -e PROM2TEAMS_GROUP_ALERTS_BY=FIELD_YOU_WANT_TO_GROUP_BY -e PROM2TEAMS_CONNECTOR="CONNECTOR_URL" -p 8089:8089 idealista/prom2teams:VERSION
-```
-
-#### Provide custom config file
-
-If you prefer to use your own config file, you just need to provide it as a Docker volume to the container and map it to `/opt/prom2teams/config.ini`. Sample:
-
-```bash
-$ docker run -it -d -v pathToTheLocalConfigFile:/opt/prom2teams/config.ini -p 8089:8089 idealista/prom2teams:VERSION
-```
-
 ### Production
 
 For production environments you should prefer using a WSGI server. [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/)
@@ -223,6 +220,13 @@ The url is formed by the host and port defined in the previous step.
 url: 0.0.0.0:8089/v2/<Connector1>
 ```
 
+### Prom2teams Prometheus metrics
+
+Prom2teams uses Flask and, to have the service monitored, we use @rycus66's [Prometheus Flask Exporter](https://github.com/rycus86/prometheus_flask_exporter). This will enable an endpoint in `/metrics` where you could find interesting metrics to monitor such as number of responses with a certain status. To enable this endpoint, just either:
+
+- Use the `--enablemetrics` or `-m` flag when launching prom2teams.
+- Set the environment variable `PROM2TEAMS_PROMETHEUS_METRICS=true`.
+
 ### Templating
 
 prom2teams provides a [default template](prom2teams/resources/templates/teams.j2) built with [Jinja2](http://jinja.pocoo.org/docs/2.10/) to render messages in Microsoft Teams. This template could be overrided using the 'templatepath' argument ('--templatepath <Jinja2 template file path>') during the application start.
@@ -232,7 +236,8 @@ If such a field is not included a default value of 'unknown' is assigned.
 
 All non-mandatory labels not in excluded list are injected in `extra_labels` key. All non-mandatory annotations not in excluded list are injected in `extra_annotations` key.
 
-#### Swagger UI
+## Documentation
+### Swagger UI
 
 Accessing to `<Host>:<Port>` (e.g. `localhost:8089`) in a web browser shows the API v1 documentation.
 

prom2teams/app/teams_client.py

@@ -12,7 +12,7 @@ def post(teams_webhook_url, message):
         exception_msg = 'Error performing request to: {}.\n' \
                         ' Returned status code: {}.\n' \
                         ' Returned data: {}\n' \
-                        ' Sended message: {}\n'
+                        ' Sent message: {}\n'
         raise MicrosoftTeamsRequestException(exception_msg.format(teams_webhook_url,
                                                                   str(response.status_code),
                                                                   str(response.text),

prom2teams/teams/alarm_mapper.py

@@ -2,12 +2,6 @@
 from collections import defaultdict
 
 
-def map_alarm_to_json(alarm):
-    schema = TeamsAlarmSchema()
-    result = schema.dump(alarm)
-    return result
-
-
 def map_prom_alerts_to_teams_alarms(alerts):
     alerts = group_alerts(alerts, 'status')
     teams_alarms = []

requirements.txt

@@ -3,7 +3,11 @@ flask-restplus==0.12.1
 marshmallow==3.0.0rc6
 jinja2==2.10.1
 Flask==1.0.2
-pyyaml==3.13
+pyyaml==5.1
 uwsgi==2.0.16
 prometheus_flask_exporter==0.9.0
 werkzeug==0.16.1
+DeepDiff==4.3.0
+zipp==1.2.0
+MarkupSafe==1.1.1
+pyrsistent==0.16.0

setup.py

@@ -10,7 +10,7 @@
 
 
 setup(name='prom2teams',
-      version='2.5.4',
+      version='2.5.5',
       description='Project that redirects Prometheus Alert Manager '
       'notifications to Microsoft Teams',
       long_description=readme,

tests/test_app_configuration.py

@@ -1,46 +1,48 @@
 import unittest
+import os
+
 from prom2teams.app import configuration
 from prom2teams.app import exceptions
 
 
 class TestServer(unittest.TestCase):
-    TEST_CONFIG_FILES_PATH = 'tests/data/'
+    TEST_CONFIG_FILES_PATH = './tests/data/'
     DEFAULT_CONFIG_RELATIVE_PATH = './prom2teams/config.ini'
 
     def test_get_config_with_invalid_path(self):
-        invalid_relative_path = self.TEST_CONFIG_FILES_PATH + 'invalid_path'
+        invalid_relative_path = os.path.join(self.TEST_CONFIG_FILES_PATH, 'invalid_path')
         self.assertRaises(FileNotFoundError, configuration._config_provided, invalid_relative_path)
 
     def test_get_config_without_required_keys_should_raise_exception(self):
-        empty_config_relative_path = self.TEST_CONFIG_FILES_PATH + 'empty_config.ini'
+        empty_config_relative_path = os.path.join(self.TEST_CONFIG_FILES_PATH, 'empty_config.ini')
 
         self.assertRaises(exceptions.MissingConnectorConfigKeyException, configuration._config_provided,
                           empty_config_relative_path)
 
     def test_get_config_without_override(self):
-        provided_config_relative_path = self.TEST_CONFIG_FILES_PATH + 'without_overriding_defaults.ini'
+        provided_config_relative_path = os.path.join(self.TEST_CONFIG_FILES_PATH, 'not_overriding_defaults.ini')
         config = configuration._config_provided(provided_config_relative_path)
 
         self.assertTrue(config.get('Microsoft Teams', 'Connector'))
 
     def test_get_config_overriding_defaults(self):
-        provided_config_relative_path = self.TEST_CONFIG_FILES_PATH + 'overriding_defaults.ini'
+        provided_config_relative_path = os.path.join(self.TEST_CONFIG_FILES_PATH, 'overriding_defaults.ini')
         config = configuration._config_provided(provided_config_relative_path)
 
         self.assertEqual(config.get('HTTP Server', 'Host'), '1.1.1.1')
         self.assertEqual(config.get('HTTP Server', 'Port'), '9089')
         self.assertTrue(config.get('Microsoft Teams', 'Connector'))
 
     def test_connectors_configured(self):
-        provided_config_relative_path = self.TEST_CONFIG_FILES_PATH + 'multiple_connectors_config.ini'
+        provided_config_relative_path = os.path.join(self.TEST_CONFIG_FILES_PATH, 'multiple_connectors_config.ini')
         config = configuration._config_provided(provided_config_relative_path)
 
         self.assertEqual(config['Microsoft Teams']['connector1'], 'teams_webhook_url')
         self.assertEqual(config['Microsoft Teams']['connector2'], 'another_teams_webhook_url')
         self.assertEqual(config['Microsoft Teams']['connector3'], 'definitely_another_teams_webhook_url')
 
     def test_get_config_for_all_fields(self):
-        provided_config_relative_path = self.TEST_CONFIG_FILES_PATH + 'all_fields.ini'
+        provided_config_relative_path = os.path.join(self.TEST_CONFIG_FILES_PATH, 'all_fields.ini')
         config = configuration._config_provided(provided_config_relative_path)
 
         self.assertEqual(config.get('HTTP Server', 'Host'), '1.1.1.1')
@@ -51,7 +53,5 @@ def test_get_config_for_all_fields(self):
         self.assertEqual(config.get('Template', 'Path'), 'jinja2/template/path')
         self.assertEqual(config.get('Group Alerts', 'Field'), 'name')
 
-
-
 if __name__ == '__main__':
     unittest.main()