Skip to content

[Linter] Add gracePeriodInDays option to use-recent-api-versions to prevent recommending undeployable API versions #19168

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[Linter] Add gracePeriodInDays option to use-recent-api-versions to prevent recommending undeployable API versions #19168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2398a9
Initial plan
Copilot Mar 10, 2026
59fc392
Add gracePeriodInDays config option to use-recent-api-versions linter…
Copilot Mar 10, 2026
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
2 changes: 1 addition & 1 deletion global.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
},
"sdk": {
"allowPrerelease": false,
"version": "10.0.103",
"version": "10.0.102",
"rollForward": "latestPatch"
}
}
159 changes: 151 additions & 8 deletions src/Bicep.Core.UnitTests/Diagnostics/LinterRuleTests/UseRecentApiVersionRuleTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public static void VerifyAllTypesAndDatesAreFake(params string[] bicepStrings)
}
}

private static void CompileAndTestWithFakeDateAndTypes(string bicep, ResourceScope scope, string[] resourceTypes, string fakeToday, string[] expectedMessagesForCode, OnCompileErrors onCompileErrors = OnCompileErrors.IncludeErrors, int? maxAgeInDays = null)
private static void CompileAndTestWithFakeDateAndTypes(string bicep, ResourceScope scope, string[] resourceTypes, string fakeToday, string[] expectedMessagesForCode, OnCompileErrors onCompileErrors = OnCompileErrors.IncludeErrors, int? maxAgeInDays = null, int? gracePeriodInDays = null)
{
VerifyAllTypesAndDatesAreFake(bicep, string.Join(", ", resourceTypes), fakeToday, string.Join(", ", expectedMessagesForCode));

Expand All @@ -48,7 +48,7 @@ private static void CompileAndTestWithFakeDateAndTypes(string bicep, ResourceSco
new Options(
OnCompileErrors: onCompileErrors,
IncludePosition.LineNumber,
ConfigurationPatch: c => CreateConfigurationWithFakeToday(c, fakeToday, maxAgeInDays),
ConfigurationPatch: c => CreateConfigurationWithFakeToday(c, fakeToday, maxAgeInDays, gracePeriodInDays),
// Test with the linter thinking today's date is fakeToday and also fake resource types from FakeResourceTypes
// Note: The compiler does not know about these fake types, only the linter.
AzResourceTypeLoader: resourceTypes.Any() ? FakeResourceTypes.GetAzResourceTypeLoaderWithInjectedTypes(resourceTypes).Object : null));
Expand Down Expand Up @@ -98,7 +98,7 @@ private static void CompileAndTestFixWithFakeDateAndTypes(string bicep, Resource
AzResourceTypeLoader: FakeResourceTypes.GetAzResourceTypeLoaderWithInjectedTypes(resourceTypes).Object));
}

private static RootConfiguration CreateConfigurationWithFakeToday(RootConfiguration original, string today, int? maxAgeInDays = null)
private static RootConfiguration CreateConfigurationWithFakeToday(RootConfiguration original, string today, int? maxAgeInDays = null, int? gracePeriodInDays = null)
{
VerifyAllTypesAndDatesAreFake(today);

Expand All @@ -118,13 +118,15 @@ private static RootConfiguration CreateConfigurationWithFakeToday(RootConfigurat
"test-today": "<TESTING_TODAY_DATE>",
"test-warn-not-found": true
<MAX_AGE_PROP>
<GRACE_PERIOD_PROP>
}
}
}
}
"""
.Replace("<TESTING_TODAY_DATE>", today)
.Replace("<MAX_AGE_PROP>", maxAgeInDays.HasValue ? $", \"maxAgeInDays\": {maxAgeInDays}" : ""))),
.Replace("<MAX_AGE_PROP>", maxAgeInDays.HasValue ? $", \"maxAgeInDays\": {maxAgeInDays}" : "")
.Replace("<GRACE_PERIOD_PROP>", gracePeriodInDays.HasValue ? $", \"gracePeriodInDays\": {gracePeriodInDays}" : ""))),
original.CacheRootDirectory,
original.ExperimentalFeaturesWarning,
original.ExperimentalFeaturesEnabled with
Expand All @@ -139,15 +141,15 @@ original.ExperimentalFeaturesEnabled with
[TestClass]
public class GetAcceptableApiVersionsTests
{
private static void TestGetAcceptableApiVersions(string fullyQualifiedResourceType, ResourceScope scope, string resourceTypes, string today, string[] expectedApiVersions, int maxAgeInDays = UseRecentApiVersionRule.DefaultMaxAgeInDays)
private static void TestGetAcceptableApiVersions(string fullyQualifiedResourceType, ResourceScope scope, string resourceTypes, string today, string[] expectedApiVersions, int maxAgeInDays = UseRecentApiVersionRule.DefaultMaxAgeInDays, int gracePeriodInDays = UseRecentApiVersionRule.DefaultGracePeriodInDays)
{
VerifyAllTypesAndDatesAreFake(fullyQualifiedResourceType, today);
VerifyAllTypesAndDatesAreFake(resourceTypes);
VerifyAllTypesAndDatesAreFake(expectedApiVersions);

var apiVersionProvider = new ApiVersionProvider(BicepTestConstants.Features, []);
apiVersionProvider.InjectTypeReferences(scope, FakeResourceTypes.GetFakeResourceTypeReferences(resourceTypes));
var (_, allowedVersions) = UseRecentApiVersionRule.GetAcceptableApiVersions(apiVersionProvider, AzureResourceApiVersion.Parse(today).Date, maxAgeInDays, scope, fullyQualifiedResourceType);
var (_, allowedVersions) = UseRecentApiVersionRule.GetAcceptableApiVersions(apiVersionProvider, AzureResourceApiVersion.Parse(today).Date, maxAgeInDays, scope, fullyQualifiedResourceType, gracePeriodInDays);
var allowedVersionsStrings = allowedVersions.Select(v => v.ToString()).ToArray();
allowedVersionsStrings.Should().BeEquivalentTo(expectedApiVersions, options => options.WithStrictOrdering());
}
Expand Down Expand Up @@ -712,6 +714,65 @@ public void LotsOfPreviewVersions_AndOneRecentGA_Available_AllowOnlyPreviewsMore
"2421-02-01", // No previews older than this allowed, even if < 2 years old
]);
}

// Grace period tests

[TestMethod]
public void GracePeriod_FiltersOutTooNewVersions()
{
// Only the version older than the grace period should be returned
TestGetAcceptableApiVersions(
"Fake.Kusto/clusters",
ResourceScope.ResourceGroup,
@"
Fake.Kusto/clusters@2421-04-01
Fake.Kusto/clusters@2421-06-07
",
"2421-07-07",
[
"2421-04-01", // 96 days old, outside 60-day grace period
// 2421-06-07 is 30 days old, within 60-day grace period - excluded
],
gracePeriodInDays: 60);
}

[TestMethod]
public void GracePeriod_FallsBackWhenAllVersionsWithinGracePeriod()
{
// When all versions are within the grace period, fall back to including all
TestGetAcceptableApiVersions(
"Fake.Kusto/clusters",
ResourceScope.ResourceGroup,
@"
Fake.Kusto/clusters@2421-06-07
Fake.Kusto/clusters@2421-07-01
",
"2421-07-07",
[
"2421-07-01", // All are within 60-day grace period, so fall back to all versions
"2421-06-07",
],
gracePeriodInDays: 60);
}

[TestMethod]
public void GracePeriod_ZeroGracePeriod_IncludesAllVersions()
{
// Zero grace period should include all versions (default behavior)
TestGetAcceptableApiVersions(
"Fake.Kusto/clusters",
ResourceScope.ResourceGroup,
@"
Fake.Kusto/clusters@2421-04-01
Fake.Kusto/clusters@2421-06-07
",
"2421-07-07",
[
"2421-06-07", // Both included, most recent is recommended
"2421-04-01",
],
gracePeriodInDays: 0);
}
}

[TestClass]
Expand Down Expand Up @@ -913,7 +974,8 @@ private static void Test(
DateOnly[] gaVersionDates,
DateOnly[] previewVersionDates,
(string message, string acceptableVersions, string replacement)? expectedFix,
int maxAllowedAgeInDays = 730)
int maxAllowedAgeInDays = 730,
int gracePeriodInDays = 0)
{
string[] gaVersions = gaVersionDates.Select(d => "Whoever.whatever/whichever@" + CreateApiVersion(d)).ToArray();
string[] previewVersions = previewVersionDates.Select(d => "Whoever.whatever/whichever@" + CreateApiVersion(d) + "-preview").ToArray();
Expand All @@ -929,7 +991,8 @@ private static void Test(
ResourceScope.ResourceGroup,
"Whoever.whatever/whichever",
CreateApiVersion(currentVersionDate, currentVersionSuffix),
returnNotFoundDiagnostics: true);
returnNotFoundDiagnostics: true,
gracePeriodInDays: gracePeriodInDays);

if (expectedFix == null)
{
Expand Down Expand Up @@ -1167,6 +1230,86 @@ public void WithPreviewVersion_WhenGAVersionisNull_AndCurrentVersionIsRecent_Sho
Test(currentVersionDate, "-preview", [], [recentPreviewVersionDate, currentVersionDate],
null);
}

// Grace period tests

[TestMethod]
public void GracePeriod_WhenNewerVersionIsWithinGracePeriod_ShouldNotRecommendIt()
{
// The newest GA version is within the grace period (too new to be recommended)
// The current version is outside the grace period but is the most recent eligible version
// so it should not be flagged
DateOnly currentVersionDate = GetToday().AddDays(-3 * 365);
string currentVersion = CreateApiVersion(currentVersionDate);

DateOnly newVersionDate = GetToday().AddDays(-30); // 30 days old, within 60-day grace period

// Without grace period, the new version would be recommended and the current would be flagged
// With grace period, the current version should be acceptable since it's the most recent eligible version
Test(currentVersionDate, "", [currentVersionDate, newVersionDate], [], null, gracePeriodInDays: 60);
}

[TestMethod]
public void GracePeriod_WhenCurrentVersionIsWithinGracePeriod_ShouldNotAddDiagnostics()
{
// Current version is within the grace period (too new to warn about)
DateOnly currentVersionDate = GetToday().AddDays(-30); // 30 days old, within 60-day grace period
DateOnly olderVersionDate = GetToday().AddDays(-2 * 365);

// Even though there's an older version that would be in the acceptable list,
// the current version is within the grace period so it should not be flagged
Test(currentVersionDate, "", [olderVersionDate, currentVersionDate], [], null, gracePeriodInDays: 60);
}

[TestMethod]
public void GracePeriod_WhenAllVersionsWithinGracePeriod_ShouldNotAddDiagnostics()
{
// All versions are within the grace period
DateOnly currentVersionDate = GetToday().AddDays(-20);
DateOnly newerVersionDate = GetToday().AddDays(-10);

Test(currentVersionDate, "", [currentVersionDate, newerVersionDate], [], null, gracePeriodInDays: 60);
}

[TestMethod]
public void GracePeriod_WhenNewerVersionIsJustOutsideGracePeriod_ShouldRecommendIt()
{
// The newer version is just outside the grace period (61 days old, > 60-day grace period)
// The current version is much older (flagged)
DateOnly currentVersionDate = GetToday().AddDays(-3 * 365);
string currentVersion = CreateApiVersion(currentVersionDate);

DateOnly newerVersionDate = GetToday().AddDays(-61); // 61 days old, just outside 60-day grace period
string newerVersion = CreateApiVersion(newerVersionDate);

Test(currentVersionDate, "", [currentVersionDate, newerVersionDate], [],
(
$"Use more recent API version for 'Whoever.whatever/whichever'. '{currentVersion}' is {3 * 365} days old, should be no more than 730 days old, or the most recent.",
acceptableVersions: newerVersion,
replacement: newerVersion
),
gracePeriodInDays: 60);
}

[TestMethod]
public void GracePeriod_ZeroGracePeriod_BehavesLikeDefault()
{
// Zero grace period should have no effect (backward compat)
DateOnly currentVersionDate = GetToday().AddDays(-3 * 365);
string currentVersion = CreateApiVersion(currentVersionDate);

DateOnly newerVersionDate = GetToday().AddDays(-30);
string newerVersion = CreateApiVersion(newerVersionDate);

// Without grace period (default), the new version would be recommended
Test(currentVersionDate, "", [currentVersionDate, newerVersionDate], [],
(
$"Use more recent API version for 'Whoever.whatever/whichever'. '{currentVersion}' is {3 * 365} days old, should be no more than 730 days old, or the most recent.",
acceptableVersions: newerVersion,
replacement: newerVersion
),
gracePeriodInDays: 0);
}
}

[TestClass]
Expand Down
Loading