added echo cmd

.gitea/workflows/pipeline.yaml

@@ -0,0 +1,50 @@
+name: pipeline
+run-name: ${{ gitea.actor }} is running script
+runs-on: ubuntu-latest
+on: [push]
+image: python:3.10
+jobs:
+  show-gitea-ref:
+    name: Show Gitea.ref
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Show
+        run: echo "${{ gitea.ref }}"
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: https://github.com/actions/setup-python@v3
+        with:
+          python-version: "3.10"
+          architecture: "x64"
+      - name: Install Packages
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 mypy pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: PEP8 check
+        run: flake8 ./code --benchmark --exit-zero
+      - name: Type check
+        run: mypy ./code    
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    needs: [test]
+    if: gitea.ref == 'refs/heads/release'
+    env:
+      repository_host: 192.168.1.2:5000
+      repository_name: ${{ gitea.repository }}
+      repository_tag: latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build
+        run: docker build . --file Dockerfile --tag ${repository_name}:${repository_tag}
+      - name: Tag
+        run: docker tag ${repository_name}:${repository_tag} ${repository_host}/${repository_name}:${repository_tag}
+      - name: Push
+        run: docker push ${repository_host}/${repository_name}:${repository_tag}
+

Dockerfile

@@ -0,0 +1,49 @@
+###########
+# BUILDER #
+###########
+
+# pull official base image
+FROM python:3.10-bookworm as BUILDER
+
+# install Ookla's speedtest
+RUN apt update && \
+    apt install -y speedtest-cli
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# install dependencies
+WORKDIR /usr/src/app
+COPY requirements.txt .
+RUN pip install --upgrade pip && \
+    pip wheel --no-cache-dir --no-deps --wheel-dir /usr/src/app/wheels -r requirements.txt
+
+#########
+# FINAL #
+#########
+
+FROM python:3.10-bookworm
+
+# create home direcroty and app user
+RUN mkdir -p /home/app && \
+    addgroup --system app && \
+    adduser --system --group app
+
+# install packages from builder
+COPY --from=BUILDER /usr/src/app/wheels /wheels
+COPY --from=BUILDER /usr/src/app/requirements.txt requirements.txt
+RUN pip install --no-cache /wheels/*
+
+# copy in files
+WORKDIR /home/app
+COPY ./code .
+
+# change ownership to app user
+RUN chown -R app:app /home/app
+
+# change to the app user
+USER app
+
+# start execution
+ENTRYPOINT [ "python", "main.py" ]

README.md

@@ -1,3 +1,3 @@
 # bandwidth_probing
 
-Service that runs in a container and measures network bandwidth at a specified interval. The results are sent to a PostgreSQL database.
+Service that runs in a container and measures network bandwidth at a specified interval. The results are sent to a MongoDB database. Logs are sent to discord channel.

code/bandwidth.py

@@ -0,0 +1,23 @@
+from speedtest import Speedtest
+from dotenv import load_dotenv
+import logging
+
+
+def measure():
+    """
+    Measure bandwidth usiing Ookla/speedtest.
+    """
+    s = Speedtest()
+    s.get_servers(servers=[])
+    s.get_best_server()
+    s.download(threads=None)
+    s.upload(threads=None)
+    s.results.share()
+    logging.debug('finished')
+    return s.results.dict()
+
+
+if __name__ == '__main__':
+    load_dotenv()
+    res = measure()
+    print(res)

code/database.py

@@ -0,0 +1,35 @@
+from pymongo import MongoClient
+from dotenv import load_dotenv
+from configparser import ConfigParser
+from pathlib import Path
+import logging
+
+
+# load default values
+config = ConfigParser()
+config.read(Path(__file__).parent / 'defaults.ini')
+DB_IP_ADDRESS = config.get('database', 'db_ip_address')
+DB_NAME = config.get('database', 'db_name')
+DB_COLLECTION_NAME = config.get('database', 'db_collection_name')
+
+
+def connect(
+    ip_addr: str = DB_IP_ADDRESS,
+    db_name: str = DB_NAME,
+    collection_name: str = DB_COLLECTION_NAME
+):
+    """
+    Connect to MongoDB database and return collection.
+    """
+    # connect to database
+    client: MongoClient = MongoClient(ip_addr)
+    db = client[db_name]
+    collection = db[collection_name]
+    logging.debug('finished')
+    return collection
+
+
+if __name__ == '__main__':
+    load_dotenv()
+    collection = connect()
+    print(collection)

code/defaults.ini

@@ -0,0 +1,15 @@
+[main]
+logger_level=info
+user_id=0
+replicates=3
+trigger_interval_seconds=60
+
+[database]
+db_ip_address=192.168.1.2
+db_name=bandwidth_probing
+db_collection_name=data
+
+[discord]
+webhook_url=https://discord.com/api/webhooks/1127970367047225354/wNkoRex4OncMw11OCJg6atR_xgHS2VhLrku4jYIUw81Kr4sutdD3Tt-XAltG0UQy14rZ
+service_name=bandwidth_probing
+logger_level=warning

code/initialise_app.py

@@ -0,0 +1,65 @@
+from discord_logging.handler import DiscordHandler
+from dotenv import load_dotenv
+from configparser import ConfigParser
+from pathlib import Path
+import logging
+import os
+
+
+# load default values
+config = ConfigParser()
+config.read(Path(__file__).parent / 'defaults.ini')
+LOGGER_LEVEL = config.get('main', 'logger_level')
+DISCORD_SERVICE_NAME = config.get('discord', 'service_name')
+DISCORD_WEBHOOK_URL = config.get('discord', 'webhook_url')
+DISCORD_LOGGER_LEVEL = config.get('discord', 'logger_level')
+
+
+def initialise_app(
+    logger_level: str = LOGGER_LEVEL,
+    discord_service_name: str = DISCORD_SERVICE_NAME,
+    discord_webhook_url: str = DISCORD_WEBHOOK_URL,
+    discord_logger_level: str = DISCORD_LOGGER_LEVEL
+):
+    """
+    Convienience function that ensures eveything is ready
+    before running the main loop.
+    """
+    # load environment variables
+    load_dotenv()
+    logger_level = os.getenv(
+        'LOGGER_LEVEL',
+        default=LOGGER_LEVEL
+    )
+    discord_service_name = os.getenv(
+        'DISCORD_SERVICE_NAME',
+        default=DISCORD_SERVICE_NAME
+    )
+    discord_webhook_url = os.getenv(
+        'DISCORD_WEBHOOK_URL',
+        default=DISCORD_WEBHOOK_URL
+    )
+    discord_logger_level = os.getenv(
+        'DISCORD_LOGGER_LEVEL',
+        default=DISCORD_LOGGER_LEVEL
+    )
+    # setup logging
+    fmt = '|%(asctime)s| %(levelname)s %(filename)s:%(funcName)s:%(message)s'
+    datefmt = '%Y-%m-%d %H:%M:%S'
+    level = getattr(logging, logger_level.upper())
+    logging.basicConfig(format=fmt, datefmt=datefmt, level=level)
+    # setup logging to discord
+    logger = logging.getLogger()
+    discord_handler = DiscordHandler(
+        service_name=discord_service_name,
+        webhook_url=discord_webhook_url,
+    )
+    discord_handler.setFormatter(logging.Formatter('%(message)s'))
+    level = getattr(logging, discord_logger_level.upper())
+    discord_handler.setLevel(level=level)
+    logger.addHandler(discord_handler)
+
+
+if __name__ == '__main__':
+    initialise_app()
+    logging.warning('test message')

code/main.py

@@ -0,0 +1,78 @@
+import time
+import logging
+import os
+from configparser import ConfigParser
+from pathlib import Path
+from initialise_app import initialise_app
+from bandwidth import measure as measure_bandwidth
+from database import connect
+
+
+# load default values
+config = ConfigParser()
+config.read(Path(__file__).parent / 'defaults.ini')
+REPLICATES = int(config.get('main', 'replicates'))
+USER_ID = int(config.get('main', 'user_id'))
+TRIGGER_INTERVAL_SECONDS = float(
+    config.get(
+        'main',
+        'trigger_interval_seconds'
+    )
+)
+
+
+def event(
+    replicates: int = REPLICATES,
+    user_id: int = USER_ID
+):
+    logging.debug('started event')
+    # load environment variables
+    replicates = int(os.getenv('REPLICATES', default=REPLICATES))
+    user_id = int(os.getenv('USER_ID', default=USER_ID))
+    # setup database connection
+    db = connect()
+    # run event
+    for rep_num in range(replicates):
+        logging.info(f'running replicate {rep_num}')
+        # do measurement
+        try:
+            res = measure_bandwidth()
+        except Exception as e:
+            logging.error(f'failed to measure bandwidth: {e}')
+            continue
+        # upload result to database
+        payload_dict = {
+            'user_id': user_id,
+            'data': res
+        }
+        try:
+            db_id = db.insert_one(payload_dict).inserted_id
+        except Exception as e:
+            logging.error(f'failed sending results to database: {e}')
+            continue
+        logging.debug(f'data sent to database received db_id: {db_id}')
+        time.sleep(1)
+    logging.debug('finished')
+
+
+if __name__ == '__main__':
+    initialise_app()
+    trigger_time = time.time()
+    while True:
+        if time.time() >= trigger_time:
+            # set new trigger time
+            trigger_interval = float(
+                os.getenv(
+                    'TRIGGER_INTERVAL_SECONDS',
+                    default=TRIGGER_INTERVAL_SECONDS
+                )
+            )
+            trigger_time += trigger_interval
+            # run event
+            try:
+                event()
+            except Exception as e:
+                logging.error(e)
+            else:
+                logging.info('finished event')
+        time.sleep(1)

docker-compose.yml

@@ -0,0 +1,8 @@
+version: "3.9"
+services:
+  bandwidth-probing:
+    build: .
+    container_name: bandwidth-probing
+    restart: unless-stopped
+    env_file:
+      - .env

mypy.ini

@@ -0,0 +1,7 @@
+[mypy]
+
+[mypy-discord_logging.*]
+ignore_missing_imports = True
+
+[mypy-speedtest.*]
+ignore_missing_imports = True

requirements.txt

@@ -0,0 +1,17 @@
+aiosignal==1.3.1
+async-timeout==4.0.2
+attrs==23.1.0
+certifi==2023.5.7
+charset-normalizer==3.2.0
+discord-webhook==1.1.0
+dnspython==2.3.0
+frozenlist==1.3.3
+idna==3.4
+multidict==6.0.4
+pymongo==4.4.0
+python-dotenv==1.0.0
+python-logging-discord-handler==0.1.4
+requests==2.31.0
+speedtest-cli==2.1.3
+urllib3==2.0.3
+yarl==1.9.2