feat(rest.packages.provider): add deploy/v2 Rest API

kura/distrib/config/kura.build.properties

@@ -114,6 +114,7 @@ org.eclipse.kura.log.filesystem.provider.version=1.3.0-SNAPSHOT
 org.eclipse.kura.rest.configuration.provider.version=1.3.0-SNAPSHOT
 org.eclipse.kura.rest.inventory.provider.version=1.0.0-SNAPSHOT
 org.eclipse.kura.rest.command.provider.version=1.0.0-SNAPSHOT
+org.eclipse.kura.rest.packages.provider.version=1.0.0-SNAPSHOT
 org.eclipse.kura.rest.position.provider.version=1.0.0-SNAPSHOT
 org.eclipse.kura.rest.security.provider.version=1.0.0-SNAPSHOT
 org.eclipse.kura.rest.service.listing.provider.version=1.0.0-SNAPSHOT

kura/distrib/pom.xml

@@ -608,6 +608,11 @@
                                     <artifactId>org.eclipse.kura.rest.command.provider</artifactId>
                                     <version>${org.eclipse.kura.rest.command.provider.version}</version>
                                 </artifactItem>
+                                <artifactItem>
+                                    <groupId>org.eclipse.kura</groupId>
+                                    <artifactId>org.eclipse.kura.rest.packages.provider</artifactId>
+                                    <version>${org.eclipse.kura.rest.packages.provider.version}</version>
+                                </artifactItem>
                                 <artifactItem>
                                     <groupId>org.eclipse.kura</groupId>
                                     <artifactId>org.eclipse.kura.rest.position.provider</artifactId>
@@ -820,6 +825,7 @@
                                 <move file="target/plugins/org.eclipse.kura.rest.configuration.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.configuration.provider_${org.eclipse.kura.rest.configuration.provider.version}.jar" />
                                 <move file="target/plugins/org.eclipse.kura.rest.inventory.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.inventory.provider_${org.eclipse.kura.rest.inventory.provider.version}.jar" />
                                 <move file="target/plugins/org.eclipse.kura.rest.command.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.command.provider_${org.eclipse.kura.rest.command.provider.version}.jar" />
+                                <move file="target/plugins/org.eclipse.kura.rest.packages.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.packages.provider_${org.eclipse.kura.rest.packages.provider.version}.jar" />
                                 <move file="target/plugins/org.eclipse.kura.rest.position.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.position.provider_${org.eclipse.kura.rest.position.provider.version}.jar" />
                                 <move file="target/plugins/org.eclipse.kura.rest.security.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.security.provider_${org.eclipse.kura.rest.security.provider.version}.jar" />
                                 <move file="target/plugins/org.eclipse.kura.rest.service.listing.provider.jar" tofile="target/plugins/org.eclipse.kura.rest.service.listing.provider_${org.eclipse.kura.rest.service.listing.provider.version}.jar" />
@@ -2535,6 +2541,7 @@
                                         <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.configuration.provider_${org.eclipse.kura.rest.configuration.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />
                                         <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.inventory.provider_${org.eclipse.kura.rest.inventory.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />
                                         <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.command.provider_${org.eclipse.kura.rest.command.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />
+                                        <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.packages.provider_${org.eclipse.kura.rest.packages.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />
                                         <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.position.provider_${org.eclipse.kura.rest.position.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />
                                         <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.security.provider_${org.eclipse.kura.rest.security.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />
                                         <copy file="${project.build.directory}/plugins/org.eclipse.kura.rest.service.listing.provider_${org.eclipse.kura.rest.service.listing.provider.version}.jar" todir="${project.build.directory}/staging/target-definition/equinox_3.16.0/repository/plugins" />

kura/distrib/src/main/ant/build_equinox_distrib.xml

@@ -1315,6 +1315,8 @@ fi]]>
                 value=", reference:file:${kura.install.dir}/${kura.symlink}/${plugins.folder}/org.eclipse.kura.rest.inventory.provider_${org.eclipse.kura.rest.inventory.provider.version}.jar@4:start" />
             <entry key="osgi.bundles" operation="+"
                 value=", reference:file:${kura.install.dir}/${kura.symlink}/${plugins.folder}/org.eclipse.kura.rest.command.provider_${org.eclipse.kura.rest.command.provider.version}.jar@4:start" />
+            <entry key="osgi.bundles" operation="+"
+                value=", reference:file:${kura.install.dir}/${kura.symlink}/${plugins.folder}/org.eclipse.kura.rest.packages.provider_${org.eclipse.kura.rest.packages.provider.version}.jar@4:start" />
             <entry key="osgi.bundles" operation="+"
                 value=", reference:file:${kura.install.dir}/${kura.symlink}/${plugins.folder}/org.eclipse.kura.rest.position.provider_${org.eclipse.kura.rest.position.provider.version}.jar@4:start" />
             <entry key="osgi.bundles" operation="+"
@@ -1415,6 +1417,9 @@ fi]]>
             <zipfileset
                 file="${project.build.directory}/plugins/org.eclipse.kura.rest.command.provider_${org.eclipse.kura.rest.command.provider.version}.jar"
                 prefix="${build.output.name}/${plugins.folder}" />
+            <zipfileset
+                file="${project.build.directory}/plugins/org.eclipse.kura.rest.packages.provider_${org.eclipse.kura.rest.packages.provider.version}.jar"
+                prefix="${build.output.name}/${plugins.folder}" />
             <zipfileset
                 file="${project.build.directory}/plugins/org.eclipse.kura.rest.position.provider_${org.eclipse.kura.rest.position.provider.version}.jar"
                 prefix="${build.output.name}/${plugins.folder}" />

kura/org.eclipse.kura.rest.packages.provider/META-INF/MANIFEST.MF

@@ -0,0 +1,22 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: Kura Deployment Packages Rest Provider
+Bundle-SymbolicName: org.eclipse.kura.rest.packages.provider;singleton:=true
+Bundle-Version: 1.0.0.qualifier
+Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.8))"
+Bundle-ClassPath: .
+Bundle-ActivationPolicy: lazy
+Service-Component: OSGI-INF/*.xml
+Import-Package: com.google.gson;version="2.7.0",
+ javax.annotation.security;version="1.2.0",
+ javax.ws.rs;version="2.0.1",
+ javax.ws.rs.core;version="2.0.1",
+ javax.ws.rs.ext;version="2.0.1",
+ org.eclipse.kura;version="[1.3,2.0)",
+ org.eclipse.kura.deployment.agent;version="[1.0,2.0)",
+ org.osgi.framework;version="1.8.0",
+ org.osgi.service.component;version="1.3.0",
+ org.osgi.service.deploymentadmin;version="1.0.0",
+ org.osgi.service.useradmin;version="1.1.0";resolution:=optional,
+ org.slf4j;version="1.7.21"
+Export-Package: org.eclipse.kura.rest.deployment.agent.api;version="1.0.0";x-internal:=true

kura/org.eclipse.kura.rest.packages.provider/OSGI-INF/deployment_rest_service.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2023 Eurotech and/or its affiliates and others
+
+    This program and the accompanying materials are made
+    available under the terms of the Eclipse Public License 2.0
+    which is available at https://www.eclipse.org/legal/epl-2.0/
+
+	SPDX-License-Identifier: EPL-2.0
+
+	Contributors:
+	 Eurotech
+
+-->
+<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" name="org.eclipse.kura.rest.deployment.agent.DeploymentRestService">
+   <implementation class="org.eclipse.kura.internal.rest.deployment.agent.DeploymentRestService"/>
+   <property name="kura.service.pid" type="String" value="org.eclipse.kura.rest.deployment.agent.DeploymentRestService"/>
+   <service>
+      <provide interface="org.eclipse.kura.internal.rest.deployment.agent.DeploymentRestService"/>
+   </service>
+   <reference name="DeploymentAgentService"
+       cardinality="1..1"
+       interface="org.eclipse.kura.deployment.agent.DeploymentAgentService"
+       bind="setDeploymentAgentService"
+       policy="static"/>
+   <reference name="DeploymentAdmin"
+       cardinality="1..1"
+       interface="org.osgi.service.deploymentadmin.DeploymentAdmin"
+       bind="setDeploymentAdmin"
+       policy="static"/>
+   <reference name="UserAdmin"
+       cardinality="0..1"
+       interface="org.osgi.service.useradmin.UserAdmin"
+       bind="setUserAdmin"
+       policy="static"/>
+</scr:component>

kura/org.eclipse.kura.rest.packages.provider/build.properties

@@ -0,0 +1,17 @@
+#
+#  Copyright (c) 2023 Eurotech and/or its affiliates and others
+#
+#  This program and the accompanying materials are made
+#  available under the terms of the Eclipse Public License 2.0
+#  which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+#  SPDX-License-Identifier: EPL-2.0
+#
+#  Contributors:
+#   Eurotech
+#
+output.. = target/classes
+bin.includes = .,\
+               META-INF/,\
+               OSGI-INF/
+source.. = src/main/java/

kura/org.eclipse.kura.rest.packages.provider/pom.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright (c) 2023 Eurotech and/or its affiliates and others
+
+    This program and the accompanying materials are made
+    available under the terms of the Eclipse Public License 2.0
+    which is available at https://www.eclipse.org/legal/epl-2.0/
+
+    SPDX-License-Identifier: EPL-2.0
+
+    Contributors:
+     Eurotech
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.eclipse.kura</groupId>
+        <artifactId>kura</artifactId>
+        <version>5.4.0-SNAPSHOT</version>
+    </parent>
+
+    <properties>
+        <kura.basedir>${project.basedir}/..</kura.basedir>
+        <sonar.coverage.jacoco.xmlReportPaths>
+            ${project.basedir}/../test/*/target/site/jacoco-aggregate/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
+    </properties>
+
+    <artifactId>org.eclipse.kura.rest.packages.provider</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <packaging>eclipse-plugin</packaging>
+</project>

kura/org.eclipse.kura.rest.packages.provider/src/main/java/org/eclipse/kura/internal/rest/deployment/agent/DeploymentPackageInfo.java

@@ -0,0 +1,33 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Eurotech and/or its affiliates and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Eurotech
+ *******************************************************************************/
+package org.eclipse.kura.internal.rest.deployment.agent;
+
+public class DeploymentPackageInfo {
+
+    private final String name;
+    private final String version;
+
+    public DeploymentPackageInfo(String name, String version) {
+        this.name = name;
+        this.version = version;
+    }
+
+    public String getName() {
+        return this.name;
+    }
+
+    public String getVersion() {
+        return this.version;
+    }
+
+}

kura/org.eclipse.kura.rest.packages.provider/src/main/java/org/eclipse/kura/internal/rest/deployment/agent/DeploymentRestService.java

@@ -0,0 +1,143 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Eurotech and/or its affiliates and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Eurotech
+ *******************************************************************************/
+package org.eclipse.kura.internal.rest.deployment.agent;
+
+import static org.eclipse.kura.rest.deployment.agent.api.Validable.validate;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import javax.annotation.security.RolesAllowed;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+import org.eclipse.kura.deployment.agent.DeploymentAgentService;
+import org.eclipse.kura.rest.deployment.agent.api.DeploymentRequestStatus;
+import org.eclipse.kura.rest.deployment.agent.api.InstallRequest;
+import org.osgi.service.deploymentadmin.DeploymentAdmin;
+import org.osgi.service.deploymentadmin.DeploymentPackage;
+import org.osgi.service.useradmin.Role;
+import org.osgi.service.useradmin.UserAdmin;
+
+@Path("/deploy/v2")
+public class DeploymentRestService {
+
+    private static final String KURA_PERMISSION_REST_DEPLOY_ROLE = "kura.permission.rest.deploy";
+    private static final String ERROR_INSTALLING_PACKAGE = "Error installing deployment package: ";
+    private static final String ERROR_UNINSTALLING_PACKAGE = "Error uninstalling deployment package: ";
+    private static final String BAD_REQUEST_MESSAGE = "Bad request";
+
+    private DeploymentAdmin deploymentAdmin;
+    private DeploymentAgentService deploymentAgentService;
+    private UserAdmin userAdmin;
+
+    public void setUserAdmin(UserAdmin userAdmin) {
+        this.userAdmin = userAdmin;
+        this.userAdmin.createRole(KURA_PERMISSION_REST_DEPLOY_ROLE, Role.GROUP);
+    }
+
+    public void setDeploymentAdmin(DeploymentAdmin deploymentAdmin) {
+        this.deploymentAdmin = deploymentAdmin;
+    }
+
+    public void setDeploymentAgentService(DeploymentAgentService deploymentAgentService) {
+        this.deploymentAgentService = deploymentAgentService;
+    }
+
+    /**
+     * GET method.
+     *
+     * Provides the list of all the deployment packages installed and tracked by the framework.
+     *
+     * @return a list of {@link DeploymentPackageInfo}
+     */
+    @GET
+    @RolesAllowed("deploy")
+    @Produces(MediaType.APPLICATION_JSON)
+    public List<DeploymentPackageInfo> listDeploymentPackages() {
+
+        List<DeploymentPackageInfo> deploymentPackageInfos = new ArrayList<>();
+        List<DeploymentPackage> deploymentPackages = Arrays.asList(this.deploymentAdmin.listDeploymentPackages());
+
+        deploymentPackages.forEach(
+                dp -> deploymentPackageInfos.add(new DeploymentPackageInfo(dp.getName(), dp.getVersion().toString())));
+
+        return deploymentPackageInfos;
+    }
+
+    /**
+     * POST method.
+     *
+     * Installs the deployment package specified in the {@link InstallRequest}. If the request was already issued for
+     * the same {@link InstallRequest}, it returns the status of the installation process.
+     *
+     * @param installRequest
+     * @return a {@link DeploymentRequestStatus} object that represents the status of the installation request
+     */
+    @POST
+    @RolesAllowed("deploy")
+    @Path("/_install")
+    @Produces(MediaType.APPLICATION_JSON)
+    public DeploymentRequestStatus installDeploymentPackage(InstallRequest installRequest) {
+        validate(installRequest, BAD_REQUEST_MESSAGE);
+        String url = installRequest.getUrl();
+
+        if (this.deploymentAgentService.isInstallingDeploymentPackage(url)) {
+            return DeploymentRequestStatus.INSTALLING;
+        }
+
+        try {
+            this.deploymentAgentService.installDeploymentPackageAsync(url);
+        } catch (Exception e) {
+            throw new WebApplicationException(Response.status(Response.Status.INTERNAL_SERVER_ERROR)
+                    .type(MediaType.TEXT_PLAIN).entity(ERROR_INSTALLING_PACKAGE + url).build());
+        }
+
+        return DeploymentRequestStatus.REQUEST_RECEIVED;
+    }
+
+    /**
+     * DELETE method.
+     *
+     * Uninstalls the deployment package identified by the specified name. If the request was already issued, it reports
+     * the status of the uninstallation operation.
+     *
+     * @param name
+     * @return a {@link DeploymentRequestStatus} object that represents the status of the uninstallation request
+     */
+    @DELETE
+    @RolesAllowed("deploy")
+    @Path("/{name}")
+    @Produces(MediaType.APPLICATION_JSON)
+    public DeploymentRequestStatus uninstallDeploymentPackage(@PathParam("name") String name) {
+        if (this.deploymentAgentService.isUninstallingDeploymentPackage(name)) {
+            return DeploymentRequestStatus.UNINSTALLING;
+        }
+        try {
+            this.deploymentAgentService.uninstallDeploymentPackageAsync(name);
+        } catch (Exception e) {
+            throw new WebApplicationException(Response.status(Response.Status.INTERNAL_SERVER_ERROR)
+                    .type(MediaType.TEXT_PLAIN).entity(ERROR_UNINSTALLING_PACKAGE + name).build());
+        }
+
+        return DeploymentRequestStatus.REQUEST_RECEIVED;
+    }
+}

kura/org.eclipse.kura.rest.packages.provider/src/main/java/org/eclipse/kura/rest/deployment/agent/api/DeploymentRequestStatus.java

@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Eurotech and/or its affiliates and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Eurotech
+ *******************************************************************************/
+package org.eclipse.kura.rest.deployment.agent.api;
+
+/**
+ * Enumeration representing the status of the deployment requests received via REST.
+ *
+ */
+public enum DeploymentRequestStatus {
+    REQUEST_RECEIVED,
+    INSTALLING,
+    UNINSTALLING;
+}