Add dedicated endpoint for pending plugins

This commit is contained in:
Rene Pfeuffer
2019-09-13 14:17:06 +02:00
parent b7aa2ea1cd
commit 0ceb1ad295
10 changed files with 299 additions and 35 deletions

View File

@@ -101,16 +101,4 @@ public class AvailablePluginResource {
pluginManager.install(name, restartAfterInstallation);
return Response.ok().build();
}
@POST
@Path("/install-pending")
@StatusCodes({
@ResponseCode(code = 200, condition = "success"),
@ResponseCode(code = 500, condition = "internal server error")
})
public Response installPending() {
PluginPermissions.manage().check();
pluginManager.installPendingAndRestart();
return Response.ok().build();
}
}

View File

@@ -54,6 +54,9 @@ public class IndexDtoGenerator extends HalAppenderMapper {
builder.single(link("installedPlugins", resourceLinks.installedPluginCollection().self()));
builder.single(link("availablePlugins", resourceLinks.availablePluginCollection().self()));
}
if (PluginPermissions.manage().isPermitted()) {
builder.single(link("pendingPlugins", resourceLinks.pendingPluginCollection().self()));
}
if (UserPermissions.list().isPermitted()) {
builder.single(link("users", resourceLinks.userCollection().self()));
}

View File

@@ -0,0 +1,77 @@
package sonia.scm.api.v2.resources;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
import de.otto.edison.hal.Embedded;
import de.otto.edison.hal.HalRepresentation;
import de.otto.edison.hal.Links;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.PluginManager;
import sonia.scm.plugin.PluginPermissions;
import sonia.scm.web.VndMediaType;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;
import java.util.List;
import static de.otto.edison.hal.Link.link;
import static de.otto.edison.hal.Links.linkingTo;
import static java.util.stream.Collectors.toList;
public class PendingPluginResource {
private final PluginManager pluginManager;
private final ResourceLinks resourceLinks;
private final PluginDtoMapper mapper;
@Inject
public PendingPluginResource(PluginManager pluginManager, ResourceLinks resourceLinks, PluginDtoMapper mapper) {
this.pluginManager = pluginManager;
this.resourceLinks = resourceLinks;
this.mapper = mapper;
}
@GET
@Path("")
@StatusCodes({
@ResponseCode(code = 200, condition = "success"),
@ResponseCode(code = 500, condition = "internal server error")
})
@Produces(VndMediaType.PLUGIN_COLLECTION)
public Response getPending() {
PluginPermissions.manage().check();
List<AvailablePlugin> pending = pluginManager
.getAvailable()
.stream()
.filter(AvailablePlugin::isPending)
.collect(toList());
Links.Builder linksBuilder = linkingTo().self(resourceLinks.pendingPluginCollection().self());
if (!pending.isEmpty()) {
linksBuilder.single(link("install", resourceLinks.pendingPluginCollection().installPending()));
}
Embedded.Builder embedded = Embedded.embeddedBuilder();
embedded.with("available", pending.stream().map(mapper::mapAvailable).collect(toList()));
return Response.ok(new HalRepresentation(linksBuilder.build(), embedded.build())).build();
}
@POST
@Path("/install")
@StatusCodes({
@ResponseCode(code = 200, condition = "success"),
@ResponseCode(code = 500, condition = "internal server error")
})
public Response installPending() {
PluginPermissions.manage().check();
pluginManager.installPendingAndRestart();
return Response.ok().build();
}
}

View File

@@ -53,10 +53,6 @@ public class PluginDtoCollectionMapper {
Links.Builder linksBuilder = linkingTo()
.with(Links.linkingTo().self(baseUrl).build());
if (PluginPermissions.manage().isPermitted() && containsPending(plugins)) {
linksBuilder.single(Link.link("installPending", resourceLinks.availablePluginCollection().installPending()));
}
return linksBuilder.build();
}

View File

@@ -9,11 +9,13 @@ public class PluginRootResource {
private Provider<InstalledPluginResource> installedPluginResourceProvider;
private Provider<AvailablePluginResource> availablePluginResourceProvider;
private Provider<PendingPluginResource> pendingPluginResourceProvider;
@Inject
public PluginRootResource(Provider<InstalledPluginResource> installedPluginResourceProvider, Provider<AvailablePluginResource> availablePluginResourceProvider) {
public PluginRootResource(Provider<InstalledPluginResource> installedPluginResourceProvider, Provider<AvailablePluginResource> availablePluginResourceProvider, Provider<PendingPluginResource> pendingPluginResourceProvider) {
this.installedPluginResourceProvider = installedPluginResourceProvider;
this.availablePluginResourceProvider = availablePluginResourceProvider;
this.pendingPluginResourceProvider = pendingPluginResourceProvider;
}
@Path("/installed")
@@ -23,4 +25,7 @@ public class PluginRootResource {
@Path("/available")
public AvailablePluginResource availablePlugins() { return availablePluginResourceProvider.get(); }
@Path("/pending")
public PendingPluginResource pendingPlugins() { return pendingPluginResourceProvider.get(); }
}

View File

@@ -715,12 +715,28 @@ class ResourceLinks {
availablePluginCollectionLinkBuilder = new LinkBuilder(pathInfo, PluginRootResource.class, AvailablePluginResource.class);
}
String self() {
return availablePluginCollectionLinkBuilder.method("availablePlugins").parameters().method("getAvailablePlugins").parameters().href();
}
}
public PendingPluginCollectionLinks pendingPluginCollection() {
return new PendingPluginCollectionLinks(scmPathInfoStore.get());
}
static class PendingPluginCollectionLinks {
private final LinkBuilder pendingPluginCollectionLinkBuilder;
PendingPluginCollectionLinks(ScmPathInfo pathInfo) {
pendingPluginCollectionLinkBuilder = new LinkBuilder(pathInfo, PluginRootResource.class, PendingPluginResource.class);
}
String installPending() {
return availablePluginCollectionLinkBuilder.method("availablePlugins").parameters().method("installPending").parameters().href();
return pendingPluginCollectionLinkBuilder.method("pendingPlugins").parameters().method("installPending").parameters().href();
}
String self() {
return availablePluginCollectionLinkBuilder.method("availablePlugins").parameters().method("getAvailablePlugins").parameters().href();
return pendingPluginCollectionLinkBuilder.method("pendingPlugins").parameters().method("getPending").parameters().href();
}
}