Merge pull request #24 from redhat-aqe/actions

Add github actions

Author: Allda

.github/workflows/main.yml

@@ -0,0 +1,48 @@
+name: CI/CD release pipeline
+
+# Run this workflow every time a new commit pushed to your repository
+on: push
+
+jobs:
+  tox-test:
+    name: Tox test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Run Tox tests
+        uses: fedora-python/tox-github-action@master
+        with:
+          tox_env: ${{ matrix.tox_env }}
+    strategy:
+      matrix:
+        tox_env: [py3, black, pylint, mypy]
+
+  build-and-release:
+    name: Build package and release to PyPi
+    runs-on: ubuntu-latest
+    needs: [tox-test]
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Python 3.x
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel
+      - name: Build
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.TEST_PYPI_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+          skip_existing: true
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

README.md

@@ -1,6 +1,8 @@
 Kafka Logging Handler
 =====================
 [![Downloads](https://pepy.tech/badge/kafka-logging-handler)](https://pepy.tech/project/kafka-logging-handler)
+![Workflow](https://github.com/redhat-aqe/kafka-logging-handler/workflows/release-pipeline/badge.svg)
+
 
 The following library simplifies the process of forwarding logs to a Kafka consumer.
 

build_requirements.txt

@@ -1,2 +1,3 @@
-flake8
+black
 pypandoc
+pytest

examples/mt_mp.py

@@ -1,5 +1,5 @@
 """Usage of kafka-logging-handler with multiprocessing and multithreading."""
-
+# pylint: disable=global-statement
 from concurrent.futures import ThreadPoolExecutor
 import logging
 import multiprocessing
@@ -10,7 +10,7 @@
 
 from kafka_logger.handlers import KafkaLoggingHandler
 
-REQUIRED_ENV_VARS = ['KAFKA_SERVER', 'KAFKA_CERT', 'KAFKA_TOPIC']
+REQUIRED_ENV_VARS = ["KAFKA_SERVER", "KAFKA_CERT", "KAFKA_TOPIC"]
 
 MAIN_PROCESS_THREADS = 2
 CHILD_PROCESSES = 2
@@ -25,8 +25,7 @@ def get_process_thread():
     # you can get PID and thread ID as well:
     # os.getpid(), threading.current_thread().ident
     return "(process: {}, thread: {})".format(
-        multiprocessing.current_process().name,
-        threading.current_thread().name
+        multiprocessing.current_process().name, threading.current_thread().name
     )
 
 
@@ -48,9 +47,7 @@ def grandchild_process():
 def child_process_with_grandchild():
     """Spawn grandchild process."""
     LOGGER.info("I'm going to spawn another child %s", get_process_thread())
-    subprocess = Process(
-        target=grandchild_process,
-        name="Grandchild process")
+    subprocess = Process(target=grandchild_process, name="Grandchild process")
     subprocess.start()
     subprocess.join()
 
@@ -59,7 +56,9 @@ def thread_worker(index):
     """Log a message."""
     LOGGER.info(
         "Hi, I'm a thread worker #%d in the child process thread pool %s",
-        index, get_process_thread())
+        index,
+        get_process_thread(),
+    )
 
 
 def child_process_with_threads():
@@ -72,15 +71,18 @@ def child_process_with_threads():
 
 def main_process_thread(index):
     """Log a message."""
-    LOGGER.info("Hi, I'm a thread #%d in the main process %s",
-                index, get_process_thread())
+    LOGGER.info(
+        "Hi, I'm a thread #%d in the main process %s", index, get_process_thread()
+    )
 
 
 def child_process_with_exception():
     """Raise an exception after start."""
-    LOGGER.info("Hi, I'm child process that is going to raise exception %s",
-                get_process_thread())
-    raise Exception('This exception will not occur in Kafka!')
+    LOGGER.info(
+        "Hi, I'm child process that is going to raise exception %s",
+        get_process_thread(),
+    )
+    raise Exception("This exception will not occur in Kafka!")
 
 
 def main():
@@ -95,8 +97,8 @@ def main():
     log_level = logging.DEBUG
 
     log_format = logging.Formatter(
-        '%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
-        '%Y-%m-%dT%H:%M:%S')
+        "%(asctime)s %(name)-12s %(levelname)-8s %(message)s", "%Y-%m-%dT%H:%M:%S"
+    )
 
     # create handler to show logs at stdout
     stdout_handler = logging.StreamHandler(sys.stdout)
@@ -106,14 +108,12 @@ def main():
 
     # create Kafka logging handler
     kafka_handler = KafkaLoggingHandler(
-        os.environ['KAFKA_SERVER'],
-        os.environ['KAFKA_TOPIC'],
-        security_protocol='SSL',
-        ssl_cafile=os.environ['KAFKA_CERT'],
+        os.environ["KAFKA_SERVER"],
+        os.environ["KAFKA_TOPIC"],
+        security_protocol="SSL",
+        ssl_cafile=os.environ["KAFKA_CERT"],
         unhandled_exception_logger=LOGGER,
-        additional_fields={
-            "service": "test_service"
-        }
+        additional_fields={"service": "test_service"},
     )
     kafka_handler.setFormatter(log_format)
     LOGGER.addHandler(kafka_handler)
@@ -126,9 +126,8 @@ def main():
     child_processes = []
     for idx in range(CHILD_PROCESSES):
         child = Process(
-            target=child_process,
-            name="Child process #{}".format(idx),
-            args=(idx,))
+            target=child_process, name="Child process #{}".format(idx), args=(idx,)
+        )
         child_processes.append(child)
         child.start()
 
@@ -138,7 +137,8 @@ def main():
         thread = threading.Thread(
             target=main_process_thread,
             name="Thread of the main process #{}".format(idx),
-            args=(idx, ))
+            args=(idx,),
+        )
         threads.append(thread)
         thread.start()
     # wait for threads to finish
@@ -153,27 +153,28 @@ def main():
     # test if a child of a child process logs correctly
     child_with_subprocess = Process(
         target=child_process_with_grandchild,
-        name="Child process that spawns another child")
+        name="Child process that spawns another child",
+    )
     child_with_subprocess.start()
     child_with_subprocess.join()
 
     # test threads in a child process
     child_with_threads = Process(
-        target=child_process_with_threads,
-        name="Child process that has a thread pool")
+        target=child_process_with_threads, name="Child process that has a thread pool"
+    )
     child_with_threads.start()
     child_with_threads.join()
 
     # test unhandled exception in a child process
     child_exception = Process(
-        target=child_process_with_exception,
-        name="Child process with an exception")
+        target=child_process_with_exception, name="Child process with an exception"
+    )
     child_exception.start()
     child_exception.join()
 
     # top-level exception works only in the main process
-    raise Exception('Testing top-level exception!')
+    raise Exception("Testing top-level exception!")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

examples/preprocess.py

@@ -2,14 +2,14 @@
 
 import logging
 import os
+import random
 import sys
 import time
-import random
 
 from kafka_logger.handlers import KafkaLoggingHandler
 
-REQUIRED_ENV_VARS = ['KAFKA_SERVER', 'KAFKA_CERT', 'KAFKA_TOPIC']
-PASSWORDS = ['qwerty', '12345', 'password']
+REQUIRED_ENV_VARS = ["KAFKA_SERVER", "KAFKA_CERT", "KAFKA_TOPIC"]
+PASSWORDS = ["qwerty", "12345", "password"]
 
 
 def main():
@@ -22,8 +22,8 @@ def main():
     log_level = logging.DEBUG
 
     log_format = logging.Formatter(
-        '%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
-        '%Y-%m-%dT%H:%M:%S')
+        "%(asctime)s %(name)-12s %(levelname)-8s %(message)s", "%Y-%m-%dT%H:%M:%S"
+    )
 
     # create handler to show logs at stdout
     stdout_handler = logging.StreamHandler(sys.stdout)
@@ -33,40 +33,35 @@ def main():
 
     def remove_lineno(log):
         """Example preprocessor, includes lineno to message field."""
-        log['message'] += ' (at line {})'.format(log['lineno'])
-        del log['lineno']
-        log['custom_field'] = 42
+        log["message"] += " (at line {})".format(log["lineno"])
+        del log["lineno"]
+        log["custom_field"] = 42
         return log
 
     def hide_passwords(log):
         """Example preprocessor, hides passwords."""
         for password in PASSWORDS:
-            hidden_password = \
-                password[0] + \
-                '*' * (len(password) - 2) + \
-                password[-1]
-            log['message'] = log['message'].replace(password, hidden_password)
+            hidden_password = password[0] + "*" * (len(password) - 2) + password[-1]
+            log["message"] = log["message"].replace(password, hidden_password)
         return log
 
     # create Kafka logging handler
     kafka_handler = KafkaLoggingHandler(
-        os.environ['KAFKA_SERVER'],
-        os.environ['KAFKA_TOPIC'],
-        security_protocol='SSL',
-        ssl_cafile=os.environ['KAFKA_CERT'],
+        os.environ["KAFKA_SERVER"],
+        os.environ["KAFKA_TOPIC"],
+        security_protocol="SSL",
+        ssl_cafile=os.environ["KAFKA_CERT"],
         # you can configure how often logger will send logs to Kafka
         # flush_buffer_size=3,  # uncomment to see that it works slower
         # flush_interval=3.0,  # interval in seconds
         unhandled_exception_logger=logger,
         kafka_producer_args={
-            'api_version_auto_timeout_ms': 1000000,
-            'request_timeout_ms': 1000000,
+            "api_version_auto_timeout_ms": 1000000,
+            "request_timeout_ms": 1000000,
         },
         # you can include arbitrary fields to all produced logs
-        additional_fields={
-            "service": "test_service"
-        },
-        log_preprocess=[remove_lineno, hide_passwords]
+        additional_fields={"service": "test_service"},
+        log_preprocess=[remove_lineno, hide_passwords],
     )
     kafka_handler.setFormatter(log_format)
     logger.addHandler(kafka_handler)
@@ -80,5 +75,5 @@ def hide_passwords(log):
         time.sleep(0.5)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()