Refactor all deployments to use the MSI package.

.github/workflows/dependency-review.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation
+# SPDX-License-Identifier: MIT
+
 # Dependency Review Action
 #
 # This Action will scan dependency manifest files that change as part of a Pull Request,

.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation
+# SPDX-License-Identifier: MIT
+
 repos:
 - repo: https://github.com/gitleaks/gitleaks
   rev: v8.16.3

docs/InstallEbpf.md

@@ -112,11 +112,11 @@ has already built the binaries for `x64/Debug` or `x64/Release`.
 
 ### Method 3 (Install files you built yourself, with a VM checkpoint)
 
-This method uses a machine that
-has already built the binaries for `x64/Debug` or `x64/Release`.
+This method uses a machine that has already built the binaries for
+ the desired build configuration, i.e., `\x64\[Debug|Release|NativeOnlyDebug|NativeOnlyRelease]`.
 
-Copy the build output in `\x64\[Debug|Release]` to the host of the test VM and run the following in a Powershell
-command prompt:
+Copy the build output in `\x64\[Debug|Release|NativeOnlyDebug|NativeOnlyRelease]` to the host of the test VM and run the following in a Powershell
+ command prompt:
 
 1. Create a snapshot of the test VM named **baseline**, by running:
 
@@ -134,32 +134,37 @@ command prompt:
    New-StoredCredential -Target TEST_VM -Username <VM Administrator> -Password <VM Administrator account password> -Persist LocalMachine
    ```
 
-   > Note that "`TEST_VM`" is literal and is used in step 5 below; it need not be the name of any actual test VM.
-1. Enter the `\x64\[Debug|Release]` directory (`cd`) where the build artifacts are stored.
-1. Modify `.\vm_list.json` to specify the name of the test VM under `VMList`, eg:
+   > Note that "`TEST_VM`" is literal and is later used to look up the actual VM name; it need not be the name of any actual test VM.
+1. Enter the desired directory (`cd`) where the build artifacts are stored (i.e., `\x64\[Debug|Release|NativeOnlyDebug|NativeOnlyRelease]`).
+1. Modify `test_execution.json` to specify the name of the test VM under the `VMMap` attribute, e.g.:
 
     ```json
     {
         ...
 
-        "VMList":
-        [
-            {
-                "Name": "<test-vm-name>"
-            }
-        ]
+        "VMMap":
+        {
+            "MY_VM_RUNNERS":
+            [
+                {
+                    "Name": "<test-vm-name>"
+                }
+            ],
+            ...
+        }
+        ...
     }
     ```
 
 1. Run the following commands to setup to use the credentials saved with `TEST_VM` in step 2,
- for logging into each of the VMs named in `vm_list.json`:
+ for logging into each of the VMs named in `test_execution.json`:
 
     ```ps
     Set-ExecutionPolicy unrestricted -Force
     ```
 
     ```ps
-    .\setup_ebpf_cicd_tests.ps1
+    .\setup_ebpf_cicd_tests.ps1 -SelfHostedRunnerName MY_VM_RUNNERS
     ```
 
 ## Installing eBPF with host-process container

scripts/check_msi_installation.ps1

@@ -75,10 +75,9 @@ function Install-MsiPackage {
 
     $res = $true
 
-    $arguments = "/i $MsiPath /qn /norestart /log msi-install.log $MsiAdditionalArguments"
+    $arguments = "/i $MsiPath /qn /norestart /l*v msi-install.log $MsiAdditionalArguments"
     Write-Host "Installing MSI package with arguments: '$arguments'..."
     $process = Start-Process -FilePath msiexec.exe -ArgumentList $arguments -Wait -PassThru
-
     if ($process.ExitCode -eq 0) {
         Write-Host "Installation successful!"
     } else {
@@ -105,7 +104,7 @@ function Uninstall-MsiPackage {
 
     Write-Host "Uninstalling MSI package..."
     $res = $true
-    $process = Start-Process -FilePath msiexec.exe -ArgumentList "/x $MsiPath /qn /norestart /log msi-uninstall.log" -Wait -PassThru
+    $process = Start-Process -FilePath msiexec.exe -ArgumentList "/x $MsiPath /qn /norestart /l*v msi-uninstall.log" -Wait -PassThru
     if ($process.ExitCode -eq 0) {
         Write-Host "Uninstallation successful!"
     } else {

scripts/cleanup_ebpf_cicd_tests.ps1

@@ -15,11 +15,19 @@ $TestVMCredential = Get-StoredCredential -Target $Target -ErrorAction Stop
 # Load other utility modules.
 Import-Module .\common.psm1 -Force -ArgumentList ($LogFileName) -WarningAction SilentlyContinue
 Import-Module .\config_test_vm.psm1 -Force -ArgumentList ($TestVMCredential.UserName, $TestVMCredential.Password, $WorkingDirectory, $LogFileName) -WarningAction SilentlyContinue
+Import-Module .\install_ebpf.psm1 -ArgumentList ($WorkingDirectory, $LogFileName) -Force -WarningAction SilentlyContinue
 
 # Read the test execution json.
 $TestExecutionConfig = Get-Content ("{0}\{1}" -f $PSScriptRoot, $TestExecutionJsonFileName) | ConvertFrom-Json
 $VMList = $TestExecutionConfig.VMMap.$SelfHostedRunnerName
 
+# Uninstall eBPF Components on the test VM.
+foreach($VM in $VMList) {
+       $VMName = $VM.Name
+       Write-Host "Uninstalling eBPF components on VM $VMName..."
+       Uninstall-eBPFComponentsOnVM -VMName $VMname -ErrorAction Stop
+}
+
 # Import logs from VMs.
 Import-ResultsFromVM -VMList $VMList -KmTracing $KmTracing
 

scripts/config_test_vm.psm1

@@ -179,6 +179,7 @@ function Export-BuildArtifactsToVMs
     &tar @("cfz", "$tempFileName", "*")
     Write-Log "Created $tempFileName containing files in $pwd"
 
+    # Copy artifacts to the given VM list.
     foreach($VM in $VMList) {
         $VMName = $VM.Name
         $TestCredential = New-Credential -Username $Admin -AdminPassword $AdminPassword
@@ -210,6 +211,52 @@ function Export-BuildArtifactsToVMs
     Remove-Item -Force $tempFileName
 }
 
+#
+# Install eBPF components on VM.
+#
+
+function Install-eBPFComponentsOnVM
+{
+    param([parameter(Mandatory=$true)][string] $VMName,
+          [parameter(Mandatory=$true)][bool] $KmTracing,
+          [parameter(Mandatory=$true)][string] $KmTraceType)
+
+    Write-Log "Installing eBPF components on $VMName"
+    $TestCredential = New-Credential -Username $Admin -AdminPassword $AdminPassword
+
+    Invoke-Command -VMName $VMName -Credential $TestCredential -ScriptBlock {
+        param([Parameter(Mandatory=$True)] [string] $WorkingDirectory,
+              [Parameter(Mandatory=$True)] [string] $LogFileName,
+              [Parameter(Mandatory=$true)] [bool] $KmTracing,
+              [Parameter(Mandatory=$true)] [string] $KmTraceType)
+        $WorkingDirectory = "$env:SystemDrive\$WorkingDirectory"
+        Import-Module $WorkingDirectory\common.psm1 -ArgumentList ($LogFileName) -Force -WarningAction SilentlyContinue
+        Import-Module $WorkingDirectory\install_ebpf.psm1 -ArgumentList ($WorkingDirectory, $LogFileName) -Force -WarningAction SilentlyContinue
+
+        Install-eBPFComponents -KmTracing $KmTracing -KmTraceType $KmTraceType -KMDFVerifier $true -ErrorAction Stop
+    } -ArgumentList ("eBPF", $LogFileName, $KmTracing, $KmTraceType) -ErrorAction Stop
+    Write-Log "eBPF components installed on $VMName" -ForegroundColor Green
+}
+
+function Uninstall-eBPFComponentsOnVM
+{
+    param([parameter(Mandatory=$true)][string] $VMName)
+
+    Write-Log "Unnstalling eBPF components on $VMName"
+    $TestCredential = New-Credential -Username $Admin -AdminPassword $AdminPassword
+
+    Invoke-Command -VMName $VMName -Credential $TestCredential -ScriptBlock {
+        param([Parameter(Mandatory=$True)] [string] $WorkingDirectory,
+              [Parameter(Mandatory=$True)] [string] $LogFileName)
+        $WorkingDirectory = "$env:SystemDrive\$WorkingDirectory"
+        Import-Module $WorkingDirectory\common.psm1 -ArgumentList ($LogFileName) -Force -WarningAction SilentlyContinue
+        Import-Module $WorkingDirectory\install_ebpf.psm1 -ArgumentList ($WorkingDirectory, $LogFileName) -Force -WarningAction SilentlyContinue
+
+        Uninstall-eBPFComponents
+    } -ArgumentList ("eBPF", $LogFileName) -ErrorAction Stop
+    Write-Log "eBPF components uninstalled on $VMName" -ForegroundColor Green
+}
+
 #
 # Import test logs from VM.
 #
@@ -256,7 +303,6 @@ function Import-ResultsFromVM
         if (!(Test-Path ".\TestLogs\$VMName\Logs")) {
             New-Item -ItemType Directory -Path ".\TestLogs\$VMName\Logs"
         }
-
         $VMTemp = Invoke-Command -Session $VMSession -ScriptBlock {return $Env:TEMP}
         Write-Log ("Copy $LogFileName from $VMTemp on $VMName to $pwd\TestLogs")
         Copy-Item -FromSession $VMSession "$VMTemp\$LogFileName" -Destination ".\TestLogs\$VMName\Logs" -Recurse -Force -ErrorAction Ignore 2>&1 | Write-Log
@@ -327,30 +373,9 @@ function Import-ResultsFromVM
     Move-Item "$env:TEMP\$LogFileName" -Destination ".\TestLogs" -Force -ErrorAction Ignore 2>&1 | Write-Log
 }
 
-function Install-eBPFComponentsOnVM
-{
-    param([parameter(Mandatory=$true)][string] $VMName,
-          [parameter(Mandatory=$true)][bool] $KmTracing,
-          [parameter(Mandatory=$true)][string] $KmTraceType)
-
-    Write-Log "Installing eBPF components on $VMName"
-    $TestCredential = New-Credential -Username $Admin -AdminPassword $AdminPassword
-
-    Invoke-Command -VMName $VMName -Credential $TestCredential -ScriptBlock {
-        param([Parameter(Mandatory=$True)] [string] $WorkingDirectory,
-              [Parameter(Mandatory=$True)] [string] $LogFileName,
-              [Parameter(Mandatory=$true)] [bool] $KmTracing,
-              [Parameter(Mandatory=$true)] [string] $KmTraceType)
-        $WorkingDirectory = "$env:SystemDrive\$WorkingDirectory"
-        Import-Module $WorkingDirectory\common.psm1 -ArgumentList ($LogFileName) -Force -WarningAction SilentlyContinue
-        Import-Module $WorkingDirectory\install_ebpf.psm1 -ArgumentList ($WorkingDirectory, $LogFileName) -Force -WarningAction SilentlyContinue
-
-        Install-eBPFComponents -KmTracing $KmTracing -KmTraceType $KmTraceType -KMDFVerifier $true
-        Enable-KMDFVerifier
-    } -ArgumentList ("eBPF", $LogFileName, $KmTracing, $KmTraceType) -ErrorAction Stop
-    Write-Log "eBPF components installed on $VMName" -ForegroundColor Green
-}
-
+#
+# Configure network adapters on VMs.
+#
 function Initialize-NetworkInterfacesOnVMs
 {
     param([parameter(Mandatory=$true)] $VMMap)
@@ -426,3 +451,14 @@ function Get-Duonic {
     Move-Item -Path "$DownloadPath\corenet-ci-main\vm-setup\notmyfault64.exe" -Destination $pwd -Force
     Remove-Item -Path $DownloadPath -Force -Recurse
 }
+
+# Download the Visual C++ Redistributable.
+function Get-VCRedistributable {
+    $url = "https://aka.ms/vs/16/release/vc_redist.x64.exe"
+    $DownloadPath = "$pwd\vc-redist"
+    mkdir $DownloadPath
+    Write-Host "Downloading Visual C++ Redistributable from $url to $DownloadPath"
+    Invoke-WebRequest -Uri $url -OutFile "$DownloadPath\vc_redist.x64.exe"
+    Move-Item -Path "$DownloadPath\vc_redist.x64.exe" -Destination $pwd -Force
+    Remove-Item -Path $DownloadPath -Force -Recurse
+}

scripts/execute_ebpf_cicd_tests.ps1

@@ -20,8 +20,8 @@ $AdminTestVMCredential = Get-StoredCredential -Target $AdminTarget -ErrorAction
 $StandardUserTestVMCredential = Get-StoredCredential -Target $StandardUserTarget -ErrorAction Stop
 
 # Load other utility modules.
-Import-Module .\common.psm1 -Force -ArgumentList ($LogFileName) -WarningAction SilentlyContinue
-Import-Module .\vm_run_tests.psm1  `
+Import-Module $PSScriptRoot\common.psm1 -Force -ArgumentList ($LogFileName) -WarningAction SilentlyContinue
+Import-Module $PSScriptRoot\vm_run_tests.psm1 `
     -Force `
     -ArgumentList (
         $AdminTestVMCredential.UserName,