From 3477371021f075fe64aaec386b7d8b6d5b652d24 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Tue, 10 Nov 2020 22:07:02 +0100 Subject: [PATCH] Fixed naming --- .../verifier/converter/StubGenerator.java | 20 +++++++++--- .../converter/StubGeneratorProvider.java | 14 ++++++++ .../wiremock/DslToWireMockConverter.java | 32 +++++++++++++++++++ .../main/resources/META-INF/spring.factories | 3 ++ .../RecursiveFilesConverterSpec.groovy | 9 ++++-- 5 files changed, 71 insertions(+), 7 deletions(-) create mode 100644 spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/resources/META-INF/spring.factories diff --git a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGenerator.java b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGenerator.java index 9ab3415956..3c1dccbaa8 100644 --- a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGenerator.java +++ b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGenerator.java @@ -16,6 +16,7 @@ package org.springframework.cloud.contract.verifier.converter; +import java.io.File; import java.util.Map; import org.springframework.cloud.contract.spec.Contract; @@ -29,14 +30,22 @@ import org.springframework.cloud.contract.verifier.file.ContractMetadata; public interface StubGenerator { /** - * @param contractFileName - file name + * @param fileName - file name * @return {@code true} if the converter can handle the file to convert it into a * stub. - * @deprecated all present converters will be picked + * @deprecated use {@link StubGenerator#canReadStubMapping(File)} */ @Deprecated - default boolean canHandleFileName(String contractFileName) { - return contractFileName.endsWith(fileExtension()); + default boolean canReadStubMapping(String fileName) { + return fileName.endsWith(fileExtension()); + } + + /** + * @param mapping - potential stub mapping mapping + * @return {@code true} if this converter could have generated this mapping stub. + */ + default boolean canReadStubMapping(File mapping) { + return mapping.getName().endsWith(fileExtension()); } /** @@ -61,7 +70,8 @@ public interface StubGenerator { String generateOutputFileNameForInput(String inputFileName); /** - * Describes the file extension that this stub generator can handle. + * Describes the file extension of the generated mapping that this stub generator can + * handle. * @return string describing the file extension */ default String fileExtension() { diff --git a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGeneratorProvider.java b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGeneratorProvider.java index babf98e21e..da1651bf1c 100644 --- a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGeneratorProvider.java +++ b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/converter/StubGeneratorProvider.java @@ -16,10 +16,12 @@ package org.springframework.cloud.contract.verifier.converter; +import java.io.File; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.List; +import java.util.stream.Collectors; import org.springframework.core.io.support.SpringFactoriesLoader; @@ -42,6 +44,18 @@ public class StubGeneratorProvider { this.converters.addAll(converters); } + /** + * @param file - stub mapping file + * @return collection of stub generators matching the stub mapping + * @deprecated use {@link #allOrDefault(StubGenerator)} + */ + @Deprecated + public Collection converterForName(final File file) { + return this.converters.stream() + .filter(stubGenerator -> stubGenerator.canReadStubMapping(file)) + .collect(Collectors.toList()); + } + public Collection allOrDefault(StubGenerator defaultStubGenerator) { return this.converters.isEmpty() ? Collections.singletonList(defaultStubGenerator) : this.converters; diff --git a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.java b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.java index 1fc0b9ea26..4f0f1260c5 100644 --- a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.java +++ b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/java/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.java @@ -16,7 +16,19 @@ package org.springframework.cloud.contract.verifier.wiremock; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.Charset; +import java.nio.file.Files; + +import com.github.tomakehurst.wiremock.common.JsonException; +import com.github.tomakehurst.wiremock.stubbing.StubMapping; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + import org.springframework.cloud.contract.verifier.converter.StubGenerator; +import org.springframework.util.StreamUtils; /** * WireMock implementation of the {@link StubGenerator}. @@ -25,6 +37,8 @@ import org.springframework.cloud.contract.verifier.converter.StubGenerator; */ public abstract class DslToWireMockConverter implements StubGenerator { + private static final Log log = LogFactory.getLog(DslToWireMockConverter.class); + @Override public String generateOutputFileNameForInput(String inputFileName) { return inputFileName.replaceAll(extension(inputFileName), "json"); @@ -38,4 +52,22 @@ public abstract class DslToWireMockConverter implements StubGenerator { return ""; } + @Override + public boolean canReadStubMapping(File mapping) { + if (!mapping.getName().endsWith(".json")) { + return false; + } + try (InputStream stream = Files.newInputStream(mapping.toPath())) { + StubMapping.buildFrom( + StreamUtils.copyToString(stream, Charset.forName("UTF-8"))); + return true; + } + catch (IOException | JsonException e) { + if (log.isDebugEnabled()) { + log.debug("Cannot read file", e); + } + return false; + } + } + } diff --git a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..9c00e75f2b --- /dev/null +++ b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Stub converters +org.springframework.cloud.contract.verifier.converter.StubGenerator=\ +org.springframework.cloud.contract.verifier.wiremock.DslToWireMockClientConverter diff --git a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/converter/RecursiveFilesConverterSpec.groovy b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/converter/RecursiveFilesConverterSpec.groovy index d0a469a25d..57af2e1a00 100755 --- a/spring-cloud-contract-tools/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/converter/RecursiveFilesConverterSpec.groovy +++ b/spring-cloud-contract-tools/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/converter/RecursiveFilesConverterSpec.groovy @@ -110,7 +110,7 @@ org.springframework.cloud.contract.spec.Contract.make { }""" and: StubGenerator stubGenerator = Stub(StubGenerator) - stubGenerator.canHandleFileName(_) >> { true } + stubGenerator.canReadStubMapping(_) >> { true } stubGenerator.convertContents(_, _) >> { throw new NullPointerException("Test conversion error") } @@ -194,7 +194,12 @@ org.springframework.cloud.contract.spec.Contract.make { private StubGenerator stubGenerator(String stub) { return new StubGenerator() { @Override - boolean canHandleFileName(String contractFileName) { + boolean canReadStubMapping(String fileName) { + return true + } + + @Override + boolean canReadStubMapping(File mapping) { return true }