Add /rest/admin API

vip-api/src/main/java/fr/insalyon/creatis/vip/api/controller/admin/AppVersionController.java

@@ -0,0 +1,176 @@
+/*
+ * Copyright and authors: see LICENSE.txt in base repository.
+ *
+ * This software is a web portal for pipeline execution on distributed systems.
+ *
+ * This software is governed by the CeCILL-B license under French law and
+ * abiding by the rules of distribution of free software.  You can  use,
+ * modify and/ or redistribute the software under the terms of the CeCILL-B
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and  rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty  and the software's author,  the holder of the
+ * economic rights,  and the successive licensors  have only  limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading,  using,  modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean  that it is complicated to manipulate,  and  that  also
+ * therefore means  that it is reserved for developers  and  experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and,  more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL-B license and that you accept its terms.
+ */
+package fr.insalyon.creatis.vip.api.controller.admin;
+
+import fr.insalyon.creatis.vip.api.controller.ApiController;
+import fr.insalyon.creatis.vip.api.exception.ApiException;
+import fr.insalyon.creatis.vip.application.client.bean.AppVersion;
+import fr.insalyon.creatis.vip.application.client.bean.Application;
+import fr.insalyon.creatis.vip.application.server.business.AppVersionBusiness;
+import fr.insalyon.creatis.vip.application.server.business.ApplicationBusiness;
+import fr.insalyon.creatis.vip.core.server.business.BusinessException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RequestBody;
+import jakarta.validation.Valid;
+
+import java.util.ArrayList;
+import java.util.List;
+
+@RestController
+@RequestMapping("admin/appVersions")
+public class AppVersionController extends ApiController {
+    private final Logger logger = LoggerFactory.getLogger(getClass());
+
+    private final ApplicationBusiness applicationBusiness;
+    private final AppVersionBusiness appVersionBusiness;
+
+    @Autowired
+    protected AppVersionController(ApplicationBusiness applicationBusiness, AppVersionBusiness appVersionBusiness) {
+        this.applicationBusiness = applicationBusiness;
+        this.appVersionBusiness = appVersionBusiness;
+    }
+
+    @RequestMapping(method = RequestMethod.GET)
+    public List<AppVersion> listAppVersions() throws ApiException {
+        logMethodInvocation(logger, "listAppVersions");
+        try {
+            List<Application> apps = applicationBusiness.getApplications();
+            List<AppVersion> appVersions = new ArrayList<>();
+            for (Application app : apps) {
+                appVersions.addAll(appVersionBusiness.getVersions(app.getName()));
+            }
+            return appVersions;
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    private class AppVersionStrings {
+        public String appName;
+        public String version;
+        AppVersionStrings(String appName, String version) {
+            this.appName = appName;
+            this.version = version;
+        }
+    }
+
+    private AppVersionStrings parseAppVersionId(String appVersionId) throws ApiException {
+        int delimiterPos = appVersionId.lastIndexOf("/");
+        if (delimiterPos >= 0) {
+            String appName = appVersionId.substring(0, delimiterPos);
+            String version = appVersionId.substring(delimiterPos + 1);
+            return new AppVersionStrings(appName, version);
+        } else {
+            logger.error("Error decoding appVersionId {}", appVersionId);
+            throw new ApiException(ApiException.ApiError.INVALID_PIPELINE_IDENTIFIER, appVersionId);
+        }
+    }
+
+    @RequestMapping(value = "{appVersionId}", method = RequestMethod.GET)
+    public AppVersion getAppVersion(@PathVariable String appVersionId) throws ApiException {
+        logMethodInvocation(logger, "getAppVersion", appVersionId);
+        AppVersionStrings input = parseAppVersionId(appVersionId);
+        try {
+            AppVersion appVersion = appVersionBusiness.getVersion(input.appName, input.version);
+            if (appVersion == null) {
+                throw new ApiException(ApiException.ApiError.INVALID_PIPELINE_IDENTIFIER, appVersionId);
+            }
+            return appVersion;
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    @RequestMapping(value = "{appVersionIdFirstPart}/{appVersionIdSecondPart}", method = RequestMethod.GET)
+    public AppVersion getAppVersion(@PathVariable String appVersionIdFirstPart,
+                                    @PathVariable String appVersionIdSecondPart) throws ApiException {
+        return getAppVersion(appVersionIdFirstPart + "/" + appVersionIdSecondPart);
+    }
+
+    @RequestMapping(value = "/{appVersionId}", method = RequestMethod.PUT)
+    public AppVersion createOrUpdateAppVersion(@PathVariable String appVersionId,
+                                               @RequestBody @Valid AppVersion appVersion) throws ApiException {
+        logMethodInvocation(logger, "createOrUpdateAppVersion", appVersionId);
+        AppVersionStrings input = parseAppVersionId(appVersionId);
+        String appVersionIdBody = appVersion.getApplicationName() + "/" + appVersion.getVersion();
+        if (!appVersionId.equals(appVersionIdBody)) {
+            logger.error("appVersionId mismatch: {}!={}", appVersionId, appVersionIdBody);
+            throw new ApiException(ApiException.ApiError.INPUT_FIELD_NOT_VALID, appVersionId);
+        }
+        try {
+            AppVersion existingAppVersion = appVersionBusiness.getVersion(input.appName, input.version);
+            if (existingAppVersion == null) {
+                appVersionBusiness.add(appVersion);
+            } else {
+                appVersionBusiness.update(appVersion);
+            }
+            return appVersionBusiness.getVersion(input.appName, input.version);
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    @RequestMapping(value = "/{appVersionIdFirstPart}/{appVersionIdSecondPart}", method = RequestMethod.PUT)
+    public AppVersion createOrUpdateAppVersion(@PathVariable String appVersionIdFirstPart,
+                                               @PathVariable String appVersionIdSecondPart,
+                                               @RequestBody @Valid AppVersion appVersion) throws ApiException {
+        return createOrUpdateAppVersion(appVersionIdFirstPart + "/" + appVersionIdSecondPart, appVersion);
+    }
+
+    @RequestMapping(method = RequestMethod.POST)
+    public AppVersion createAppVersion(@RequestBody @Valid AppVersion appVersion) throws ApiException {
+        return createOrUpdateAppVersion(appVersion.getApplicationName(), appVersion.getVersion(), appVersion);
+    }
+
+    @RequestMapping(value = "/{appVersionId}", method = RequestMethod.DELETE)
+    public void deleteAppVersion(@PathVariable String appVersionId) throws ApiException {
+        logMethodInvocation(logger, "deleteAppVersion", appVersionId);
+        AppVersionStrings input = parseAppVersionId(appVersionId);
+        try {
+            appVersionBusiness.remove(input.appName, input.version);
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    @RequestMapping(value = "/{appVersionIdFirstPart}/{appVersionIdSecondPart}", method = RequestMethod.DELETE)
+    public void deleteAppVersion(@PathVariable String appVersionIdFirstPart,
+                                 @PathVariable String appVersionIdSecondPart) throws ApiException {
+        deleteAppVersion(appVersionIdFirstPart + "/" + appVersionIdSecondPart);
+    }
+}

vip-api/src/main/java/fr/insalyon/creatis/vip/api/controller/admin/ApplicationController.java

@@ -0,0 +1,122 @@
+/*
+ * Copyright and authors: see LICENSE.txt in base repository.
+ *
+ * This software is a web portal for pipeline execution on distributed systems.
+ *
+ * This software is governed by the CeCILL-B license under French law and
+ * abiding by the rules of distribution of free software.  You can  use,
+ * modify and/ or redistribute the software under the terms of the CeCILL-B
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and  rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty  and the software's author,  the holder of the
+ * economic rights,  and the successive licensors  have only  limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading,  using,  modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean  that it is complicated to manipulate,  and  that  also
+ * therefore means  that it is reserved for developers  and  experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and,  more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL-B license and that you accept its terms.
+ */
+package fr.insalyon.creatis.vip.api.controller.admin;
+
+import fr.insalyon.creatis.vip.api.controller.ApiController;
+import fr.insalyon.creatis.vip.api.exception.ApiException;
+import fr.insalyon.creatis.vip.application.client.bean.Application;
+import fr.insalyon.creatis.vip.application.server.business.ApplicationBusiness;
+import fr.insalyon.creatis.vip.core.server.business.BusinessException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RequestBody;
+import jakarta.validation.Valid;
+
+import java.util.List;
+
+@RestController
+@RequestMapping("admin/applications")
+public class ApplicationController extends ApiController {
+    private final Logger logger = LoggerFactory.getLogger(getClass());
+
+    private final ApplicationBusiness applicationBusiness;
+
+    @Autowired
+    protected ApplicationController(ApplicationBusiness applicationBusiness) {
+        this.applicationBusiness = applicationBusiness;
+    }
+
+    @RequestMapping(method = RequestMethod.GET)
+    public List<Application> listApplications() throws ApiException {
+        logMethodInvocation(logger, "listApplications");
+        try {
+            return applicationBusiness.getApplications();
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    @RequestMapping(value = "{applicationId}", method = RequestMethod.GET)
+    public Application getApplication(@PathVariable String applicationId) throws ApiException {
+        logMethodInvocation(logger, "getApplication", applicationId);
+        try {
+            Application app = applicationBusiness.getApplication(applicationId);
+            if (app == null) {
+                throw new ApiException(ApiException.ApiError.APPLICATION_NOT_FOUND, applicationId);
+            }
+            return app;
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    @RequestMapping(value = "/{applicationId}", method = RequestMethod.PUT)
+    public Application createOrUpdateApplication(@PathVariable String applicationId,
+                                                 @RequestBody @Valid Application app) throws ApiException {
+        logMethodInvocation(logger, "createOrUpdateApplication", applicationId);
+        if (!applicationId.equals(app.getName())) {
+            logger.error("applicationId mismatch: {}!={}", applicationId, app.getName());
+            throw new ApiException(ApiException.ApiError.INPUT_FIELD_NOT_VALID, applicationId);
+        }
+        try {
+            Application existingApp = applicationBusiness.getApplication(applicationId);
+            if (existingApp == null) {
+                applicationBusiness.add(app);
+            } else {
+                applicationBusiness.update(app);
+            }
+            return applicationBusiness.getApplication(applicationId);
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+
+    @RequestMapping(method = RequestMethod.POST)
+    public Application createApplication(@RequestBody @Valid Application app) throws ApiException {
+        return createOrUpdateApplication(app.getName(), app);
+    }
+
+    @RequestMapping(value = "/{applicationId}", method = RequestMethod.DELETE)
+    public void deleteApplication(@PathVariable String applicationId) throws ApiException {
+        logMethodInvocation(logger, "deleteApplication", applicationId);
+        try {
+            applicationBusiness.remove(applicationId);
+        } catch (BusinessException e) {
+            throw new ApiException(e);
+        }
+    }
+}

vip-api/src/main/java/fr/insalyon/creatis/vip/api/security/ApiSecurityConfig.java

@@ -112,6 +112,7 @@ public SecurityFilterChain apiFilterChain(HttpSecurity http) throws Exception {
                         .requestMatchers(antMatcher("/rest/register")).permitAll()
                         .requestMatchers(antMatcher("/rest/executions/{executionId}/summary")).hasAnyRole("SERVICE")
                         .requestMatchers(antMatcher("/rest/statistics/**")).hasAnyRole("ADVANCED", "ADMINISTRATOR")
+                        .requestMatchers(antMatcher("/rest/admin/**")).hasAnyRole("ADMINISTRATOR")
                         .requestMatchers(antMatcher("/rest/**")).authenticated()
                         .anyRequest().permitAll()
                 )

vip-application/src/main/java/fr/insalyon/creatis/vip/application/server/business/AppVersionBusiness.java

@@ -107,6 +107,9 @@ public AppVersion getVersion(String applicationName, String applicationVersion)
             throws BusinessException {
         try {
             AppVersion version = applicationDAO.getVersion(applicationName, applicationVersion);
+            if (version == null) {
+                return null;
+            }
 
             version.setResources(resourceBusiness.getByAppVersion(version).stream().map((e) -> e.getName()).collect(Collectors.toList()));
             version.setTags(tagBusiness.getTags(version).stream().map((e) -> e.getName()).collect(Collectors.toList()));

vip-application/src/main/java/fr/insalyon/creatis/vip/application/server/dao/mysql/ApplicationData.java

@@ -344,7 +344,7 @@ public void removeVersion(String applicationName, String version) throws DAOExce
         try (PreparedStatement ps = getConnection().prepareStatement(query)) {
             ps.setString(1, applicationName);
             ps.setString(2, version);
-            ps.executeUpdate(query);
+            ps.executeUpdate();
 
         } catch (SQLException ex) {
             logger.error("Error removing version {}/{}", applicationName, version, ex);