Add code formatting (#36)

* feat: feat: added job which checks if code is formatted correctly in CircleCi, code formatted using black

* fixing typo

Author: pszkamruk-splunk

.circleci/config.yml

@@ -40,6 +40,17 @@ jobs:
           path: build-container
           destination: build-container
 
+  format-code:
+    docker:
+      - image: circleci/python:3.8.6
+    steps:
+      - checkout
+      - run:
+          name: "Check Formatting"
+          command: |
+            pip install black
+            black --check ./
+
   release:
     docker:
       - image: circleci/node:12
@@ -118,6 +129,8 @@ workflows:
   version: 2
   build_test:
     jobs:
+      - format-code
+
       - build:
           context:
             - gdi-github

.gitignore

@@ -130,3 +130,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Intellij
+.idea

tests/conftest.py

@@ -1,4 +1,8 @@
-pytest_plugins = ['tests.snmp_utils.arguments_setup', 'tests.snmp_utils.fixtures.splunk_setup',
-                  'tests.snmp_utils.fixtures.splunk_docker_setup', 'tests.snmp_utils.fixtures.mongo_docker_setup',
-                  'tests.snmp_utils.fixtures.snmp_simulator_docker_setup',
-                  'tests.snmp_utils.fixtures.rabbitmq_docker_setup']
+pytest_plugins = [
+    "tests.snmp_utils.arguments_setup",
+    "tests.snmp_utils.fixtures.splunk_setup",
+    "tests.snmp_utils.fixtures.splunk_docker_setup",
+    "tests.snmp_utils.fixtures.mongo_docker_setup",
+    "tests.snmp_utils.fixtures.snmp_simulator_docker_setup",
+    "tests.snmp_utils.fixtures.rabbitmq_docker_setup",
+]

tests/mongo_integration_test.py

@@ -4,20 +4,25 @@
 # TODO as for now this is just a demo on how to use WalkedHostsRepository
 # TODO final version should use fixures to run MongoDB in Docker
 def main():
-    mongo_config = {'host': 'localhost', 'port': 27017, 'database': 'snmp_poller', 'collection': 'walked_hosts'}
+    mongo_config = {
+        "host": "localhost",
+        "port": 27017,
+        "database": "snmp_poller",
+        "collection": "walked_hosts",
+    }
 
     try:
         mongo = WalkedHostsRepository(mongo_config)
     except Exception:
-        print('Exception!')
+        print("Exception!")
 
     mongo.clear()
-    mongo.add_host('192.168.0.2')
-    print(mongo.contains_host('192.168.0.2'))
+    mongo.add_host("192.168.0.2")
+    print(mongo.contains_host("192.168.0.2"))
 
-    mongo.delete_host('192.168.0.2')
-    print(mongo.contains_host('192.168.0.2'))
+    mongo.delete_host("192.168.0.2")
+    print(mongo.contains_host("192.168.0.2"))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

tests/snmp_utils/__init__.py

@@ -1,3 +1,5 @@
 import logging.config
 
-logging.basicConfig(level=logging.INFO, format='%(asctime)s | %(name)s | %(levelname)s | %(message)s')
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s | %(name)s | %(levelname)s | %(message)s"
+)

tests/snmp_utils/arguments_setup.py

@@ -1,12 +1,45 @@
 def pytest_addoption(parser):
-    group = parser.getgroup('splunk-addon')
+    group = parser.getgroup("splunk-addon")
     # NOTE: for 'splunk-type' you can either specify 'external' or 'docker'
-    group.addoption('--splunk_type', action='store', dest='splunk_type', default='docker', help='Type of Splunk')
-    group.addoption('--splunk_host', action='store', dest='splunk_host', default='127.0.0.1',
-                    help='Address of the Splunk Server')
-    group.addoption('--splunk_port', action='store', dest='splunk_port', default='8089', help='Splunk rest port')
-    group.addoption('--splunk_user', action='store', dest='splunk_user', default='admin', help='Splunk login user')
-    group.addoption('--splunk_password', action='store', dest='splunk_password', default='Changed@11',
-                    help='Splunk password')
-    group.addoption('--connect_max_retries', action='store', dest='splunk_connect_max_retries', default='600',
-                    help='Max number of tries when connecting to Splunk before giving up')
+    group.addoption(
+        "--splunk_type",
+        action="store",
+        dest="splunk_type",
+        default="docker",
+        help="Type of Splunk",
+    )
+    group.addoption(
+        "--splunk_host",
+        action="store",
+        dest="splunk_host",
+        default="127.0.0.1",
+        help="Address of the Splunk Server",
+    )
+    group.addoption(
+        "--splunk_port",
+        action="store",
+        dest="splunk_port",
+        default="8089",
+        help="Splunk rest port",
+    )
+    group.addoption(
+        "--splunk_user",
+        action="store",
+        dest="splunk_user",
+        default="admin",
+        help="Splunk login user",
+    )
+    group.addoption(
+        "--splunk_password",
+        action="store",
+        dest="splunk_password",
+        default="Changed@11",
+        help="Splunk password",
+    )
+    group.addoption(
+        "--connect_max_retries",
+        action="store",
+        dest="splunk_connect_max_retries",
+        default="600",
+        help="Max number of tries when connecting to Splunk before giving up",
+    )

tests/snmp_utils/fixtures/mongo_docker_setup.py

@@ -12,12 +12,19 @@ def is_mongo_running(mongo_config):
     return client.is_connected()
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def mongo_service(request, docker_services):
-    service_name = 'mongo'
+    service_name = "mongo"
     docker_services.start(service_name)
     port = docker_services.port_for(service_name, 27017)
-    configuration = {'host': 'localhost', 'port': port, 'database': 'snmp_poller', 'collection': 'walked_hosts'}
-
-    docker_services.wait_until_responsive(timeout=180.0, pause=1.0, check=lambda: is_mongo_running(configuration))
-    logger.info(f'Initialized {service_name} from Docker with {configuration}')
+    configuration = {
+        "host": "localhost",
+        "port": port,
+        "database": "snmp_poller",
+        "collection": "walked_hosts",
+    }
+
+    docker_services.wait_until_responsive(
+        timeout=180.0, pause=1.0, check=lambda: is_mongo_running(configuration)
+    )
+    logger.info(f"Initialized {service_name} from Docker with {configuration}")

tests/snmp_utils/fixtures/rabbitmq_docker_setup.py

@@ -11,12 +11,14 @@ def is_rabbitmq_running(mongo_config):
     return True
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def rabbitmq_service(request, docker_services):
-    service_name = 'rabbitmq'
+    service_name = "rabbitmq"
     docker_services.start(service_name)
     port = docker_services.port_for(service_name, 5672)
     configuration = {}
 
-    docker_services.wait_until_responsive(timeout=180.0, pause=1.0, check=lambda: is_rabbitmq_running(configuration))
-    logger.info(f'Initialized {service_name} from Docker with {configuration}')
+    docker_services.wait_until_responsive(
+        timeout=180.0, pause=1.0, check=lambda: is_rabbitmq_running(configuration)
+    )
+    logger.info(f"Initialized {service_name} from Docker with {configuration}")

tests/snmp_utils/fixtures/snmp_simulator_docker_setup.py

@@ -7,19 +7,24 @@
 
 def is_snmp_simulator_running(snmp_config):
     import pysnmp.hlapi as snmp
-    iterator = snmp.getCmd(snmp.SnmpEngine(), snmp.CommunityData('public'),
-                           snmp.UdpTransportTarget((snmp_config['host'], snmp_config['port'])),
-                           snmp.ContextData(),
-                           snmp.ObjectType(snmp.ObjectIdentity('1.3.6.1.2.1.1.1.0')))
+
+    iterator = snmp.getCmd(
+        snmp.SnmpEngine(),
+        snmp.CommunityData("public"),
+        snmp.UdpTransportTarget((snmp_config["host"], snmp_config["port"])),
+        snmp.ContextData(),
+        snmp.ObjectType(snmp.ObjectIdentity("1.3.6.1.2.1.1.1.0")),
+    )
     error_indication, error_status, error_index, var_binds = next(iterator)
     return True if error_indication is None else False
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def snmp_simulator_service(request, docker_services):
-    service_name = 'snmpsim'
+    service_name = "snmpsim"
     docker_services.start(service_name)
-    snmp_config = {'host': 'localhost', 'port': 161}
-    docker_services.wait_until_responsive(timeout=180.0, pause=1.0,
-                                          check=lambda: is_snmp_simulator_running(snmp_config))
-    logger.info(f'Initialized {service_name} from Docker with {snmp_config}')
+    snmp_config = {"host": "localhost", "port": 161}
+    docker_services.wait_until_responsive(
+        timeout=180.0, pause=1.0, check=lambda: is_snmp_simulator_running(snmp_config)
+    )
+    logger.info(f"Initialized {service_name} from Docker with {snmp_config}")

tests/snmp_utils/fixtures/splunk_docker_setup.py

@@ -8,37 +8,46 @@
 
 
 def is_responsive_splunk(splunk_conn_config):
-    logger.debug(f'Calling with parameters {splunk_conn_config}')
+    logger.debug(f"Calling with parameters {splunk_conn_config}")
     try:
-        connection_params = {'username': splunk_conn_config['username'], 'password': splunk_conn_config['password'],
-                             'host': splunk_conn_config['host'], 'port': splunk_conn_config['port']}
+        connection_params = {
+            "username": splunk_conn_config["username"],
+            "password": splunk_conn_config["password"],
+            "host": splunk_conn_config["host"],
+            "port": splunk_conn_config["port"],
+        }
         client.connect(**connection_params)
-        logger.info(f'Connected to Splunk!')
+        logger.info(f"Connected to Splunk!")
         return True
     except Exception:
         return False
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def docker_compose_files(pytestconfig):
     # This took me hours to figure. We must return a collection!
-    return [os.path.join(str(pytestconfig.rootdir), 'docker-compose.yml')]
+    return [os.path.join(str(pytestconfig.rootdir), "docker-compose.yml")]
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def splunk_docker_configuration(request, docker_services):
-    service_name = 'splunk'
+    service_name = "splunk"
     docker_services.start(service_name)
-    default_port = request.config.getoption('splunk_port')
+    default_port = request.config.getoption("splunk_port")
     port = docker_services.port_for(service_name, int(default_port))
 
-    configuration = {'host': docker_services.docker_ip, 'port': port,
-                     'username': request.config.getoption('splunk_user'),
-                     'password': request.config.getoption('splunk_password'),
-                     'connect_max_retries': request.config.getoption('splunk_connect_max_retries')}
+    configuration = {
+        "host": docker_services.docker_ip,
+        "port": port,
+        "username": request.config.getoption("splunk_user"),
+        "password": request.config.getoption("splunk_password"),
+        "connect_max_retries": request.config.getoption("splunk_connect_max_retries"),
+    }
 
     logger.info(configuration)
-    docker_services.wait_until_responsive(timeout=180.0, pause=1.0, check=lambda: is_responsive_splunk(configuration))
-    logger.info(f'Initialized {service_name} from Docker')
+    docker_services.wait_until_responsive(
+        timeout=180.0, pause=1.0, check=lambda: is_responsive_splunk(configuration)
+    )
+    logger.info(f"Initialized {service_name} from Docker")
 
     return configuration