Update findings, add getFindingsData to return

all findings info in the findings array

Author: emiliorizzo

src/Findings.ts

@@ -42,10 +42,16 @@ import {
   MdBlock,
   MdDoc,
   sortBlocks,
-  iterateBlocks
+  iterateBlocks,
+  mdBlockToMd,
+  mdDocToMd
 } from './mdModel'
 import { flipObject, camelCaseToText, toCamelCase } from './utils'
 
+export const FINDING_SECTIONS_PROPS = FINDING_SECTIONS.map((x) =>
+  x.toLowerCase()
+)
+
 export type FindingMetadata = {
   id?: string
   impact: string
@@ -270,12 +276,38 @@ export const reindexFindings = (doc: MdDoc): MdDoc => {
   return doc
 }
 
-export const getFindings = (doc: MdDoc) => {
+const getFindingsArray = (doc: MdDoc) => {
   const findings: any[] = []
   iterateFindings(doc, (f: any) => findings.push(f))
+  return findings
+}
+
+export const getFindings = (doc: MdDoc) => {
+  const findings = getFindingsArray(doc)
   return findings.map(({ metadata }) => metadata)
 }
 
+export const getFindingsData = (doc: MdDoc) => {
+  const findings = getFindingsArray(doc)
+  return findings.map(({ metadata, children }) => {
+    const data = FINDING_SECTIONS_PROPS.reduce(
+      (v: { [key: string]: any }, a) => {
+        v[a] = ''
+        const ch = children.filter(
+          (c: any) => a === c.metadata.title.toLowerCase()
+        )
+        if (ch.length) {
+          ch[0].metadata.hideMdTitle = true
+          v[a] = mdDocToMd(ch)
+        }
+        return v
+      },
+      {}
+    )
+    return { metadata, ...data }
+  })
+}
+
 export const findingListFieds = [ID, TITLE, TOTAL_RISK, FIXED]
 
 export const FINDING_LIST_TITLES = findingFields.reduce(

src/mdModel.ts

@@ -68,7 +68,9 @@ export const mdBlockToMd = (block: MdBlock): string => {
   if (isHeadingType(blockType)) {
     const markup = '#'.repeat(parseInt(blockType.replace('h', '')))
     const title = metadata.title || ''
-    resultMd = [`${markup} ${title}`, '', ...resultMd]
+    resultMd = !metadata.hideMdTitle
+      ? [`${markup} ${title}`, '', ...resultMd]
+      : resultMd
   } else {
     delete metadata.type
     resultMd = [

src/test/findings.test.ts

@@ -15,7 +15,9 @@ import {
   FINDING_MODEL,
   sortFindingFields,
   isAllowedInfoImpact,
-  createFindigsExampleMetadata
+  createFindigsExampleMetadata,
+  getFindingsData,
+  FINDING_SECTIONS_PROPS
 } from '../Findings'
 import {
   ALLOWED_INFO_IMPACT,
@@ -442,4 +444,66 @@ describe('findings', () => {
       expect(findings.length).toBe(total)
     })
   })
+
+  const testFindingData = (finding: any) => {
+    for (const s of ['metadata', ...FINDING_SECTIONS_PROPS]) {
+      it(`should have a ${s} proerty`, () => {
+        expect(finding.hasOwnProperty(s)).toBe(true)
+      })
+    }
+  }
+
+  describe.only('getFindingsData', () => {
+    describe('test finding', () => {
+      const description = 'This is a test..'
+      const recommendation = 'This is a recomendation example'
+      const status = 'Finding STATUS'
+      const fmd = `# TEST
+--- finding
+
+id: xxx-001
+title: Untitled finding
+likelihood: low
+impact: low
+risk: low
+resolution: open
+status: ⚠
+location: test
+fixed: false
+
+#### Description
+
+${description}
+
+#### Recommendation
+
+${recommendation}
+
+#### Status
+
+${status}
+
+/--
+      `
+
+      const props: { [key: string]: any } = {
+        description,
+        recommendation,
+        status
+      }
+      const data: { [key: string]: any } = getFindingsData(MdToObj()(fmd))[0]
+      for (const p in props) {
+        it('should have the section content', () => {
+          expect(data[p]).toContain(props[p])
+        })
+      }
+    })
+
+    describe('example test', () => {
+      const findings = getFindingsData(MdToObj()(example))
+      for (const finding of findings) {
+        testFindingData(finding)
+      }
+    })
+  })
 })