Initial commit

skills/test-environment-manager/assets/README.md

@@ -0,0 +1,7 @@
+# Assets
+
+Bundled resources for test-environment-manager skill
+
+- [ ] docker-compose-template.yml: Template for creating Docker Compose files.
+- [ ] test_environment_diagram.png: Diagram illustrating the architecture of a typical test environment.
+- [ ] example_test_script.py: Example Python test script that uses the test environment.

skills/test-environment-manager/assets/docker-compose-template.yml

@@ -0,0 +1,53 @@
+# docker-compose-template.yml
+# Template for defining services and dependencies for test environments.
+
+version: "3.9"  # Specify the Docker Compose file version
+
+services:
+  # Database service (e.g., PostgreSQL)
+  db:
+    image: postgres:14  # Use a specific PostgreSQL version
+    container_name: test-db  # A descriptive container name
+    restart: always  # Automatically restart the container if it fails
+    ports:
+      - "5432:5432"  # Map host port 5432 to container port 5432
+    environment:
+      POSTGRES_USER: REPLACE_ME  # Replace with your desired username
+      POSTGRES_PASSWORD: REPLACE_ME  # Replace with a strong password
+      POSTGRES_DB: test_database  # The database name
+    volumes:
+      - db_data:/var/lib/postgresql/data  # Persist data even if the container is stopped
+
+  # Redis service (for caching or messaging)
+  redis:
+    image: redis:latest  # Use the latest Redis image
+    container_name: test-redis
+    restart: always
+    ports:
+      - "6379:6379"  # Map host port 6379 to container port 6379
+
+  # Application service (the service you are testing)
+  app:
+    build:
+      context: .  # Path to the application's Dockerfile
+      dockerfile: Dockerfile  # Name of the Dockerfile
+    container_name: test-app
+    restart: always
+    ports:
+      - "8080:8080"  # Map host port 8080 to container port 8080
+    environment:
+      DATABASE_URL: "postgresql://REPLACE_ME:REPLACE_ME@db:5432/test_database" # Database connection string
+      REDIS_URL: "redis://redis:6379" # Redis connection string
+      YOUR_APP_CONFIG: YOUR_VALUE_HERE # Example: App-specific configuration
+    depends_on:
+      - db  # Ensure the database is running before starting the application
+      - redis # Ensure redis is running before starting the application
+    healthcheck:
+      test: ["CMD-SHELL", "curl -f http://localhost:8080/health || exit 1"] # Example: Health check endpoint
+      interval: 30s
+      timeout: 10s
+      retries: 3
+
+# Define named volumes for data persistence
+volumes:
+  db_data:

skills/test-environment-manager/assets/example_test_script.py

@@ -0,0 +1,100 @@
+#!/usr/bin/env python3
+
+"""
+Example Python test script that uses the test environment.
+
+This script demonstrates how to interact with services running in the test environment,
+managed by the test-environment-manager plugin.
+
+It assumes that services like a database or message queue are running within Docker containers.
+"""
+
+import os
+import time
+import logging
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+
+
+def connect_to_database(host, port, user, password, database):
+    """
+    Attempts to connect to the database.
+
+    Args:
+        host (str): Database host.
+        port (int): Database port.
+        user (str): Database user.
+        password (str): Database password.
+        database (str): Database name.
+
+    Returns:
+        bool: True if connection successful, False otherwise.
+    """
+    try:
+        import psycopg2  # Example: PostgreSQL
+        conn = psycopg2.connect(host=host, port=port, user=user, password=password, database=database)
+        conn.close()
+        logging.info("Successfully connected to the database.")
+        return True
+    except ImportError:
+        logging.error("psycopg2 (PostgreSQL driver) is not installed. Please install it: pip install psycopg2-binary")
+        return False
+    except Exception as e:
+        logging.error(f"Failed to connect to the database: {e}")
+        return False
+
+
+def send_message(queue_host, queue_port, message):
+    """
+    Sends a message to a message queue.
+
+    Args:
+        queue_host (str): Message queue host.
+        queue_port (int): Message queue port.
+        message (str): Message to send.
+
+    Returns:
+        bool: True if message sent successfully, False otherwise.
+    """
+    try:
+        import redis  # Example: Redis
+        r = redis.Redis(host=queue_host, port=queue_port)
+        r.publish('test_channel', message)
+        logging.info(f"Successfully sent message to the queue: {message}")
+        return True
+    except ImportError:
+        logging.error("redis is not installed. Please install it: pip install redis")
+        return False
+    except Exception as e:
+        logging.error(f"Failed to send message to the queue: {e}")
+        return False
+
+
+def main():
+    """
+    Main function to demonstrate test environment interaction.
+    """
+    database_host = os.environ.get("DATABASE_HOST", "localhost")
+    database_port = int(os.environ.get("DATABASE_PORT", "5432"))
+    database_user = os.environ.get("DATABASE_USER", "test_user")
+    database_password = os.environ.get("DATABASE_PASSWORD", "test_password")
+    database_name = os.environ.get("DATABASE_NAME", "test_db")
+
+    queue_host = os.environ.get("QUEUE_HOST", "localhost")
+    queue_port = int(os.environ.get("QUEUE_PORT", "6379"))
+
+    # Example usage:
+    if connect_to_database(database_host, database_port, database_user, database_password, database_name):
+        logging.info("Database connection test passed.")
+    else:
+        logging.error("Database connection test failed.")
+
+    if send_message(queue_host, queue_port, "Hello from the test environment!"):
+        logging.info("Message queue test passed.")
+    else:
+        logging.error("Message queue test failed.")
+
+
+if __name__ == "__main__":
+    main()

skills/test-environment-manager/assets/test_environment_diagram.png

@@ -0,0 +1,35 @@
+// This is a placeholder image. Replace it with a real diagram illustrating the architecture of a typical test environment.
+//
+// Consider including the following elements:
+// - Client application
+// - Test environment manager (the plugin)
+// - Docker Compose
+// - Testcontainers
+// - Databases (e.g., PostgreSQL, MySQL)
+// - Message queues (e.g., RabbitMQ, Kafka)
+// - Other services (e.g., Redis, Memcached)
+// - Environment variables
+// - Network connections
+//
+//  The diagram should illustrate how the test environment manager orchestrates these components to create isolated and reproducible test environments.
+//
+// Example (textual representation, to be visually diagrammed):
+//
+// [Client Application] --> [Test Environment Manager]
+//
+// [Test Environment Manager] --> [Docker Compose] --> [Containers (Database, Message Queue, Other Services)]
+//
+// [Test Environment Manager] --> [Testcontainers] --> [Containers (Database, Message Queue, Other Services)]
+//
+// [Test Environment Manager] <--> [Environment Variables]
+//
+// Consider using a diagramming tool like draw.io, Lucidchart, or similar to create the visual representation.
+// Ensure the diagram is clear, concise, and easy to understand.
+//
+// When replacing this placeholder, ensure the filename is "test_environment_diagram.png".
+//
+// You can use a tool like ImageMagick to optimize the image for web use:
+// `convert test_environment_diagram_original.png -strip -interlace Plane -gaussian-blur 0.05 -quality 85% test_environment_diagram.png`
+//
+//  This placeholder image is a 1x1 transparent pixel.  It is here to meet the requirement for a .png file.
+iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=