KT Testing Suite AE

Extension of the KT Testing Suite for Adobe After Effects, providing specific matchers for testing After Effects scripts in ExtendScript.

Overview

This extension adds custom matchers for After Effects, allowing you to write tests for layers, compositions, and other AE elements in an easy and expressive way. It is designed to work with KT Testing Suite Core and KT ExtendScript Builder.

Installation

To install the extension, use the following command:

npm install kt-testing-suite-ae

Writing Tests

Examples of writing tests using the suite with AE-specific matchers:

// src/tests/my-tests.test.ts
import { AE } from "kt-testing-suite-ae";
import { describe, it, expect } from "kt-testing-suite-core";

describe("Layer Tests", () => {
    it("should be a solid layer with correct opacity", () => {
        AE.expect(someLayer).toBeSolidLayer();
        AE.expect(someLayer).toMatchOpacity(100);
    });

    it("should have specific scale and position", () => {
        AE.expect(someLayer).toMatchScale([100, 100, 100]);
        AE.expect(someLayer).toMatchPosition([960, 540, 0]);
    });
});

Adobe Type Helpers

Use type helpers to avoid TypeScript errors when accessing Adobe-specific properties (see KT Testing Suite Core for details).

Build Tests

To transpile tests to ExtendScript, run:

npm run build-tests

Run Tests

To execute tests, use the ExtendScript Debugger, pointing to your tests entry file, usually src/tests/index.test.ts.

Example output:

Suite: Layer Tests
  Test: should be a solid layer with correct opacity
    ✅ Passed
  Test: should have specific scale and position
    ✅ Passed

Test Results:
Passed: 2
Failed: 0

Using Hooks

The suite supports hooks for setup and teardown (see KT Testing Suite Core for details).

Documentation

For detailed documentation on AE-specific matchers, see the docs/ folder:

• Matchers

Test Files

Test files are located in src/tests/:

• Layer Matchers Tests
• Project Item Matchers Tests

Links

• KT Testing Suite Core
• KT ExtendScript Builder
• Bolt CEP
• After Effects Scripting Guide
• Types for Adobe

About

Base extension for testing Adobe After Effects scripts.

Resources

Read the full README on GitHub.