Streamline plugin API

* Decouples runtime configuration and testing from the ExtensionFactory interface into separate RuntimeConfigurable and Testable interfaces.
* Replace ExtensionContext with a more generic ServiceRegistry, which will be easier to extend going forward.
* Improve naming of various classes, e.g. ExtensionKVStore -> KeyValueStore.
* Updates the extensions REST API to indicate whether a given extension supports runtime configuration or testing.
* Aligns response of extension list endpoints with others in the API.

Signed-off-by: nscuro <nscuro@protonmail.com>

Author: nscuro

api/src/main/openapi/components/schemas/extensions/list-extension-points-response.yaml

@@ -15,10 +15,12 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 type: object
+allOf:
+- $ref: "../paginated-response.yaml"
 properties:
-  extension_points:
+  items:
     type: array
     items:
       $ref: "./list-extension-points-response-item.yaml"
 required:
-- extension_points
+- items

api/src/main/openapi/components/schemas/extensions/list-extensions-response-item.yaml

@@ -18,5 +18,13 @@ type: object
 properties:
   name:
     type: string
+  configurable:
+    type: boolean
+    description: Whether the extension supports runtime configuration.
+  testable:
+    type: boolean
+    description: Whether the extension can be tested.
 required:
-- name
+- name
+- configurable
+- testable

api/src/main/openapi/components/schemas/extensions/list-extensions-response.yaml

@@ -15,10 +15,12 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 type: object
+allOf:
+- $ref: "../paginated-response.yaml"
 properties:
-  extensions:
+  items:
     type: array
     items:
       $ref: "./list-extensions-response-item.yaml"
 required:
-- extensions
+- items

apiserver/src/main/java/org/dependencytrack/plugin/PluginInitializer.java

@@ -83,7 +83,6 @@ public void contextInitialized(ServletContextEvent event) {
                 secretManager::getSecretValue,
                 JdbiFactory.createJdbi(),
                 HttpClient.INSTANCE,
-                HttpClient.INSTANCE.userAgent(),
                 extensionPoints);
 
         LOGGER.info("Discovering plugins");

apiserver/src/main/java/org/dependencytrack/resources/v2/ExtensionsResource.java

@@ -36,13 +36,17 @@
 import org.dependencytrack.api.v2.model.ListExtensionsResponseItem;
 import org.dependencytrack.api.v2.model.TestExtensionRequest;
 import org.dependencytrack.api.v2.model.TestExtensionResponse;
+import org.dependencytrack.api.v2.model.TotalCount;
+import org.dependencytrack.api.v2.model.TotalCountType;
 import org.dependencytrack.api.v2.model.UpdateExtensionConfigRequest;
 import org.dependencytrack.auth.Permissions;
 import org.dependencytrack.common.MdcScope;
 import org.dependencytrack.plugin.api.ExtensionFactory;
 import org.dependencytrack.plugin.api.ExtensionPoint;
 import org.dependencytrack.plugin.api.ExtensionTestCheck;
 import org.dependencytrack.plugin.api.ExtensionTestResult;
+import org.dependencytrack.plugin.api.RuntimeConfigurable;
+import org.dependencytrack.plugin.api.Testable;
 import org.dependencytrack.plugin.api.config.MutableConfigRegistry;
 import org.dependencytrack.plugin.api.config.RuntimeConfig;
 import org.dependencytrack.plugin.api.config.RuntimeConfigSpec;
@@ -58,6 +62,7 @@
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
+import java.util.Comparator;
 import java.util.Map;
 import java.util.SequencedCollection;
 
@@ -93,7 +98,7 @@ public Response listExtensionPoints() {
                 pluginManager.getExtensionPoints();
 
         final var response = ListExtensionPointsResponse.builder()
-                .extensionPoints(
+                .items(
                         extensionPoints.stream()
                                 .map(ExtensionPointMetadata::name)
                                 .sorted()
@@ -102,6 +107,11 @@ public Response listExtensionPoints() {
                                                 .name(name)
                                                 .build())
                                 .toList())
+                .total(
+                        TotalCount.builder()
+                                .count((long) extensionPoints.size())
+                                .type(TotalCountType.EXACT)
+                                .build())
                 .build();
 
         return Response.ok(response).build();
@@ -121,15 +131,21 @@ public Response listExtensions(String extensionPointName) {
                 pluginManager.getFactories(extensionPointClass);
 
         final var response = ListExtensionsResponse.builder()
-                .extensions(
+                .items(
                         extensionFactories.stream()
-                                .map(ExtensionFactory::extensionName)
-                                .sorted()
+                                .sorted(Comparator.comparing(ExtensionFactory::extensionName))
                                 .<ListExtensionsResponseItem>map(
-                                        extensionName -> ListExtensionsResponseItem.builder()
-                                                .name(extensionName)
+                                        extensionFactory -> ListExtensionsResponseItem.builder()
+                                                .name(extensionFactory.extensionName())
+                                                .configurable(extensionFactory instanceof RuntimeConfigurable)
+                                                .testable(extensionFactory instanceof Testable)
                                                 .build())
                                 .toList())
+                .total(
+                        TotalCount.builder()
+                                .count((long) extensionFactories.size())
+                                .type(TotalCountType.EXACT)
+                                .build())
                 .build();
 
         return Response.ok(response).build();
@@ -148,7 +164,8 @@ public Response getExtensionConfig(
         final ExtensionFactory<?> extensionFactory =
                 getExtensionFactory(extensionPointClass, extensionName);
 
-        if (extensionFactory.runtimeConfigSpec() == null) {
+        if (!(extensionFactory instanceof RuntimeConfigurable rc)
+                || rc.runtimeConfigSpec() == null) {
             throw new NotFoundException();
         }
 
@@ -189,7 +206,10 @@ public Response updateExtensionConfig(
         final ExtensionFactory<?> extensionFactory =
                 getExtensionFactory(extensionPointClass, extensionName);
 
-        final RuntimeConfigSpec runtimeConfigSpec = extensionFactory.runtimeConfigSpec();
+        final RuntimeConfigSpec runtimeConfigSpec =
+                extensionFactory instanceof RuntimeConfigurable rc
+                        ? rc.runtimeConfigSpec()
+                        : null;
         if (runtimeConfigSpec == null) {
             throw new BadRequestException();
         }
@@ -235,7 +255,10 @@ public Response getExtensionConfigSchema(
         final ExtensionFactory<?> extensionFactory =
                 getExtensionFactory(extensionPointClass, extensionName);
 
-        final RuntimeConfigSpec runtimeConfigSpec = extensionFactory.runtimeConfigSpec();
+        final RuntimeConfigSpec runtimeConfigSpec =
+                extensionFactory instanceof RuntimeConfigurable rc
+                        ? rc.runtimeConfigSpec()
+                        : null;
         if (runtimeConfigSpec == null) {
             return Response.noContent().build();
         }
@@ -267,7 +290,10 @@ public Response testExtension(
         }
 
         RuntimeConfig runtimeConfig = null;
-        final RuntimeConfigSpec runtimeConfigSpec = extensionFactory.runtimeConfigSpec();
+        final RuntimeConfigSpec runtimeConfigSpec =
+                extensionFactory instanceof RuntimeConfigurable rc
+                        ? rc.runtimeConfigSpec()
+                        : null;
         if (runtimeConfigSpec == null) {
             if (request.getConfig() != null) {
                 throw new BadRequestException("The extension does not support configuration");
@@ -281,13 +307,12 @@ public Response testExtension(
             }
         }
 
-        final ExtensionTestResult testResult;
-        try {
-            testResult = extensionFactory.test(runtimeConfig);
-        } catch (UnsupportedOperationException e) {
+        if (!(extensionFactory instanceof Testable testable)) {
             throw new BadRequestException("The extension does not support testing");
         }
 
+        final ExtensionTestResult testResult = testable.test(runtimeConfig);
+
         final var response = TestExtensionResponse.builder()
                 .checks(testResult.checks().stream()
                         .map(ExtensionsResource::convert)

apiserver/src/test/java/org/dependencytrack/dex/DexEngineInitializerTest.java

@@ -105,7 +105,7 @@ void shouldStartEngine() throws Exception {
                 .when(servletContextMock).getAttribute(eq(FileStorage.class.getName()));
         doReturn(new PluginManager(config, cacheManager, secretManager::getSecretValue,
                 JdbiFactory.createJdbi(),
-                HttpClient.newHttpClient(), "Dependency-Track", Collections.emptyList()))
+                HttpClient.newHttpClient(), Collections.emptyList()))
                 .when(servletContextMock).getAttribute(eq(PluginManager.class.getName()));
         doReturn(secretManager)
                 .when(servletContextMock).getAttribute(eq(SecretManager.class.getName()));

apiserver/src/test/java/org/dependencytrack/event/EventSubsystemInitializerTest.java

@@ -63,7 +63,6 @@ void shouldSubscribeAndUnsubscribeListeners() throws Exception {
                 secretName -> null,
                 JdbiFactory.createJdbi(),
                 HttpClient.newHttpClient(),
-                "Dependency-Track",
                 Collections.emptyList());
         final var servletContextMock = mock(ServletContext.class);
 

apiserver/src/test/java/org/dependencytrack/notification/PublishNotificationWorkflowTest.java

@@ -83,7 +83,6 @@ void beforeEach() {
                 secretName -> null,
                 JdbiFactory.createJdbi(),
                 HttpClient.newHttpClient(),
-                "Dependency-Track",
                 List.of(NotificationPublisher.class));
         pluginManager.loadPlugins(List.of(
                 new DefaultNotificationPublishersPlugin()));

apiserver/src/test/java/org/dependencytrack/pkgmetadata/MockPackageMetadataResolverPlugin.java

@@ -23,10 +23,10 @@
 import org.dependencytrack.pkgmetadata.resolution.api.PackageMetadataResolver;
 import org.dependencytrack.pkgmetadata.resolution.api.PackageMetadataResolverFactory;
 import org.dependencytrack.pkgmetadata.resolution.api.PackageRepository;
-import org.dependencytrack.plugin.api.ExtensionContext;
 import org.dependencytrack.plugin.api.ExtensionFactory;
 import org.dependencytrack.plugin.api.ExtensionPoint;
 import org.dependencytrack.plugin.api.Plugin;
+import org.dependencytrack.plugin.api.ServiceRegistry;
 import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
 
@@ -83,7 +83,7 @@ private static final class MockPackageMetadataResolverFactory implements Package
         }
 
         @Override
-        public void init(@NonNull ExtensionContext ctx) {
+        public void init(@NonNull ServiceRegistry serviceRegistry) {
         }
 
         @Override

apiserver/src/test/java/org/dependencytrack/pkgmetadata/ResolvePackageMetadataWorkflowTest.java

@@ -81,7 +81,6 @@ void beforeEach() {
                 secretName -> null,
                 JdbiFactory.createJdbi(),
                 HttpClient.newHttpClient(),
-                "Dependency-Track",
                 List.of(PackageMetadataResolver.class));
         pluginManager.loadPlugins(List.of(mockPlugin));