Linux Integration Services Automation (LISA), version 2

Nov 2018

Overview

LISAv2 is the one-stop automation solution implemented by PowerShell scripts, Linux BASH scripts and Python scripts for verifying Linux image/kernel on below platforms:

• Microsoft Azure
• Microsoft Azure Stack
• Microsoft Hyper-V

LISAv2 includes below test suite categories:

• BVT tests
• Smoke tests
• Functional tests
• Performance tests
• Test suites developed by Open Source communities

Prerequisite

1. You must have a Windows Machine (Host) with PowerShell (v5.0 and above) as test driver. It should be Windows Server for localhost, or any Windows system including Windows 10 for remote host access case.

2. You must be connected to Internet.

3. You download 3rd party software in Tools folder. If you are using secure blob in Azure Storage Account or UNC path, you can add a tag https://myownsecretlocation.blob.core.windows.net/binarytools in the secret xml file.

• 7za.exe
• dos2unix.exe
• gawk
• jq
• plink.exe
• pscp.exe
• kvp_client32
• kvp_client64
• nc.exe

4. For running Azure tests, you must have a valid Windows Azure Subscription.

5. For running Hyper-V tests, the resource requirements are:

• Hyper-V role enabled
• At least 8 GB of memory on the Host - Most of lisav2 tests will create and start Virtual Machines (Guests) with 3.5 GB of memory assigned
• 1 External vSwitch in Hyper-V Manager/Virtual Switch Manager. This vSwitch will be named 'External' and must have an internet connection. For Hyper-V NETWORK tests you need 2 more vSwitch types created: Internal and Private. These 2 vSwitches will have the naming also 'Internal' and 'Private'.

6. For running WSL tests, you must enable WSL on the test server

   a. Open Powershell as Administrator and run:

   Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
   

   b. Restart your computer when prompted.

Download Latest Azure PowerShell

1. Download Web Platform Installer from here
2. Start Web Platform Installer and select Azure PowerShell (required 6.3.0 or above) and proceed for Azure PowerShell Installation.

Authenticate Your Test Driver Machine with Your Azure Subscription

Azure AD method

This creates a 12 Hours temporary session in PowerShell. In that session, you are allowed to run Windows Azure Cmdlets to control / use your subscription.

After 12 hours you will be asked to enter username and password of your subscription again.

Service Principal method

Refer to this URL here

Prepare VHD for Your Test

Applicable if you are uploading your own Linux VHD to Azure for test.

A VHD with Linux OS must be made compatible to work in Hyper-V environment. This includes:

• Linux Integration Services. If not available, at least KVP daemon must be running. Without KVP daemon running, the framework will not be able to obtain an IP address from the guest.
• Windows Azure Linux Agent (for testing in Azure environment only)
• SSH, and the SSH daemon configured to start on boot.
• Port 22 open in the firewall
• A regular user account on the guest OS

"root" user cannot be used in the test configuration

Please follow the steps mentioned at here

Launch Test Suite

1. Clone this automation code to your test driver by:

      git clone https://github.com/LIS/LISAv2.git
   

2. Use a secret file or update the .\XML\GlobalConfigurations.xml manually for preparatory work:

   2.1 Update below subscription info using created service principal, can use this script to create service principal If run test case in location eastasia, create a standard and premium storage account under the test subscription in eastasia, and replace storage account names in secrets file if run against other region, add new sections like

       <secrets>
           <!--Not mandatory-->
           <SubscriptionName></SubscriptionName>
           <!--Below four sections are mandatory when test against Azure platform-->
           <SubscriptionID></SubscriptionID>
           <SubscriptionServicePrincipalTenantID></SubscriptionServicePrincipalTenantID>
           <SubscriptionServicePrincipalClientID></SubscriptionServicePrincipalClientID>
           <SubscriptionServicePrincipalKey><SubscriptionServicePrincipalKey>
           <!--Download needed tools from the blob-->
           <blobStorageLocation> </blobStorageLocation>
           <!--VMs Credential-->
           <linuxTestUsername></linuxTestUsername>
           <linuxTestPassword></linuxTestPassword>
           <!--Database info for upload results-->
           <DatabaseServer></DatabaseServer>
           <DatabaseUser></DatabaseUser>
           <DatabasePassword></DatabasePassword>
           <DatabaseName></DatabaseName>
           <RegionAndStorageAccounts>
               <eastasia>
                   <StandardStorage>HERE</StandardStorage>
                   <PremiumStorage>HERE</PremiumStorage>
               </eastasia>
               <westus>
                   <StandardStorage>HERE</StandardStorage>
                   <PremiumStorage>HERE</PremiumStorage>
               </westus>
               <!--Other locations sections-->
           </RegionAndStorageAccounts>
       </secrets>

   2.2 Update the .\XML\GlobalConfigurations.xml file with your Azure subscription information or Hyper-V host information:

    Go to Global > Azure/HyperV and update following fields:
   
        a. SubscriptionID
        b. SubscriptionName (Optional)
        c. ManagementEndpoint
        d. Environment (For Azure PublicCloud, use `AzureCloud`)
        e. ARMStorageAccount
   
    Example:
   

       <Azure>
           <Subscription>
               <SubscriptionID>2cd20493-0000-1111-2222-0123456789ab</SubscriptionID>
               <SubscriptionName>YOUR_SUBSCRIPTION_NAME</SubscriptionName>
               <ManagementEndpoint>https://management.core.windows.net</ManagementEndpoint>
               <Environment>AzureCloud</Environment>
               <ARMStorageAccount>ExistingStorage_Standard</ARMStorageAccount>
           </Subscription>
       </Azure>
       <HyperV>
           <Hosts>
               <Host>
                   <!--ServerName can be localhost or Hyper-V host name-->
                   <ServerName>localhost</ServerName>
                   <DestinationOsVHDPath>VHDs_Destination_Path</DestinationOsVHDPath>
               </Host>
               <Host>
                   <!--If run test against 2 hosts, set ServerName as another host computer name-->
                   <ServerName>lis-01</ServerName>
                   <!--If run test against 2 hosts, DestinationOsVHDPath is mandatory-->
                   <DestinationOsVHDPath>D:\vhd</DestinationOsVHDPath>
               </Host>
           </Hosts>
       </HyperV>
       <WSL>
           <Hosts>
               <Host>
                   <!--The name of the WSL host, which can be local or remote -->
                   <ServerName>localhost</ServerName>
                   <!--The destination path to extract the distro package on the WSL host-->
                   <DestinationOsVHDPath></DestinationOsVHDPath>
               </Host>
               <Host>
                   <ServerName>localhost</ServerName>
                   <DestinationOsVHDPath></DestinationOsVHDPath>
               </Host>
           </Hosts>
       </WSL>

3. There are two ways to run LISAv2 tests:

   a. Provide all parameters to Run-LisaV2.ps1

    .\Run-LisaV2.ps1 -TestPlatform "Azure" -TestLocation "<Region location>" -RGIdentifier "<Identifier of the resource group>" [-ARMImageName "<publisher offer SKU version>" | -OsVHD "<VHD from storage account>" ] [[-TestCategory "<Test Catogry from Jenkins pipeline>" | -TestArea "<Test Area from Jenkins pipeline>"]* | -TestTag "<A Tag from Jenkins pipeline>" | -TestNames "<Test cases separated by comma>"]
    Example:
    .\Run-LisaV2.ps1 -TestPlatform "Azure" -TestLocation "westus" -RGIdentifier "deployment" -ARMImageName "canonical ubuntuserver 18.04-lts Latest" -TestNames "BVT-VERIFY-DEPLOYMENT-PROVISION"
    Using secret file
    .\Run-LisaV2.ps1 -TestPlatform "Azure" -TestLocation "westus" -RGIdentifier "deployment" -ARMImageName "canonical ubuntuserver 18.04-lts Latest" -TestNames "BVT-VERIFY-DEPLOYMENT-PROVISION" -XMLSecretFile "E:\AzureCredential.xml"
   
    .\Run-LisaV2.ps1 -TestPlatform "HyperV" [-TestLocation "ServerName"] -RGIdentifier "<Identifier of the vm group>" -OsVHD "<local or UNC path or downloadable URL of VHD>" [[-TestCategory "<Test Catogry from Jenkins pipeline>" | -TestArea "<Test Area from Jenkins pipeline>"]* | -TestTag "<A Tag from Jenkins pipeline>" | -TestNames "<Test cases separated by comma>"]
    Example:
    .\Run-LisaV2.ps1 -TestPlatform "HyperV" -RGIdentifier "ntp" -OsVHD 'E:\vhd\ubuntu_18_04.vhd' -TestNames "BVT-CORE-TIMESYNC-NTP"
    .\Run-LisaV2.ps1 -TestPlatform "HyperV" -RGIdentifier "ntp" -OsVHD 'http://www.somewebsite.com/vhds/ubuntu_18_04.vhd' -TestNames "BVT-CORE-TIMESYNC-NTP"
   
    .\Run-LisaV2.ps1 -TestPlatform "WSL" [-TestLocation "<WSL host name>"] -RGIdentifier "<Identifier for the test run>" -OsVHD "<local path or public URL>" [-DestinationOsVHDPath "<destination path on WSL host>"] [[-TestCategory "<Test Catogry from Jenkins pipeline>" | -TestArea "<Test Area from Jenkins pipeline>"]* | -TestTag "<A Tag from Jenkins pipeline>" | -TestNames "<Test cases separated by comma>"]
    Example:
    .\Run-LisaV2.ps1 -TestPlatform WSL -TestLocation "localhost" -RGIdentifier 'ubuntuwsl' -TestNames "BVT-VERIFY-BOOT-ERROR-WARNINGS" -OsVHD 'https://aka.ms/wsl-ubuntu-1804' -DestinationOsVHDPath "D:\test"
   

   b. Provide parameters in .\XML\TestParameters.xml.

    .\Run-LisaV2.ps1 -TestParameters .\XML\TestParameters.xml
   

   Note: Please refer .\XML\TestParameters.xml file for more details.

More Information

For more details, please refer to the documents here.

Contact: lisasupport@microsoft.com