improved obsolete mapping format/key check

Author: hauner

src/main/groovy/com/github/hauner/openapi/core/processor/MappingConverter.groovy

@@ -22,8 +22,6 @@ import com.github.hauner.openapi.core.processor.mapping.Mapping as MappingV1
 import com.github.hauner.openapi.core.processor.mapping.VersionedMapping
 import com.github.hauner.openapi.core.processor.mapping.v2.MappingConverter as MappingConverterV2
 import com.github.hauner.openapi.core.processor.mapping.v2.Mapping as MappingV2
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
 
 /**
  *  Converter for the type mapping from the mapping yaml. It converts the type mapping information
@@ -32,14 +30,12 @@ import org.slf4j.LoggerFactory
  *  @author Martin Hauner
  */
 class MappingConverter {
-    private static final Logger LOG = LoggerFactory.getLogger (MappingConverter)
 
     List<Mapping> convert (VersionedMapping source) {
         if (source?.isV2()) {
             def converter = new MappingConverterV2 ()
             converter.convert (source as MappingV2)
         } else {
-            LOG.warn ("current mapping.yaml format is deprecated, upgrade to v2")
             def converter = new MappingConverterV1 ()
             converter.convert (source as MappingV1)
         }

src/main/groovy/com/github/hauner/openapi/core/processor/MappingReader.groovy

@@ -30,12 +30,14 @@ import com.github.hauner.openapi.core.processor.mapping.version.Mapping as Versi
 import com.github.hauner.openapi.core.processor.mapping.v2.Mapping as MappingV2
 import com.github.hauner.openapi.core.processor.mapping.v2.Parameter as ParameterV2
 import com.github.hauner.openapi.core.processor.mapping.v2.ParameterDeserializer as ParameterDeserializerV2
+import groovy.util.logging.Slf4j
 
 /**
  *  Reader for mapping yaml.
  *
  *  @author Martin Hauner
  */
+@Slf4j
 class MappingReader {
 
     VersionedMapping read (String typeMappings) {
@@ -54,11 +56,19 @@ class MappingReader {
 
         def versionMapper = createVersionParser ()
         VersionMapping version = versionMapper.readValue (mapping, VersionMapping)
+
+        if (version.isDeprecatedVersionKey ()) {
+            log.warn ('the mapping version key "openapi-processor-spring" is deprecated, please use "openapi-processor-mapping"')
+        }
+
         if (version.v2) {
             def mapper = createV2Parser ()
             mapper.readValue (mapping, MappingV2)
         } else {
             // assume v1
+            log.info ('please update the mapping to the latest format')
+            log.info ('see https://hauner.github.io/openapi-processor/spring/mapping/structure.html')
+
             def mapper = createYamlParser ()
             mapper.readValue (mapping, Mapping)
         }

src/main/kotlin/com/github/hauner/openapi/core/processor/mapping/version/Mapping.kt

@@ -16,20 +16,32 @@
 
 package com.github.hauner.openapi.core.processor.mapping.version
 
-import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonProperty
 
 data class Mapping(
         @JsonProperty("openapi-processor-mapping")
-        @JsonAlias("openapi-processor-spring") // deprecated
-        val version: String?) {
+        val version: String? = null,
+
+        @JsonProperty("openapi-processor-spring")
+        val versionObsolete: String? = null
+) {
 
     fun isV2(): Boolean {
-        if (version == null) {
-            return false
-        }
+        return getSafeVersion().startsWith("v2")
+    }
+
+    fun isDeprecatedVersionKey (): Boolean {
+        return versionObsolete != null
+    }
+
+    private fun getSafeVersion(): String {
+        if (version != null)
+            return version
+
+        if (versionObsolete != null)
+            return versionObsolete
 
-        return version.startsWith("v2")
+        return "no version"
     }
 
 }

src/test/groovy/com/github/hauner/openapi/core/processor/MappingReaderSpec.groovy

@@ -16,10 +16,12 @@
 
 package com.github.hauner.openapi.core.processor
 
+import com.github.hauner.openapi.core.test.Sl4jMockRule
 import com.google.common.jimfs.Configuration
 import com.google.common.jimfs.Jimfs
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
+import org.slf4j.Logger
 import spock.lang.Shared
 import spock.lang.Specification
 
@@ -33,6 +35,9 @@ class MappingReaderSpec extends Specification {
     @Rule
     TemporaryFolder folder
 
+    def log = Mock Logger
+    @Rule Sl4jMockRule rule = new Sl4jMockRule(MappingReader, log)
+
     void "ignores empty type mapping" () {
         when:
         def reader = new MappingReader()
@@ -105,4 +110,28 @@ map:
         mapping
     }
 
+    void "warns use of old mapping version key" () {
+        def yaml = """\
+openapi-processor-spring: v2
+"""
+
+        when:
+        new MappingReader().read (yaml)
+
+        then:
+        1 * log.warn (*_)
+    }
+
+    void "warns use of old mapping format" () {
+        def yaml = """\
+openapi-processor-mapping: v1
+"""
+
+        when:
+        new MappingReader().read (yaml)
+
+        then:
+        2 * log.info (*_)
+    }
+
 }