lowered giveup time

hopefully

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit=venv/*

.drone.yml

@@ -3,11 +3,25 @@ type: docker
 name: default
 
 steps:
+- name: restore-cache-with-filesystem
+  image: meltwater/drone-cache
+  settings:
+    backend: "filesystem"
+    restore: true
+    cache_key: "{{ .Repo.Name }}"
+    archive_format: "gzip"
+    filesystem_cache_root: "/tmp/cache"
+    mount:
+      - '.pipcache'
+  volumes:
+  - name: cache
+    path: /tmp/cache
+
 - name: static_analysis
   image: python:3.8
   commands:
-  - pip3 install pylint bandit mccabe
-  - pip3 install -r requirements.txt
+  - pip3 install --cache-dir='./.pipcache' pylint bandit mccabe
+  - pip3 install --cache-dir='./.pipcache' -r requirements.txt
   - find . -name "*.py" -exec python3 -m py_compile '{}' \;
   - find . -name "*.py" -exec pylint '{}' + || if [ $? -eq 1 ]; then echo "you fail"; fi
   - find . -name "*.py" -exec python3 -m mccabe --min 3 '{}' + || if [ $? -eq 1 ]; then echo "you fail"; fi
@@ -15,35 +29,83 @@ steps:
 
 - name: unit_test
   image: python:3.8
+  environment:
+    PRODUCER_REDIS: cache
   commands:
-  - pip3 install -r requirements.txt
+  - pip3 install --cache-dir='./.pipcache' -r requirements.txt
   - pytest test.py
 
-- name: build
+- name: coverage
+  image: python:3.8
+  environment:
+    PRODUCER_REDIS: cache
+  commands:
+    - pip3 install --cache-dir='./.pipcache' -r requirements.txt
+    - pip3 install --cache-dir='./.pipcache' coverage pytest
+    - coverage run -m pytest test.py
+    - coverage report -m
+
+- name: integration_test
+  image: python:3.8
+  environment:
+    PRODUCER_REDIS: cache
+  commands:
+  - pip3 install --cache-dir='./.pipcache' -r requirements.txt
+  - pytest integtest.py
+
+- name: build-app
+  image: banzaicloud/drone-kaniko
+  settings:
+    registry: registry.kmlabz.com
+    repo: goldenpogacsa/${DRONE_REPO_NAME}
+    username:
+      from_secret: DOCKER_USERNAME
+    password:
+      from_secret: DOCKER_PASSWORD
+    tags:
+      - latest
+      - ${DRONE_BUILD_NUMBER}
+  
+- name: make_docs
+  image: python:3.8
+  commands:
+  - pip3 install --cache-dir='./.pipcache' Sphinx sphinx_rtd_theme
+  - pip3 install --cache-dir='./.pipcache' -r requirements.txt
+  - cd docs
+  - make html
+
+- name: rebuild-cache-with-filesystem
+  image: meltwater/drone-cache
+  pull: true
+  settings:
+    backend: "filesystem"
+    rebuild: true
+    cache_key: "{{ .Repo.Name }}"
+    archive_format: "gzip"
+    filesystem_cache_root: "/tmp/cache"
+    mount:
+      - '.pipcache'
+  volumes:
+  - name: cache
+    path: /tmp/cache
+
+- name: build_docs
   image: docker:stable-dind
   volumes:
-  - name: dockersock
-    path: /var/run
+    - name: dockersock
+      path: /var/run
   environment:
-      DOCKER_USERNAME:
-        from_secret: DOCKER_USERNAME
-      DOCKER_PASSWORD:
-        from_secret: DOCKER_PASSWORD
+    DOCKER_USERNAME:
+      from_secret: DOCKER_USERNAME
+    DOCKER_PASSWORD:
+      from_secret: DOCKER_PASSWORD
   commands:
-  - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
-  - docker build -t="$DOCKER_USERNAME/producer" .
-  - docker build -t="$DOCKER_USERNAME/producer:$DRONE_BUILD_NUMBER" .
-  - docker push "$DOCKER_USERNAME/producer"
-  - docker push "$DOCKER_USERNAME/producer:$DRONE_BUILD_NUMBER"
-  
-- name: build_docs
-  image: python:3
-  commands:
-  - pip3 install Sphinx
-  - pip3 install -r requirements.txt
-  - cd docs
-  - sphinx-apidoc -o source/ ../
-  - make html
+    - cd docs
+    - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin registry.kmlabz.com
+    - docker build -t="registry.kmlabz.com/goldenpogacsa/producer-docs" .
+    - docker build -t="registry.kmlabz.com/goldenpogacsa/producer-docs:$DRONE_BUILD_NUMBER" .
+    - docker push "registry.kmlabz.com/goldenpogacsa/producer-docs"
+    - docker push "registry.kmlabz.com/goldenpogacsa/producer-docs:$DRONE_BUILD_NUMBER"
 
 - name: slack
   image: plugins/slack
@@ -62,7 +124,12 @@ services:
   volumes:
   - name: dockersock
     path: /var/run
+- name: cache
+  image: redis
 
 volumes:
 - name: dockersock
   temp: {}
+- name: cache
+  host:
+    path: "/tmp/cache"

.gitignore

@@ -131,3 +131,4 @@ dmypy.json
 #Pycharm
 .idea/
 *.iml
+.coverage

Dockerfile

@@ -2,8 +2,10 @@ FROM python:3.8
 
 WORKDIR /app
 
-COPY . ./
+COPY requirements.txt ./
 
 RUN pip3 install --no-cache-dir -r requirements.txt
 
+COPY . ./
+
 CMD ["python3", "app.py"]

README.rst

@@ -0,0 +1,12 @@
+============
+P2P Producer
+============
+
+This repository contains the Producer part of the project. The module manages the list of consumers and
+sends data to the currently active one. If that becomes unavailable, it chooses an other one to the data to.
+
+Implementation is done in python, the code is put into Docker images (as the consumers). To run the full project
+clone the main repository and run
+*docker-compose up.*
+
+Produced by GoldenPogácsa Inc.

app.py

@@ -1,18 +1,20 @@
 #!/usr/bin/env python
 
+"""
+Main entry point, this module builds the producer from the submodules.
+"""
+
 import os
 import random
 import uuid
 import logging
 import sentry_sdk
 import time
+from consumerinformation import ConsumerInformation
 from communicator import Communicator
 from consumerlocator import ConsumerLocator
 from messagesender import MessageSender
-
-"""
-Main entry point, This module builds the producer from the submodules. 
-"""
+from redisconnector import RedisConnector
 
 __author__ = "@tormakris"
 __copyright__ = "Copyright 2020, GoldenPogácsa Team"
@@ -27,23 +29,31 @@ logging.basicConfig(
 )
 LOGGER = logging.getLogger(__name__)
 
-KNOWNCONSUMER = os.getenv("PRODUCER_KNOWNCONSUMER",'10.69.42.1')
+KNOWNCONSUMER = os.getenv("PRODUCER_KNOWNCONSUMER", '10.69.42.1')
 
-"""
-This is the producers entry point, initializes all the components (:class:'communicator.Communicator',
-:class:'consumerlocator.ConsumerLocator' and :class:'messagesender.MessageSender') and sends infinite random
-messages.
-"""
 if __name__ == "__main__":
+    """
+    This is the producers entry point, initializes all the components (:class:`communicator.Communicator`,
+    :class:`consumerlocator.ConsumerLocator` and :class:`messagesender.MessageSender`) and sends infinite random
+    messages. Basically this is a big loop, learning about consumers ( :func:`consumerlocator.ConsumerLocator.learnconsumerlist` ),
+    updating the current ( :func:`consumerlocator.ConsumerLocator.updateconsumer` ) one and sending the message
+    ( :func:`messagesender.MessageSender.sendmessage` ).
+    If the current consumer is unavailable, the update will change to an available one. To not flood the network with
+    infinite data, we some random time.
+    """
     LOGGER.info("Producer started")
     generateduuid = str(uuid.uuid4())
-    communicator = Communicator(currentconsumer=KNOWNCONSUMER, uuid=generateduuid)
+    redisconnector = RedisConnector()
+    consumerinfomation = ConsumerInformation(redisconnector=redisconnector)
+    communicator = Communicator(currentconsumer=KNOWNCONSUMER, uuid=generateduuid,
+                                consumerinformation=consumerinfomation)
     LOGGER.debug(f"My uuid is {generateduuid}")
-    consumerlocator = ConsumerLocator(uuid=generateduuid, communicator=communicator)
-    messagesender = MessageSender(communicator=communicator)
-    consumerlocator.learnconsumerlist()
+    messagesender = MessageSender(communicator=communicator, uuid=generateduuid)
+    consumerlocator = ConsumerLocator(communicator=communicator,
+                                      redisconnector=redisconnector)
 
     while True:
+        consumerlocator.learnconsumerlist()
         LOGGER.info(f"Updating consumer list of {generateduuid}")
         consumerlocator.updateconsumer()
         LOGGER.info("Sending message to consumer")

communicator.py

@@ -1,11 +1,14 @@
 #!/usr/bin/env python
-import logging
-import requests
 
 """
 Communicator module
 """
 
+import logging
+import requests
+import requests.exceptions
+from consumerinformation import ConsumerInformation
+
 __author__ = "@tormakris"
 __copyright__ = "Copyright 2020, GoldenPogácsa Team"
 __module_name__ = "messagesender"
@@ -14,74 +17,92 @@ __version__text__ = "1"
 logging.basicConfig(level=logging.INFO)
 LOGGER = logging.getLogger(__name__)
 
+
 class Communicator:
     """
     Class handling low level communication with consumers.
     """
 
-    def __init__(self, currentconsumer: str, uuid: str):
-        """Initialize object
-        :param consumerlocator: the current consumer's IP address as a string
+    def __init__(self, currentconsumer: str, uuid: str, consumerinformation: ConsumerInformation):
+        """**Constructor:**
+        Initializes the object.
+
+        :param currentconsumer: the current consumer's IP address as a string
         :param uuid: string typed UUID.
         """
-        self.currenctconsumer=currentconsumer
+        self.currenctconsumer = currentconsumer
         self.uuid = uuid
+        self.consumerinformation = consumerinformation
 
     def sendmessage(self, message: str) -> None:
         """Send message to the current consumer. Logs the process.
+
         :param message: the message of type string that will be sent.
         :return: None
         """
-        currentconsumer=self.currenctconsumer
+        currentconsumer = self.currenctconsumer
         LOGGER.info(f"Sending message to {currentconsumer}")
-        postresponse=requests.post(f'http://{currentconsumer}/log', json={'uuid': self.uuid, 'message': message})
-        LOGGER.debug(f"Message status code is:{postresponse.status_code}")
+
+        for consumer in self.consumerinformation.getconsumerlist():
+            try:
+                postresponse = requests.post(f'http://{consumer}/log', json={'uuid': self.uuid, 'message': message},
+                                             timeout=5)
+                LOGGER.debug(f"Message status code is:{postresponse.status_code}")
+                if postresponse.status_code < 300:
+                    return None
+            except (requests.exceptions.Timeout, requests.exceptions.ConnectionError) as e:
+                LOGGER.warning(f"Could not send message to {consumer}")
 
     def discoveravailableconsumers(self) -> list:
         """Get the list of available consumer from the current primary consumer. Logs the received list.
+
         :return: list of consumers' IP addresses
         """
         try:
             currentconsumer = self.currenctconsumer
-            response = requests.get(f'http://{currentconsumer}/consumers')
+            response = requests.get(f'http://{currentconsumer}/consumers', timeout=5)
             json = response.json()
             LOGGER.info(f"List of currently available consumers: {json}")
             return json
         except Exception as e:
-            LOGGER.exception(e)
+            LOGGER.warning("Could not query available consumer list!")
+            # LOGGER.exception(e)
             return []
 
     def isconsumeravailable(self) -> bool:
         """Readiness probe current consumer. Logs the result.
+
         :return: True if available, False otherwise
         """
         currentconsumer = self.currenctconsumer
         try:
-            response = requests.get(f'http://{currentconsumer}/consumers')
+            response = requests.get(f'http://{currentconsumer}/consumers', timeout=5)
             isavailable = response.status_code == 200
         except Exception as e:
-            LOGGER.exception(e)
+            # LOGGER.exception(e)
             isavailable = False
         LOGGER.info(f"Current consumer availability: {isavailable}")
         return isavailable
 
     def checkconsumer(self, consumer: str) -> bool:
         """Readiness probe of a particular consumer. Logs the result.
+
         :param consumer: the consumer's IP address
         :return: True if available, False otherwise
         """
         try:
-            response = requests.get(f'http://{consumer}/consumers')
+            response = requests.get(f'http://{consumer}/consumers', timeout=5)
             isavailable = response.status_code == 200
         except Exception as e:
-            LOGGER.exception(e)
+            # LOGGER.exception(e)
             isavailable = False
         LOGGER.info(f"Consumer {consumer} availability: {isavailable}")
         return isavailable
 
-    def set_currentconsumer(self,currenctconsumer) -> None:
+    def set_currentconsumer(self, currenctconsumer) -> None:
         """Set current consumer
+
         :param currenctconsumer: the consumer's IP address
         :return: None
         """
-        self.currenctconsumer=currenctconsumer
+        self.currenctconsumer = currenctconsumer

consumerinformation.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+"""
+Consumer locator module, that manages the list of consumers.
+"""
+
+from redisconnector import RedisConnector
+
+__author__ = "@ricsik52"
+__copyright__ = "Copyright 2020, GoldenPogácsa Team"
+__module_name__ = "consumerlocator"
+__version__text__ = "1"
+
+
+class ConsumerInformation:
+    """
+    Component responsible for providing high level information about consumers
+    """
+
+    def __init__(self, redisconnector: RedisConnector):
+        """**Constructor:**
+        Initializes the object.
+
+        :param redisconnector: the :class:'redisconnector.RedisConnector' instance that will be used for Redis connection.
+        """
+        self.red = redisconnector
+
+    def getconsumerlist(self) -> list:
+        """
+        Gets the list of currently available consumers.
+        :return:
+        """
+        toreturn = []
+        for consumer in self.red.consumerlist:
+            if consumer['State']:
+                toreturn.append(consumer['Host'])
+        return toreturn

consumerlocator.py

@@ -1,80 +1,102 @@
 #!/usr/bin/env python
 
-import datetime
-from communicator import Communicator
-import os
-
 """
 Consumer locator module, that manages the list of consumers.
 """
 
+import datetime
+from communicator import Communicator
+import os
+from redisconnector import RedisConnector
+import logging
+
 __author__ = "@dscharnitzky"
 __copyright__ = "Copyright 2020, GoldenPogácsa Team"
 __module_name__ = "consumerlocator"
 __version__text__ = "1"
 
-KNOWNCONSUMER = os.getenv("PRODUCER_KNOWNCONSUMER",'10.69.42.1')
+KNOWNCONSUMER = os.getenv("PRODUCER_KNOWNCONSUMER", '10.69.42.1')
+LOGGER = logging.getLogger(__name__)
+
 
 class ConsumerLocator:
-
     """
-    Component responsible for managing the list of consumers. Requires an instance of :class:'communicator.Communicator'
+    Component responsible for managing the list of consumers. Requires an instance of :class:`communicator.Communicator`
     """
 
-    def __init__(self, uuid: str, communicator: Communicator):
-        """Initializes the object.
+    def __init__(self, communicator: Communicator, redisconnector: RedisConnector):
+        """**Constructor:**
+        Initializes the object.
+
         Gets the known consumer's IP address from the PRODUCER_KNOWNCONSUMER envar.
-        :param: uuid: Not used
-        :param: communicator: the :class:'communicator.Communicator' instance that will be used for the low level
-        communication.
+
+        :param communicator: the :class:'communicator.Communicator' instance that will be used for the low level communication.
         """
-        self.consumerlist = [{"Host": KNOWNCONSUMER, "State": True, "LastOk": datetime.datetime.now()}]
-        self.currentconsumer = self.consumerlist[0]
+        self.red = redisconnector
+        self.red.consumerlist = [{"Host": KNOWNCONSUMER, "State": True, "LastOk": datetime.datetime.now().timestamp()}]
+        self.red.currentconsumer = self.red.consumerlist[0]
         self.communicator = communicator
 
     def learnconsumerlist(self) -> None:
         """"Learns the list of consumers from the current consumer.
-        Calls :func:'~communicator.Communicator.didiscoveravailableconsumers', adds the learned consumers to the list
-        if are not present, and then calls :func:'~consumerlocator.ConsumerLocator.updateconsumerlist'
-        :return: None
+        
+        Calls :func:`communicator.Communicator.didiscoveravailableconsumers`, adds the learned consumers to the list
+        if are not present, and then calls :func:`consumerlocator.ConsumerLocator.updateconsumerlist`
+        
+        :returns: None
         """
         recievedconsumerlist = self.communicator.discoveravailableconsumers()
-        if recievedconsumerlist is None:
+        if not recievedconsumerlist:
             return
+
+        consumer_list = self.red.consumerlist
+
         for recconsumer in recievedconsumerlist:
             contains = False
-            for consumer in self.consumerlist:
+            for consumer in consumer_list:
                 if consumer["Host"] == recconsumer:
                     contains = True
 
             if not contains:
-                self.consumerlist.append({"Host": recconsumer, "State": True, "LastOk": datetime.datetime.now()})
+                LOGGER.info(f"Learned about new consumer at {recconsumer}")
+                consumer_list.append(
+                    {"Host": recconsumer, "State": True, "LastOk": datetime.datetime.now().timestamp()})
 
+        self.red.consumerlist = consumer_list
         self.updateconsumerlist()
 
     def updateconsumerlist(self) -> None:
         """ Updates the consumer list based on their availability.
+        
         Marks for each consumer if they are available or not. If a consumer is not available for some time (1 hour),
         the it will be deleted from the list.
+        
         :return: None
         """
         removelist = []
-        for consumer in self.consumerlist:
+        consumer_list = self.red.consumerlist
+
+        for consumer in consumer_list:
             if not self.communicator.checkconsumer(consumer["Host"]):
                 consumer["State"] = False
-                if datetime.datetime.now() - consumer["LastOk"] > datetime.timedelta(hours=1):
+                if datetime.datetime.now() - datetime.datetime.fromtimestamp(consumer["LastOk"]) > datetime.timedelta(
+                        seconds=15):
                     removelist.append(consumer)
             else:
-                consumer["LastOk"] = datetime.datetime.now()
+                consumer["LastOk"] = datetime.datetime.now().timestamp()
                 consumer["State"] = True
         for rem in removelist:
-            self.consumerlist.remove(rem)
+            consumer_list.remove(rem)
+
+        self.red.consumerlist = consumer_list
 
     def updateconsumer(self):
         """If the current consumer is not available, checks all the consumers in the list and updates the current one.
-        Calls :func:'~consumerlocator.ConsumerLocator.checkcurrentconsumer' and if needed
-        :func:'~consumerlocator.ConsumerLocator.updateconsumerlist'. Sets the :class:'communicator.Communicator'
-        current instance with :func:'~communicator.Communicator.set_currentconsumer'.
+       
+        Calls :func:`consumerlocator.ConsumerLocator.checkcurrentconsumer` and if needed
+        :func:`consumerlocator.ConsumerLocator.updateconsumerlist`. Sets the :class:`communicator.Communicator`
+        current instance with :func:`communicator.Communicator.set_currentconsumer`.
+        
         :return: the current consumer or None if there are no available customers at the moment.
         """
 
@@ -82,33 +104,34 @@ class ConsumerLocator:
             self.updateconsumerlist()
             newcurrentconsumer = None
 
-            for consumer in self.consumerlist:
+            for consumer in self.red.consumerlist:
                 if consumer["State"]:
                     newcurrentconsumer = consumer
                     break
 
-            self.currentconsumer = newcurrentconsumer
-            if self.currentconsumer is not None:
+            self.red.currentconsumer = newcurrentconsumer
+            if self.red.currentconsumer is not None:
+                LOGGER.warning(f"Falling back to consumer at {newcurrentconsumer['Host']}")
                 self.learnconsumerlist()
 
-        if self.currentconsumer is not None:
-            self.communicator.set_currentconsumer(self.currentconsumer["Host"])
-            return self.currentconsumer["Host"]
+        if self.red.currentconsumer is not None:
+            self.communicator.set_currentconsumer(self.red.currentconsumer["Host"])
+            return self.red.currentconsumer["Host"]
         else:
             return None
 
     def getcurrentconsumer(self) -> str:
-        """
-        Returns the currently selected consumer's IP address.
+        """Returns the currently selected consumer's IP address.
+        
         :return: the current consumer
         """
-        return self.currentconsumer["Host"]
+        return self.red.currentconsumer["Host"]
 
     def checkcurrentconsumer(self) -> bool:
-        """
-        Check the current consumer's health.
+        """Check the current consumer's health.
+        
         :return: True if OK, False if fail
         """
-        if self.currentconsumer is None:
+        if self.red.currentconsumer is None:
             return False
-        return self.communicator.checkconsumer(self.currentconsumer["Host"])
+        return self.communicator.checkconsumer(self.red.currentconsumer["Host"])

docs/Dockerfile

@@ -0,0 +1,3 @@
+FROM httpd:2.4
+
+COPY _build/html/ /usr/local/apache2/htdocs/

docs/conf.py

@@ -44,7 +44,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+autoclass_content = 'both'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -10,6 +10,8 @@ Welcome to Producer's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   readme
+   source/modules
 
 
 Indices and tables
@@ -18,3 +20,5 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+* `Git repository <https://git.kmlabz.com/GoldenPogacsa/producer>`_
+

docs/readme.rst

@@ -0,0 +1,2 @@
+.. include:: ../README.rst
+

docs/source/app.rst

@@ -0,0 +1,7 @@
+app module
+==========
+
+.. automodule:: app
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/communicator.rst

@@ -0,0 +1,7 @@
+communicator module
+===================
+
+.. automodule:: communicator
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/consumerlocator.rst

@@ -0,0 +1,7 @@
+consumerlocator module
+======================
+
+.. automodule:: consumerlocator
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/messagesender.rst

@@ -0,0 +1,7 @@
+messagesender module
+====================
+
+.. automodule:: messagesender
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules.rst

@@ -0,0 +1,11 @@
+producer
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   app
+   communicator
+   consumerlocator
+   messagesender
+   test

docs/source/test.rst

@@ -0,0 +1,7 @@
+test module
+===========
+
+.. automodule:: test
+   :members:
+   :undoc-members:
+   :show-inheritance:

integtest.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python
+
+"""
+Integration test for the producer module.
+"""
+
+import re
+from consumerinformation import ConsumerInformation
+from communicator import Communicator
+from consumerlocator import ConsumerLocator
+from messagesender import MessageSender
+from redisconnector import RedisConnector
+from pytest_redis import factories
+
+__author__ = "@dscharnitzky"
+__copyright__ = "Copyright 2020, GoldenPogácsa Team"
+__module_name__ = "integtest"
+__version__text__ = "1"
+
+generateduuid = '2fbff1f2-27e7-44c8-88d9-7348cee8c1c3'
+redis_proc = factories.redis_proc(host='cache', port=6379)
+redis_db = factories.redisdb('redis_nooproc')
+
+answer = ""
+
+
+def answermethod(Request):
+    global answer
+    answer = Request
+    return ""
+
+
+def test_integration(httpserver):
+    """
+    Tests the whole system.
+
+    :param httpserver: simple HTTP server
+    """
+    #Inint
+    httpserver.expect_request(
+        uri="/consumers",
+        method='GET',
+        data="").respond_with_json(
+        ["localhost", "localhost", "1.2.3.4"])
+    httpserver.expect_request(
+        uri="/log",
+        method='POST').respond_with_handler(answermethod)
+    url = httpserver.url_for("/")
+    port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnector = RedisConnector()
+    consumerinfomation = ConsumerInformation(redisconnector=redisconnector)
+    comm = Communicator(
+        currentconsumer=f"127.0.0.1:{port}",
+        uuid=generateduuid, consumerinformation=consumerinfomation)
+    messagesender = MessageSender(communicator=comm, uuid=generateduuid)
+    consumerlocator = ConsumerLocator(communicator=comm,
+                                      redisconnector=redisconnector)
+    #First test method
+    consumerlocator.learnconsumerlist()
+    conslist = consumerlocator.red.consumerlist
+    assert len(conslist) == 3
+    #Mock in port numbers
+    consrepllist = []
+    for consumer in conslist:
+        newconsumer = {"Host": consumer["Host"]+":"+port, "State": consumer["State"], "LastOk": consumer["LastOk"]}
+        consrepllist.append(newconsumer)
+    consumerlocator.red.consumerlist = consrepllist
+    conslist = consumerlocator.red.consumerlist
+    #Second test method call
+    consumerlocator.updateconsumerlist()
+    conslist = consumerlocator.red.consumerlist
+    error = False
+    for consumer in conslist:
+        if consumer["Host"] == "localhost:"+port and consumer["State"] is True:
+            pass
+        elif consumer["Host"] == "1.2.3.4:"+port and consumer["State"] is False:
+            pass
+        elif consumer["Host"] == "10.69.42.1:"+port and consumer["State"] is False:
+            pass
+        else:
+            error = True
+    assert error is False
+    #Third test method call
+    consumerlocator.updateconsumer()
+    assert consumerlocator.red.currentconsumer["Host"] == "localhost:"+port
+    messagesender.sendmessage()
+    assert answer != ""

messagesender.py

@@ -1,13 +1,15 @@
 #!/usr/bin/env python
+
+"""
+Message sender component.
+"""
+
 import logging
 import random
 import string
+import json
 from communicator import Communicator
 
-"""
-Message sender component
-"""
-
 __author__ = "@kovacsbence"
 __copyright__ = "Copyright 2020, GoldenPogácsa Team"
 __module_name__ = "messagesender"
@@ -19,18 +21,21 @@ LOGGER = logging.getLogger(__name__)
 
 class MessageSender:
     """
-    Component responsible for sending the messages. Requires an instance of :class:'communicator.Communicator'
+    Component responsible for sending the messages. Requires an instance of :class:`communicator.Communicator`.
     """
 
-    def __init__(self, communicator: Communicator):
-        """Initializes the object.
-        :param: communicator: an instance of :class:'communicator.Communicator'
+    def __init__(self, communicator: Communicator, uuid: str):
+        """**Constructor:**
+        Initializes the object.
+
+        :param communicator: an instance of :class:`communicator.Communicator`.
         """
         self.communicator = communicator
+        self.uuid = uuid
 
     def randomstring(self, stringlength: int) -> str:
-        """
-        Generate a random string of fixed length
+        """Generate a random string of fixed length
+
         :param stringlength: the length of the string
         :return: the generated string
         """
@@ -39,14 +44,16 @@ class MessageSender:
 
     def sendmessage(self, message: str = "") -> None:
         """Sends the given message.
+
         If the message is omitted (empty), then a random message will be generated with length 23 (with
-        :func:'~messagesender.MessageSender.randomstring'. Calls :func:'~communicator.Communicator.sendmessage'
+        :func:`messagesender.MessageSender.randomstring`. Calls :func:`communicator.Communicator.sendmessage`
         to send the message.
-        :param message: the message of type string that will be sent
+
+        :param message: the message of type string that will be sent.
         :return: None
         """
         if not message:
             data = self.randomstring(32)
         else:
             data = message
-        self.communicator.sendmessage(data)
+        self.communicator.sendmessage(json.dumps({"message": data, "uuid": self.uuid}))

redisconnector.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+import os
+import redis
+import json
+
+"""
+Redis interaction
+"""
+
+__author__ = "@tormakris"
+__copyright__ = "Copyright 2020, GoldenPogácsa Team"
+__module_name__ = "redis"
+__version__text__ = "1"
+
+
+REDISHOST = os.getenv("PRODUCER_REDIS", 'localhost')
+
+
+class RedisConnector:
+    """
+    Class abstracting Redis communication
+    """
+    def __init__(self):
+        """
+        Initialize class
+        """
+        self.redisconnection = redis.StrictRedis(host=REDISHOST, port=6379, db=0)
+
+    def get_consumerlist(self):
+        """
+        Gets list of consumers stored in Redis.
+        :return:
+        """
+        return json.loads(self.redisconnection.get('consumerList'))
+
+    def set_consumerlist(self, consumerlist):
+        """
+        Sets list of consumers stored in Redis.
+        :param consumerlist:
+        :return:
+        """
+        json_list = json.dumps(consumerlist)
+        self.redisconnection.set('consumerList', json_list)
+
+    def get_currentconsumer(self):
+        """
+        Gets currently active consumer.
+        :return:
+        """
+        return json.loads(self.redisconnection.get('currentConsumer'))
+
+    def set_currentconsumer(self, currentconsumer):
+        """
+        Sets currently active consumer
+        :param currentconsumer:
+        :return:
+        """
+        json_dict = json.dumps(currentconsumer)
+        self.redisconnection.set('currentConsumer', json_dict)
+
+    consumerlist = property(get_consumerlist, set_consumerlist)
+    currentconsumer = property(get_currentconsumer, set_currentconsumer)

requirements.txt

@@ -2,4 +2,6 @@ sentry_sdk
 requests
 pytest
 pytest-mock
-pytest-httpserver
+pytest-httpserver
+pytest-redis
+redis

test.py

@@ -1,13 +1,16 @@
 #!/usr/bin/env python
 
+"""
+Unit tests for the producer module.
+"""
+
 import re
 import consumerlocator
 import communicator
 import messagesender
-
-"""
-Unit tests for producer module.
-"""
+import redisconnector
+import consumerinformation
+from pytest_redis import factories
 
 __author__ = "@tormakris"
 __copyright__ = "Copyright 2020, GoldenPogácsa Team"
@@ -15,18 +18,23 @@ __module_name__ = "test"
 __version__text__ = "1"
 
 generateduuid = 'c959ad81-58f9-4445-aab4-8f3d68aee1ad'
+redis_proc = factories.redis_proc(host='cache', port=6379)
+redis_db = factories.redisdb('redis_nooproc')
 
 
 def test_generate_string(mocker):
     """
-    Tests :func:'~messagesender.MessageSender.randomstring'.
-    :param: mocker:
+    Tests :func:`messagesender.MessageSender.randomstring`.
+
+    :param mocker: patches the :class:`communicator.Communicator`.
     """
     mocker.patch('communicator.Communicator')
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
     comm = communicator.Communicator(
         currentconsumer="localhost",
-        uuid=generateduuid)
-    mess = messagesender.MessageSender(communicator=comm)
+        uuid=generateduuid, consumerinformation=consumerinfo)
+    mess = messagesender.MessageSender(communicator=comm, uuid=generateduuid)
     msg = mess.randomstring(stringlength=32)
     assert isinstance(msg, str)
     assert len(msg) == 32
@@ -34,7 +42,8 @@ def test_generate_string(mocker):
 
 def test_sendmessage(httpserver):
     """
-    Tests :func:'~communicator.Communicator.sendmessage'.
+    Tests :func:`communicator.Communicator.sendmessage`.
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -46,9 +55,13 @@ def test_sendmessage(httpserver):
             "test": "ok"})
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     mess = "SENDING"
     ret = comm.sendmessage(message=mess)
     assert ret is None
@@ -56,15 +69,20 @@ def test_sendmessage(httpserver):
 
 def test_send_message(mocker):
     """
-    Tests :func:'~messagesender.MessageSender.sendmessage'.
-    :param mocker:
+    Tests :func:`messagesender.MessageSender.sendmessage`.
+
+    :param mocker: patches the :class:`communicator.Communicator`.
     :return: None
     """
     mocker.patch('communicator.Communicator')
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1", "State": True, "LastOk": "1589479202"}]
     comm = communicator.Communicator(
         currentconsumer="127.0.0.1",
-        uuid=generateduuid)
-    mess = messagesender.MessageSender(communicator=comm)
+        uuid=generateduuid, consumerinformation=consumerinfo)
+    mess = messagesender.MessageSender(communicator=comm, uuid=generateduuid)
     messa = "SENDING"
     msg = mess.sendmessage(message=messa)
     assert msg is None
@@ -72,7 +90,8 @@ def test_send_message(mocker):
 
 def test_discoveravailableconsumers(httpserver):
     """
-    Tests :func:'~communicator.Communicator.discoveravailableconsumers'
+    Tests :func:`communicator.Communicator.discoveravailableconsumers`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -83,9 +102,13 @@ def test_discoveravailableconsumers(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     ret = comm.discoveravailableconsumers()
     assert isinstance(ret, list)
     assert ret == ["10.69.42.1", "10.10.10.10", "10.20.30.40"]
@@ -93,7 +116,8 @@ def test_discoveravailableconsumers(httpserver):
 
 def test_isconsumeravailable(httpserver):
     """
-    Tests :func:'~communicator.Communicator.isconsumeravailable'
+    Tests :func:`communicator.Communicator.isconsumeravailable`.
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -104,9 +128,13 @@ def test_isconsumeravailable(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     ret = comm.isconsumeravailable()
     assert isinstance(ret, bool)
     assert ret
@@ -117,7 +145,7 @@ def test_isconsumeravailable(httpserver):
 
     comm2 = communicator.Communicator(
         currentconsumer="127.0.0.1:69",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
 
     ret3 = comm2.isconsumeravailable()
     assert isinstance(ret3, bool)
@@ -126,7 +154,8 @@ def test_isconsumeravailable(httpserver):
 
 def test_checkconsumer(httpserver):
     """
-    Tests :func:'~communicator.Communicator.checkconsumer'
+    Tests :func:`communicator.Communicator.checkconsumer`.
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -137,9 +166,13 @@ def test_checkconsumer(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     comm = communicator.Communicator(
         currentconsumer="127.0.0.1",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     ret = comm.checkconsumer(f"127.0.0.1:{port}")
     assert isinstance(ret, bool)
     assert ret
@@ -150,8 +183,7 @@ def test_checkconsumer(httpserver):
 
     comm2 = communicator.Communicator(
         currentconsumer="127.0.0.1",
-        uuid=generateduuid)
-
+        uuid=generateduuid, consumerinformation=consumerinfo)
     ret3 = comm2.checkconsumer(f"127.0.0.1:{port}")
     assert isinstance(ret3, bool)
     assert ret3 == False
@@ -159,19 +191,23 @@ def test_checkconsumer(httpserver):
 
 def test_setcurrentconsumer():
     """
-    Tests :func:'~communicator.Communicator.set_currentconsumer'
+    Tests :func:`communicator.Communicator.set_currentconsumer`
+
     :return: None
     """
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
     comm = communicator.Communicator(
         currentconsumer="127.0.0.1",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     comm.set_currentconsumer("10.69.42.1")
     assert comm.currenctconsumer == "10.69.42.1"
 
 
 def test_learnconsumerlist(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.learnconsumerlist'
+    Tests :func:`consumerlocator.ConsumerLocator.learnconsumerlist`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -182,34 +218,44 @@ def test_learnconsumerlist(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     consumerlocator.KNOWNCONSUMER = f"127.0.0.1:{port}"
     locator = consumerlocator.ConsumerLocator(
-        uuid=generateduuid, communicator=comm)
+        communicator=comm,
+        redisconnector=redisconnector.RedisConnector())
     ret = locator.learnconsumerlist()
     assert ret is None
 
 
 def test_getcurrentconsumer(mocker):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.getcurrentconsumer'
-    :param mocker:
+    Tests :func:`consumerlocator.ConsumerLocator.getcurrentconsumer`
+
+    :param mocker: patches the :class:`communicator.Communicator`.
     :return: None
     """
     mocker.patch('communicator.Communicator')
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
     comm = communicator.Communicator(
         currentconsumer="127.0.0.1",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     locator = consumerlocator.ConsumerLocator(
-        uuid=generateduuid, communicator=comm)
+        communicator=comm,
+        redisconnector=redisconnector.RedisConnector())
     assert locator.getcurrentconsumer() == consumerlocator.KNOWNCONSUMER
 
 
 def test_checkcurrentconsumer(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.checkcurrentconsumer'
+    Tests :func:`consumerlocator.ConsumerLocator.checkcurrentconsumer`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -220,19 +266,25 @@ def test_checkcurrentconsumer(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     consumerlocator.KNOWNCONSUMER = f"127.0.0.1:{port}"
     locator = consumerlocator.ConsumerLocator(
-        uuid=generateduuid, communicator=comm)
+        communicator=comm,
+        redisconnector=redisconnector.RedisConnector())
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     ret = locator.checkcurrentconsumer()
     assert ret == True
 
 
 def test_updateconsumer(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.updateconsumer'
+    Tests :func:`consumerlocator.ConsumerLocator.updateconsumer`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -243,20 +295,27 @@ def test_updateconsumer(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     consumerlocator.KNOWNCONSUMER = f"127.0.0.1:{port}"
+    redisconn = redisconnector.RedisConnector()
     locator = consumerlocator.ConsumerLocator(
-        uuid=generateduuid, communicator=comm)
-    assert locator.currentconsumer is not None
+        communicator=comm,
+        redisconnector=redisconn)
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
+    assert redisconn.currentconsumer is not None
     ret = locator.updateconsumer()
     assert ret == f"127.0.0.1:{port}"
 
 
 def test_updateconsumerlist(httpserver):
     """
-    Tests :func:'~consumerlocator.ConsumerLocator.updateconsumerlist'
+    Tests :func:`consumerlocator.ConsumerLocator.updateconsumerlist`
+
     :param httpserver: simple HTTP server
     :return: None
     """
@@ -267,11 +326,16 @@ def test_updateconsumerlist(httpserver):
         ["10.69.42.1", "10.10.10.10", "10.20.30.40"])
     url = httpserver.url_for("/")
     port = re.match(r"\W*http[^:]*\D*(\d+)", url).group(1)
+    redisconnect = redisconnector.RedisConnector()
+    consumerinfo = consumerinformation.ConsumerInformation(redisconnector=redisconnect)
     comm = communicator.Communicator(
         currentconsumer=f"127.0.0.1:{port}",
-        uuid=generateduuid)
+        uuid=generateduuid, consumerinformation=consumerinfo)
     consumerlocator.KNOWNCONSUMER = f"127.0.0.1:{port}"
     locator = consumerlocator.ConsumerLocator(
-        uuid=generateduuid, communicator=comm)
+        communicator=comm,
+        redisconnector=redisconnector.RedisConnector())
+    redisconnect.currentconsumer = {"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}
+    redisconnect.consumerlist = [{"Host": f"127.0.0.1:{port}", "State": True, "LastOk": "1589479202"}]
     ret = locator.updateconsumerlist()
     assert ret is None