[TypeSpecRequirement] Add tests #29639

mikeharder · 2024-06-29T06:19:42Z

Fixes [TypeSpecRequirement] Add end-to-end test #29009

openapi-pipeline-app · 2024-06-29T06:19:45Z

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

openapi-pipeline-app · 2024-06-29T06:19:46Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️❌Avocado: 5 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: resource-manager/Microsoft.HandWritten/preview/2024-01-01-preview
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: resource-manager/Microsoft.NoTspConfig/preview/2024-01-01-preview
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: resource-manager/Microsoft.ParseError/preview/2024-01-01-preview
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: resource-manager/Microsoft.Suppression/preview/2024-01-01-preview
`❌` MISSING_README	Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: resource-manager/Microsoft.TypeSpecGenerated/preview/2024-01-01-preview

️❌SwaggerAPIView: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` Failed to generate swagger APIView. The readme file format is invalid and the tag is not defined. Use the provided readme template for guidance readme template. For more details, please check the detail log.	"How to fix":"Check the readme file and make sure the readme file format is valid and the tag is defined. Use the provided readme template"

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️⌛Automated merging requirements met pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-06-29T06:19:46Z

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` RestBuild error	"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=436900&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 "

️🔄 $(sdkName) inProgress [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-06-29T06:19:46Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

mikeharder · 2024-07-02T01:02:28Z

eng/scripts/TypeSpec-Requirement.ps1

@@ -59,7 +63,7 @@ $repoPath = Resolve-Path "$PSScriptRoot/../.."
 $pathsWithErrors = @()

 $filesToCheck = $CheckAllUnder ?
-  (Get-ChildItem -Path $CheckAllUnder -Recurse -File | Resolve-Path -Relative | ForEach-Object { $_ -replace '\\', '/' }) :
+  (Get-ChildItem -Path $CheckAllUnder -Recurse -File | Resolve-Path -Relative -RelativeBasePath $repoPath | ForEach-Object { $_ -replace '\\', '/' }) :


Fixes bug when testing files outside root "specification" folder

mikeharder · 2024-07-02T01:02:55Z

eng/scripts/TypeSpec-Requirement.ps1

-            | Where-Object { $_.Name -eq "tspconfig.yaml" })
+        if ($file -match "^.*specification/[^/]+/") {
+          $rpFolder = $Matches[0];
+          $tspConfigs = @(Get-ChildItem -Path $rpFolder -Recurse -File | Where-Object { $_.Name -eq "tspconfig.yaml" })


Fixes bug when testing files outside root "specification" folder

mikeharder · 2024-07-02T01:03:46Z

eng/scripts/TypeSpec-Requirement.ps1

@@ -176,12 +179,12 @@ else {
    if ($responseStatus -eq 200) {
      LogInfo "  Branch 'main' contains path '$servicePath/stable', so spec already exists and is not required to use TypeSpec"
    }
-    elseif ($response.StatusCode -eq 404) {
+    elseif ($responseStatus -eq 404) {


Bug fix (unlikely to hit in practice)

…-specs into tsr-unit-tests

weshaggard · 2024-07-02T15:54:54Z

eng/scripts/Logging-Functions.ps1

@@ -15,7 +15,7 @@ function LogWarning {
    Write-Host ("##vso[task.LogIssue type=warning;]$args" -replace "`n", "%0D%0A")
  }
  elseif (Test-SupportsGitHubLogging) {
-    Write-Host ("::warning::$args" -replace "`n", "%0D%0A")
+    Write-Warning ("::warning::$args" -replace "`n", "%0D%0A")


What does this give us? Doesn't GH just interpret these logging messages and not display them?

At least for GH, it seemed more correct to use both the intended pwsh Write-* method, along with including the GH-specific logging strings.

Write-Warning might write to stdout instead of stderr, so it might not matter in practice. What did matter in practice was using Write-Error instead of Write-Host, to ensure errors are always written to stderr.

Example:

azure-rest-api-specs/eng/tools/typespec-requirement/test/typespec-requirement.test.ts

Lines 38 to 43 in c142d61

test.concurrent("No tspconfig.yaml", async ({ expect }) => {

const { stderr, exitCode } = await checkAllUnder("specification/no-tspconfig");

expect(stderr).toContain("no files named 'tspconfig.yaml'");

expect(exitCode).toBe(1);

});

mikeharder added 2 commits June 29, 2024 06:14

Add _ResponseCache parameter for testing

91093de

Improve comment

6862c6a

mikeharder self-assigned this Jun 29, 2024

mikeharder added 23 commits June 29, 2024 06:27

Add skeleton test project

9dc25d8

Add action

00fd6ae

Add concurrent tests

05f2d46

npm update

2af85df

Add test for suppressions

e17cf79

Add test for no tspconfig.yaml

31f6b6a

Remove debugging

4674bfa

Add debugging

0da256e

More debugging

ae8447b

Remove debugging

16c7c6c

Write GitHub logs to correct stream

81a0078

Add trailing newline

1c523de

Remove blank line

2dde729

Add test for error parsing json

bdb3bfc

Add test for success case

ad2c350

Add test for hand-written exists in main

3e89bf8

Add tests for not exist in main

dc4a47e

Rename test folder

27c33af

Add content to test file

951b992

Add readme to fix Avocado

0f86d47

Delete test readme

ad4101d

Add vite config

ad07733

Add test content

a4caceb

Fill empty file

a038aae

mikeharder marked this pull request as ready for review July 2, 2024 00:59

mikeharder requested review from weshaggard, konrad-jamrozik and benbp as code owners July 2, 2024 00:59

Merge branch 'main' into tsr-unit-tests

d542598

mikeharder commented Jul 2, 2024

View reviewed changes

mikeharder added 3 commits July 1, 2024 18:04

Remove debug statement

01d3b65

Merge branch 'tsr-unit-tests' of github.com:mikeharder/azure-rest-api…

f6898c7

…-specs into tsr-unit-tests

npm update

016ce40

konrad-jamrozik approved these changes Jul 2, 2024

View reviewed changes

mikeharder merged commit 87a08b9 into Azure:main Jul 2, 2024
24 of 32 checks passed

mikeharder deleted the tsr-unit-tests branch July 2, 2024 01:25

weshaggard reviewed Jul 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TypeSpecRequirement] Add tests #29639

[TypeSpecRequirement] Add tests #29639

mikeharder commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

mikeharder Jul 2, 2024

mikeharder Jul 2, 2024

mikeharder Jul 2, 2024

weshaggard Jul 2, 2024

mikeharder Jul 2, 2024 •

edited

Loading

	test.concurrent("No tspconfig.yaml", async ({ expect }) => {
	const { stderr, exitCode } = await checkAllUnder("specification/no-tspconfig");

	expect(stderr).toContain("no files named 'tspconfig.yaml'");
	expect(exitCode).toBe(1);
	});

[TypeSpecRequirement] Add tests #29639

[TypeSpecRequirement] Add tests #29639

Conversation

mikeharder commented Jun 29, 2024 • edited Loading

openapi-pipeline-app bot commented Jun 29, 2024 • edited Loading

openapi-pipeline-app bot commented Jun 29, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 29, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Jun 29, 2024 • edited Loading

mikeharder Jul 2, 2024

Choose a reason for hiding this comment

mikeharder Jul 2, 2024

Choose a reason for hiding this comment

mikeharder Jul 2, 2024

Choose a reason for hiding this comment

weshaggard Jul 2, 2024

Choose a reason for hiding this comment

mikeharder Jul 2, 2024 • edited Loading

Choose a reason for hiding this comment

mikeharder commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 29, 2024 •

edited

Loading

mikeharder Jul 2, 2024 •

edited

Loading