data-sourcerer 0.1.0__py3-none-any.whl

sourcerer/infrastructure/access_credentials/services.py

@@ -0,0 +1,396 @@
+"""
+Implementation of access credential services.
+
+This module provides concrete implementations of the BaseAccessCredentialsService
+interface for various cloud providers and authentication methods.
+"""
+
+import json
+from abc import ABC
+
+import boto3
+from dependency_injector.wiring import Provide
+from google.cloud import storage
+
+from sourcerer.domain.access_credentials.entities import Credentials, Boto3Credentials
+from sourcerer.domain.access_credentials.repositories import BaseCredentialsRepository
+from sourcerer.domain.access_credentials.services import (
+    BaseAccessCredentialsService,
+    AuthField,
+)
+from sourcerer.domain.shared.entities import StorageProvider
+from sourcerer.infrastructure.access_credentials.exceptions import CredentialsAuthError
+from sourcerer.infrastructure.access_credentials.registry import (
+    access_credentials_method,
+    AccessCredentialsMethod,
+)
+from sourcerer.infrastructure.utils import generate_uuid
+from sourcerer.presentation.di_container import DiContainer
+
+
+class CredentialsService:
+    """
+    Service for managing credentials.
+
+    This class provides methods for listing, retrieving, activating,
+    and deactivating credentials.
+    """
+
+    def __init__(
+        self,
+        credentials_repo: BaseCredentialsRepository = Provide[
+            DiContainer.credentials_repository
+        ],
+    ):
+        """
+        Initialize the service with a credentials repository.
+
+        Args:
+            credentials_repo (BaseCredentialsRepository): Repository for storing credentials
+        """
+        self.credentials_repo = credentials_repo
+
+    def list(self, active_only=False):
+        """
+        List credentials.
+
+        Args:
+            active_only (bool, optional): If True, return only active credentials.
+                Defaults to False.
+
+        Returns:
+            List[Credentials]: List of credentials objects
+        """
+        return self.credentials_repo.list(active_only)
+
+    def get(self, uuid):
+        """
+        Get credentials by UUID.
+
+        Args:
+            uuid (str): Unique identifier for the credentials
+
+        Returns:
+            Credentials: The credentials object
+        """
+        return self.credentials_repo.get(uuid)
+
+    def activate(self, uuid):
+        """
+        Activate credentials by UUID.
+
+        Args:
+            uuid (str): Unique identifier for the credentials to activate
+        """
+        self.credentials_repo.activate(uuid)
+
+    def deactivate(self, uuid):
+        """
+        Deactivate credentials by UUID.
+
+        Args:
+            uuid (str): Unique identifier for the credentials to deactivate
+        """
+        self.credentials_repo.deactivate(uuid)
+
+
+class AccessCredentialsService(BaseAccessCredentialsService, ABC):
+    """
+    Base class for access credentials services.
+
+    This abstract class serves as a base for provider-specific
+    access credential service implementations.
+    """
+
+    def __init__(
+        self,
+        credentials_repo: BaseCredentialsRepository = Provide[
+            DiContainer.credentials_repository
+        ],
+    ):
+        """
+        Initialize the service with a credentials repository.
+
+        Args:
+            credentials_repo (BaseCredentialsRepository): Repository for storing credentials
+        """
+        super().__init__(credentials_repo)
+
+
+class S3AccessCredentialsService(AccessCredentialsService, ABC):
+    """
+    Base class for AWS S3 access credentials services.
+
+    This abstract class serves as a base for S3-specific
+    access credential service implementations.
+    """
+
+
+@access_credentials_method(AccessCredentialsMethod(StorageProvider.S3, "key_pair"))
+class S3AccessKeySecretKeyPair(S3AccessCredentialsService):
+    """
+    AWS S3 access credentials service using access key and secret key.
+
+    This class provides methods for storing, retrieving, and authenticating
+    with AWS S3 using access key and secret key credentials.
+    """
+
+    def store(self, name, credentials: dict):
+        """
+        Store AWS access key credentials.
+
+        Args:
+            name (str): Name identifier for the credentials
+            credentials (dict): Dictionary containing AWS credential information
+        """
+        self.credentials_repo.create(
+            Credentials(
+                uuid=generate_uuid(),
+                name=name,
+                provider=StorageProvider.S3,
+                credentials_type="key_pair",
+                credentials=json.dumps(credentials),
+                active=True,
+            )
+        )
+
+    def extract(self, uuid: str):
+        """
+        Extract credentials by UUID.
+
+        Args:
+            uuid (str): UUID of the credentials to extract
+
+        Returns:
+            Credentials: The credentials object
+        """
+        return self.credentials_repo.get(uuid)
+
+    def authenticate(self, credentials: str):  # type: ignore
+        """
+        Authenticate using stored credentials.
+
+        Args:
+            credentials (str): JSON string containing credential information
+
+        Returns:
+            boto3.Session: Authenticated boto3 session
+        """
+        credentials: dict = json.loads(credentials)
+
+        session_args = {
+            "aws_access_key_id": credentials.get("aws_access_key_id"),
+            "aws_secret_access_key": credentials.get("aws_secret_access_key"),
+        }
+
+        if region := credentials.get("region"):
+            session_args["region_name"] = region
+
+        session = boto3.Session(**session_args)
+
+        return Boto3Credentials(
+            session=session,
+            endpoint_url=credentials.get("endpoint_url", None),
+            signature_version=credentials.get("signature_version", None),
+        )
+
+    @classmethod
+    def auth_fields(cls):
+        """
+        Get list of authentication fields.
+
+        Returns:
+            List[AuthField]: List of authentication field definitions
+        """
+        return [
+            AuthField("aws_access_key_id", "AWS Access Key Id", True),
+            AuthField("aws_secret_access_key", "AWS Secret Access Key", True),
+            AuthField("region", "Region", False),
+            AuthField("endpoint_url", "Endpoint Url", False),
+        ]
+
+
+@access_credentials_method(AccessCredentialsMethod(StorageProvider.S3, "profile_name"))
+class S3ProfileName(S3AccessCredentialsService):
+    """
+    AWS S3 access credentials service using profile name.
+
+    This class provides methods for storing, retrieving, and authenticating
+    with AWS S3 using a named profile from AWS configuration.
+    """
+
+    def store(self, name, credentials: dict):
+        """
+        Store AWS profile name credentials.
+
+        Args:
+            name (str): Name identifier for the credentials
+            credentials (dict): Dictionary containing profile name information
+        """
+        self.credentials_repo.create(
+            Credentials(
+                uuid=generate_uuid(),
+                name=name,
+                provider=StorageProvider.S3,
+                credentials_type="profile_name",
+                credentials=json.dumps(credentials),
+                active=True,
+            )
+        )
+
+    def extract(self, uuid: str):
+        """
+        Extract credentials by UUID.
+
+        Args:
+            uuid (str): UUID of the credentials to extract
+
+        Returns:
+            Credentials: The credentials object
+        """
+        return self.credentials_repo.get(uuid)
+
+    def authenticate(self, credentials: str):  # type: ignore
+        """
+        Authenticate using stored profile name.
+
+        Args:
+            credentials (str): Dictionary containing profile name information
+
+        Returns:
+            boto3.Session: Authenticated boto3 session
+        """
+        credentials: dict = json.loads(credentials)
+        session = boto3.Session(profile_name=credentials.get("profile_name"))
+        return Boto3Credentials(
+            session=session,
+            endpoint_url=credentials.get("endpoint_url"),
+        )
+
+    @classmethod
+    def auth_fields(cls):
+        """
+        Get list of authentication fields.
+
+        Returns:
+            List[AuthField]: List of authentication field definitions
+        """
+        return [
+            AuthField("profile_name", "Profile Name", True),
+            AuthField("endpoint_url", "Endpoint Url", False),
+        ]
+
+
+@access_credentials_method(
+    AccessCredentialsMethod(StorageProvider.GoogleCloudStorage, "Service account")
+)
+class GCPCredentialsService(AccessCredentialsService):
+    """
+    Google Cloud Platform test credentials service.
+
+    This class provides methods for storing, retrieving, and authenticating
+    with GCP using test credentials.
+    """
+
+    def store(self, name, credentials: dict):
+        """
+        Store GCP test credentials.
+
+        Args:
+            name (str): Name identifier for the credentials
+            credentials (dict): Dictionary containing GCP credential information
+        """
+        self.credentials_repo.create(
+            Credentials(
+                uuid=generate_uuid(),
+                name=name,
+                provider=StorageProvider.GoogleCloudStorage,
+                credentials_type="Service account",
+                credentials=json.dumps(credentials),
+                active=True,
+            )
+        )
+
+    def extract(self, uuid):
+        """
+        Extract credentials by UUID.
+
+        Args:
+            uuid (str): UUID of the credentials to extract
+
+        Returns:
+            Credentials: The credentials object
+        """
+        return self.credentials_repo.get(uuid)
+
+    def authenticate(self, credentials: str):  # type: ignore
+        """
+        Authenticate with Google Cloud Platform using service account credentials.
+
+        This method parses the stored credentials JSON string, extracts the service account
+        information, and creates a Google Cloud Storage client authenticated with those
+        credentials.
+
+        Args:
+            credentials (str): JSON string containing the service account credentials
+
+        Returns:
+            storage.Client: Authenticated Google Cloud Storage client
+
+        Raises:
+            ValueError: If the credentials are missing required fields
+            json.JSONDecodeError: If the credentials are not valid JSON
+            Exception: If authentication fails for any other reason
+        """
+        try:
+            # Parse the outer JSON structure
+            parsed_credentials = json.loads(credentials)
+
+            # Extract the service account JSON string
+            service_acc_json = parsed_credentials.get("service_acc")
+            if not service_acc_json:
+                raise ValueError("Missing 'service_acc' field in credentials")
+
+            # Parse the service account JSON
+            try:
+                service_acc_info = json.loads(service_acc_json)
+            except json.JSONDecodeError as e:
+                raise ValueError("Invalid service account JSON format") from e
+
+            # Validate required fields for service account
+            required_fields = [
+                "type",
+                "project_id",
+                "private_key_id",
+                "private_key",
+                "client_email",
+            ]
+            missing_fields = [
+                field for field in required_fields if field not in service_acc_info
+            ]
+            if missing_fields:
+                raise ValueError(
+                    f"Service account missing required fields: {', '.join(missing_fields)}"
+                )
+
+            # Create and return the authenticated client
+            return storage.Client.from_service_account_info(service_acc_info)
+
+        except json.JSONDecodeError as e:
+            raise CredentialsAuthError(f"Invalid credentials format: {str(e)}") from e
+        except Exception as e:
+            raise CredentialsAuthError(
+                f"Failed to authenticate with GCP: {str(e)}"
+            ) from e
+
+    @classmethod
+    def auth_fields(cls):
+        """
+        Get list of authentication fields.
+
+        Returns:
+            List[AuthField]: List of authentication field definitions
+        """
+        return [
+            AuthField("service_acc", "Service acc", True, True),
+        ]

sourcerer/infrastructure/db/__init__.py

@@ -0,0 +1,6 @@
+"""
+Database infrastructure module.
+
+This package provides database-related components, including models,
+configuration, and utilities for database access and management.
+"""

sourcerer/infrastructure/db/config.py

@@ -0,0 +1,73 @@
+"""
+Database configuration and session management.
+
+This module provides classes and utilities for configuring and
+managing database connections and sessions.
+"""
+
+import contextlib
+
+import sqlalchemy
+from sqlalchemy.orm import scoped_session, sessionmaker
+
+from sourcerer.infrastructure.db.models import Base
+
+
+class Database:
+    """
+    Acts as a connection pool and session factory.
+
+    This class manages database connections and provides
+    session management for database operations.
+    """
+
+    def __init__(self, db_url):
+        """
+        Initialize the database with a connection URL.
+
+        Args:
+            db_url (str): Database connection URL
+        """
+        self.db_url = db_url
+        self.engine = sqlalchemy.create_engine(db_url)
+        self.scoped_session = scoped_session(sessionmaker(bind=self.engine))  # type: ignore
+
+    def prepare_db(self):
+        """
+        Prepare the database by creating tables based on model definitions.
+        """
+        # Prepare mappings
+        Base.metadata.create_all(self.engine)
+
+    @contextlib.contextmanager
+    def session(self):
+        """
+        Context manager for database sessions.
+
+        Yields:
+            Session: A database session
+
+        Raises:
+            Exception: Any exception that occurs during session use
+        """
+        session = self.scoped_session()
+        try:
+            yield session
+        except Exception as e:
+            session.rollback()
+            raise e
+        finally:
+            session.close()
+
+    @staticmethod
+    def session_factory(db):
+        """
+        Create a session factory for the given database.
+
+        Args:
+            db (Session): Database instance
+
+        Returns:
+            callable: Session factory function
+        """
+        return db.session

sourcerer/infrastructure/db/models.py

@@ -0,0 +1,47 @@
+"""
+Database models for the application.
+
+This module defines SQLAlchemy models representing database tables
+and their relationships.
+"""
+
+from datetime import datetime
+
+from sqlalchemy import Column, Integer, Boolean, DateTime, String
+from sqlalchemy.orm import declarative_base
+from sqlalchemy_utils.types.encrypted.encrypted_type import EncryptedType
+
+from sourcerer.settings import ENCRYPTION_KEY
+
+Base = declarative_base()
+
+
+class Credentials(Base):
+    """
+    SQLAlchemy model for storing access credentials.
+
+    This model represents the credentials table in the database,
+    storing encrypted credential information for various providers.
+
+    Attributes:
+        id (int): Primary key
+        uuid (str): Unique identifier for the credentials
+        name (str): Name of the credentials
+        provider (str): Name of the service provider
+        credentials_type (str): Type of credentials (e.g., key_pair)
+        credentials (str): Encrypted credentials data
+        active (bool): Indicates if the credentials are active
+        created_at (datetime): Timestamp when the credentials were created
+        updated_at (datetime): Timestamp when the credentials were last updated
+    """
+
+    __tablename__ = "credentials"
+    id = Column(Integer, primary_key=True)
+    uuid = Column(String, unique=True, nullable=False)
+    name = Column(String, nullable=False)
+    provider = Column(String, nullable=False)
+    credentials_type = Column(String, nullable=False)
+    credentials = Column(EncryptedType(String, ENCRYPTION_KEY), nullable=False)
+    active = Column(Boolean, default=True)
+    created_at = Column(DateTime, default=datetime.utcnow)
+    updated_at = Column(DateTime, default=datetime.utcnow, onupdate=datetime.utcnow)

sourcerer/infrastructure/file_system/__init__.py

@@ -0,0 +1,7 @@
+"""
+File system infrastructure module.
+
+This package provides concrete implementations of the file system
+service interfaces defined in the domain layer, along with
+infrastructure-specific exceptions and utilities.
+"""

sourcerer/infrastructure/file_system/exceptions.py

@@ -0,0 +1,89 @@
+"""
+File system exception classes.
+
+This module defines exception classes for handling errors that occur
+during interactions with the local file system.
+"""
+
+from sourcerer.domain.file_system.exceptions import BaseFileSystemException
+
+
+class FileSystemGrepException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system search operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of searching and grepping through file system contents.
+    It provides additional context about the nature of the error.
+    """
+
+
+class ReadFileException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system read operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of reading file contents.
+    It provides additional context about the nature of the error.
+    """
+
+
+class CreateFileException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system create file operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of creating a new file.
+    It provides additional context about the nature of the error.
+    """
+
+
+class CreateDirException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system create directory operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of creating a new directory.
+    It provides additional context about the nature of the error.
+    """
+
+
+class MoveFileException(BaseFileSystemException):
+    """
+    Exception raised for errors during file move operation.
+
+    This class is a specific type of exception that handles issues encountered
+    when attempting to move files in a file system. It inherits from
+    `BaseFileSystemException` to maintain consistency with other file system
+    related exceptions.
+    """
+
+
+class ListDirException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system list directory operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of listing directory contents.
+    It provides additional context about the nature of the error.
+    """
+
+
+class DeleteFileException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system delete file operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of deleting a file.
+    It provides additional context about the nature of the error.
+    """
+
+
+class DeleteDirException(BaseFileSystemException):
+    """
+    Custom exception for errors occurring during a file system delete directory operation.
+
+    This exception is used to indicate and encapsulate errors specific
+    to the process of deleting a directory.
+    It provides additional context about the nature of the error.
+    """