chore: add S3 storage toggle, test service in Docker Compose, and boto3 dependency

Author: MickaelCa

.env.example

@@ -40,6 +40,8 @@ MINIO_ROOT_USER=minioadmin
 MINIO_ROOT_PASSWORD=minioadmin
 
 # S3 Configuration (for application)
+# Set to "true" to enable S3 storage for digests
+# S3_ENABLED=true
 # Endpoint URL for the S3 service (MinIO in development)
 S3_ENDPOINT=http://minio:9000
 # Access key for the S3 bucket (created automatically in development)

.pre-commit-config.yaml

@@ -113,6 +113,7 @@ repos:
         files: ^src/
         additional_dependencies:
           [
+            boto3>=1.28.0,
             click>=8.0.0,
             'fastapi[standard]>=0.109.1',
             httpx,
@@ -135,6 +136,7 @@ repos:
           - --rcfile=tests/.pylintrc
         additional_dependencies:
           [
+            boto3>=1.28.0,
             click>=8.0.0,
             'fastapi[standard]>=0.109.1',
             httpx,

compose.yml

@@ -46,14 +46,15 @@ services:
       - DEBUG=true
       - GITINGEST_SENTRY_ENVIRONMENT=${GITINGEST_SENTRY_ENVIRONMENT:-development}
       # S3 Configuration
+      - S3_ENABLED=true
       - S3_ENDPOINT=http://minio:9000
       - S3_ACCESS_KEY=${S3_ACCESS_KEY:-gitingest}
       - S3_SECRET_KEY=${S3_SECRET_KEY:-gitingest123}
       # Use lowercase bucket name to ensure compatibility with MinIO
       - S3_BUCKET_NAME=${S3_BUCKET_NAME:-gitingest-bucket}
       - S3_REGION=${S3_REGION:-us-east-1}
       # Public URL for S3 resources
-      - S3_ALIAS_HOST=${S3_ALIAS_HOST:-127.0.0.1:9000/${S3_BUCKET_NAME:-gitingest-bucket}}
+      - S3_ALIAS_HOST=${S3_ALIAS_HOST:-http://127.0.0.1:9000/${S3_BUCKET_NAME:-gitingest-bucket}}
     volumes:
       # Mount source code for live development
       - ./src:/app:ro
@@ -104,6 +105,22 @@ services:
     entrypoint: sh
     command: -c /setup.sh
 
+  # Test service for running tests
+  test:
+    build:
+      context: .
+      dockerfile: Dockerfile.dev
+    profiles:
+      - dev
+    environment:
+      - DEBUG=true
+      - PYTHONPATH=/app:/tests
+    volumes:
+      - ./tests:/tests:ro
+      - ./src:/app/src:ro
+    working_dir: /tests
+    command: ["python", "-m", "pytest"]
+
 volumes:
   minio-data:
     driver: local

pyproject.toml

@@ -5,6 +5,7 @@ description="CLI tool to analyze and create text dumps of codebases for LLMs"
 readme = {file = "README.md", content-type = "text/markdown" }
 requires-python = ">= 3.8"
 dependencies = [
+    "boto3>=1.28.0",
     "click>=8.0.0",
     "fastapi[standard]>=0.109.1",  # Minimum safe release (https://osv.dev/vulnerability/PYSEC-2024-38)
     "httpx",

requirements.txt

@@ -1,3 +1,4 @@
+boto3>=1.28.0  # AWS SDK for S3 support
 click>=8.0.0
 fastapi[standard]>=0.109.1  # Vulnerable to https://osv.dev/vulnerability/PYSEC-2024-38
 httpx