isabella232 / htl-tck

HTML Template Language Technology Compatibility Kit

HTML Template Language Technology Compatibility Kit

The HTML Template Language (HTL), formerly known as Sightly, has been introduced with Adobe Experience Manager 6.0 and takes the place of JSP (JavaServer Pages) as the preferred and recommended server-side template system for HTML.

This TCK provides a suite of tests meant to certify that an HTL implementation conforms with the official language specification.

How To

Building the package

To build the TCK just run the following command:

mvn clean install

This will result in two artifacts being built:

1. io.sightly.tck-<version>.jar
2. io.sightly.tck-<version>-standalone.jar

Extracting and deploying the test scripts

The test files used by the TCK can be extracted using the following commands:

# extracts the test files in the current directory:
java -jar io.sightly.tck-<version>-standalone.jar --extract 

# extracts the test files in a specified folder
java -jar io.sightly.tck-<version>-standalone.jar --extract path/to/folder

The extracted files are organised as follows:

testfiles/
├── definitions # contains JSON files describing the tests
├── output      # contains the expected output markup
└── scripts     # contains the test scripts

The TCK assumes the scripts are available at some predefined URLs. The URL at which a test can be found is composed from /sightlytck, to which the relative path of script file from testfiles/scripts is added.

Assuming we have the following structure in testfiles:

testfiles/
└── scripts
    └── exprlang
        └── operators
            └── operators.html

the URL at which the output of the operators.html script is expected to be found is <severURL>/sightlytck/exprlang/operators.html.

Running the TCK

The HTL TCK can be run standalone or as a Maven artifact. Both modes assume that you have a server running where you have deployed the testing scripts.

Run the TCK as part of the integration-test Maven build phase

Add the TCK as a test dependency to your pom.xml file:

<!-- testing dependencies -->
<dependency>
    <groupId>io.sightly</groupId>
    <artifactId>io.sightly.tck</artifactId>
    <version>1.4.2</version>
    <scope>test</scope>
</dependency>

The following Java properties need to be set for successfully Running the TCK:

io.sightly.tck.serverURL=<server root URL>
io.sightly.tck.user=<Basic authentication user> # optional
io.sightly.tck.pass=<Basic authentication password> # optional

The TCK can then be run during the integration-test phase of your Maven project build using the following configuration:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-failsafe-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>integration-test</goal>
                        <goal>verify</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <dependenciesToScan>
                    <dependency>io.sightly:io.sightly.tck</dependency>
                </dependenciesToScan>
                <includes>
                    <include>%regex[io.*sightly.*tck.*TestsRunner.*]</include>
                </includes>
                <systemPropertyVariables>
                    <io.sightly.tck.serverURL>http://${test.host}:${test.host.port}</io.sightly.tck.serverURL>
                </systemPropertyVariables>
            </configuration>
        </plugin>
    </plugins>
</build>

Run the TCK in standalone mode

For this mode you need the io.sightly.tck-<version>-standalone.jar artifact.

The standalone mode assumes that you have deployed the test scripts on your platform.

The following commands run the TCK:

# run the TCK
java -jar io.sightly.tck-<version>-standalone.jar --url http://www.example.com

# run the TCK on a server that requires Basic authentication
java -jar io.sightly.tck-<version>-standalone.jar --url http://www.example.com --authUser user --authPass pass

In case you need the standalone version of the artifact in a Maven project, you can add the following dependency to your pom.xml file:

<dependency>
    <groupId>io.sightly</groupId>
    <artifactId>io.sightly.tck</artifactId>
    <version>1.4.2</version>
    <classifier>standalone</classifier>
</dependency>

Versioning

The TCK artifacts use a semantic versioning scheme - MAJOR.MINOR.PATCH:

• MAJOR.MINOR - identify the specification version for which the TCK was built
• PATCH - identifies the version of the TCK artifact for the corresponding specification version

Exceptions

1. version 1.4.0 corresponds to version 1.4 of the HTML Template Language Specification