-
Notifications
You must be signed in to change notification settings - Fork 4.2k
[KeyVault] Fix New-AzKeyVault RequestDisallowedByPolicy error by explicitly setting enableSoftDelete in the request body #29497
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.
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
Open
rahulalapati43
wants to merge
2
commits into
Azure:main
Choose a base branch
from
rahulalapati43:fix/keyvault-soft-delete-policy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
180 changes: 180 additions & 0 deletions
180
src/KeyVault/KeyVault.Test/UnitTests/NewAzureKeyVaultSoftDeleteTests.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| // ---------------------------------------------------------------------------------- | ||
| // | ||
| // Copyright Microsoft Corporation | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // ---------------------------------------------------------------------------------- | ||
|
|
||
| using Microsoft.Azure.Commands.KeyVault.Models; | ||
| using Microsoft.Azure.Management.Internal.Resources; | ||
| using Microsoft.Azure.Management.KeyVault; | ||
| using Microsoft.Azure.Management.KeyVault.Models; | ||
| using Microsoft.Rest.Azure; | ||
| using Microsoft.WindowsAzure.Commands.ScenarioTest; | ||
| using Moq; | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Management.Automation; | ||
| using System.Net; | ||
| using System.Net.Http; | ||
| using System.Reflection; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Xunit; | ||
| using KVSku = Microsoft.Azure.Management.KeyVault.Models.Sku; | ||
|
|
||
| namespace Microsoft.Azure.Commands.KeyVault.Test.UnitTests | ||
| { | ||
| /// <summary> | ||
| /// Verify that New-AzKeyVault explicitly sets EnableSoftDelete=true in the request body | ||
| /// so that Azure Policy checks requiring the property to be present are satisfied. | ||
| /// </summary> | ||
| public class NewAzureKeyVaultSoftDeleteTests : KeyVaultUnitTestBase | ||
| { | ||
| private VaultCreateOrUpdateParameters _capturedSdkParameters; | ||
| private VaultManagementClient _vaultManagementClient; | ||
|
|
||
| /// <summary> | ||
| /// A fake HTTP handler that returns an empty resource list for any GET (FilterResources) | ||
| /// and prevents real network calls during unit tests. | ||
| /// </summary> | ||
| private class FakeHttpHandler : HttpClientHandler | ||
| { | ||
| protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) | ||
| { | ||
| var response = new HttpResponseMessage(HttpStatusCode.OK) | ||
| { | ||
| Content = new StringContent("{\"value\":[]}") | ||
| }; | ||
| response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/json"); | ||
| return Task.FromResult(response); | ||
| } | ||
| } | ||
|
|
||
| private void SetupVaultManagementClient() | ||
| { | ||
| _capturedSdkParameters = null; | ||
|
|
||
| var mockVaultsOps = new Mock<IVaultsOperations>(); | ||
| mockVaultsOps | ||
| .Setup(v => v.CreateOrUpdateWithHttpMessagesAsync( | ||
| It.IsAny<string>(), | ||
| It.IsAny<string>(), | ||
| It.IsAny<VaultCreateOrUpdateParameters>(), | ||
| It.IsAny<Dictionary<string, List<string>>>(), | ||
| It.IsAny<CancellationToken>())) | ||
| .Callback<string, string, VaultCreateOrUpdateParameters, Dictionary<string, List<string>>, CancellationToken>( | ||
| (rg, name, parameters, headers, ct) => _capturedSdkParameters = parameters) | ||
| .Returns(Task.FromResult(new AzureOperationResponse<Vault> | ||
| { | ||
| Body = new Vault( | ||
| properties: new VaultProperties | ||
| { | ||
| TenantId = Guid.NewGuid(), | ||
| Sku = new KVSku(SkuName.Standard), | ||
| AccessPolicies = new AccessPolicyEntry[] { }, | ||
| VaultUri = "https://testvault.vault.azure.net" | ||
| }, | ||
| name: "testvault", | ||
| location: "eastus") | ||
| })); | ||
|
|
||
| var mockKvMgmtClient = new Mock<IKeyVaultManagementClient>(); | ||
| mockKvMgmtClient.Setup(c => c.Vaults).Returns(mockVaultsOps.Object); | ||
|
|
||
| _vaultManagementClient = new VaultManagementClient(); | ||
| typeof(VaultManagementClient) | ||
| .GetProperty("KeyVaultManagementClient", BindingFlags.NonPublic | BindingFlags.Instance) | ||
| .SetValue(_vaultManagementClient, mockKvMgmtClient.Object); | ||
| } | ||
|
|
||
| private ResourceManagementClient CreateFakeResourceClient() | ||
| { | ||
| var client = new ResourceManagementClient( | ||
| new Microsoft.Rest.TokenCredentials("fake-token"), | ||
| new FakeHttpHandler()); | ||
| client.SubscriptionId = "00000000-0000-0000-0000-000000000000"; | ||
| return client; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Exercises NewAzureKeyVault.ExecuteCmdlet() end-to-end and verifies that | ||
| /// the cmdlet hardcodes EnableSoftDelete=true in the outgoing request. | ||
| /// This test would FAIL if the assignment at NewAzureKeyVault.cs line 171 | ||
| /// were removed, because VaultManagementClient is a pure pass-through | ||
| /// (as proved by VaultManagementClient_Does_Not_Default_EnableSoftDelete). | ||
| /// </summary> | ||
| [Fact] | ||
| [Trait(Category.AcceptanceType, Category.CheckIn)] | ||
| public void ExecuteCmdlet_Sets_EnableSoftDelete_True_In_Request() | ||
| { | ||
| // Arrange | ||
| SetupVaultManagementClient(); | ||
|
|
||
| var cmdRuntimeMock = new Mock<ICommandRuntime>(); | ||
| cmdRuntimeMock.Setup(cr => cr.ShouldProcess(It.IsAny<string>(), It.IsAny<string>())).Returns(true); | ||
|
|
||
| var cmdlet = new NewAzureKeyVault | ||
| { | ||
| CommandRuntime = cmdRuntimeMock.Object, | ||
| Name = "test-vault", | ||
| ResourceGroupName = "test-rg", | ||
| Location = "eastus" | ||
| }; | ||
| cmdlet.KeyVaultManagementClient = _vaultManagementClient; | ||
| cmdlet.ResourceClient = CreateFakeResourceClient(); | ||
|
|
||
| // Act | ||
| cmdlet.ExecuteCmdlet(); | ||
|
|
||
| // Assert | ||
| Assert.NotNull(_capturedSdkParameters); | ||
| Assert.True(_capturedSdkParameters.Properties.EnableSoftDelete, | ||
| "NewAzureKeyVault.ExecuteCmdlet() must set EnableSoftDelete=true in the request body " + | ||
| "so that Azure Policy checks requiring the property to be present are satisfied."); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Proves VaultManagementClient.CreateNewVault is a pure pass-through: | ||
| /// it does NOT inject a default for EnableSoftDelete. | ||
| /// Combined with ExecuteCmdlet_Sets_EnableSoftDelete_True_In_Request, this proves | ||
| /// that only the cmdlet's hardcoded assignment provides the value. | ||
| /// If someone removes EnableSoftDelete=true from NewAzureKeyVault.cs, | ||
| /// the request would go out with EnableSoftDelete=null and Azure Policy would reject it. | ||
| /// </summary> | ||
| [Fact] | ||
| [Trait(Category.AcceptanceType, Category.CheckIn)] | ||
| public void VaultManagementClient_Does_Not_Default_EnableSoftDelete() | ||
| { | ||
| // Arrange | ||
| SetupVaultManagementClient(); | ||
|
|
||
| var createParameters = new VaultCreationOrUpdateParameters | ||
| { | ||
| Name = "testvault", | ||
| ResourceGroupName = "testrg", | ||
| Location = "eastus", | ||
| SkuFamilyName = "A", | ||
| SkuName = "Standard", | ||
| TenantId = Guid.NewGuid(), | ||
| EnableSoftDelete = null, // Deliberately not set | ||
| SoftDeleteRetentionInDays = 90, | ||
| NetworkAcls = new NetworkRuleSet() | ||
| }; | ||
|
|
||
| // Act | ||
| _vaultManagementClient.CreateNewVault(createParameters); | ||
|
|
||
| // Assert - null in means null out; client does NOT inject a default | ||
| Assert.NotNull(_capturedSdkParameters); | ||
| Assert.Null(_capturedSdkParameters.Properties.EnableSoftDelete); | ||
| } | ||
| } | ||
| } |
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.