Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 1.96 KB

Testing.md

File metadata and controls

57 lines (34 loc) · 1.96 KB
Raw

Testing

All modules are tested in ExtendScript using the intended target application. We can run our tests with tap-es. Please check the results_log.md file inside the test folder of each module. If you can't see your version/app we would love if you ran a test on your platform and app version. See Running Tests below.

You can test against a range of targets

Running Tests

You can simply run a test to your target with the npm run command. To test a package in both target-1 and target-2 run:

npm run test target-1 target-2

This will create a rapport called results.md inside the test folder, which will look similarly to the rapport below.

# Tests

- ✔ Platform target-1: scriptName [pass: 1, fail: 0] 
- ✔ Platform target-2: scriptName [pass: 1, fail: 0]


# Summary	

- planned: 2	
- assertions: 2	
- pass: 2	
- fail: 0

Copy the two lines under Tests and add them to the results_log.md under the package major version (first digit in 1.3.2):

> Version 1

- ✔ Darwin target-0: scriptName [pass: 1, fail: 0] 
- ✔ Platform target-1: scriptName [pass: 1, fail: 0] 
- ✔ Platform target-2: scriptName [pass: 1, fail: 0]

Thanks!

The results.md file is automatically excluded from Git

Creating Tests

Add your ExtendScript test files with .jsx extension to the test folder and prepend the name with test. Then the test.js script as defined in the package.json will glob them together:

+ test  
  - test-function01-case01.jsx
  - test-function01-case02.jsx
  - test-function02-case01.jsx

As we use markdown in the reports it is advised to not use underscores in the file name

Append $.write( Boolean ) at end in extendscript code of each test because the test.js script defines a Boolean comparator for the tap test. (You can change this course, up to you)