Claude finished @potatoqualitee's task —— View job

Azure Test Pattern Investigation - Complete

Search for existing Azure-related tests in the codebase
Examine how Azure blob storage features are currently tested
Check test configuration for Azure credentials and setup
Identify environment checks and test skipping patterns
Report findings and recommendations

Findings

Current Azure Test Infrastructure

Test Configuration (private/testing/Get-TestConfig.ps1):

$TestConfig.azureblob = "https://dbatools.blob.core.windows.net/sql"
$TestConfig.azureblobaccount = "dbatools"
$TestConfig.azureserver = "psdbatools.database.windows.net"
$TestConfig.azuresqldblogin = "appveyor@clemairegmail.onmicrosoft.com"

Environment Variables (checked in tests):

$env:azurepasswd - SAS token for blob storage (SHARED ACCESS SIGNATURE)
$env:azurelegacypasswd - Storage account key for legacy credential authentication

Azure Test Pattern (from `Backup-DbaDatabase.Tests.ps1`)

The standard pattern used is:

if ($env:azurepasswd) {
    Context "Azure works" {
        BeforeAll {
            # Create SQL Server credential for SAS token
            $sql = "CREATE CREDENTIAL [$($TestConfig.azureblob)] WITH IDENTITY = N'SHARED ACCESS SIGNATURE', SECRET = N'$($env:azurepasswd)'"
            $server.Query($sql)
            
            # Create SQL Server credential for legacy storage account key
            $sql = "CREATE CREDENTIAL [dbatools_ci] WITH IDENTITY = N'$($TestConfig.azureblobaccount)', SECRET = N'$($env:azurelegacypasswd)'"
            $server.Query($sql)
        }

        AfterAll {
            # Cleanup credentials
            $server.Query("DROP CREDENTIAL [$TestConfig.azureblob]")
        }

        It "backs up to Azure properly using SHARED ACCESS SIGNATURE" {
            $results = Backup-DbaDatabase -SqlInstance $TestConfig.instance2 -AzureBaseUrl $TestConfig.azureblob -Database dbatoolsci_azure -BackupFileName dbatoolsci_azure.bak -WithFormat
            $results.DeviceType | Should -Be "URL"
        }

        It "backs up to Azure properly using legacy credential" {
            $results = Backup-DbaDatabase -SqlInstance $TestConfig.instance2 -AzureBaseUrl $TestConfig.azureblob -Database dbatoolsci_azure -BackupFileName dbatoolsci_azure2.bak -WithFormat -AzureCredential dbatools_ci
            $results.DeviceType | Should -Be "URL"
        }
    }
}

Key Points:

Tests are conditional - Only run when $env:azurepasswd exists
Two authentication methods tested:
- SAS token (modern, recommended) - credential name matches the blob URL
- Storage account key (legacy) - credential name is arbitrary (dbatools_ci)
Credentials are SQL Server credentials - Created on the SQL instance, not PowerShell credentials
Tests clean up - Credentials are dropped in AfterAll

Commands with Azure Support

Based on grep results, these commands have Azure blob storage integration:

✅ Backup-DbaDatabase - Has AzureBaseUrl and AzureCredential parameters (fully tested)
✅ Restore-DbaDatabase - Can restore from Azure blob URLs (tested)
✅ Copy-DbaDatabase - Supports Azure blob as backup location (tested)
✅ Read-DbaBackupHeader - Can read backup headers from Azure blobs
✅ Get-DbaBackupInformation - Can read backup info from Azure blobs

Log Shipping Status

Current Implementation:

Invoke-DbaDbLogShipping uses SharedPath parameter (expects UNC path like \\server\share)
Integration tests are SKIPPED (line 101: -Skip) with comment: "LogShipping need additional setup"
Test uses local paths: BackupNetworkPath = "C:\temp"

Azure Support:

❌ NOT currently supported - No Azure parameters exist
❌ No Azure test patterns for log shipping

Recommendations for Adding Azure Blob Support to Log Shipping

1. Environment is NOT fully configured

The CI environment has Azure blob storage credentials configured ($env:azurepasswd and $env:azurelegacypasswd), but:

We'd need to verify these work with the test instances
Log shipping tests are currently skipped entirely
May need additional setup for log shipping scenarios

2. Implementation Approach

For Invoke-DbaDbLogShipping, I recommend:

Add new parameters:

[string]$AzureBaseUrl,
[string]$AzureCredential,
[switch]$UseAzureBackup

Logic:

If AzureBaseUrl is specified:
- Validate it's a valid Azure blob URL
- Create backup job to backup directly to Azure (no local path needed)
- Skip/modify the copy job - not needed when backing up to cloud
- Modify restore job to restore from Azure blob URL
- Use AzureCredential parameter or default to credential matching the URL

Pattern validation should accept:

UNC paths: \\server\share
Azure blob URLs: https://storageaccount.blob.core.windows.net/container/

3. Test Strategy

When implementing Azure blob support for log shipping:

if ($env:azurepasswd) {
    Context "Log shipping to Azure blob storage" {
        BeforeAll {
            # Setup SQL credentials on both instances
            # Create test database
        }

        It "Should configure log shipping with Azure blob URL" {
            $splatLogShip = @{
                SourceSqlInstance      = $TestConfig.instance2
                DestinationSqlInstance = $TestConfig.instance3
                Database               = "dbatoolsci_logship_azure"
                AzureBaseUrl           = $TestConfig.azureblob
                GenerateFullBackup     = $true
            }
            $results = Invoke-DbaDbLogShipping @splatLogShip
            $results.Status | Should -Be "Success"
        }

        AfterAll {
            # Cleanup log shipping configuration
            # Drop SQL credentials
        }
    }
}

4. Files to Examine/Modify

For implementation, you'd need to update:

public/Invoke-DbaDbLogShipping.ps1 - Add Azure parameters
private/functions/New-DbaLogShippingPrimaryDatabase.ps1 - Support blob URLs
private/functions/New-DbaLogShippingSecondaryDatabase.ps1 - Support blob URLs
tests/Invoke-DbaDbLogShipping.Tests.ps1 - Add Azure test context

Summary

Is the CI environment set up for Azure testing?

✅ Partially - Blob storage credentials exist ($env:azurepasswd, $env:azurelegacypasswd)
✅ Test infrastructure has patterns for conditional Azure tests
❌ Log shipping tests are currently skipped entirely (not just Azure tests)
❌ Would need to enable/fix log shipping tests first before adding Azure support

Next Steps:

First, get basic log shipping tests working (currently skipped)
Then add Azure blob storage support following the patterns from Backup-DbaDatabase
Use the conditional if ($env:azurepasswd) pattern to skip Azure tests when credentials aren't available

Would you like me to start implementing the Azure blob storage support for log shipping?

Uh oh!

log shipping enhancements #5278

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions