Skip to content

SQL Ledger Cmdlets #14974

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

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions src/Sql/Sql.Test/ScenarioTests/Common.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,47 @@ function Create-BasicTestEnvironmentWithParams ($params, $location, $serverVersi
New-AzSqlDatabase -DatabaseName $params.databaseName -ResourceGroupName $params.rgname -ServerName $params.serverName -Edition Basic
}

<#
.SYNOPSIS
Gets the values of the parameters used for ledger digest upload tests
#>
function Get-LedgerTestEnvironmentParameters ($testSuffix)
{
return @{ subscriptionId = (Get-AzContext).Subscription.Id;
rgname = "ledger-cmdlet-test-rg" + $testSuffix;
serverName = "ledger-cmdlet-server" + $testSuffix;
databaseName = "ledger-cmdlet-db" + $testSuffix;
}
}

<#
.SYNOPSIS
Creates the basic test environment used for the ledger tests - creates resource group, server, and database
#>
function Create-LedgerTestEnvironment ($params)
{
$location = "eastus2euap"
$serverVersion = "12.0"
New-AzResourceGroup -Name $params.rgname -Location $location
$serverName = $params.serverName
$serverLogin = "testusername"
<#[SuppressMessage("Microsoft.Security", "CS002:SecretInNextLine", Justification="Test passwords only valid for the duration of the test")]#>
$serverPassword = "t357ingP@s5w0rd!ledger"
$credentials = new-object System.Management.Automation.PSCredential($serverLogin, ($serverPassword | ConvertTo-SecureString -asPlainText -Force))
New-AzSqlServer -ResourceGroupName $params.rgname -ServerName $params.serverName -Location $location -ServerVersion $serverVersion -SqlAdministratorCredentials $credentials
New-AzSqlDatabase -DatabaseName $params.databaseName -ResourceGroupName $params.rgname -ServerName $params.serverName -Edition Basic
}

<#
.SYNOPSIS
Removes the test environment that was needed to perform the ledger digest upload tests
#>
function Remove-LedgerTestEnvironment ($testSuffix)
{
$params = Get-LedgerTestEnvironmentParameters $testSuffix
Remove-AzResourceGroup -Name $params.rgname -Force
}

<#
.SYNOPSIS
Creates the basic test environment needed to perform the Sql data security tests - resource group, managed instance and managed database
Expand Down
7 changes: 7 additions & 0 deletions src/Sql/Sql.Test/ScenarioTests/DatabaseCrudTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -190,5 +190,12 @@ public void TestDatabaseGetWithBackupStorageRedundancy()
{
RunPowerShellTest("Test-GetDatabaseWithBackupStorageRedundancy");
}

[Fact]
[Trait(Category.AcceptanceType, Category.CheckIn)]
public void TestDatabaseCreateWithLedgerEnabled()
{
RunPowerShellTest("Test-DatabaseCreateWithLedgerEnabled");
}
}
}
23 changes: 23 additions & 0 deletions src/Sql/Sql.Test/ScenarioTests/DatabaseCrudTests.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -973,6 +973,29 @@ function Test-GetDatabaseWithMaintenanceConfigurationId
}
}

<#
.SYNOPSIS
Tests creating a database with ledger enabled
#>
function Test-DatabaseCreateWithLedgerEnabled ($location = "eastus2euap")
{
# Setup
$rg = Create-ResourceGroupForTest
$server = Create-ServerForTest $rg $location

# Create with ledger enabled
$databaseName = Get-DatabaseName
$db1 = New-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName -EnableLedger -Force
Assert-AreEqual $db1.DatabaseName $databaseName
Assert-AreEqual "True" $db1.EnableLedger

# Validate Get-AzSqlDatabase returns ledger property
$databaseFromGet = Get-AzSqlDatabase -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -DatabaseName $databaseName
Assert-AreEqual "True" $databaseFromGet.EnableLedger

Remove-ResourceGroupForTest $rg
}

<#
.SYNOPSIS
Tests Deleting a database
Expand Down
60 changes: 60 additions & 0 deletions src/Sql/Sql.Test/ScenarioTests/LedgerDigestUploadTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// ----------------------------------------------------------------------------------
//
// 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.ScenarioTest.SqlTests;
using Microsoft.Azure.ServiceManagement.Common.Models;
using Microsoft.WindowsAzure.Commands.ScenarioTest;
using Xunit;
using Xunit.Abstractions;

namespace Microsoft.Azure.Commands.Sql.Test.ScenarioTests
{
public class LedgerDigestUploadTests : SqlTestsBase
{
public LedgerDigestUploadTests(ITestOutputHelper output) : base(output)
{
base.resourceTypesToIgnoreApiVersion = new string[] {
"Microsoft.Sql/servers"
};
}

[Fact]
[Trait(Category.AcceptanceType, Category.CheckIn)]
public void TestGetDefaultLedgerDigestUpload()
{
RunPowerShellTest("Test-GetDefaultLedgerDigestUpload");
}

[Fact]
[Trait(Category.AcceptanceType, Category.CheckIn)]
public void TestSetLedgerDigestUploadByName()
{
RunPowerShellTest("Test-SetLedgerDigestUploadByName");
}

[Fact]
[Trait(Category.AcceptanceType, Category.CheckIn)]
public void TestSetLedgerDigestUploadByDatabaseObject()
{
RunPowerShellTest("Test-SetLedgerDigestUploadByDatabaseObject");
}

[Fact]
[Trait(Category.AcceptanceType, Category.CheckIn)]
public void TestSetLedgerDigestUploadByResourceId()
{
RunPowerShellTest("Test-SetLedgerDigestUploadByResourceId");
}
}
}
194 changes: 194 additions & 0 deletions src/Sql/Sql.Test/ScenarioTests/LedgerDigestUploadTests.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
# ----------------------------------------------------------------------------------
#
# 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.
# ----------------------------------------------------------------------------------

<#
.SYNOPSIS
Tests getting default ledger digest upload configuration
#>
function Test-GetDefaultLedgerDigestUpload
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the Get case, we don't have various parameter options:name, resourceID, etc.? Only for Set?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh it seems like we do but you test everything in one test?

{
# Setup
$testSuffix = getAssetName
$params = Get-LedgerTestEnvironmentParameters $testSuffix
Create-LedgerTestEnvironment $params

$databaseResourceId = "/subscriptions/" + $params.subscriptionId + "/resourceGroups/" + $params.rgname + "/providers/Microsoft.Sql/servers/" + $params.serverName + "/databases/" + $params.databaseName
$databaseObject = Get-AzSqlDatabase -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName

try
{
# Test
$ledgerDigestUpload = Get-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName

# Assert
Assert-AreEqual $ledgerDigestUpload.State "Disabled"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we only test Get for Disabled? Are the other scenarios tested as part of the Set tests?


# Test
$ledgerDigestUploadByResourceId = Get-AzSqlDatabaseLedgerDigestUpload -ResourceId $databaseResourceId

# Assert
Assert-AreEqual $ledgerDigestUploadByResourceId.State "Disabled"

# Test
$ledgerDigestUploadByDatabase = Get-AzSqlDatabaseLedgerDigestUpload -InputObject $databaseObject

# Assert
Assert-AreEqual $ledgerDigestUploadByDatabase.State "Disabled"
}
finally
{
# Cleanup
Remove-LedgerTestEnvironment $testSuffix
}
}

<#
.SYNOPSIS
Tests enabling and disabling ledger digest uploading using named parameters
#>
function Test-SetLedgerDigestUploadByName
{
# Setup
$testSuffix = getAssetName
$params = Get-LedgerTestEnvironmentParameters $testSuffix
Create-LedgerTestEnvironment $params
$endpoint = "https://test.confidential-ledger.azure.com"

try
{
# Test enabling
$ledgerDigestUploadEnable = Enable-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName -Endpoint $endpoint

# Assert
Assert-AreEqual $ledgerDigestUploadEnable.State "Enabled"
Assert-AreEqual $ledgerDigestUploadEnable.Endpoint $endpoint

# Test get enabled settings
$ledgerDigestUploadEnabledGet = Get-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName

# Assert
Assert-AreEqual $ledgerDigestUploadEnabledGet.State "Enabled"

# Test disabling
$ledgerDigestUploadDisable = Disable-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName

# Assert
Assert-AreEqual $ledgerDigestUploadDisable.State "Disabled"

# Test get disabled settings
$ledgerDigestUploadDisabledGet = Get-AzSqlDatabaseLedgerDigestUpload -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName

# Assert
Assert-AreEqual $ledgerDigestUploadDisabledGet.State "Disabled"
}
finally
{
# Cleanup
Remove-LedgerTestEnvironment $testSuffix
}
}

<#
.SYNOPSIS
Tests enabling and disabling ledger digest uploading using the database object
#>
function Test-SetLedgerDigestUploadByDatabaseObject
{
# Setup
$testSuffix = getAssetName
$params = Get-LedgerTestEnvironmentParameters $testSuffix
Create-LedgerTestEnvironment $params
$endpoint = "https://test.confidential-ledger.azure.com"
$databaseObject = Get-AzSqlDatabase -ResourceGroupName $params.rgname -ServerName $params.serverName -DatabaseName $params.databaseName

try
{
# Test enabling
$ledgerDigestUploadEnable = Enable-AzSqlDatabaseLedgerDigestUpload -InputObject $databaseObject -Endpoint $endpoint

# Assert
Assert-AreEqual $ledgerDigestUploadEnable.State "Enabled"
Assert-AreEqual $ledgerDigestUploadEnable.Endpoint $endpoint

# Test get enabled settings
$ledgerDigestUploadEnabledGet = Get-AzSqlDatabaseLedgerDigestUpload -InputObject $databaseObject

# Assert
Assert-AreEqual $ledgerDigestUploadEnabledGet.State "Enabled"

# Test disabling
$ledgerDigestUploadDisable = Disable-AzSqlDatabaseLedgerDigestUpload -InputObject $databaseObject

# Assert
Assert-AreEqual $ledgerDigestUploadDisable.State "Disabled"

# Test get disabled settings
$ledgerDigestUploadDisabledGet = Get-AzSqlDatabaseLedgerDigestUpload -InputObject $databaseObject

# Assert
Assert-AreEqual $ledgerDigestUploadDisabledGet.State "Disabled"
}
finally
{
# Cleanup
Remove-LedgerTestEnvironment $testSuffix
}
}

<#
.SYNOPSIS
Tests enabling and disabling ledger digest uploading using the resource ID
#>
function Test-SetLedgerDigestUploadByResourceId
{
# Setup
$testSuffix = getAssetName
$params = Get-LedgerTestEnvironmentParameters $testSuffix
Create-LedgerTestEnvironment $params
$endpoint = "https://test.confidential-ledger.azure.com"
$databaseResourceId = "/subscriptions/" + $params.subscriptionId + "/resourceGroups/" + $params.rgname + "/providers/Microsoft.Sql/servers/" + $params.serverName + "/databases/" + $params.databaseName

try
{
# Test enabling
$ledgerDigestUploadEnable = Enable-AzSqlDatabaseLedgerDigestUpload -ResourceId $databaseResourceId -Endpoint $endpoint

# Assert
Assert-AreEqual $ledgerDigestUploadEnable.State "Enabled"
Assert-AreEqual $ledgerDigestUploadEnable.Endpoint $endpoint

# Test get enabled settings
$ledgerDigestUploadEnabledGet = Get-AzSqlDatabaseLedgerDigestUpload -ResourceId $databaseResourceId

# Assert
Assert-AreEqual $ledgerDigestUploadEnabledGet.State "Enabled"

# Test disabling
$ledgerDigestUploadDisable = Disable-AzSqlDatabaseLedgerDigestUpload -ResourceId $databaseResourceId

# Assert
Assert-AreEqual $ledgerDigestUploadDisable.State "Disabled"

# Test get disabled settings
$ledgerDigestUploadDisabledGet = Get-AzSqlDatabaseLedgerDigestUpload -ResourceId $databaseResourceId

# Assert
Assert-AreEqual $ledgerDigestUploadDisabledGet.State "Disabled"
}
finally
{
# Cleanup
Remove-LedgerTestEnvironment $testSuffix
}
}
Loading