Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split agent templates into multiple pages #493

Merged
merged 2 commits into from
Jan 8, 2024
Merged

Split agent templates into multiple pages #493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db87c34
Split agent templates into multiple pages
timja Jan 4, 2024
4c76c0a
Add template name validation
timja Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<properties>
<changelist>9999-SNAPSHOT</changelist>
<gitHubRepo>jenkinsci/azure-vm-agents-plugin</gitHubRepo>
<jenkins.version>2.387.3</jenkins.version>
<jenkins.version>2.426.1</jenkins.version>
<maven.javadoc.skip>true</maven.javadoc.skip>
<hpi.compatibleSinceVersion>883</hpi.compatibleSinceVersion>
</properties>
Expand All @@ -54,8 +54,8 @@
<dependencies>
<dependency>
<groupId>io.jenkins.tools.bom</groupId>
<artifactId>bom-2.387.x</artifactId>
<version>2543.vfb_1a_5fb_9496d</version>
<artifactId>bom-2.426.x</artifactId>
<version>2675.v1515e14da_7a_6</version>
<scope>import</scope>
<type>pom</type>
</dependency>
Expand Down
143 changes: 114 additions & 29 deletions src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,24 @@
import hudson.model.TaskListener;
import hudson.model.labels.LabelAtom;
import hudson.security.ACL;
import hudson.slaves.Cloud;
import hudson.slaves.RetentionStrategy;
import hudson.util.FormApply;
import hudson.util.FormValidation;
import hudson.util.ListBoxModel;
import jenkins.model.Jenkins;
import net.sf.json.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.AncestorInPath;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.verb.POST;

import javax.servlet.ServletException;
Expand Down Expand Up @@ -1421,6 +1428,54 @@ public List<String> verifyTemplate() throws Exception {
nsgName);
}

/**
* Deletes the template.
*/
@POST
public HttpResponse doDoDelete(@AncestorInPath AzureVMCloud azureVMCloud) throws IOException {
Jenkins j = Jenkins.get();
j.checkPermission(Jenkins.ADMINISTER);
if (azureVMCloud == null) {
throw new IllegalStateException("Cloud could not be found");
}
azureVMCloud.removeTemplate(this);
j.save();
// take the user back.
return new HttpRedirect("../../templates");
}

@POST
public HttpResponse doConfigSubmit(StaplerRequest req, @AncestorInPath AzureVMCloud azureVMCloud)
throws IOException, ServletException, Descriptor.FormException {
Jenkins j = Jenkins.get();
j.checkPermission(Jenkins.ADMINISTER);
if (azureVMCloud == null) {
throw new IllegalStateException("Cloud could not be found");
}
azureVMCloud.removeTemplate(this);
AzureVMAgentTemplate newTemplate = reconfigure(req, req.getSubmittedForm());
if (StringUtils.isBlank(newTemplate.getTemplateName())) {
throw new Descriptor.FormException("Template name is mandatory", "templateName");
}
boolean templateNameExists = azureCloud.templateNameExists(newTemplate.getTemplateName());
if (templateNameExists) {
throw new Descriptor.FormException("Agent template name must be unique", "templateName");
}

azureVMCloud.addTemplate(newTemplate);
j.save();
// take the user back.
return FormApply.success("../../templates");
}

private AzureVMAgentTemplate reconfigure(@NonNull final StaplerRequest req, JSONObject form)
throws Descriptor.FormException {
if (form == null) {
return null;
}
return getDescriptor().newInstance(req, form);
}

@Extension
public static final class DescriptorImpl extends Descriptor<AzureVMAgentTemplate> {

Expand All @@ -1440,10 +1495,12 @@ public List<Descriptor<RetentionStrategy<?>>> getAzureVMRetentionStrategy() {

@POST
public ListBoxModel doFillVirtualMachineSizeItems(
@RelativePath("..") @QueryParameter String azureCredentialsId,
@QueryParameter("cloudName") String cloudName,
@QueryParameter String location) {
Jenkins.get().checkPermission(Jenkins.SYSTEM_READ);

String azureCredentialsId = getAzureCredentialsIdFromCloud(cloudName);

ListBoxModel model = new ListBoxModel();
if (StringUtils.isBlank(azureCredentialsId)) {
return model;
Expand Down Expand Up @@ -1476,10 +1533,34 @@ public ListBoxModel doFillOsTypeItems() throws IOException, ServletException {
return model;
}

private String getAzureCredentialsIdFromCloud(String cloudName) {
AzureVMCloud cloud = getAzureCloud(cloudName);

if (cloud != null) {
return cloud.getAzureCredentialsId();
}

return null;
}

private AzureVMCloud getAzureCloud(String cloudName) {
Cloud cloud = Jenkins.get().getCloud(cloudName);

if (cloud instanceof AzureVMCloud) {
return (AzureVMCloud) cloud;
}

return null;
}

@POST
public ListBoxModel doFillLocationItems(@RelativePath("..") @QueryParameter String azureCredentialsId) {
public ListBoxModel doFillLocationItems(
@QueryParameter("cloudName") String cloudName
) {
Jenkins.get().checkPermission(Jenkins.SYSTEM_READ);

String azureCredentialsId = getAzureCredentialsIdFromCloud(cloudName);

ListBoxModel model = new ListBoxModel();
if (StringUtils.isBlank(azureCredentialsId)) {
return model;
Expand Down Expand Up @@ -1511,21 +1592,27 @@ public AzureComputerLauncher getDefaultComputerLauncher() {

@POST
public ListBoxModel doFillAvailabilitySetItems(
@RelativePath("../..") @QueryParameter String azureCredentialsId,
@RelativePath("../..") @QueryParameter String resourceGroupReferenceType,
@RelativePath("../..") @QueryParameter String newResourceGroupName,
@RelativePath("../..") @QueryParameter String existingResourceGroupName,
@QueryParameter("cloudName") String cloudName,
@RelativePath("..") @QueryParameter String location) {
Jenkins.get().checkPermission(Jenkins.SYSTEM_READ);

ListBoxModel model = new ListBoxModel();
model.add("--- Select Availability Set in current resource group and location ---", "");

AzureVMCloud cloud = getAzureCloud(cloudName);
if (cloud == null) {
return model;
}

String azureCredentialsId = cloud.getAzureCredentialsId();
if (StringUtils.isBlank(azureCredentialsId)) {
return model;
}

//resourceGroupReferenceType passed wrong value in 2.60.1-LTS, we won't use this value until bug resolved.
resourceGroupReferenceType = null;
String resourceGroupReferenceType = cloud.getResourceGroupReferenceType();
String newResourceGroupName = cloud.getNewResourceGroupName();
String existingResourceGroupName = cloud.getExistingResourceGroupName();


try {
AzureResourceManager azureClient = AzureResourceManagerCache.get(azureCredentialsId);
Expand Down Expand Up @@ -1585,19 +1672,23 @@ public ListBoxModel doFillUsageModeItems() throws IOException, ServletException

@POST
public ListBoxModel doFillExistingStorageAccountNameItems(
@RelativePath("..") @QueryParameter String azureCredentialsId,
@RelativePath("..") @QueryParameter String resourceGroupReferenceType,
@RelativePath("..") @QueryParameter String newResourceGroupName,
@RelativePath("..") @QueryParameter String existingResourceGroupName,
@QueryParameter("cloudName") String cloudName,
@QueryParameter String storageAccountType) {
Jenkins.get().checkPermission(Jenkins.SYSTEM_READ);

AzureVMCloud cloud = getAzureCloud(cloudName);
ListBoxModel model = new ListBoxModel();
if (cloud == null) {
return model;
}
String azureCredentialsId = cloud.getAzureCredentialsId();

if (StringUtils.isBlank(azureCredentialsId)) {
return model;
}
//resourceGroupReferenceType passed wrong value in 2.60.1-LTS, we won't use this value until bug resolved.
resourceGroupReferenceType = null;
String resourceGroupReferenceType = cloud.getResourceGroupReferenceType();
String newResourceGroupName = cloud.getNewResourceGroupName();
String existingResourceGroupName = cloud.getExistingResourceGroupName();

try {
AzureResourceManager azureClient = AzureResourceManagerCache.get(azureCredentialsId);
Expand Down Expand Up @@ -1775,12 +1866,7 @@ public FormValidation doCheckJvmOptions(@QueryParameter String value) {

@POST
public FormValidation doVerifyConfiguration(
@RelativePath("..") @QueryParameter String azureCredentialsId,
@RelativePath("..") @QueryParameter String resourceGroupReferenceType,
@RelativePath("..") @QueryParameter String newResourceGroupName,
@RelativePath("..") @QueryParameter String existingResourceGroupName,
@RelativePath("..") @QueryParameter String maxVirtualMachinesLimit,
@RelativePath("..") @QueryParameter String deploymentTimeout,
@QueryParameter String cloudName,
@QueryParameter String templateName,
@QueryParameter String labels,
@QueryParameter String location,
Expand All @@ -1802,7 +1888,6 @@ public FormValidation doVerifyConfiguration(
@QueryParameter String galleryName,
@QueryParameter String galleryImageDefinition,
@QueryParameter String galleryImageVersion,
@QueryParameter boolean galleryImageSpecialized,
@QueryParameter String gallerySubscriptionId,
@QueryParameter String galleryResourceGroup,
@RelativePath("..") @QueryParameter String sshConfig,
Expand Down Expand Up @@ -1830,13 +1915,13 @@ public FormValidation doVerifyConfiguration(
galleryResourceGroup
);

String resourceGroupName = AzureVMCloud.getResourceGroupName(
resourceGroupReferenceType, newResourceGroupName, existingResourceGroupName);
AzureVMCloud cloud = (AzureVMCloud) Jenkins.get().getCloud(cloudName);

String storageAccountName = getStorageAccountName(
storageAccountNameReferenceType, newStorageAccountName, existingStorageAccountName);
if (storageAccountName.trim().isEmpty()) {
storageAccountName = AzureVMAgentTemplate.generateUniqueStorageAccountName(
resourceGroupName, templateName);
cloud.getResourceGroupName(), templateName);
}

LOGGER.log(Level.INFO,
Expand Down Expand Up @@ -1876,7 +1961,7 @@ public FormValidation doVerifyConfiguration(
"",
"",
"",
resourceGroupName,
cloud.getResourceGroupName(),
templateName,
labels,
location,
Expand Down Expand Up @@ -1909,8 +1994,8 @@ public FormValidation doVerifyConfiguration(

// First validate the subscription info. If it is not correct,
// then we can't validate the
String result = AzureClientHolder.getDelegate(azureCredentialsId)
.verifyConfiguration(resourceGroupName, deploymentTimeout);
String result = AzureClientHolder.getDelegate(cloud.getAzureCredentialsId())
.verifyConfiguration(cloud.getResourceGroupName(), String.valueOf(cloud.getDeploymentTimeout()));
if (!result.equals(Constants.OP_SUCCESS)) {
return FormValidation.error(result);
}
Expand All @@ -1920,7 +2005,7 @@ public FormValidation doVerifyConfiguration(
azureComputerLauncher.setSshConfig(sshConfig);
}

final List<String> errors = AzureClientHolder.getDelegate(azureCredentialsId).verifyTemplate(
final List<String> errors = AzureClientHolder.getDelegate(cloud.getAzureCredentialsId()).verifyTemplate(
templateName,
labels,
location,
Expand All @@ -1940,7 +2025,7 @@ public FormValidation doVerifyConfiguration(
subnetName,
new AzureVMCloudRetensionStrategy(0),
jvmOptions,
resourceGroupName,
cloud.getResourceGroupName(),
false,
usePrivateIP,
nsgName);
Expand Down
Loading