Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

954 write tests for cli OpenAPI import #956

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion packages/breadboard-cli/src/commands/import.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ const outputBoard = async (
path.resolve(process.cwd(), outputPath),
`${boardName}.json`
);
writeFile(boardPath, boardJSON, { encoding: "utf-8" });
await writeFile(boardPath, boardJSON, { encoding: "utf-8" });
};
111 changes: 111 additions & 0 deletions packages/breadboard-cli/tests/data/petstore.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Pet:
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
70 changes: 69 additions & 1 deletion packages/breadboard-cli/tests/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import test from "ava";
import { ExecException, exec } from "child_process";
import * as fs from "fs";
import path from "path";
import { importGraph } from "../src/commands/import.js";
import { mkdirSync } from "fs";

const packageDir = getPackageDir("@google-labs/breadboard-cli");
console.debug("packageDir", packageDir);
Expand Down Expand Up @@ -202,6 +204,72 @@ test.after.always(() => {
fs.rmSync(testDataDir, { recursive: true });
});

test("import can import an openapi spec from URL", async (t) => {
const outputDir = path.join(testDataDir, "import_all_from_url")
mkdirSync(outputDir)

await importGraph("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.1.0/examples/v3.0/petstore.yaml", {
api: undefined,
output: outputDir,
root: "",
save: false,
watch: false
})

const routes: string[] = ["createPets.json", "listPets.json", "showPetById.json"]
.map(f =>
path.resolve(outputDir, f)
)

routes.forEach(f => {
t.true(fs.existsSync(f))
})
})

test("import can import an openapi spec from file", async (t) => {
const outputDir = path.join(testDataDir, "import_all_from_file")
mkdirSync(outputDir)

await importGraph(`file://${path.relative(process.cwd(), "tests/data/")}/petstore.yaml`, {
api: undefined,
output: outputDir,
root: "",
save: false,
watch: false
})

const routes: string[] = ["createPets.json", "listPets.json", "showPetById.json"]
.map(f =>
path.resolve(outputDir, f)
)

routes.forEach(f => {
t.true(fs.existsSync(f))
})
})

test("import can import a specific API from an openapi spec", async (t) => {
const outputDir = path.join(testDataDir, "import_one")
mkdirSync(outputDir)

await importGraph("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.1.0/examples/v3.0/petstore.yaml", {
api: "createPets",
output: outputDir,
root: "",
save: false,
watch: false
})

const routes: string[] = ["createPets.json"]
.map(f =>
path.resolve(outputDir, f)
)

routes.forEach(f => {
t.true(fs.existsSync(f))
})
})

//////////////////////////////////////////////////
test("all test files exist", (t) => {
testFiles.forEach((p) => {
Expand Down Expand Up @@ -375,4 +443,4 @@ test("can run a json board", async (t) => {
.replace(/:\s*'([^']+)'/g, ': "$1"');

t.deepEqual(JSON.parse(resultString), inputData);
});
});