improve(semval): $ref formatting validation (#1656)

* Validate $ref formatting via Swagger-Client $$ref meta patches
* Stop falling back to raw $refs
* Add control test for well-formed remote references

Author: shockey

src/plugins/validate-semantic/validators/refs.js

@@ -1,9 +1,8 @@
 import get from "lodash/get"
 
 export const validateRefHasNoSiblings = () => system => {
-  return Promise.all([
-    system.validateSelectors.all$refArtifacts(),
-  ]).then(([nodes]) => {
+  return system.validateSelectors.all$refArtifacts()
+  .then((nodes) => {
       const immSpecJson = system.specSelectors.specJson()
       const specJson = immSpecJson.toJS ? immSpecJson.toJS() : {}
 
@@ -28,16 +27,9 @@ export const validateRefHasNoSiblings = () => system => {
 
 // Add warnings for unused definitions
 export const validateUnusedDefinitions = () => (system) => {
-  return Promise.all([
-    system.validateSelectors.all$refs(),
-    system.validateSelectors.all$refArtifacts()
-  ]).then(([refs, refArtifacts]) => {
-    const references = (
-      (refs.length ? refs : null)
-      || (refArtifacts.length ? refArtifacts : null)
-      || []
-    ).map(node => node.node)
-
+  return system.validateSelectors.all$refArtifacts()
+  .then((nodes) => {
+    const references = nodes.map(node => node.node)
     const errors = []
 
     system.specSelectors.definitions()
@@ -55,3 +47,29 @@ export const validateUnusedDefinitions = () => (system) => {
     return errors
   })
 }
+
+export const validateRefPathFormatting = () => (system) => {
+  return system.validateSelectors.all$refArtifacts()
+  .then((refArtifacts) => {
+
+    const errors = []
+    refArtifacts.forEach((node) => {
+      const value = node.node
+      if(typeof value === "string") {
+        // eslint-disable-next-line no-unused-vars
+        const [refUrl, refPath] = value.split("#")
+
+        if(!refPath || refPath[0] !== "/") {
+          errors.push({
+            // $ref instead of $$ref
+            path: [...node.path.slice(0, -1), "$ref"],
+            message: "$ref paths must begin with `#/`",
+            level: "error"
+          })
+        }
+      }
+    })
+
+    return errors
+  })
+}

test/plugins/validate-semantic/refs.js

@@ -58,6 +58,54 @@ describe("validation plugin - semantic - refs", function() {
       })
     })
 
+  })
+  describe("Malformed $ref values", () => {
+    it("should return an error when a JSON pointer lacks a leading `#/`", () => {
+      const spec = {
+        paths: {
+          "/CoolPath": {
+            $ref: "#myObj/abc"
+          }
+        },
+        myObj: {
+          abc: {
+            type: "string"
+          }
+        }
+      }
+
+      return validateHelper(spec)
+      .then(system => {
+        const allErrors = system.errSelectors.allErrors().toJS()
+        expect(allErrors.length).toEqual(1)
+        const firstError = allErrors[0]
+        expect(firstError.message).toMatch("$ref paths must begin with `#/`")
+        expect(firstError.level).toEqual("error")
+        expect(firstError.path).toEqual(["paths", "/CoolPath", "$ref"])
+      })
+    })
+
+    it("should return no errors when a JSON pointer is a well-formed remote reference", () => {
+      const spec = {
+        paths: {
+          "/CoolPath": {
+            $ref: "http://google.com#/myObj/abc"
+          }
+        },
+        myObj: {
+          abc: {
+            type: "string"
+          }
+        }
+      }
+
+      return validateHelper(spec)
+      .then(system => {
+        const allErrors = system.errSelectors.allErrors().toJS()
+        expect(allErrors).toEqual([])
+      })
+    })
+
   })
   describe.skip("Refs are restricted in specific areas of a spec", () => {
     describe("Response $refs", () => {