feat: Add support for default settings at /config/default.yaml

Author: PSanetra

README.md

@@ -44,16 +44,16 @@ Copy your SPA resources to `/app/`. All resources in this directory will be serv
 
 ### YAML Configuration
 
-The container is configured using YAML files.
+The application container is configured via YAML files at startup time.
 
-You can mount your custom configuration file at `/config/config.yaml`. Every specified option in this file will override the default configuration.
+If you need to configure some default settings for your application image, you can add a default configuration file to `/config/default.yaml`.
+
+To configure settings at runtime, you can mount your runtime configuration file at `/config/config.yaml`. Every specified setting in this file will override the default setting.
 
 It is also possible to merge multiple configuration files by specifying the `CONFIG_FILES` environment variable like `CONFIG_FILES="file:///config/config1.yaml|file:///config/config2.yaml"`. The configuration options, specified in the first configuration file in that variable, will have priority over the options in later declared files.
 
-The following configuration shows the default values for every available option:
+The following configuration shows the default values of this base image for every available setting:
 ```yaml
-# Do not edit or replace this file!
-# Instead create a second config file, which overrides these defaults.
 default:
   # Specifies to which host names this configuration should apply.
   server_names:
@@ -114,7 +114,7 @@ default:
       style-src: "'self'"
 ```
 
-Aside to the `default` configuration block, you can also define other blocks, which might define configuration options for special hosts. The non-default blocks will inherit the configured options of the default-block if they are not explicitly redeclared.
+Aside to the `default` configuration block, you can also define other blocks, which might define configuration settings for special hosts. The non-default blocks will inherit the configured settings of the default-block if they are not explicitly redeclared.
 
 Example:
 ```yaml

config/bootstrap.sh

@@ -4,13 +4,21 @@ test -n "${APP_ROOT}" || ( echo 'APP_ROOT is not defined!' && false )
 test -n "${CONFIG_DIR}" || ( echo 'CONFIG_DIR is not defined!' && false )
 
 if [ -z "${CONFIG_FILES}" ] && [ -f "${CONFIG_DIR}/config.yaml" ]; then
-  export CONFIG_FILES="file://${CONFIG_DIR}/config.yaml"
+  CONFIG_FILES="file://${CONFIG_DIR}/config.yaml"
+fi
+
+if [ -f "${CONFIG_DIR}/default.yaml" ]; then
+  if [ -z "${CONFIG_FILES}" ]; then
+    CONFIG_FILES="file://${CONFIG_DIR}/default.yaml"
+  else
+    CONFIG_FILES="${CONFIG_FILES}|file://${CONFIG_DIR}/default.yaml"
+  fi
 fi
 
 if [ -z "${CONFIG_FILES}" ]; then
-  export CONFIG_FILES="file://${CONFIG_DIR}/.internal_default.yaml"
+  CONFIG_FILES="file://${CONFIG_DIR}/.internal_default.yaml"
 else
-  export CONFIG_FILES="merge:${CONFIG_FILES}|file://${CONFIG_DIR}/.internal_default.yaml"
+  CONFIG_FILES="merge:${CONFIG_FILES}|file://${CONFIG_DIR}/.internal_default.yaml"
 fi
 
 rm -rf "${CONFIG_DIR}/.out"

examples/angular-example/Dockerfile

@@ -8,6 +8,8 @@ RUN npm ci && npm run build:prod
 
 FROM codecentric/single-page-application-server:1-nginx-stable-alpine
 
+COPY ./default-config.yaml /config/default.yaml
+
 # Usually we would mount this file at runtime, but we will add it to the image for demo purposes.
 COPY ./runtime-config.yaml /config/config.yaml
 

examples/angular-example/README.md

@@ -8,6 +8,7 @@ This is a small Angular example app, which includes a `spa_config.js` to configu
 2. Add `"src/spa_config.js"` to `.projects["your-project"].architect.build.options.assets` in `angular.json`
 3. Declare `spaConfig` in the `window` object via the TypeScript definition file `/src/@types/spa_config.d.ts`
 4. Add `<script src="./spa_config.js"></script>` to `index.html`
+5. Add a `/config/default.yaml` configuration file to the image, which allows 'unsafe-inline' styles. (See `default-config.yaml`, [#angular/26152](https://github.com/angular/angular/issues/26152))
 
 ## Build Dockerfile
 

examples/angular-example/default-config.yaml

@@ -0,0 +1,4 @@
+default:
+  hardening:
+    content_security_policy:
+      style-src: "'self' 'unsafe-inline'"

examples/angular-example/runtime-config.yaml

@@ -1,6 +1,3 @@
 default:
   spa_config:
     appTitle: "Prod Title"
-  hardening:
-    content_security_policy:
-      style-src: "'self' 'unsafe-inline'"

tests/src/test/java/de/codecentric/spa/server/tests/DefaultConfigTests.java

@@ -0,0 +1,79 @@
+package de.codecentric.spa.server.tests;
+
+import de.codecentric.spa.server.tests.containers.SpaServerContainer;
+import de.codecentric.spa.server.tests.helpers.Http;
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.Test;
+import org.testcontainers.shaded.com.google.common.collect.ImmutableMap;
+
+import java.io.IOException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@Slf4j
+public class DefaultConfigTests {
+
+    @Test
+    public void shouldBeAppliedWithLeastPriority() throws IOException, InterruptedException {
+
+        try (var container = new SpaServerContainer(SpaServerContainer.Options.builder()
+            .indexResourcePath("spa_config/index_with_spa_config_without_hash.html")
+            .defaultConfigResourcePath("default_config/default.yaml")
+            .configResourcePath("default_config/config.yaml")
+            .build())) {
+            container.start();
+
+            var response = Http
+                .get("http://" + container.getHost() + ":" + container.getMappedPort(SpaServerContainer.DEFAULT_HTTP_PORT));
+            assertThat(response.statusCode()).isEqualTo(200);
+
+            assertThat((String) response.body()).contains(
+                "<script type=\"text/javascript\" src=\"./spa_config.01c639aa476ec270940bf7d3ebdab1de56a79fdc.js\"></script>"
+            );
+
+            response = Http.get(String.format(
+                "http://%s:%d/spa_config.01c639aa476ec270940bf7d3ebdab1de56a79fdc.js",
+                container.getHost(),
+                container.getMappedPort(SpaServerContainer.DEFAULT_HTTP_PORT)
+            ));
+
+            assertThat((String) response.body()).isEqualTo(
+                "var spaConfig = {\"defaultProperty\":\"This is not overridden\",\"endpoints\":{},\"testProperty\":\"Overridden Value\"}"
+            );
+        }
+
+    }
+
+    @Test
+    public void shouldBeAppliedWhenConfigFilesEnvironmentVariableIsSet() throws IOException, InterruptedException {
+
+        try (var container = new SpaServerContainer(SpaServerContainer.Options.builder()
+            .indexResourcePath("spa_config/index_with_spa_config_without_hash.html")
+            .defaultConfigResourcePath("default_config/default.yaml")
+            .additionalConfigResources(ImmutableMap.of("/config/custom.yaml", "default_config/config.yaml"))
+            .build())) {
+            container.addEnv("CONFIG_FILES", "file:///config/custom.yaml");
+            container.start();
+
+            var response = Http
+                .get("http://" + container.getHost() + ":" + container.getMappedPort(SpaServerContainer.DEFAULT_HTTP_PORT));
+            assertThat(response.statusCode()).isEqualTo(200);
+
+            assertThat((String) response.body()).contains(
+                "<script type=\"text/javascript\" src=\"./spa_config.01c639aa476ec270940bf7d3ebdab1de56a79fdc.js\"></script>"
+            );
+
+            response = Http.get(String.format(
+                "http://%s:%d/spa_config.01c639aa476ec270940bf7d3ebdab1de56a79fdc.js",
+                container.getHost(),
+                container.getMappedPort(SpaServerContainer.DEFAULT_HTTP_PORT)
+            ));
+
+            assertThat((String) response.body()).isEqualTo(
+                "var spaConfig = {\"defaultProperty\":\"This is not overridden\",\"endpoints\":{},\"testProperty\":\"Overridden Value\"}"
+            );
+        }
+
+    }
+
+}

tests/src/test/java/de/codecentric/spa/server/tests/containers/SpaServerContainer.java

@@ -77,9 +77,16 @@ public SpaServerContainer(Options options) {
         withExposedPorts(options.exposedPorts);
         waitingFor(Wait.forListeningPort());
 
+        if (options.defaultConfigResourcePath != null) {
+            withClasspathResourceMapping(options.defaultConfigResourcePath, "/config/default.yaml", BindMode.READ_ONLY);
+        }
+
         if (options.configResourcePath != null) {
             withClasspathResourceMapping(options.configResourcePath, "/config/config.yaml", BindMode.READ_ONLY);
         }
+
+        options.additionalConfigResources
+            .forEach((key, value) -> withClasspathResourceMapping(value, key, BindMode.READ_ONLY));
     }
 
     private SpaServerContainer(@NonNull Future image) {
@@ -93,6 +100,9 @@ private SpaServerContainer(@NonNull Future image) {
     @Builder
     public static class Options {
         public String configResourcePath;
+        public String defaultConfigResourcePath;
+        @Builder.Default
+        public Map<String, String> additionalConfigResources = ImmutableMap.of();
         @Builder.Default
         public String indexResourcePath = "simple_spa/index.html";
         public String spaConfigFileName;

tests/src/test/resources/default_config/config.yaml

@@ -0,0 +1,3 @@
+default:
+  spa_config:
+    testProperty: "Overridden Value"

tests/src/test/resources/default_config/default.yaml

@@ -0,0 +1,4 @@
+default:
+  spa_config:
+    defaultProperty: "This is not overridden"
+    testProperty: "Default Value"