fluent-ci-templates/microcks-pipeline

Import API specifications into Microcks and run Microcks tests

Microcks Pipeline

A ready-to-use CI/CD Pipeline for importing API specifications into Microcks and running Microcks tests.

🚀 Usage

Run the following command:

fluentci run microcks_pipeline

Or, if you want to use it as a template:

fluentci init -t microcks

This will create a .fluentci folder in your project.

Now you can run the pipeline with:

fluentci run .

🧩 Dagger Module

Use as a Dagger module:

dagger install github.com/fluent-ci-templates/microcks-pipeline@main

Call a function from the module:

# Import API specifications into Microcks
dagger call import-api-specs --src . \
          --specification-files $SPECIFICATION_FILES \
          --microcks-url $MICROCKS_URL \
          --keycloak-client-id $KEYCLOAK_CLIENT_ID \
          --keycloak-client-secret KEYCLOAK_CLIENT_SECRET

# Run Microcks tests
dagger call run-tests --api-name-and-version "$API_NAME_AND_VERSION" \
--test-endpoint $TEST_ENDPOINT \
--runner $RUNNER \
--microcks-url $MICROCKS_URL \
--keycloak-client-id $KEYCLOAK_CLIENT_ID \
--keycloak-client-secret KEYCLOAK_CLIENT_SECRET

🛠️ Environment variables

Variable	Description	Default
SPECIFICATION_FILES	The path to the API specifications
MICROCKS_URL	Microcks instance API endpoint
KEYCLOAK_CLIENT_ID	Keycloak Realm Service Account ClientId
KEYCLOAK_CLIENT_SECRET	Keycloak Realm Service Account ClientSecret
API_NAME_AND_VERSION	The name and version of the API to test
TEST_ENDPOINT	The endpoint to test
RUNNER	Test strategy (one of: HTTP, SOAP, SOAP_UI, POSTMAN, OPEN_API_SCHEMA, ASYNC_API_SCHEMA, GRPC_PROTOBUF, GRAPHQL_SCHEMA)	HTTP
WAIT_FOR	Time to wait for test to finish (int + one of: milli, sec, min)	5sec
SECRET_NAME	The name of a Secret to use for connecting test endpoint
FILTERED_OPERATIONS	JSON that allows to filter a list of operations to launch a test for

✨ Jobs

Job	Description
import-api-specs	Import API specifications into Microcks
run-tests	Launch a Microcks test on an API endpoint

importApiSpecs(
  src: string | Directory,
  specificationFiles: string,
  microcksURL: string,
  keycloakClientId: string,
  keycloakClientSecret: string | Secret
): Promise<string>;

runTests(
  apiNameAndVersion: string,
  testEndpoint: string,
  microcksURL: string,
  keycloakClientId: string,
  keycloakClientSecret: string | Secret,
  runner = "HTTP",
  waitFor = "5sec",
  secretName?: string,
  filteredOperations?: string,
  operationsHeaders?: string
): Promise<string>;

👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

import { importApiSpecs, runTests } from "jsr:@fluentci/microcks";

await importApiSpecs(
    ".",
    Deno.env.get("SPECIFICATION_FILES")!,
    Deno.env.get("MICROCKS_URL")!,
    Deno.env.get("KEYCLOAK_CLIENT_ID")!,
    Deno.env.get("KEYCLOAK_CLIENT_SECRET")!
);

await runTests(
    Deno.env.get("API_NAME_AND_VERSION")!,
    Deno.env.get("TEST_ENDPOINT")!,
    Deno.env.get("MICROCKS_URL")!,
    Deno.env.get("KEYCLOAK_CLIENT_ID")!,
    Deno.env.get("KEYCLOAK_CLIENT_SECRET")!,
    Deno.env.get("RUNNER")!,
    Deno.env.get("WAIT_FOR"),
    Deno.env.get("SECRET_NAME"),
    Deno.env.get("FILTERED_OPERATIONS")
);