Expanding e2e tests on Windows self-hosted runners via CI
an invention by iguimaraes
Updated over 2 years ago. 2 hacker ♥️. 3 followers.

Achievements:

  • Documented all necessary steps to setup the testing environment on Windows 11
  • Created a GitHub workflow that successfully executes the following tasks:
  • cleanup test environment from the previous run, removing files and WSL distributions from the previous run
  • checkout latest version of the target repository's main branch
  • install all project dependencies
  • run the automated e2e test suites
  • upload the test artifacts in case of failure for debugging
  • All e2e test suites - 147 tests in total - passed in the last 2 runs of the created workflow

Link to Pull Request: https://github.com/rancher-sandbox/rancher-desktop/pull/3871/files

Findings:

  • WSL and kernel must be used in their in-box version, not downloaded from Microsoft Store, as the latter is installed as an appx, and as running GitHub actions as a service is not logged in full to a graphical session, making WSL doesn't work as expected
  • Github runner must log in the service as the local user's account instead of other users from the domain "nt authority"

Project Description

Rancher Desktop is an electron-based application relying on nested virtualization to run Kubernetes and Container Management resources locally on the desktop. It is supported on the 3 major platforms: Linux, MacOS and Windows. Regarding the Quality Assurance stage of the Software Development Lifecycle, there are technical challenges when it comes to running e2e tests on Windows via CI, as these tests are executed in a Windows Subsystem for Linux - WSL - distribution, which requires the CI to spin up a virtual Linux machine. Many workarounds were attempted to make it possible to expand the Quality Matrix to all three platforms, as Linux and MacOS are already supported. The goal of this project is to expand Rancher Desktop's e2e test automation via GitHub Actions in self-hosted Windows runners.

Goals for Hack Week 2022

  • To have a workflow successfully running e2e test suites in self-hosted Windows runners via GitHub Actions - ACHIEVED
  • Logging and monitoring workflow runs - ACHIEVED

Resources

Ideal project mates: Experience in running GitHub Actions on Windows, Experience with WSL

Project Repository: https://github.com/rancher-sandbox/rancher-desktop https://rancherdesktop.io/

Looking for hackers with the skills:

wsl vm virtualization ci ci/cd github-ci github windows github_actions rancher_desktop self-hosted_runner

This project is part of:

Hack Week 22

Activity

  • over 2 years ago: mook_work joined this project.
  • over 2 years ago: iguimaraes started this project.
  • over 2 years ago: okurz liked this project.
  • almost 3 years ago: paulgonin liked this project.
  • almost 3 years ago: iguimaraes added keyword "wsl" to this project.
  • almost 3 years ago: iguimaraes added keyword "vm" to this project.
  • almost 3 years ago: iguimaraes added keyword "virtualization" to this project.
  • almost 3 years ago: iguimaraes added keyword "ci" to this project.
  • almost 3 years ago: iguimaraes added keyword "ci/cd" to this project.
  • almost 3 years ago: iguimaraes added keyword "github-ci" to this project.
  • almost 3 years ago: iguimaraes added keyword "github" to this project.
  • almost 3 years ago: iguimaraes added keyword "windows" to this project.
  • almost 3 years ago: iguimaraes added keyword "github_actions" to this project.
  • almost 3 years ago: iguimaraes added keyword "rancher_desktop" to this project.
  • almost 3 years ago: iguimaraes added keyword "self-hosted_runner" to this project.
  • almost 3 years ago: iguimaraes originated this project.


    • Comments

    Be the first to comment!

    Similar Projects

    Extracting, converting and importing VMs from Nutanix into SUSE Virtualization by emendonca

    Description

    The idea is to delve into understanding Nutanix AHV internals on how it stores and runs VMs, and how to extract them in an automated way for importing into a KVM-compatible hypervisor, like SUSE Virtualization/Harvester. The final product will be not only be documentation, but a working prototype that can be used to automate the process.

    Goals

    1) document how to create a simple lab with NutaniX AHV community edition 2) determine the basic elements we need to interact with 3) determine what are the best paths to grab the images through, balancing speed and complexity 4) document possible issues and create a roadmap for tackling them 4) should we adapt an existing solution or implement a new one? 5) implement the solution!

    Resources

    Similar project I created: https://github.com/doccaz/vm-import-ui Nutanix AHV forums Nutanix technical bulletins

    SUSE KVM Best Practices by roseswe

    Description

    SUSE Best Practices around KVM, especially for SAP workloads. Early Google presentation already made from various customer projects and SUSE sources.

    Goals

    Complete presentation we can reuse in SUSE Consulting projects

    Resources

    KVM (virt-manager) images

    SUSE/SAP/KVM Best Practices

    • https://documentation.suse.com/en-us/sles/15-SP6/single-html/SLES-virtualization/
    • SAP Note 1522993 - "Linux: SAP on SUSE KVM - Kernel-based Virtual Machine" && 2284516 - SAP HANA virtualized on SUSE Linux Enterprise hypervisors https://me.sap.com/notes/2284516
    • SUSECon24: [TUTORIAL-1253] Virtualizing SAP workloads with SUSE KVM || https://youtu.be/PTkpRVpX2PM
    • SUSE Best Practices for SAP HANA on KVM - https://documentation.suse.com/sbp/sap-15/html/SBP-SLES4SAP-HANAonKVM-SLES15SP4/index.html

    Q2Boot - A handy QEMU VM launcher by amanzini

    Description

    Q2Boot (Qemu Quick Boot) is a command-line tool that wraps QEMU to provide a streamlined experience for launching virtual machines. It automatically configures common settings like KVM acceleration, virtio drivers, and networking while allowing customization through both configuration files and command-line options.

    The project originally was a personal utility in D, now recently rewritten in idiomatic Go. It lives at repository https://github.com/ilmanzo/q2boot

    Goals

    Improve the project, testing with different scenarios , address issues and propose new features. It will benefit of some basic integration testing by providing small sample disk images.

    Resources