Identus integration suite

This repository aggregates the result of end-to-end test between the new components and stable components.

Table of Contents

• Quick Start
• End-to-end Test Matrix
• Usage
• Components
• Runners
• Testing
• Development
• Architecture
• Release Flow
• Troubleshooting
• Integration Flows

🚀 New Feature: Manual Integration Testing

We now support manual integration testing that allows developers to trigger custom integration tests with specific component versions. This feature enables:

• Custom Version Combinations: Test any combination of component versions
• Compatibility Validation: Verify cross-component compatibility
• Regression Testing: Ensure existing functionality works with new versions
• Historical Tracking: Maintain a compatibility matrix over time

Quick Start

Via GitHub Actions:

1. Go to Actions → Manual Integration Tests
2. Click "Run workflow"
3. Select components and enter versions
4. Run the test

End-to-end test matrix

Flow	sdk-ts	sdk-swift	sdk-kmp
Backup and restorations	✔︎	✔︎	❌
Establish connection	✔︎	✔︎	❌
Receive issued JWT credential	✔︎	✔︎	❌
Receive issued SD-JWT credential	✔︎	✔︎	❌
Receive issued AnonCreds credential	✔︎	✔︎	❌
Provide JWT proof	✔︎	✔︎	❌
Provide SD-JWT proof	✔︎	✔︎	❌
Provide AnonCreds proof	✔︎	✔︎	❌
Receive JWT revocation notification	✔︎	✔︎	❌
Verify JWT proof	✔︎	✔︎	❌
Verify SD-JWT proof	✔︎	✔︎	❌
Verify AnonCreds proof	✔︎	✔︎	❌
Receive out-of-band JWT credential	✔︎		❌
Provide out-of-band JWT proof	✔︎		❌

Note: The Kotlin SDK (sdk-kmp) is currently broken and non-functional. Tests are skipped with clear warnings. See PLAN.md for details on the improvement roadmap.

Testing

This project includes comprehensive unit and integration tests using Vitest.

Running Tests

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage
npm run test:coverage

Development

Local Development Setup

1. Clone the repository

   git clone https://github.com/hyperledger-identus/integration.git
   cd integration

2. Install dependencies

   npm ci

3. Set up environment variables

   cp .env.example .env
   # Edit .env with your configuration

4. Run tests

   npm test

Scripts Directory

The scripts/ directory contains utility scripts for local development and testing:

• integration-flow.ts: Manual integration flow script for local testing
• Use these scripts to test integration flows without triggering GitHub Actions

See CONTRIBUTING.md for detailed development guidelines.

Architecture

The integration suite follows a modular architecture:

• CLI Layer (src/cli/): Command-line interfaces for different operations
• Runner Layer (src/runner/): Core business logic for integration, reporting, and environment setup
• Test Runners (src/test-runner/): SDK-specific test execution implementations
• Configuration (src/config/): Validation, sanitization, and configuration management
• Utilities (src/utils/): Shared utilities including structured logging

For detailed architecture documentation, see ARCHITECTURE.md.

Release Flow

The integration suite supports both draft and final releases:

Draft Releases

• Triggered when a draft release is created on GitHub
• Version format: {version}-draft (e.g., 1.0.0-draft)
• Reports are generated and stored separately from final releases
• Used for pre-release validation

Final Releases

• Triggered when a final (non-draft) release is published
• Version format: {version} (e.g., 1.0.0)
• Automatically cleans up corresponding draft release reports
• Updates release manifest with final release information

Release Cleanup

When a final release is processed:

1. The system checks for a corresponding draft version
2. If found, removes the draft release directory and manifest entry
3. Ensures only final releases appear in the release history

Troubleshooting

Common Issues

Issue: Environment variable not found

• Ensure .env file exists and contains required variables
• Check that GH_TOKEN is set for GitHub API access
• Verify SLACK_WEBHOOK is set if you want Slack notifications

Issue: Tests failing locally

• Ensure all dependencies are installed: npm ci
• Check that required environment variables are set
• Verify Node.js version is 20 or higher: node --version

Issue: Workflow failures

• Check GitHub Actions logs for detailed error messages
• Verify secrets are properly configured in repository settings
• Ensure workflow inputs match expected format

Issue: Report generation fails

• Check that Allure results are present in tmp/ directories
• Verify GitHub Pages deployment permissions
• Check Slack webhook URL format if notifications fail

Debug Mode

Enable detailed logging by setting:

export DEBUG=true

This will show:

• Detailed command execution logs
• Full error stack traces
• Environment variable values (sanitized)

Getting Help

• Check ARCHITECTURE.md for system design details
• Review CONTRIBUTING.md for development guidelines
• See tests/README.md for test documentation

Usage

npm ci
npx tsx cli --component {component} --runner {runner}

Environment Setup

Copy the example environment file and configure the required variables:

cp .env.example .env
# Edit .env with your configuration

Required Environment Variables:

• GH_TOKEN: GitHub token with repository access

Optional Environment Variables:

• SLACK_WEBHOOK: Slack webhook URL for notifications
• DEBUG: Set to true for detailed command output
• EXTERNAL_BASE_URL: Base URL for external report links (defaults to GitHub Pages URL)
• CI: Automatically set in CI environments, enables CI-specific logging

See .env.example for detailed configuration options.

Components

Identus components are:

• cloud-agent
• mediator
• sdk-ts
• sdk-kmp
• sdk-swift

Runners

The runners are the SDKs themselves, which runs the end-to-end tests in order to guarantee the platform compatibility.

• sdk-ts
• sdk-kmp
• sdk-swift

Component testing matrix

The following table describes the artifact versioning and testing for the integration

component	cloud-agent	mediator	sdk-ts	sdk-kmp	sdk-swift
cloud-agent	main	release	release	release	release
mediator	release	main	release	release	release
sdk-ts	release	release	main	-	-
sdk-kmp	release	release	-	main	-
sdk-swift	release	release	-	-	main

• main: latest changes
• release: latest stable version

Cronjob testing

In order to test all latest components there's a weekly job.

environment	cloud-agent	mediator	sdk-ts	sdk-kmp	sdk-swift
weekly	main	main	main	main	main

Breaking change flow

When there's an expected breaking change the components will have to be compatible before making a final release. That means the latest test should be green.

Integration

Service integration

sequenceDiagram
    participant service
    participant ci
    participant runners
    service->>ci: version
    Note over ci: start services<br>using new service version
    ci->>runners: run sdk-ts
    ci->>runners: run sdk-kmp
    ci->>runners: run sdk-swift
    runners-->>ci: results
    ci-->>ci: notify slack
    ci-->>ci: update service report on gh pages

Loading

Library integration

sequenceDiagram
    participant library
    participant ci

    library->>ci: notify change
    Note over ci: start released service<br>build library
    ci->>library: run test
    library-->>ci: results
    ci-->>ci: notify slack
    ci-->>ci: update library report on gh pages

Loading

Automatic integration

This event is dispatched when there's a new commit on main branch.

{
    "component": "<component>",
    "version": "<version>"
}

Component should be of of the list and version for services should've been published or a tag/branch for libraries.