Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
test/jest/coverage/
src/generated/tests/
src/generated/util.js
src/generated/types/ObjectParamApi.js
src/generated/models/ObjectSerializer.js
Expand Down
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,11 @@ src/types/generated/git_push.sh
src/types/generated/README.md
src/types/generated/tsconfig.json
src/types/generated/package.json

# Generated test files
tmp_test_gen/
src/generated/tests/

# Local Okta credentials (never commit)
okta-config.yaml
test/generated/utils.js
14 changes: 14 additions & 0 deletions okta-config.yaml.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# okta-config.yaml — Okta credentials for test-setup.sh
# This file is gitignored. Copy from okta-config.yaml.example and fill in your values.
#
# terraform: credentials used by the Okta Terraform provider to create/destroy test resources
# client: credentials used by the Node.js SDK during test execution

terraform:
orgName: your-org-name
baseUrl: oktapreview.com
apiToken: your-terraform-api-token

client:
orgUrl: https://your-org-name.oktapreview.com/
token: your-ssws-api-token
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"build": "yarn build:cleanGenerated && yarn build:fixSpec && yarn build:generate && yarn build:fixGenerated && yarn build:emitTypes",
"build:generate": "docker run --rm -v \"${PWD}:/local\" -e JAVA_OPTS=\"-Dlog.level=warn -DmaxYamlCodePoints=99999999 -Dsnakeyaml.codepoint.limit=99999999\" openapitools/openapi-generator-cli:v7.13.0 generate -i /local/spec/management.yaml -g typescript -c /local/templates/swagger-codegen-config.json -o /local/src/generated -t /local/templates/openapi-generator --model-name-mappings User_type=UserTypeInline",
"build:validateSpec": "docker run --rm -v \"${PWD}:/local\" openapitools/openapi-generator-cli:v7.13.0 validate -i /local/spec/management.yaml",
"generate:tests": "bash scripts/generate-tests.sh",
"build:validateGenerated": "node scripts/validateGenerated.cjs",
"build:fixSpec": "node scripts/fixSpec.cjs",
"build:fixGenerated": "node scripts/fixGenerated.cjs",
Expand All @@ -30,6 +31,7 @@
"test:integration:ssws": "./scripts/test-it-ssws.sh",
"test:integration:oauth": "./scripts/test-it-oauth.sh",
"test:unit": "TEST_TYPE=unit mocha test/unit/*.js",
"test:generated": "npx mocha --no-config src/generated/tests/**/*.test.js --timeout 30000",
"test:types": "tsd && tsc --noEmit --isolatedModules --importsNotUsedAsValues error src/types/**/*.ts",
"test": "yarn eslint && yarn test:types && yarn test:unit && yarn test:integration && yarn jest",
"aftertest": "./scripts/test-it-clean.sh"
Expand Down
37 changes: 37 additions & 0 deletions scripts/generate-tests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/bin/bash
set -e

# Generates API test files from the OpenAPI spec into a temp subdirectory,
# copies only the .test.js files to src/generated/tests/, then cleans up.

PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
TMP_SUBDIR="tmp_test_gen"

rm -rf "$PROJECT_ROOT/$TMP_SUBDIR"
mkdir -p "$PROJECT_ROOT/$TMP_SUBDIR"

echo "Generating test files..."
docker run --rm \
-v "${PROJECT_ROOT}:/local" \
-e JAVA_OPTS="-Dlog.level=warn -DmaxYamlCodePoints=99999999 -Dsnakeyaml.codepoint.limit=99999999" \
openapitools/openapi-generator-cli:v7.13.0 generate \
-i /local/spec/management.yaml \
-g typescript \
-c /local/templates/swagger-codegen-tests-config.json \
-o /local/${TMP_SUBDIR} \
-t /local/templates/openapi-generator \
--global-property apiTests=true \
--model-name-mappings User_type=UserTypeInline

mkdir -p "$PROJECT_ROOT/src/generated/tests"

if [ -d "$PROJECT_ROOT/$TMP_SUBDIR/tests" ]; then
cp "$PROJECT_ROOT/$TMP_SUBDIR/tests/"*.test.js "$PROJECT_ROOT/src/generated/tests/"
echo "Test files written to src/generated/tests/"
else
echo "Warning: no tests/ directory found in generator output"
ls "$PROJECT_ROOT/$TMP_SUBDIR"
fi

rm -rf "$PROJECT_ROOT/$TMP_SUBDIR"
echo "Done."
75 changes: 75 additions & 0 deletions templates/openapi-generator/api/api_test.mustache
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/* eslint-env mocha */
/* eslint-disable no-unused-vars */
// THIS FILE IS AUTO-GENERATED BY THE OPENAPI GENERATOR. DO NOT EDIT.

'use strict';

const { expect } = require('chai');
const { PresetHelper } = require('../../../test/generated/utils');
{{#operations}}

const API_CLASS_NAME = '{{classname}}';
// Derive short resource name for fallback lookups: "ApplicationApi" → "Application"
const RESOURCE_NAME = API_CLASS_NAME.replace(/Api$/, '');

describe('{{classname}}', () => {
{{#operation}}

it('{{nickname}}', async () => {
const helper = new PresetHelper();
// Try exact operationId first, then fall back to resource-level keys
// (e.g. activateDefaultProvisioningConnectionForApplication → getApplication)
const prerequisiteData = helper.getPrerequisiteData('{{nickname}}')
|| helper.getPrerequisiteData('get' + RESOURCE_NAME)
|| helper.getPrerequisiteData('create' + RESOURCE_NAME)
|| {};

{{#allParams}}
{{#isPathParam}}
const {{paramName}} = (prerequisiteData.payload && prerequisiteData.payload['{{baseName}}']) ||
PresetHelper.findId(prerequisiteData, '{{baseName}}');
{{/isPathParam}}
{{#isQueryParam}}
const {{paramName}} = prerequisiteData.payload && prerequisiteData.payload['{{baseName}}'];
{{/isQueryParam}}
{{#isBodyParam}}
const {{paramName}} = prerequisiteData.payload || {};
{{/isBodyParam}}
{{#isHeaderParam}}
const {{paramName}} = prerequisiteData.payload && prerequisiteData.payload['{{baseName}}'];
{{/isHeaderParam}}
{{/allParams}}

const param = {
{{#allParams}}
{{#isPathParam}}
{{paramName}}: {{paramName}},
{{/isPathParam}}
{{#isQueryParam}}
{{#required}}
{{paramName}}: {{paramName}},
{{/required}}
{{^required}}
...({{paramName}} !== undefined && { {{paramName}}: {{paramName}} }),
{{/required}}
{{/isQueryParam}}
{{#isBodyParam}}
{{paramName}}: {{paramName}},
{{/isBodyParam}}
{{#isHeaderParam}}
...({{paramName}} !== undefined && { {{paramName}}: {{paramName}} }),
{{/isHeaderParam}}
{{/allParams}}
};

const apiProp = PresetHelper.resolveApiProperty(API_CLASS_NAME);
const response = await helper.oktaClient[apiProp].{{nickname}}(param);
// Some operations return void (HTTP 204) — only assert if a response body was returned
if (response !== undefined) {
expect(response).to.exist;
}
});
{{/operation}}

});
{{/operations}}
21 changes: 21 additions & 0 deletions templates/swagger-codegen-tests-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"additionalProperties": {
"supportsES6": true,
"withSeparateModelsAndApi": true,
"modelPropertyNaming": "original",
"platform": "node",
"enumPropertyNaming": "original",
"useObjectParameters": true,
"generateAliasAsModel": true
},
"moduleName": "okta",
"projectName": "@okta/okta-sdk-nodejs",
"templateDir" : "./",
"files": {
"api/api_test.mustache": {
"folder": "tests",
"destinationFilename": ".test.js",
"templateType": "APITests"
}
}
}
Loading