Skip to content

[VALIDATION] External API and Service Integration Testing Tracker #63

@jeremymanning

Description

@jeremymanning

External API/Service Validation Tracker

🎯 Purpose

This issue tracks the systematic validation of ALL Clustrix features that depend on external resources (APIs, services, credentials, etc.). We need to verify these work in practice, not just in theory with mocks.

📋 Validation Status Legend

  • VALIDATED - Manually tested with real external service, confirmed working
  • 🔄 IN PROGRESS - Currently being tested/debugged
  • PENDING - Needs testing but not started
  • FAILED - Tested but not working, needs fixes
  • 🚫 BLOCKED - Cannot test due to missing credentials/access
  • 📝 DOCUMENTED - Fallback behavior documented, external test not applicable

🔐 External Dependencies by Category

Cloud Provider Authentication & Pricing APIs

Feature Service Validation Status Last Tested Notes/Issues
AWS Pricing API AWS Pricing Service PENDING Never Need AWS credentials with pricing:GetProducts permission
Azure Pricing API Azure Retail Prices PENDING Never Public API, no credentials needed - should test immediately
GCP Pricing API GCP Cloud Billing Catalog PENDING Never Need GCP service account with billing.catalogViews.get permission
AWS EC2 Job Submission EC2 + Systems Manager PENDING Never Need AWS credentials with EC2 launch permissions
Azure VM Job Submission Azure Compute PENDING Never Need Azure subscription + VM creation permissions
GCP Compute Job Submission GCP Compute Engine PENDING Never Need GCP project + Compute Engine API enabled

HPC Cluster Integration

Feature Service Validation Status Last Tested Notes/Issues
SLURM Job Submission SLURM Scheduler PENDING Never Need access to SLURM cluster
PBS Job Submission PBS Pro/Torque PENDING Never Need access to PBS cluster
SGE Job Submission Sun Grid Engine PENDING Never Need access to SGE cluster
SSH Cluster Access SSH + Key Auth PENDING Never Need SSH access to remote cluster
SSH Key Generation/Deployment SSH + SCP/SFTP PENDING Never Need target cluster for key deployment

Container & Orchestration

Feature Service Validation Status Last Tested Notes/Issues
Kubernetes Job Submission K8s API Server PENDING Never Need K8s cluster access + job creation permissions
Docker Image Building Docker daemon PENDING Never Need Docker daemon access
Container Registry Push Docker Hub/ECR/GCR PENDING Never Need registry credentials

Specialized Cloud Services

Feature Service Validation Status Last Tested Notes/Issues
Lambda Cloud GPU Access Lambda Labs API PENDING Never Need Lambda Labs account + API key
AWS Batch Job Submission AWS Batch Service PENDING Never Need AWS Batch queue setup + permissions

Development & CI/CD

Feature Service Validation Status Last Tested Notes/Issues
GitHub Actions Integration GitHub API PENDING Never Need GitHub token with actions permissions
PyPI Package Publishing PyPI API PENDING Never Need PyPI token (test.pypi.org first)

🧪 Validation Methodology

For each external dependency:

  1. Setup Phase:

    • Identify required credentials/access
    • Document minimum permissions needed
    • Obtain test credentials (sandbox/dev accounts preferred)
    • Create test environment/resources
  2. Testing Phase:

    • Write minimal test script that exercises the external service
    • Test happy path (normal operation)
    • Test error conditions (auth failures, network issues, etc.)
    • Document actual behavior vs expected behavior
    • Note any API quirks, undocumented requirements, etc.
  3. Documentation Phase:

    • Update code comments with real-world findings
    • Update user documentation with setup instructions
    • Document credential requirements clearly
    • Add troubleshooting guide for common issues

🔄 Current Focus

Currently Working On: None (starting validation process)

Next Priority: Azure Retail Prices API (public, no credentials required)

📝 Validation Log

2025-06-30

  • Created validation tracking system
  • Identified 15+ external dependencies requiring validation
  • Need to systematically test each service with real credentials

🚨 IMPORTANT NOTES

  • DO NOT commit real credentials to the repository
  • Use environment variables or secure credential files
  • Test with sandbox/dev environments when possible
  • Document all required permissions and setup steps
  • Update this issue with progress after each validation session

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions