Merge pull request wiremock#2334 from bharatnpti/MappingsSourceExtension

Exposing MappingsSource for extension point

Author: tomakehurst

src/main/java/com/github/tomakehurst/wiremock/core/WireMockApp.java

@@ -61,6 +61,7 @@ public class WireMockApp implements StubServer, Admin {
  private final NearMissCalculator nearMissCalculator;
  private final Recorder recorder;
  private final List<GlobalSettingsListener> globalSettingsListeners;
+ private final Map<String, MappingsLoaderExtension> mappingsLoaderExtensions;
 
  private Options options;
 
@@ -116,6 +117,7 @@ public WireMockApp(Options options, Container container) {
  recorder =
  new Recorder(this, extensions, stores.getFilesBlobStore(), stores.getRecorderStateStore());
  globalSettingsListeners = List.copyOf(extensions.ofType(GlobalSettingsListener.class).values());
+ this.mappingsLoaderExtensions = extensions.ofType(MappingsLoaderExtension.class);
 
  this.container = container;
  loadDefaultMappings();
@@ -124,6 +126,7 @@ public WireMockApp(Options options, Container container) {
  public WireMockApp(
  boolean browserProxyingEnabled,
  MappingsLoader defaultMappingsLoader,
+ Map<String, MappingsLoaderExtension> mappingsLoaderExtensions,
  MappingsSaver mappingsSaver,
  boolean requestJournalDisabled,
  Integer maxRequestJournalEntries,
@@ -137,6 +140,7 @@ public WireMockApp(
 
  this.browserProxyingEnabled = browserProxyingEnabled;
  this.defaultMappingsLoader = defaultMappingsLoader;
+ this.mappingsLoaderExtensions = mappingsLoaderExtensions;
  this.mappingsSaver = mappingsSaver;
  this.settingsStore = stores.getSettingsStore();
  requestJournal =
@@ -236,6 +240,8 @@ private List<RequestFilterV2> getV2StubRequestFilters() {
 
  private void loadDefaultMappings() {
  loadMappingsUsing(defaultMappingsLoader);
+ if (mappingsLoaderExtensions != null)
+ mappingsLoaderExtensions.values().forEach(e -> loadMappingsUsing(e));
  }
 
  public void loadMappingsUsing(final MappingsLoader mappingsLoader) {

src/main/java/com/github/tomakehurst/wiremock/extension/MappingsLoaderExtension.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright (C) 2023 Thomas Akehurst
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.tomakehurst.wiremock.extension;
+
+import com.github.tomakehurst.wiremock.standalone.MappingsLoader;
+
+public interface MappingsLoaderExtension extends MappingsLoader, Extension {}

src/test/java/com/github/tomakehurst/wiremock/extension/mappingssource/DummyMappingsLoaderExtension.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) 2023 Thomas Akehurst
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.tomakehurst.wiremock.extension.mappingssource;
+
+import static com.github.tomakehurst.wiremock.common.AbstractFileSource.byFileExtension;
+
+import com.github.tomakehurst.wiremock.common.FileSource;
+import com.github.tomakehurst.wiremock.common.Json;
+import com.github.tomakehurst.wiremock.common.JsonException;
+import com.github.tomakehurst.wiremock.common.TextFile;
+import com.github.tomakehurst.wiremock.common.filemaker.FilenameMaker;
+import com.github.tomakehurst.wiremock.extension.MappingsLoaderExtension;
+import com.github.tomakehurst.wiremock.standalone.MappingFileException;
+import com.github.tomakehurst.wiremock.stubbing.StubMapping;
+import com.github.tomakehurst.wiremock.stubbing.StubMappingCollection;
+import com.github.tomakehurst.wiremock.stubbing.StubMappings;
+import java.util.*;
+import java.util.stream.Collectors;
+
+public class DummyMappingsLoaderExtension implements MappingsLoaderExtension {
+
+ private final FileSource mappingsFileSource;
+ private final Map<UUID, StubMappingFileMetadata> fileNameMap;
+ private final FilenameMaker filenameMaker;
+
+ public DummyMappingsLoaderExtension(FileSource mappingsFileSource, FilenameMaker filenameMaker) {
+ this.mappingsFileSource = mappingsFileSource;
+ this.filenameMaker = Objects.requireNonNullElseGet(filenameMaker, FilenameMaker::new);
+ fileNameMap = new HashMap<>();
+ }
+
+ @Override
+ public String getName() {
+ return null;
+ }
+
+ @Override
+ public void loadMappingsInto(StubMappings stubMappings) {
+ {
+ if (!mappingsFileSource.exists()) {
+ return;
+ }
+
+ List<TextFile> mappingFiles =
+ mappingsFileSource.listFilesRecursively().stream()
+ .filter(byFileExtension("json"))
+ .collect(Collectors.toList());
+ for (TextFile mappingFile : mappingFiles) {
+ try {
+ StubMappingCollection stubCollection =
+ Json.read(mappingFile.readContentsAsString(), StubMappingCollection.class);
+ for (StubMapping mapping : stubCollection.getMappingOrMappings()) {
+ mapping.setDirty(false);
+ stubMappings.addMapping(mapping);
+ StubMappingFileMetadata fileMetadata =
+ new StubMappingFileMetadata(mappingFile.getPath(), stubCollection.isMulti());
+ fileNameMap.put(mapping.getId(), fileMetadata);
+ }
+ } catch (JsonException e) {
+ throw new MappingFileException(mappingFile.getPath(), e.getErrors().first().getDetail());
+ }
+ }
+ }
+ }
+
+ private static class StubMappingFileMetadata {
+ final String path;
+ final boolean multi;
+
+ public StubMappingFileMetadata(String path, boolean multi) {
+ this.path = path;
+ this.multi = multi;
+ }
+ }
+}

src/test/java/com/github/tomakehurst/wiremock/extension/mappingssource/MappingsLoaderExtensionTest.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright (C) 2023 Thomas Akehurst
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.tomakehurst.wiremock.extension.mappingssource;
+
+import static com.github.tomakehurst.wiremock.common.Exceptions.throwUnchecked;
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+
+import com.github.tomakehurst.wiremock.WireMockServer;
+import com.github.tomakehurst.wiremock.common.FileSource;
+import com.github.tomakehurst.wiremock.common.SingleRootFileSource;
+import com.github.tomakehurst.wiremock.common.filemaker.FilenameMaker;
+import com.github.tomakehurst.wiremock.core.Options;
+import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
+import com.github.tomakehurst.wiremock.testsupport.WireMockResponse;
+import com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;
+import com.google.common.io.Resources;
+import java.io.File;
+import java.net.URISyntaxException;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+public class MappingsLoaderExtensionTest {
+
+ private WireMockConfiguration configuration;
+ private WireMockServer wireMockServer;
+ private WireMockTestClient testClient;
+
+ @BeforeEach
+ public void init() {
+ configuration = wireMockConfig().dynamicPort();
+ }
+
+ @AfterEach
+ public void stopWireMock() {
+ wireMockServer.stop();
+ }
+
+ private void buildWireMock(Options options) {
+ wireMockServer = new WireMockServer(options);
+ wireMockServer.start();
+ testClient = new WireMockTestClient(wireMockServer.port());
+ }
+
+ @Test
+ public void mappingsLoadedFromJsonFilesWithMultipleMappingsSource() {
+ FileSource filesRoot = new SingleRootFileSource(filePath("extension-test-request"));
+ buildWireMock(
+ configuration.extensions(new DummyMappingsLoaderExtension(filesRoot, new FilenameMaker())));
+
+ WireMockResponse response = testClient.get("/extension/resource/1");
+ assertThat(response.statusCode(), is(200));
+ }
+
+ public static String filePath(String path) {
+ try {
+ return new File(Resources.getResource(path).toURI()).getAbsolutePath();
+ } catch (URISyntaxException e) {
+ return throwUnchecked(e, String.class);
+ }
+ }
+}

src/test/resources/extension-test-request/200-example.json

@@ -0,0 +1,7 @@
+{
+ "request": {
+ "method": "GET",
+ "url": "/extension/resource/1"
+ },
+ "response": {"status": 200}
+}