100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Handle non existent / invalid directories when listing installed apps (#2979)
Eric Bariaux5c7493ecfe52
diff --git a/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.java b/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.javaindex 76328ff4f..421f5874e 100644--- a/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.java+++ b/manager/src/main/java/org/openremote/manager/apps/ConsoleAppService.java@@ -27,8 +27,12 @@ import org.openremote.model.Container;import org.openremote.model.ContainerService;import java.io.File;+import java.io.IOException;+import java.nio.file.DirectoryIteratorException;import java.nio.file.Files;import java.nio.file.Path;+import java.util.List;+import java.util.logging.Level;import java.util.logging.Logger;import java.util.stream.Stream;@@ -64,9 +68,10 @@ public class ConsoleAppService implements ContainerService {}public String[] getInstalled() throws Exception {- return Stream.concat(- Files.list(managerWebService.getBuiltInAppDocRoot()),- Files.list(managerWebService.getCustomAppDocRoot()))+ return Stream.of(+ listAppDocRoot(managerWebService.getBuiltInAppDocRoot()),+ listAppDocRoot(managerWebService.getCustomAppDocRoot()))+ .flatMap(List::stream).filter(Files::isDirectory).filter(path -> !new File(path.toString(), ".appignore").exists()).map(dir -> dir.getFileName().toString())@@ -74,6 +79,27 @@ public class ConsoleAppService implements ContainerService {.toArray(String[]::new);}+ private List<Path> listAppDocRoot(Path appDocRoot) {+ if (appDocRoot == null) {+ LOG.warning("App doc root is not configured, assuming no installed apps");+ return List.of();+ }++ try {+ if (!Files.isDirectory(appDocRoot)) {+ LOG.warning("App doc root does not exist, is not a directory, or cannot be accessed; assuming no installed apps: " + appDocRoot.toAbsolutePath());+ return List.of();+ }++ try (Stream<Path> apps = Files.list(appDocRoot)) {+ return apps.toList();+ }+ } catch (IOException | DirectoryIteratorException | SecurityException ex) {+ LOG.log(Level.WARNING, "App doc root cannot be listed, assuming no installed apps: " + appDocRoot.toAbsolutePath(), ex);+ return List.of();+ }+ }+public Path getConsoleAppDocRoot() {return resolveConsoleAppDocRoot();}diff --git a/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovy b/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovyindex 988cfa0a9..b5b42cdcb 100644--- a/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovy+++ b/test/src/test/groovy/org/openremote/test/console/ConsoleTest.groovy@@ -141,6 +141,39 @@ class ConsoleTest extends Specification implements ManagerContainerTrait {Files.deleteIfExists(customDocRoot)}+ def "Apps endpoint treats missing app doc root as empty"() {+ given: "a built-in app doc root and a missing custom app doc root"+ def builtInDocRoot = Files.createTempDirectory("apps-builtin-")+ def customDocRootParent = Files.createTempDirectory("apps-missing-custom-")+ def customDocRoot = customDocRootParent.resolve("missing")+ Files.createDirectories(builtInDocRoot.resolve("appBuiltin"))++ def container = startContainer(defaultConfig() << [+ (ManagerWebService.OR_APP_DOCROOT) : builtInDocRoot.toString(),+ (ManagerWebService.OR_CUSTOM_APP_DOCROOT): customDocRoot.toString()+ ], defaultServices())+ def requestTarget = getClientApiTarget(serverUri(serverPort), MASTER_REALM).path("apps")++ when: "requesting the apps list"+ def response = requestTarget.request().get()++ then: "the missing root is ignored and apps from the available root are returned"+ response.withCloseable { r ->+ assert r.status == 200+ def appList = parse(r.readEntity(String.class)).orElse("") as String+ appList.contains("appBuiltin")+ return true+ }++ cleanup:+ if (response != null) {+ response.close()+ }+ Files.deleteIfExists(builtInDocRoot.resolve("appBuiltin"))+ Files.deleteIfExists(builtInDocRoot)+ Files.deleteIfExists(customDocRootParent)+ }+def "Apps info endpoint returns info for custom apps"() {given: "a custom app doc root with an info.json file"def customDocRoot = Files.createTempDirectory("apps-info-custom-")