Customise module naming#3838
Merged
Merged
Conversation
danielrbradley
force-pushed
the
provider-naming-func
branch
from
5916bfb to
16cee86
Compare
Contributor
Does the PR have any schema changes?Looking good! No breaking changes found. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3838 +/- ##
==========================================
+ Coverage 56.87% 56.98% +0.10%
==========================================
Files 79 79
Lines 12253 12284 +31
==========================================
+ Hits 6969 7000 +31
Misses 4759 4759
Partials 525 525 ☔ View full report in Codecov by Sentry. |
danielrbradley
force-pushed
the
provider-naming-func
branch
from
16cee86 to
648858d
Compare
danielrbradley
force-pushed
the
provider-naming-func
branch
2 times, most recently
from
0fbf242 to
9c27adc
Compare
danielrbradley
had a problem deploying
to
env-ci
GitHub Actions
Failure
danielrbradley
force-pushed
the
provider-naming-func
branch
from
9c27adc to
d216f99
Compare
danielrbradley
changed the title
danielrbradley
had a problem deploying
to
env-ci
GitHub Actions
Failure
Move to near its only usage.
Add PreviousProviderName to ResourceSpec which is embedded into resourceVariant and passed into `func (g *packageGenerator) generateAliases(...)`
Prefer pure functions for simple string manipulation so the inputs are transparent to the caller. Make pulumi provider name a constant rather than referencing from the packageGenerator object. Simplify & test goModuleName 1. Add test of old function. 2. Add goModuleRepoPath prefixing to implementation & test. 3. Simplify implementation.
Replace makeTypeAlias with local function so it can also add to the slice directly. Allow setting the module name too so we can add aliases between modules. Add previous module variations of aliases Remove makeTypeAlias test
Note: We might be able to do this from the specification metadata at some point instead of hard-coding the corrected cases.
- Use maps instead of conditionals for conciseness & to get us to 100% coverage. - Move fetching major version number to call in Discover module so we can unit test both v2 and v3 paths. - Rename resourceProvider() to findNamespaceWithoutPrefixFromPath() - Rename fileProvider and apiProvider to be more explicit as to their string content.
danielrbradley
force-pushed
the
provider-naming-func
branch
from
14971e3 to
34f6aef
Compare
Contributor
|
This PR has been shipped in release v2.82.0. |
danielrbradley
added a commit
that referenced
this pull request
Jan 30, 2025
Stacked on top of #3906 This was only added in #3838 before changing direction in #3906 This removes a few aliases in v3 only where the explicit version was not actually present in the previous major version due to squeezing: ```diff diff --git a/provider/cmd/pulumi-resource-azure-native/schema.json b/provider/cmd/pulumi-resource-azure-native/schema.json --- a/provider/cmd/pulumi-resource-azure-native/schema.json +++ b/provider/cmd/pulumi-resource-azure-native/schema.json @@ -693311,21 +693311,6 @@ { "type": "azure-native:dns/v20230701preview:RecordSet" }, - { - "type": "azure-native:network/v20150504preview:RecordSet" - }, - { - "type": "azure-native:network/v20160401:RecordSet" - }, - { - "type": "azure-native:network/v20170901:RecordSet" - }, - { - "type": "azure-native:network/v20171001:RecordSet" - }, - { - "type": "azure-native:network/v20180301preview:RecordSet" - }, { "type": "azure-native:network/v20180501:RecordSet" }, @@ -693499,21 +693484,6 @@ { "type": "azure-native:dns/v20230701preview:Zone" }, - { - "type": "azure-native:network/v20150504preview:Zone" - }, - { - "type": "azure-native:network/v20160401:Zone" - }, - { - "type": "azure-native:network/v20170901:Zone" - }, - { - "type": "azure-native:network/v20171001:Zone" - }, - { - "type": "azure-native:network/v20180301preview:Zone" - }, { "type": "azure-native:network/v20180501:Zone" }, @@ -693749,9 +693719,6 @@ { "type": "azure-native:dnsresolver/v20230701preview:DnsResolver" }, - { - "type": "azure-native:network/v20200401preview:DnsResolver" - }, { "type": "azure-native:network/v20220701:DnsResolver" }, @@ -694326,9 +694293,6 @@ { "type": "azure-native:dnsresolver/v20230701preview:ForwardingRule" }, - { - "type": "azure-native:network/v20200401preview:ForwardingRule" - }, { "type": "azure-native:network/v20220701:ForwardingRule" }, @@ -709971,21 +709935,6 @@ { "type": "azure-native:frontdoor/v20210601:FrontDoor" }, - { - "type": "azure-native:network/v20190401:FrontDoor" - }, - { - "type": "azure-native:network/v20190501:FrontDoor" - }, - { - "type": "azure-native:network/v20200101:FrontDoor" - }, - { - "type": "azure-native:network/v20200401:FrontDoor" - }, - { - "type": "azure-native:network/v20200501:FrontDoor" - }, { "type": "azure-native:network/v20210601:FrontDoor" }, @@ -710244,18 +710193,6 @@ { "type": "azure-native:frontdoor/v20240201:Policy" }, - { - "type": "azure-native:network/v20190301:Policy" - }, - { - "type": "azure-native:network/v20191001:Policy" - }, - { - "type": "azure-native:network/v20200401:Policy" - }, - { - "type": "azure-native:network/v20201101:Policy" - }, { "type": "azure-native:network/v20210601:Policy" }, @@ -710342,15 +710279,6 @@ { "type": "azure-native:frontdoor/v20210601:RulesEngine" }, - { - "type": "azure-native:network/v20200101:RulesEngine" - }, - { - "type": "azure-native:network/v20200401:RulesEngine" - }, - { - "type": "azure-native:network/v20200501:RulesEngine" - }, { "type": "azure-native:network/v20210601:RulesEngine" }, @@ -759350,27 +759278,15 @@ { "type": "azure-native:documentdb/v20240301preview:FirewallRule" }, - { - "type": "azure-native:documentdb/v20240301preview:MongoClusterFirewallRule" - }, { "type": "azure-native:documentdb/v20240601preview:FirewallRule" }, - { - "type": "azure-native:documentdb/v20240601preview:MongoClusterFirewallRule" - }, { "type": "azure-native:documentdb/v20240701:FirewallRule" }, - { - "type": "azure-native:documentdb/v20240701:MongoClusterFirewallRule" - }, { "type": "azure-native:documentdb/v20241001preview:FirewallRule" }, - { - "type": "azure-native:documentdb/v20241001preview:MongoClusterFirewallRule" - }, { "type": "azure-native:documentdb:FirewallRule" }, @@ -759447,33 +759363,18 @@ "resourceGroupName" ], "aliases": [ - { - "type": "azure-native:documentdb/v20240301preview:MongoClusterPrivateEndpointConnection" - }, { "type": "azure-native:documentdb/v20240301preview:PrivateEndpointConnection" }, - { - "type": "azure-native:documentdb/v20240601preview:MongoClusterPrivateEndpointConnection" - }, { "type": "azure-native:documentdb/v20240601preview:PrivateEndpointConnection" }, - { - "type": "azure-native:documentdb/v20240701:MongoClusterPrivateEndpointConnection" - }, { "type": "azure-native:documentdb/v20240701:PrivateEndpointConnection" }, - { - "type": "azure-native:documentdb/v20241001preview:MongoClusterPrivateEndpointConnection" - }, { "type": "azure-native:documentdb/v20241001preview:PrivateEndpointConnection" }, - { - "type": "azure-native:documentdb:MongoClusterPrivateEndpointConnection" - }, { "type": "azure-native:mongocluster/v20240301preview:MongoClusterPrivateEndpointConnection" }, @@ -801431,12 +801332,6 @@ "resourceGroupName" ], "aliases": [ - { - "type": "azure-native:network/v20180901:PrivateRecordSet" - }, - { - "type": "azure-native:network/v20200101:PrivateRecordSet" - }, { "type": "azure-native:network/v20200601:PrivateRecordSet" }, @@ -801560,12 +801455,6 @@ "resourceGroupName" ], "aliases": [ - { - "type": "azure-native:network/v20180901:PrivateZone" - }, - { - "type": "azure-native:network/v20200101:PrivateZone" - }, { "type": "azure-native:network/v20200601:PrivateZone" }, @@ -801698,12 +801587,6 @@ "resourceGroupName" ], "aliases": [ - { - "type": "azure-native:network/v20180901:VirtualNetworkLink" - }, - { - "type": "azure-native:network/v20200101:VirtualNetworkLink" - }, { "type": "azure-native:network/v20200601:VirtualNetworkLink" }, @@ -869461,27 +869344,6 @@ "resourceGroupName" ], "aliases": [ - { - "type": "azure-native:network/v20151101:Endpoint" - }, - { - "type": "azure-native:network/v20170301:Endpoint" - }, - { - "type": "azure-native:network/v20170501:Endpoint" - }, - { - "type": "azure-native:network/v20180201:Endpoint" - }, - { - "type": "azure-native:network/v20180301:Endpoint" - }, - { - "type": "azure-native:network/v20180401:Endpoint" - }, - { - "type": "azure-native:network/v20180801:Endpoint" - }, { "type": "azure-native:network/v20220401:Endpoint" }, @@ -869694,27 +869556,6 @@ "resourceGroupName" ], "aliases": [ - { - "type": "azure-native:network/v20151101:Profile" - }, - { - "type": "azure-native:network/v20170301:Profile" - }, - { - "type": "azure-native:network/v20170501:Profile" - }, - { - "type": "azure-native:network/v20180201:Profile" - }, - { - "type": "azure-native:network/v20180301:Profile" - }, - { - "type": "azure-native:network/v20180401:Profile" - }, - { - "type": "azure-native:network/v20180801:Profile" - }, { "type": "azure-native:network/v20220401:Profile" }, @@ -869771,12 +869612,6 @@ }, "type": "object", "aliases": [ - { - "type": "azure-native:network/v20180401:TrafficManagerUserMetricsKey" - }, - { - "type": "azure-native:network/v20180801:TrafficManagerUserMetricsKey" - }, { "type": "azure-native:network/v20220401:TrafficManagerUserMetricsKey" }, ```
This was referenced Sep 1, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Choosing default versions (#3448) is hard where there's multiple versions mixed into a single module. This is sometimes because we structure our modules around Azure's namespaces rather than the SDK folders. This PR allows us to selectively restructure problematic modules to match Azure's SDK structure (#690) and avoid mixing multiple versions into a single module. An example of the result of turning on the feature flag can be seen in 14db6d8 where we split out Dns, DnsResolver, FrontDoor, PrivateDns and TrafficManager from the Network module.
Side note: when splitting the modules out, there's all previous versions generated for the new module. These will be reduced when we run the squeeze process.
Manual report of all specification folders and the namespaces within them: spec-dirs.csv
For the first Network module split, we've hard coded the new module names to use because the casing is not able to be derived from the folder name alone. In a follow-up PR we can investigate parsing the Readme.md files from the specifications to automatically infer the correct names and avoid hard-coding.
Generate implementation approach: