add support for installing QEMU (#565)

jenkinsci · Oct 15, 2024 · 09fa01e · 09fa01e
1 parent 655c495
commit 09fa01e
Show file tree

Hide file tree

Showing 18 changed files with 86 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -152,6 +152,7 @@ def myCloud = new AzureVMCloudBuilder()
         .withInstallGit(true)
         .withInstallMaven(true)
         .withInstallDocker(true)
+        .withInstallQemu(true)
     .endBuiltInImage()
     .withAdminCredential("<your admin credential ID>")
 .endTemplate()

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java
@@ -306,6 +306,8 @@ public int hashCode() {
 
     private boolean installDocker;
 
+    private boolean installQemu;
+
     private boolean trustedLaunch;
 
     private final String osType;
@@ -386,6 +388,7 @@ public int hashCode() {
     private transient boolean isInstallDocker;
     private transient boolean isInstallMaven;
     private transient boolean isInstallGit;
+    private transient boolean isInstallQemu;
 
     private transient String image;
     private transient String imageId;
@@ -760,6 +763,12 @@ public static String getBasicInitScript(AzureVMAgentTemplate template) {
                         AzureVMManagementServiceDelegate.PRE_INSTALLED_TOOLS_SCRIPT
                                 .get(builtInImage).get(Constants.INSTALL_MAVEN));
             }
+            if (template.isInstallQemu()) {
+                stringBuilder.append(getSeparator(template.getOsType()));
+                stringBuilder.append(
+                        AzureVMManagementServiceDelegate.PRE_INSTALLED_TOOLS_SCRIPT
+                                .get(builtInImage).get(Constants.INSTALL_QEMU));
+            }
             if (template.isInstallGit()) {
                 stringBuilder.append(getSeparator(template.getOsType()));
                 stringBuilder.append(
@@ -864,6 +873,10 @@ private Object readResolve() {
             installMaven = true;
         }
 
+        if (isInstallQemu) {
+            installQemu = true;
+        }
+
         if (imageReference == null) {
             imageReference = new ImageReferenceTypeClass();
         }
@@ -1083,6 +1096,11 @@ public void setInstallMaven(boolean installMaven) {
         this.installMaven = installMaven;
     }
 
+    @DataBoundSetter
+    public void setInstallQemu(boolean installQemu) {
+        this.installQemu = installQemu;
+    }
+
     @DataBoundSetter
     public void setInstallDocker(boolean installDocker) {
         this.installDocker = installDocker;
@@ -1100,6 +1118,10 @@ public boolean isInstallDocker() {
         return installDocker;
     }
 
+    public boolean isInstallQemu() {
+        return installQemu;
+    }
+
     public String getOsType() {
         return osType;
     }
@@ -1347,6 +1369,7 @@ public BuiltInImage getBuiltInImageInside() {
                 .withInstallGit(isInstallGit())
                 .withInstallDocker(isInstallDocker())
                 .withInstallMaven(isInstallMaven())
+                .withInstallQemu(isInstallQemu())
                 .build();
     }
 

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMManagementServiceDelegate.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMManagementServiceDelegate.java
@@ -167,6 +167,8 @@ public final class AzureVMManagementServiceDelegate {
 
     private static final String INSTALL_MAVEN_WINDOWS_FILENAME = "windowsInstallMavenScript.ps1";
 
+    private static final String INSTALL_QEMU_WINDOWS_FILENAME = "windowsInstallQemuScript.ps1";
+
     private static final String INSTALL_GIT_UBUNTU_FILENAME = "ubuntuInstallGitScript.sh";
 
     private static final String INSTALL_JAVA_UBUNTU_FILENAME = "ubuntuInstallJavaScript.sh";
@@ -175,6 +177,8 @@ public final class AzureVMManagementServiceDelegate {
 
     private static final String INSTALL_DOCKER_UBUNTU_FILENAME = "ubuntuInstallDockerScript.sh";
 
+    private static final String INSTALL_QEMU_UBUNTU_FILENAME = "ubuntuInstallQemuScript.sh";
+
     private static final String PRE_INSTALL_SSH_FILENAME = "sshInit.ps1";
 
     private final AzureResourceManager azureClient;
@@ -1626,6 +1630,9 @@ private static void ubuntu(String imageName, Map<String, Map<String, String>> to
         tools.get(imageName).put(
                 Constants.INSTALL_MAVEN,
                 loadScript(INSTALL_MAVEN_UBUNTU_FILENAME));
+        tools.get(imageName).put(
+                Constants.INSTALL_QEMU,
+                loadScript(INSTALL_QEMU_UBUNTU_FILENAME));
         tools.get(imageName).put(
                 Constants.INSTALL_GIT,
                 loadScript(INSTALL_GIT_UBUNTU_FILENAME));
@@ -1641,6 +1648,9 @@ private static void windows(String imageName, Map<String, Map<String, String>> t
         tools.get(imageName).put(
                 Constants.INSTALL_MAVEN,
                 loadScript(INSTALL_MAVEN_WINDOWS_FILENAME));
+        tools.get(imageName).put(
+                Constants.INSTALL_QEMU,
+                loadScript(INSTALL_QEMU_WINDOWS_FILENAME));                
         tools.get(imageName).put(
                 Constants.INSTALL_GIT,
                 loadScript(INSTALL_GIT_WINDOWS_FILENAME));

diff --git a/src/main/java/com/microsoft/azure/vmagent/builders/AzureVMTemplateBuilder.java b/src/main/java/com/microsoft/azure/vmagent/builders/AzureVMTemplateBuilder.java
@@ -142,6 +142,7 @@ public AzureVMAgentTemplate build() {
         azureVMAgentTemplate.setInstallGit(fluent.getBuiltInImage().isInstallGit());
         azureVMAgentTemplate.setInstallMaven(fluent.getBuiltInImage().isInstallMaven());
         azureVMAgentTemplate.setInstallDocker(fluent.getBuiltInImage().isInstallDocker());
+        azureVMAgentTemplate.setInstallQemu(fluent.getBuiltInImage().isInstallQemu());
         azureVMAgentTemplate.setUsePrivateIP(fluent.getAdvancedImage().isUsePrivateIP());
         azureVMAgentTemplate.setEnableMSI(fluent.getAdvancedImage().isEnableMSI());
         azureVMAgentTemplate.setEnableUAMI(fluent.getAdvancedImage().isEnableUAMI());

diff --git a/src/main/java/com/microsoft/azure/vmagent/builders/BuiltInImage.java b/src/main/java/com/microsoft/azure/vmagent/builders/BuiltInImage.java
@@ -10,14 +10,18 @@ public class BuiltInImage {
 
     private boolean isInstallDocker;
 
+    private boolean isInstallQemu;
+
     public BuiltInImage(String builtInImage,
                         boolean isInstallGit,
                         boolean isInstallMaven,
-                        boolean isInstallDocker) {
+                        boolean isInstallDocker,
+                        boolean isInstallQemu) {
         this.builtInImage = builtInImage;
         this.isInstallGit = isInstallGit;
         this.isInstallMaven = isInstallMaven;
         this.isInstallDocker = isInstallDocker;
+        this.isInstallQemu = isInstallQemu;
     }
 
     public String getBuiltInImage() {
@@ -35,4 +39,8 @@ public boolean isInstallMaven() {
     public boolean isInstallDocker() {
         return isInstallDocker;
     }
+
+    public boolean isInstallQemu() {
+        return isInstallQemu;
+    }
 }
diff --git a/src/main/java/com/microsoft/azure/vmagent/builders/BuiltInImageBuilder.java b/src/main/java/com/microsoft/azure/vmagent/builders/BuiltInImageBuilder.java
@@ -15,6 +15,7 @@ public BuiltInImageBuilder(BuiltInImage image) {
         fluent.withInstallDocker(image.isInstallDocker());
         fluent.withInstallGit(image.isInstallGit());
         fluent.withInstallMaven(image.isInstallMaven());
+        fluent.withInstallQemu(image.isInstallQemu());
     }
 
     public BuiltInImageBuilder(BuiltInImageFluent<?> fluent) {
@@ -27,12 +28,14 @@ public BuiltInImageBuilder(BuiltInImageFluent<?> fluent, BuiltInImage image) {
         fluent.withInstallDocker(image.isInstallDocker());
         fluent.withInstallGit(image.isInstallGit());
         fluent.withInstallMaven(image.isInstallMaven());
+        fluent.withInstallQemu(image.isInstallQemu());
     }
 
     public BuiltInImage build() {
         return new BuiltInImage(fluent.getBuiltInImage(),
                 fluent.isInstallGit(),
                 fluent.isInstallMaven(),
-                fluent.isInstallDocker());
+                fluent.isInstallDocker(),
+                fluent.isInstallQemu());
     }
 }
diff --git a/src/main/java/com/microsoft/azure/vmagent/builders/BuiltInImageFluent.java b/src/main/java/com/microsoft/azure/vmagent/builders/BuiltInImageFluent.java
@@ -11,11 +11,14 @@ public class BuiltInImageFluent<T extends BuiltInImageFluent<T>> {
 
     private boolean isInstallDocker;
 
+    private boolean isInstallQemu;
+
     public BuiltInImageFluent() {
         builtInImage = Constants.WINDOWS_SERVER_2016;
         isInstallDocker = false;
         isInstallMaven = false;
         isInstallGit = false;
+        isInstallQemu = false;
     }
 
     //CHECKSTYLE:OFF
@@ -38,6 +41,11 @@ public T withInstallDocker(boolean installDocker) {
         this.isInstallDocker = installDocker;
         return (T) this;
     }
+
+    public T withInstallQemu(boolean installQemu) {
+        this.isInstallQemu = installQemu;
+        return (T) this;
+    }
     //CHECKSTYLE:ON
 
     public String getBuiltInImage() {
@@ -55,4 +63,8 @@ public boolean isInstallMaven() {
     public boolean isInstallDocker() {
         return isInstallDocker;
     }
+
+    public boolean isInstallQemu() {
+        return isInstallQemu;
+    }
 }
diff --git a/src/main/java/com/microsoft/azure/vmagent/util/Constants.java b/src/main/java/com/microsoft/azure/vmagent/util/Constants.java
@@ -160,6 +160,7 @@ public final class Constants {
      */
     public static final String INSTALL_JAVA = "Java";
     public static final String INSTALL_MAVEN = "Maven";
+    public static final String INSTALL_QEMU = "QEMU";
     public static final String INSTALL_GIT = "Git";
     public static final String INSTALL_DOCKER = "Docker";
     public static final String INSTALL_JNLP = "Jnlp";

diff --git a/src/main/java/com/microsoft/azure/vmagent/util/TemplateUtil.java b/src/main/java/com/microsoft/azure/vmagent/util/TemplateUtil.java
@@ -27,6 +27,7 @@ public static boolean checkSame(AzureVMAgentTemplate a, AzureVMAgentTemplate b)
                 && a.isInstallDocker() == b.isInstallDocker()
                 && a.isInstallGit() == b.isInstallGit()
                 && a.isInstallMaven() == b.isInstallMaven()
+                && a.isInstallQemu() == b.isInstallQemu()
                 && a.getImageReference().getType() == b.getImageReference().getType()
                 && StringUtils.equals(a.getImageReference().getUri(), b.getImageReference().getUri())
                 && StringUtils.equals(a.getOsType(), b.getOsType())

diff --git a/src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.jelly b/src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.jelly
@@ -172,6 +172,10 @@
         <f:entry title="Install Docker" field="installDocker">
           <f:checkbox/>
         </f:entry>
+
+        <f:entry title="Install QEMU" field="installQemu">
+          <f:checkbox/>
+        </f:entry>
       </f:section>
     </f:radioBlock>
 

diff --git a/src/main/resources/scripts/ubuntuInstallQemuScript.sh b/src/main/resources/scripts/ubuntuInstallQemuScript.sh
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# Install QEMU
+
+set -ex
+
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y qemu-user-static
+
+"qemu-$(uname -m)-static" --version
diff --git a/src/main/resources/scripts/windowsInstallQemuScript.ps1 b/src/main/resources/scripts/windowsInstallQemuScript.ps1
@@ -0,0 +1,5 @@
+choco install -y qemu
+
+$env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User")
+
+qemu-system-x86_64 --version
diff --git a/src/test/java/com/microsoft/azure/vmagent/test/jcasc/AdvancedConfigAsCodeTest.java b/src/test/java/com/microsoft/azure/vmagent/test/jcasc/AdvancedConfigAsCodeTest.java
@@ -70,6 +70,7 @@ public void importAdvancedConfiguration() {
         assertThat(template.isInstallDocker(), is(false));
         assertThat(template.isInstallGit(), is(false));
         assertThat(template.isInstallMaven(), is(false));
+        assertThat(template.isInstallQemu(), is(false));
 
         assertThat(template.getLabels(), is("linux"));
         assertThat(template.getLocation(), is("UK South"));

diff --git a/src/test/java/com/microsoft/azure/vmagent/test/jcasc/BasicConfigAsCodeTest.java b/src/test/java/com/microsoft/azure/vmagent/test/jcasc/BasicConfigAsCodeTest.java
@@ -65,6 +65,7 @@ public void importBasicConfiguration() {
         assertThat(template.isInstallDocker(), is(true));
         assertThat(template.isInstallGit(), is(true));
         assertThat(template.isInstallMaven(), is(true));
+        assertThat(template.isInstallQemu(), is(true));
 
         assertThat(template.getLabels(), is("ubuntu"));
         assertThat(template.getLocation(), is("East US"));

diff --git a/...microsoft/azure/vmagent/test/datamigration/AzureVMAgentTemplateReadResolveTest/config.xml b/...microsoft/azure/vmagent/test/datamigration/AzureVMAgentTemplateReadResolveTest/config.xml
@@ -30,6 +30,7 @@
                     <isInstallGit>false</isInstallGit>
                     <isInstallMaven>false</isInstallMaven>
                     <isInstallDocker>false</isInstallDocker>
+                    <isInstallQemu>false</isInstallQemu>
                     <osType>Linux</osType>
                     <imagePublisher>Canonical</imagePublisher>
                     <imageOffer>UbuntuServer</imageOffer>

diff --git a/src/test/resources/com/microsoft/azure/vmagent/test/jcasc/advanced.yaml b/src/test/resources/com/microsoft/azure/vmagent/test/jcasc/advanced.yaml
@@ -35,6 +35,7 @@ jenkins:
             installDocker: false
             installGit: false
             installMaven: false
+            installQemu: false
             jvmOptions: "-xmx"
             labels: "linux"
             location: "UK South"

diff --git a/src/test/resources/com/microsoft/azure/vmagent/test/jcasc/basic.yaml b/src/test/resources/com/microsoft/azure/vmagent/test/jcasc/basic.yaml
@@ -23,6 +23,7 @@ jenkins:
             installDocker: true
             installGit: true
             installMaven: true
+            installQemu: true
             labels: "ubuntu"
             location: "East US"
             newStorageAccountName: "agent-storage"

diff --git a/src/test/resources/com/microsoft/azure/vmagent/test/jcasc/expectedBasic.yaml b/src/test/resources/com/microsoft/azure/vmagent/test/jcasc/expectedBasic.yaml
@@ -17,6 +17,7 @@
       installDocker: true
       installGit: true
       installMaven: true
+      installQemu: true
       labels: "ubuntu"
       launcher: "ssh"
       location: "East US"