Also search in step datatable

Author: vincent-psarga

react/javascript/src/search/StepSearch.ts

@@ -5,14 +5,16 @@ interface SearchableStep {
   id: string
   keyword: string
   text: string
-  docstring?: string
+  docString?: string
+  dataTable?: string
 }
 
 export default class StepSearch {
   private readonly index = elasticlunr<SearchableStep>((ctx) => {
     ctx.addField('keyword')
     ctx.addField('text')
-    ctx.addField('docstring')
+    ctx.addField('docString')
+    ctx.addField('dataTable')
     ctx.setRef('id')
     ctx.saveDocument(true)
   })
@@ -23,7 +25,8 @@ export default class StepSearch {
       id: step.id,
       keyword: step.keyword,
       text: step.text,
-      docstring: this.docstringToString(step),
+      docString: this.docStringToString(step),
+      dataTable: this.dataTableToString(step),
     }
 
     this.index.addDoc(doc)
@@ -35,16 +38,27 @@ export default class StepSearch {
       fields: {
         keyword: { bool: 'OR', expand: true, boost: 1 },
         text: { bool: 'OR', expand: true, boost: 2 },
-        docstring: { bool: 'OR', expand: true, boost: 1 },
+        docString: { bool: 'OR', expand: true, boost: 1 },
+        dataTable: { bool: 'OR', expand: true, boost: 1 },
       },
     })
 
     return results.map((result) => this.stepById.get(result.ref))
   }
 
-  private docstringToString(
+  private docStringToString(
     step: messages.GherkinDocument.Feature.IStep
   ): string {
     return step.docString ? step.docString.content : ''
   }
+
+  private dataTableToString(
+    step: messages.GherkinDocument.Feature.IStep
+  ): string {
+    return step.dataTable
+      ? step.dataTable.rows
+          .map((row) => row.cells.map((cell) => cell.value).join(' '))
+          .join(' ')
+      : undefined
+  }
 }

react/javascript/test/search/StepSearchTest.ts

@@ -13,7 +13,11 @@ describe('StepSearch', () => {
     steps = [
       makeStep('Given', 'a passed step', 'There is a docstring here'),
       makeStep('When', 'another passed step'),
-      makeStep('Then', 'a failed step'),
+      makeStep('Then', 'a failed step', '', [
+        ['name', 'value'],
+        ['errorType', 'NullPointerException'],
+        ['message', 'Something really bad hapenned here'],
+      ]),
     ]
 
     for (const step of steps) {
@@ -55,5 +59,10 @@ describe('StepSearch', () => {
       const searchResults = stepSearch.search('docstring')
       assert.deepStrictEqual(searchResults, [steps[0]])
     })
+
+    it('returns step which datatable matches the query', () => {
+      const searchResults = stepSearch.search('NullPointerException')
+      assert.deepStrictEqual(searchResults, [steps[2]])
+    })
   })
 })

react/javascript/test/search/utils.ts

@@ -53,20 +53,36 @@ function makeScenario(
 function makeStep(
   keyword: string,
   text: string,
-  docstring = ''
+  docstring = '',
+  datatable: ReadonlyArray<ReadonlyArray<string>> = []
 ): messages.GherkinDocument.Feature.IStep {
   const idGenerator = IdGenerator.uuid()
   const docStringParam = docstring
     ? messages.GherkinDocument.Feature.Step.DocString.create({
         content: docstring,
       })
     : undefined
+  const datatableParam =
+    datatable.length > 0
+      ? messages.GherkinDocument.Feature.Step.DataTable.create({
+          rows: datatable.map((row) =>
+            messages.GherkinDocument.Feature.TableRow.create({
+              cells: row.map((cell) =>
+                messages.GherkinDocument.Feature.TableRow.TableCell.create({
+                  value: cell,
+                })
+              ),
+            })
+          ),
+        })
+      : undefined
 
   return messages.GherkinDocument.Feature.Step.create({
     id: idGenerator(),
     keyword: keyword,
     text: text,
     docString: docStringParam,
+    dataTable: datatableParam,
   })
 }