Create an IntegrationTestScenario

Generated-By: Claude

Author: lubomir

.tekton/README-INTEGRATION-TESTS.md

@@ -0,0 +1,222 @@
+# CTS Integration Tests for Konflux CI
+
+This directory contains integration test scenarios for the Compose Tracking Service (CTS) that run automatically in Konflux CI after each build.
+
+## Overview
+
+The integration test scenario validates that the built CTS container image works correctly by:
+
+1. **Deploying a test environment** - Creates a PostgreSQL database and deploys the CTS service
+2. **Running integration tests** - Validates API endpoints and service functionality
+3. **Cleaning up** - Removes all test resources
+
+## Files
+
+### Integration Test Scenario
+
+- **`cts-integration-test.yaml`** - IntegrationTestScenario CRD that defines when and how tests run
+  - Runs automatically after successful builds
+  - References the test pipeline
+  - Marks failed builds if tests fail
+
+### Test Pipelines
+
+- **`integration-test-k8s.yaml`** - Main integration test pipeline (recommended)
+  - Deploys PostgreSQL database
+  - Deploys CTS service with the built image
+  - Runs comprehensive API tests
+  - Automatically cleans up resources
+
+- **`integration-test-simple.yaml`** - Simplified validation pipeline
+  - Only validates image structure and metadata
+  - Faster but less comprehensive
+  - Useful for quick smoke tests
+
+- **`integration-test-pipeline.yaml`** - Alternative podman-based approach
+  - Uses podman-in-podman for testing
+  - More complex, kept for reference
+
+### Test Scripts
+
+- **`../tests/integration_test.py`** - Standalone integration test script
+  - Can be run locally or in CI
+  - Tests all major API endpoints
+  - Usage: `CTS_URL=http://localhost:5005 python3 tests/integration_test.py`
+
+## What Gets Tested
+
+The integration tests validate:
+
+- ✅ **Service Startup** - Container starts without errors
+- ✅ **Database Connectivity** - Migrations run successfully
+- ✅ **API Endpoints** - All major endpoints respond correctly:
+  - `GET /api/1/` - API root
+  - `GET /api/1/about/` - Version information
+  - `GET /api/1/composes/` - Compose listing
+  - `GET /api/1/openapi.json` - OpenAPI specification
+- ✅ **Error Handling** - 404 responses for invalid endpoints
+- ✅ **Pagination** - Query parameters work correctly
+
+## How It Works
+
+### In Konflux CI
+
+1. Code is pushed to the repository or PR is created
+2. Tekton build pipeline builds the container image
+3. **IntegrationTestScenario** automatically triggers
+4. Test pipeline deploys and validates the image
+5. Results are reported back to the PR/commit
+
+### Pipeline Execution Flow
+
+```
+┌─────────────────────────────┐
+│ 1. Parse Snapshot           │  Extract image URL from Konflux snapshot
+└─────────────┬───────────────┘
+              │
+┌─────────────▼───────────────┐
+│ 2. Deploy PostgreSQL DB     │  Create database for testing
+└─────────────┬───────────────┘
+              │
+┌─────────────▼───────────────┐
+│ 3. Deploy CTS Service       │  Deploy CTS with test image
+└─────────────┬───────────────┘
+              │
+┌─────────────▼───────────────┐
+│ 4. Run Integration Tests    │  Execute API validation tests
+└─────────────┬───────────────┘
+              │
+┌─────────────▼───────────────┐
+│ 5. Cleanup (always runs)    │  Remove test resources
+└─────────────────────────────┘
+```
+
+## Running Tests Locally
+
+### Option 1: Using docker-compose (recommended)
+
+```bash
+# Start the services
+docker-compose up -d db api
+
+# Wait for service to be ready
+sleep 10
+
+# Run integration tests
+CTS_URL=http://localhost:5005 python3 tests/integration_test.py
+```
+
+### Option 2: Using existing deployment
+
+```bash
+# Point to your deployment
+CTS_URL=https://cts.example.com python3 tests/integration_test.py
+
+# With custom timeout
+python3 tests/integration_test.py --url http://localhost:5005 --timeout 120
+```
+
+### Option 3: Test the Tekton pipeline locally
+
+If you have a Kubernetes cluster with Tekton installed:
+
+```bash
+# Create a test snapshot (adjust IMAGE_URL)
+cat <<EOF | kubectl apply -f -
+apiVersion: tekton.dev/v1
+kind: PipelineRun
+metadata:
+  name: cts-integration-test-manual
+spec:
+  pipelineRef:
+    name: cts-integration-test-k8s
+  params:
+  - name: SNAPSHOT
+    value: |
+      {
+        "components": [
+          {
+            "name": "cts",
+            "containerImage": "quay.io/redhat-user-workloads/team-sp-rhelcmp-tenant/cts/cts:latest"
+          }
+        ]
+      }
+EOF
+
+# Watch the pipeline run
+tkn pipelinerun logs -f cts-integration-test-manual
+```
+
+## Customizing Tests
+
+### Adding New Test Cases
+
+Edit `tests/integration_test.py` and add new test methods:
+
+```python
+def test_my_new_feature(self):
+    """Test my new API endpoint"""
+    status, data = self._http_get('/api/1/my-endpoint/')
+    assert status == 200, f"Expected 200, got {status}"
+    assert 'expected_field' in data, "Missing expected field"
+```
+
+Then add it to the test suite in `run_all_tests()`:
+
+```python
+self._run_test("My new feature", self.test_my_new_feature)
+```
+
+### Modifying the Test Environment
+
+Edit `.tekton/integration-test-k8s.yaml` to change:
+
+- Database configuration (in `deploy-test-database` task)
+- CTS environment variables (in `deploy-cts-service` task)
+- Test execution logic (in `run-integration-tests` task)
+
+## Troubleshooting
+
+### Tests Failing in Konflux
+
+1. Check PipelineRun logs:
+   ```bash
+   kubectl logs -n team-sp-rhelcmp-tenant -l tekton.dev/pipeline=cts-integration-test-k8s
+   ```
+
+2. Check if image is accessible:
+   ```bash
+   skopeo inspect docker://YOUR_IMAGE_URL
+   ```
+
+3. Check pod logs:
+   ```bash
+   kubectl logs -n team-sp-rhelcmp-tenant -l app=cts-test
+   ```
+
+### Tests Timing Out
+
+- Increase timeout in IntegrationTestScenario
+- Check pod events: `kubectl describe pod -l app=cts-test`
+- Verify image pull is not failing
+- Check database readiness probe
+
+### Database Connection Issues
+
+- Verify PostgreSQL deployment is ready
+- Check service DNS resolution
+- Review CTS logs for connection errors
+
+## Best Practices
+
+1. **Keep tests fast** - Integration tests should complete within 5 minutes
+2. **Test critical paths** - Focus on essential API functionality
+3. **Make tests idempotent** - Tests should work with empty or existing data
+4. **Clean up resources** - Always clean up in `finally` section
+5. **Use meaningful assertions** - Clear error messages help debugging
+
+## Related Documentation
+
+- [Konflux Integration Tests](https://konflux-ci.dev/docs/how-tos/testing/integration/)
+- [Tekton Pipelines](https://tekton.dev/docs/pipelines/)
+- [CTS API Documentation](../cts/static/openapispec.json)

.tekton/cts-integration-test.yaml

@@ -0,0 +1,26 @@
+apiVersion: appstudio.redhat.com/v1beta1
+kind: IntegrationTestScenario
+metadata:
+  name: cts-integration-test
+  namespace: team-sp-rhelcmp-tenant
+  labels:
+    test.appstudio.openshift.io/optional: "false"
+spec:
+  application: cts
+  resolverRef:
+    resolver: git
+    params:
+    - name: url
+      value: https://github.com/release-engineering/cts
+    - name: revision
+      value: main
+    - name: pathInRepo
+      value: .tekton/integration-test-k8s.yaml
+  contexts:
+  - name: service-validation
+    description: |
+      Deploys CTS with PostgreSQL database and validates that:
+      - Service starts correctly
+      - Database migrations run successfully
+      - API endpoints respond correctly
+      - OpenAPI specification is accessible