Adds lint config for Python and link checks

Signed-off-by: Adrian Cole <[email protected]>

Author: codefromthecrypt

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: lint
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install pre-commit
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - run: make lint

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+default_language_version:
+  python: python3.12
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.0
+  hooks:
+    - id: ruff
+      args: [
+        "--fix",
+        "--line-length", "120",
+        "--extend-select=PLC,PLE,Q,A",
+      ]
+    - id: ruff-format
+      args: [
+        "--line-length", "120"
+      ]
+

Elastiflix/locustfile.py

@@ -3,16 +3,16 @@
 from time import sleep
 import random
 
+
 class HelloWorldUser(HttpUser):
     @task
     def hello_world(self):
-
         self.client.get("/api/favorites")
 
         if random.random() < 0.5:
             self.client.post("/api/favorites", json={"id": random.randint(1, 100)})
-        
+
         # in 50% of the cases, call the login endpoint
         if random.random() < 0.5:
             self.client.get("/api/login")
-        sleep(1)
+        sleep(1)

Elastiflix/python-favorite-elastic-manual/main.py

@@ -1,44 +1,43 @@
 from flask import Flask, request
-import sys
 
 from elasticapm.contrib.flask import ElasticAPM
-import elasticapm 
-import logging 
-import redis 
+import elasticapm
+import logging
+import redis
 import os
 import ecs_logging
 import datetime
 import random
-import time 
+import time
 
-delay_time = os.environ.get('TOGGLE_SERVICE_DELAY')
-if delay_time is "" or delay_time is None:
+delay_time = os.environ.get("TOGGLE_SERVICE_DELAY")
+if delay_time == "" or delay_time is None:
     delay_time = 0
 delay_time = int(delay_time)
 
-redis_host = os.environ.get('REDIS_HOST') or 'localhost'
-redis_port = os.environ.get('REDIS_PORT') or 6379
+redis_host = os.environ.get("REDIS_HOST") or "localhost"
+redis_port = os.environ.get("REDIS_PORT") or 6379
 
-application_port = os.environ.get('APPLICATION_PORT') or 5000
+application_port = os.environ.get("APPLICATION_PORT") or 5000
 
-service_name = os.environ.get('ELASTIC_APM_SERVICE_NAME') or 'python-favorite-elastic-manual'
-secret_token = os.environ.get('ELASTIC_APM_SECRET_TOKEN')
+service_name = os.environ.get("ELASTIC_APM_SERVICE_NAME") or "python-favorite-elastic-manual"
+secret_token = os.environ.get("ELASTIC_APM_SECRET_TOKEN")
 # fail if secret token not set
 if secret_token is None:
-    raise Exception('ELASTIC_APM_SECRET_TOKEN environment variable not set')
-server_url = os.environ.get('ELASTIC_APM_SERVER_URL')
+    raise Exception("ELASTIC_APM_SECRET_TOKEN environment variable not set")
+server_url = os.environ.get("ELASTIC_APM_SERVER_URL")
 # fail if server url not set
 if server_url is None:
-    raise Exception('ELASTIC_APM_SERVER_URL environment variable not set')
-environment = os.environ.get('ENVIRONMENT') or 'dev'
+    raise Exception("ELASTIC_APM_SERVER_URL environment variable not set")
+environment = os.environ.get("ENVIRONMENT") or "dev"
 
 
 app = Flask(__name__)
-app.config['ELASTIC_APM'] = {
-  'SERVICE_NAME': service_name,
-  'SECRET_TOKEN': secret_token,
-  'SERVER_URL': server_url,
-  'ENVIRONMENT': environment
+app.config["ELASTIC_APM"] = {
+    "SERVICE_NAME": service_name,
+    "SECRET_TOKEN": secret_token,
+    "SERVER_URL": server_url,
+    "ENVIRONMENT": environment,
 }
 apm = ElasticAPM(app)
 elasticapm.instrument()
@@ -51,8 +50,8 @@
 handler = logging.StreamHandler()
 handler.setFormatter(ecs_logging.StdlibFormatter())
 logger.addHandler(handler)
-logging.getLogger('werkzeug').setLevel(logging.ERROR)
-logging.getLogger('werkzeug').addHandler(handler)
+logging.getLogger("werkzeug").setLevel(logging.ERROR)
+logging.getLogger("werkzeug").addHandler(handler)
 
 r = redis.Redis(host=redis_host, port=redis_port, decode_responses=True)
 
@@ -62,56 +61,67 @@ def after_request(response):
     print(response)
     # timestamp in iso8601
     timestamp = datetime.datetime.utcnow().isoformat()
-    logger.info('%s %s %s %s %s %s', timestamp, request.remote_addr, request.method, request.scheme, request.full_path, response.status, extra={
-        "event.dataset": "favorite.log",
-        "http.request.method": request.method,
-        "http.request.path": request.full_path,
-        "source.ip": request.remote_addr,
-        "http.response.status_code": response.status
-    })
+    logger.info(
+        "%s %s %s %s %s %s",
+        timestamp,
+        request.remote_addr,
+        request.method,
+        request.scheme,
+        request.full_path,
+        response.status,
+        extra={
+            "event.dataset": "favorite.log",
+            "http.request.method": request.method,
+            "http.request.path": request.full_path,
+            "source.ip": request.remote_addr,
+            "http.response.status_code": response.status,
+        },
+    )
     return response
 
-@app.route('/')
+
+@app.route("/")
 def hello():
-    logger.info('Main request successfull')
-    return 'Hello World!'
+    logger.info("Main request successfull")
+    return "Hello World!"
+
 
-@app.route('/favorites', methods=['GET'])
+@app.route("/favorites", methods=["GET"])
 def get_favorite_movies():
     # add artificial delay if enabled
     if delay_time > 0:
-        time.sleep(max(0, random.gauss(delay_time/1000, delay_time/1000/10)))
+        time.sleep(max(0, random.gauss(delay_time / 1000, delay_time / 1000 / 10)))
 
-    user_id = str(request.args.get('user_id'))   
+    user_id = str(request.args.get("user_id"))
+
+    logger.info(
+        "Getting favorites for user " + user_id,
+        extra={"event.dataset": "favorite.log", "user.id": request.args.get("user_id")},
+    )
 
-    logger.info('Getting favorites for user ' + user_id, extra={
-        "event.dataset": "favorite.log",
-        "user.id": request.args.get('user_id')
-    })
-     
     favorites = r.smembers(user_id)
-    
+
     # convert to list
     favorites = list(favorites)
-    logger.info('User ' + user_id + ' has favorites: ' + str(favorites), extra={
-        "event.dataset": "favorite.log",
-        "user.id": user_id
-    })
-    return { "favorites": favorites}
+    logger.info(
+        "User " + user_id + " has favorites: " + str(favorites),
+        extra={"event.dataset": "favorite.log", "user.id": user_id},
+    )
+    return {"favorites": favorites}
 
-@app.route('/favorites', methods=['POST'])
+
+@app.route("/favorites", methods=["POST"])
 def add_favorite_movie():
     # add artificial delay if enabled
     if delay_time > 0:
-        time.sleep(max(0, random.gauss(delay_time/1000, delay_time/1000/10)))
+        time.sleep(max(0, random.gauss(delay_time / 1000, delay_time / 1000 / 10)))
 
-    user_id = str(request.args.get('user_id'))
-    movie_id = request.json['id']
+    user_id = str(request.args.get("user_id"))
+    movie_id = request.json["id"]
 
-    logger.info('Adding or removing favorites for user ' + user_id, extra={
-        "event.dataset": "favorite.log",
-        "user.id": user_id
-    })
+    logger.info(
+        "Adding or removing favorites for user " + user_id, extra={"event.dataset": "favorite.log", "user.id": user_id}
+    )
 
     # add movie to the user's favorite list. If it already exists, remove it from the list
     redisRespone = r.srem(user_id, int(movie_id))
@@ -122,32 +132,32 @@ def add_favorite_movie():
     # convert to list
     favorites = list(favorites)
 
-    logger.info('User ' + user_id + ' has favorites: ' + str(favorites), extra={
-        "event.dataset": "favorite.log",
-        "user.id": user_id
-    })
+    logger.info(
+        "User " + user_id + " has favorites: " + str(favorites),
+        extra={"event.dataset": "favorite.log", "user.id": user_id},
+    )
 
     # if enabled, in 50% of the cases, sleep for 2 seconds
-    sleep_time = os.getenv('TOGGLE_CANARY_DELAY')
-    if  sleep_time is None or sleep_time == "":
+    sleep_time = os.getenv("TOGGLE_CANARY_DELAY")
+    if sleep_time is None or sleep_time == "":
         sleep_time = 0
-    
+
     sleep_time = int(sleep_time)
 
     if sleep_time > 0 and random.random() < 0.5:
-        time.sleep(max(0, random.gauss(sleep_time/1000, sleep_time/1000/10)))
+        time.sleep(max(0, random.gauss(sleep_time / 1000, sleep_time / 1000 / 10)))
         # add label to transaction
-        logger.info('Canary enabled')
+        logger.info("Canary enabled")
         elasticapm.label(quiz_solution="correlations")
         elasticapm.label(canary="test-new-feature")
-        if(random.random() < float(os.getenv('TOGGLE_CANARY_FAILURE', 0))):
+        if random.random() < float(os.getenv("TOGGLE_CANARY_FAILURE", 0)):
             # throw an exception in 50% of the cases
-            logger.error('Something went wrong')
-            raise Exception('Something went wrong')
-            
-    return { "favorites": favorites}
+            logger.error("Something went wrong")
+            raise Exception("Something went wrong")
+
+    return {"favorites": favorites}
 
 
-logger.info('App startup')
-app.run(host='0.0.0.0', port=application_port)
-logger.info('App Stopped')
+logger.info("App startup")
+app.run(host="0.0.0.0", port=application_port)
+logger.info("App Stopped")