Tutorials

We've created a few short, in-browser tutorials using the Killercoda platform to get you up and running quickly depending on your level.

The courses are written in Node and Java, however, extensive experience with the languages will not be required for the workshop.

Note

To complete the workshop, you will need to authenticate to Killercoda (the online learning platform) with GitHub, Google, Twitter or LinkedIn.

katacoda-screenshot.png

Prerequisites

To complete these tutorials, you must have:

Getting Started with API Hub for Contract Testing

Level: Beginner

In this tutorial, we guide you through getting started with Pact and API Hub for Contract Testing.

You will create your first contract, publish it to API Hub for Contract Testing and verify it on your provider.

Goals

Ultimately, our goal is to get you up and integrated with API Hub for Contract Testing as quickly as possible!

You will:

  1. Learn the basic concepts of Pact.

  2. Get hands-on experience with the key aspects of writing, publishing and verifying pacts.

  3. See how API Hub for Contract Testing fits into the picture so that you can get up and running quickly.

Tutorial

Language

Link

Node JS

https://killercoda.com/pactflow/scenario/pactflow-getting-started-js

Java

https://killercoda.com/pactflow/scenario/pactflow-getting-started-java

Generating Tests with PactFlow's AI-Augmented Contract Testing Capabilities

Level: Beginner

In this tutorial, we guide you through creating a consumer Pact test with the help of API Hub for Contract Testing's Test Generation capability, featuring HaloAI.

You will download and setup the CLI tool, and generate consumer Pact tests for a JavaScript codebase.

Read more about our test generation feature, or check out our documentation here.

Goals

Learn how to quickly scaffold new pact tests from existing sources.

You will:

  1. Learn how to install the API Hub for Contract Testing AI CLI tool (API Hub for Contract Testing-ai).

  2. Learn how to authenticate the CLI with your API Hub for Contract Testing account.

  3. Get hands-on experience with all current modes of consumer Pact test generation, including:

    • Traffic capture,

    • OpenAPI descriptions, and

    • Your existing code

  4. See how test generation fits into the picture so that you can get up and running quickly.

Tutorial

You can complete the course at https://killercoda.com/pactflow/scenario/pactflow-ai.

Gating deployments with API Hub for Contract Testing

Level: Intermediate

In the scenario, we extend the workshop from above, learning how to gate deployments using the can-i-deploy tool in the process.

Goals

Learn how to prevent releasing incompatible changes to production, by using integrating can-i-deploy into your CI/CD process.

You will:

  1. Build on a basic contract testing example

  2. Learn how API Hub for Contract Testing fits into the picture

  3. Understand important Pact CLI tools

  4. Learn how deployments work with API Hub for Contract Testing

Tutorial

You can complete the course at https://killercoda.com/pactflow/scenario/pactflow-can-i-deploy-js.

Bi-Directional Contract Testing

Level: Intermediate

Learn how to implement a Bi-Directional Contract Testing workflow from end-to-end, including integration with your CI/CD system.

Goals

You will learn how:

  1. To use OpenAPI as part of a contract testing strategy

  2. API testing tools such as ReadyAPI/SoapUI/Dredd or Postman can be used with API Hub for Contract Testing

  3. To publish contracts (such as a pact file or an OpenAPI document) to API Hub for Contract Testing

  4. To prevent deploying breaking changes to an environment, such as production

  5. To use existing mocking tools (such as Mountebank or Wiremock) to create a consumer contract

Agenda

You will:

  1. Create and document an API using OpenAPI Specification

  2. Write tests for the API using the Dredd API testing tool

  3. Publish the provider contract (an OpenAPI document) to API Hub for Contract Testing

  4. Deploy the provider to production

  5. Write the API consumer

  6. Write tests for an API client using Mountebank to mock the API, and convert those mocks into a consumer contract

  7. Publish the consumer contract to API Hub for Contract Testing

  8. Deploy the consumer to production

  9. Learn about API Hub for Contract Testing's breaking change detection system

Tools used

  • Node - for the applications being tested

  • Mountebank - for API mocking

  • Dredd - for API Testing

  • Github Actions - for CI/CD pipeline

Tutorial

You can complete the course at https://killercoda.com/pactflow/scenario/pactflow-bi-directional-contracts-intro.

In this section:
© 2024
Publication date: