Skip to content

Commit

Permalink
Skip building generated Github APIs in compat test (#290)
Browse files Browse the repository at this point in the history 
### Motivation

We have an opt-in CI pipeline configured that is triggered by a comment.
It runs the same compatibility test that's run in the automatic
pipeline, which generates code for a set of real-world OpenAPI
documents, but, additionally, it builds the generated code.

However, the Github APIs are so large that we cannot compile them in a
reasonable amount of time in CI, if we want to compile the others.

### Modifications

Skip building the generated code for Github APIs, even on the opt-in
pipeline.

### Result

The opt-in pipeline now runs in ~22 minutes.

### Test Plan

We'll use this PR to trigger the CI to confirm it completes, and in a
reasonable time.
  • Loading branch information
@simonjbeaumont
simonjbeaumont authored Sep 28, 2023
1 parent 82678a7 commit 6db47f7
Showing 1 changed file with 37 additions and 19 deletions.
56 changes: 37 additions & 19 deletions Tests/OpenAPIGeneratorReferenceTests/CompatabilityTest.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,39 +40,44 @@ final class CompatibilityTest: XCTestCase {
try await _test(
"https://raw.githubusercontent.com/aws/aws-lambda-dotnet/7a516b80d83a5c5f5d951158b16b8f76120035cc/Libraries/src/Amazon.Lambda.RuntimeSupport/Client/runtime-api.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testAzureIOTIdentityService() async throws {
try await _test(
"https://raw.githubusercontent.com/Azure/iot-identity-service/6404c3bebcc03f12c441c5b018803256bfe1fffe/key/aziot-keyd/openapi/2021-05-01.yaml",
license: .mit,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testBox() async throws {
try await _test(
"https://raw.githubusercontent.com/box/box-openapi/5955d651f0cd273c0968e3855c1d873c7ae3523e/openapi.json",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testCiscoMindmeld() async throws {
try await _test(
"https://raw.githubusercontent.com/cisco/mindmeld/bd3547d5c1bd092dbd4a64a90528dfc2e2b3844a/mindmeld/openapi/custom_action.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testCloudHypervisor() async throws {
try await _test(
"https://raw.githubusercontent.com/cloud-hypervisor/cloud-hypervisor/889d06277acae45c2b55bd5f6298ca2b21a55cbb/vmm/src/api/openapi/cloud-hypervisor.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

Expand All @@ -82,92 +87,104 @@ final class CompatibilityTest: XCTestCase {
license: .apache,
expectedDiagnostics: [
"Validation warning: Inconsistency encountered when parsing `OpenAPI Schema`: Found nothing but unsupported attributes.."
]
],
skipBuild: compatibilityTestSkipBuild
)
}

func testGithub() async throws {
try await _test(
"https://raw.githubusercontent.com/github/rest-api-description/13c873cb3b15ffd5bcd88c6d6270a963ef4518f6/descriptions/api.github.com/api.github.com.yaml",
license: .mit,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: true
)
}

func testGithubEnterprise() async throws {
try await _test(
"https://raw.githubusercontent.com/github/rest-api-description/13c873cb3b15ffd5bcd88c6d6270a963ef4518f6/descriptions/ghes-3.5/ghes-3.5.yaml",
license: .mit,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: true
)
}

func testKubernetes() async throws {
try await _test(
"https://raw.githubusercontent.com/kubernetes/kubernetes/fa3d7990104d7c1f16943a67f11b154b71f6a132/api/openapi-spec/v3/api__v1_openapi.json",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testNetflixConsoleMe() async throws {
try await _test(
"https://raw.githubusercontent.com/Netflix/consoleme/774420462b0190b1bfa78aa73d39e20044f52db9/swagger.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testOpenAI() async throws {
try await _test(
"https://raw.githubusercontent.com/openai/openai-openapi/ec0b3953bfa08a92782bdccf34c1931b13402f56/openapi.yaml",
license: .mit,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testOpenAPIExamplesPetstore() async throws {
try await _test(
"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/9dff244e5708fbe16e768738f4f17cf3fddf4066/examples/v3.0/petstore.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testOpenAPIExamplesPetstoreExpanded() async throws {
try await _test(
"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/9dff244e5708fbe16e768738f4f17cf3fddf4066/examples/v3.0/petstore-expanded.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}
func testOpenAPIExamplesAPIWithExamples() async throws {
try await _test(
"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/9dff244e5708fbe16e768738f4f17cf3fddf4066/examples/v3.0/api-with-examples.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}
func testOpenAPIExamplesCallbackExample() async throws {
try await _test(
"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/9dff244e5708fbe16e768738f4f17cf3fddf4066/examples/v3.0/callback-example.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}
func testOpenAPIExamplesLinkExample() async throws {
try await _test(
"https://raw.githubusercontent.com/OAI/OpenAPI-Specification/9dff244e5708fbe16e768738f4f17cf3fddf4066/examples/v3.0/link-example.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}

func testSwiftPackageRegistry() async throws {
try await _test(
"https://raw.githubusercontent.com/apple/swift-package-manager/ce0ff6f223122c88cbf24a0eca8424664e2fb1f1/Documentation/PackageRegistry/registry.openapi.yaml",
license: .apache,
expectedDiagnostics: []
expectedDiagnostics: [],
skipBuild: compatibilityTestSkipBuild
)
}
}
Expand All @@ -189,7 +206,8 @@ fileprivate extension CompatibilityTest {
func _test(
_ documentURL: String,
license: License,
expectedDiagnostics: Set<String> = []
expectedDiagnostics: Set<String> = [],
skipBuild: Bool = false
) async throws {
let diagnosticsCollector = RecordingDiagnosticCollector()

Expand Down Expand Up @@ -230,7 +248,7 @@ fileprivate extension CompatibilityTest {
XCTAssertEqual(Set(diagnosticsCollector.diagnostics.map(\.message)), expectedDiagnostics)
XCTAssertEqual(outputs.count, 3)

if !compatibilityTestSkipBuild {
if !skipBuild {
// Create Swift package test harness.
let packageName = "swift-openapi-compatibility-test-\(testCaseName)"
let packageDir = FileManager.default.temporaryDirectory.appendingPathComponent(
Expand Down

0 comments on commit 6db47f7

Please sign in to comment.