HTTP integration tests that ensure a Stormpath web framework integration implements the Stormpath Framework Specification
Groovy Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/main
.gitignore
LICENSE.txt
NOTICE.txt
README.md
pom.xml
tck.sh

README.md

Stormpath is Joining Okta

We are incredibly excited to announce that Stormpath is joining forces with Okta. Please visit the Migration FAQs for a detailed look at what this means for Stormpath users.

We're available to answer all questions at support@stormpath.com.

Stormpath Framework TCK

The Stormpath Framework TCK (Test Compatibility Kit) is a collection of HTTP-based integration tests that ensure a Stormpath web framework integration supports all Stormpath Framework Specification behavior. The TCK uses only HTTP(S) requests to ensure that they may execute against a web application written in any programming language that uses any of the various Stormpath integrations

This project is mostly used by the Stormpath SDK teams to ensure stability and consistent behavior for our customers, especially those that use Stormpath across multiple programming languages. And for our own development sanity :) Comments, suggestions and/or contributions from the Open Source community are most welcome.

Note: The most recent version of the TCK does not make any direct calls to the Stormpath backend. This is in support of Stormpath joining forces with Okta. The TCK now interacts exclusively with the integration under test. As a result, resources created over the course of the testing can no longer be deleted. There are still some Stormpath specific elements in the TCK (such as the Account href). As the SDKs are migrated over to using Okta as a backend, we will continue to refactor the TCK accordingly.

Getting Started

  1. If you haven't installed Maven already:

     brew install maven
    
  2. Clone the project:

     git clone git@github.com:stormpath/stormpath-framework-tck.git
    

Running tests

Fire up your web application under test. For example, a Java project might do this:

mvn spring-boot:run

And a node.js project might do this:

node server.js

Once your web app is running, you can run the TCK against this webapp:

cd stormpath-framework-tck
JWT_SIGNING_KEY=<your JWT signing key> \
FACEBOOK_CLIENT_ID=<Facebook id for login tests> \
FACEBOOK_CLIENT_SECRET=<Facebook secret for login tests> \
mvn clean -Prun-ITs verify

NOTE: If you are running against in Okta application you will need to include the following environment variables:

STORMPATH_TCK_VALIDATE_JWT_URL=https://dev-123456.oktapreview.com/oauth2/<as_id>/v1/keys
STORMPATH_TCK_EMAIL_DOMAIN=<your from email domain>

This will run all tests against the targeted webapp.

NOTE: The 3 environment variables shown above are required in order to run the TCK.

OAuth2 interactions return tokens that are JWTs. These JWTs are signed and in order to verify the signature, the JWT_SIGNING_KEY must be passed in.

There are Facebook Login tests that require the FACEBOOK_CLIENT_ID and FACEBOOK_CLIENT_SECRET to generate test accounts and then ensure that login works against the integration under test.

To run a single suite, name it using the -Dtest flag:

mvn clean -Prun-ITs verify -Dtest=LogoutIT

Using Maven Profiles to Customize TCK Behavior

The TCK will attempt to interact with a web application accessible by default via http://localhost:8080. You can tell the TCK which type of application you are using by using a Maven Profile by specifying the -P flag:

mvn clean verify -Pexpress

And this will assume a default base URI of http://localhost:3000 (notice the changed port) since this is common for node.js environments.

The currently supported profile names are:

  • express
  • java
  • laravel

Additional profile names can be added if different language environments require custom settings.

Test output as HTML

Besides viewing the output in the console, there's a nicer HTML format so you can view it through your browser:

open target/surefire-reports/index.html