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.

Sign up for GitHub

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

[TypeSpec Requirement] Improve check if OpenAPI cannot be parsed as JSON #27341

Merged
merged 5 commits into from
Jan 17, 2024
Merged

[TypeSpec Requirement] Improve check if OpenAPI cannot be parsed as JSON #27341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d993f9
Test new spec with invalid json
mikeharder Jan 10, 2024
327d363
Add commit parameters for easier local testing
mikeharder Jan 10, 2024
dc7859f
Merge branch 'main' into tsr-invalid-json
mikeharder Jan 16, 2024
c208df0
Catch exception parsing OpenAPI as JSON
mikeharder Jan 17, 2024
3f22f44
Revert "Test new spec with invalid json"
mikeharder Jan 17, 2024
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
4 changes: 2 additions & 2 deletions eng/scripts/ChangedFiles-Functions.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ function Get-ChangedFiles($baseCommitish = "HEAD^", $targetCommitish = "HEAD", $
return $changedFiles
}

function Get-ChangedSwaggerFiles() {
$changedFiles = Get-ChangedFilesUnderSpecification
function Get-ChangedSwaggerFiles($changedFiles = (Get-ChangedFiles)) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added to enable testing scripts on other commits

$changedFiles = Get-ChangedFilesUnderSpecification($changedFiles)
mikeharder marked this conversation as resolved.
Show resolved Hide resolved

$changedSwaggerFiles = $changedFiles.Where({
$_.EndsWith(".json")
Expand Down
27 changes: 19 additions & 8 deletions eng/scripts/TypeSpec-Requirement.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
[CmdletBinding()]
param (
[Parameter(Position = 0)]
Copy link
Member Author

@mikeharder mikeharder Jan 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added to enable testing script on other commits

[string] $BaseCommitish = "HEAD^",
[Parameter(Position = 1)]
[string] $TargetCommitish = "HEAD"

)
Set-StrictMode -Version 3

Expand All @@ -9,7 +14,7 @@ Set-StrictMode -Version 3
$repoPath = Resolve-Path "$PSScriptRoot/../.."
$pathsWithErrors = @()

$filesToCheck = @(Get-ChangedSwaggerFiles).Where({
$filesToCheck = (Get-ChangedSwaggerFiles (Get-ChangedFiles $BaseCommitish $TargetCommitish)).Where({
($_ -notmatch "/(examples|scenarios|restler|common|common-types)/") -and
($_ -match "specification/[^/]+/(data-plane|resource-manager).*?/(preview|stable)/[^/]+/[^/]+\.json$")
})
Expand All @@ -30,15 +35,21 @@ else {
foreach ($file in $filesToCheck) {
LogInfo "Checking $file"

$jsonContent = Get-Content (Join-Path $repoPath $file) | ConvertFrom-Json -AsHashtable
try {
$jsonContent = Get-Content (Join-Path $repoPath $file) | ConvertFrom-Json -AsHashtable

if ($null -ne ${jsonContent}?["info"]?["x-typespec-generated"]) {
LogInfo " OpenAPI was generated from TypeSpec (contains '/info/x-typespec-generated')"
# Skip further checks, since spec is already using TypeSpec
continue
if ($null -ne ${jsonContent}?["info"]?["x-typespec-generated"]) {
LogInfo " OpenAPI was generated from TypeSpec (contains '/info/x-typespec-generated')"
# Skip further checks, since spec is already using TypeSpec
continue
}
else {
LogInfo " OpenAPI was not generated from TypeSpec (missing '/info/x-typespec-generated')"
}
}
else {
LogInfo " OpenAPI was not generated from TypeSpec (missing '/info/x-typespec-generated')"
catch {
LogWarning " OpenAPI cannot be parsed as JSON, so assuming not generated from TypeSpec"
LogWarning " $_"
}

# Extract path between "specification/" and "/(preview|stable)"
Expand Down