Update bicep generator to use bicep-types and new contract #7506

sk593 · 2024-04-15T17:58:44Z

Description

Update bicep generator to use bicep-types and new contract

Type of change

This pull request fixes a bug in Radius and has an approved issue (issue link required).
This pull request adds or changes features of Radius and has an approved issue (issue link required).
This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Fixes: #issue_number

rynowak · 2024-04-15T20:35:16Z

Are there functionality changes in this PR or just updates to the new types?

sk593 · 2024-04-15T20:46:49Z

Are there functionality changes in this PR or just updates to the new types?

A little of both. Since the type contract for bicep was recently updated, there has been some change in functionality (mostly with adding functions to resources and getting our repo in sync with the bicep-types repo). But the outcome of the changes are the same w.r.t. to the code being used to generate types/index files

hack/bicep-types-radius/src/generator/src/cmd/generate.ts

build/generate.mk

lakshmimsft · 2024-05-13T22:15:38Z

...ypes-radius/src/autorest.bicep/test/integration/generated/basic/test.rp1/2021-10-31/types.md

+### Properties
+* **basicString**: string: Description for a basic string property.
+* **stringEnum**: 'Bar' | 'Foo': Description for a basic enum property.
+
 ## TrackedResourceTags
 ### Properties
 ### Additional Properties
 * **Additional Properties Type**: string


FoosRequest. FoosResponse still exists under :
hack/bicep-types-radius/src/autorest.bicep/test/integration/generated/basic/test.rp1/2021-10-31/types.md and
sk593/radius/hack/bicep-types-radius/src/autorest.bicep/test/integration/generated/basic/test.rp1/2021-10-31/types.json .. should it be deleted here?

This might be because of how the bicep-types markdown generator is written. Ideally, it should still be generated but I'll double check if this was missed in that repo or if it's an issue in our code

Following up here: We need some clarity/more info on the .md files under the hack/bicep-types-radius/generated/ folder not added to github (they are in .gitignore folder) but then there is a test folder which also includes these generated files which gets into github and there is some discrepancy in there.

I think the test folder can keep the MD files in case we ever add them back to the generated types folder. From what I remember, the other MD files were added to the .gitignore because there was a discrepancy between the MD files and the docs page and we wanted to keep them the same. @willtsai or the PMs may have more insight on this. This is the PR that removed the MD files from the hack folder: #6331

okay, so it looks like Aaron removed the MD files from the hack folder in PR#6331 because these MD documents gets autogenerated in the workflow added by the same PR. Thus, I believe the right call is to continue keeping the MD files in the .gitignore so that the docs site can depend on the autogeneration workflow that keeps the documentation (for example) up to date.

sounds good, thanks for looking into that. I still think it makes sense to keep the MD file in the test folder since we do generate those (even if they're not uploaded to Github). since the types in that file are just test resources, I don't think it'll be a point for confusion. thoughts @lakshmimsft ?

Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 · 2024-05-28T21:19:31Z

hack/bicep-types-radius/src/autorest.bicep/src/type-generator.ts

@@ -142,66 +138,74 @@ export function generateTypes(host: AutorestExtensionHost, definition: ProviderD
      }

      const { descriptor, bodyType } = output;
+      let resourceTypeFunctions: Record<string, ResourceTypeFunction> = {};
+
+      let actions = resourceFunctionType[fullyQualifiedType];


We are now tracking functions per resource instead of overall. So each function will be in the types file associated with that resource's namespace.

Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 · 2024-05-30T19:04:46Z

hack/bicep-types-radius/src/generator/src/cmd/generate.ts

-        };
-
-        continue;
+function getRadiusRelease(): Promise<string> {


Thinking about this more and this actually might not work. PRs should get merged in with the "latest" tag but when we test, we'd want to test against a PR-specific tag, not "latest". So this might end up generating the wrong version number. Will look into this more

Leaving this for now. Will address in a follow up PR when we get to uploading to ACR

willdavsmith

LGTM, but can you quickly summarize how you tested this in a comment?

sk593 · 2024-05-31T22:44:36Z

LGTM, but can you quickly summarize how you tested this in a comment?

A lot of it was manual testing but we have an integration test file that verifies the generation is accurate. The test wasn't updated but the test files were

Signed-off-by: sk593 <shruthikumar@microsoft.com>

# Description Update bicep generator to use bicep-types and new contract ## Type of change  - This pull request fixes a bug in Radius and has an approved issue (issue link required). - This pull request adds or changes features of Radius and has an approved issue (issue link required). - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).  Fixes: #issue_number --------- Signed-off-by: sk593 <shruthikumar@microsoft.com>

Update bicep generator to use bicep-types and new contract  - This pull request fixes a bug in Radius and has an approved issue (issue link required). - This pull request adds or changes features of Radius and has an approved issue (issue link required). - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).  Fixes: #issue_number --------- Signed-off-by: sk593 <shruthikumar@microsoft.com>

# Description Update bicep generator to use bicep-types and new contract ## Type of change  - This pull request fixes a bug in Radius and has an approved issue (issue link required). - This pull request adds or changes features of Radius and has an approved issue (issue link required). - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).  Fixes: #issue_number --------- Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 requested review from a team as code owners April 15, 2024 17:58

sk593 force-pushed the update-bicep-types-radius branch from bcf59ee to a57c0db Compare April 25, 2024 17:16

lakshmimsft reviewed May 13, 2024

View reviewed changes

hack/bicep-types-radius/src/generator/src/cmd/generate.ts Outdated Show resolved Hide resolved

lakshmimsft reviewed May 13, 2024

View reviewed changes

build/generate.mk Show resolved Hide resolved

lakshmimsft reviewed May 13, 2024

View reviewed changes

sk593 added 2 commits May 28, 2024 14:02

update generator code to use bicep-types

81dae4c

Signed-off-by: sk593 <shruthikumar@microsoft.com>

update bicep generator code to use bicep-types

cd4cdf5

Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 force-pushed the update-bicep-types-radius branch 2 times, most recently from 01054ed to f37db26 Compare May 28, 2024 21:17

sk593 commented May 28, 2024

View reviewed changes

update with typesettings and new version of bicep-types

99888d1

Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 force-pushed the update-bicep-types-radius branch from f37db26 to 99888d1 Compare May 29, 2024 17:59

sk593 commented May 30, 2024

View reviewed changes

willdavsmith approved these changes May 30, 2024

View reviewed changes

sk593 force-pushed the update-bicep-types-radius branch from 3ae9ea3 to 99888d1 Compare June 3, 2024 23:59

update bicep generator code to use bicep-types

f545d04

Signed-off-by: sk593 <shruthikumar@microsoft.com>

sk593 force-pushed the update-bicep-types-radius branch from 474af86 to f545d04 Compare June 4, 2024 04:54

sk593 merged commit edd635a into radius-project:feature-bicep-compiler-merge Jun 4, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update bicep generator to use bicep-types and new contract #7506

Update bicep generator to use bicep-types and new contract #7506

sk593 commented Apr 15, 2024

rynowak commented Apr 15, 2024

sk593 commented Apr 15, 2024

lakshmimsft May 13, 2024

sk593 May 14, 2024

lakshmimsft May 28, 2024

sk593 May 28, 2024

willtsai May 28, 2024

sk593 May 29, 2024

sk593 May 28, 2024

sk593 May 30, 2024

sk593 Jun 3, 2024

willdavsmith left a comment

sk593 commented May 31, 2024

Update bicep generator to use bicep-types and new contract #7506

Update bicep generator to use bicep-types and new contract #7506

Conversation

sk593 commented Apr 15, 2024

Description

Type of change

rynowak commented Apr 15, 2024

sk593 commented Apr 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willdavsmith left a comment

Choose a reason for hiding this comment

sk593 commented May 31, 2024