Add Types for JaCoCo XML object (#95)

* Adding type information to the parsed XML obj

* Refactoring convertObjToReport

* Rename jacoco-types file

* Removing nonNull function

* Adding Unit Tests

* Fix parser to not return NaN

* Remove redundant number parsing

__tests__/__fixtures__/reports/empty.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Empty Report"/>

__tests__/__fixtures__/reports/group/empty_group.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Empty Group">
+    <group name="Group1" />
+</report>

__tests__/__fixtures__/reports/group/group_with_counter.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Group with Counter">
+    <group name="Group1"><counter type="INSTRUCTION" missed="1" covered="2"/></group>
+</report>

__tests__/__fixtures__/reports/group/group_with_empty_package.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Group with empty Package">
+    <group name="Group1">
+        <package name="Package1" />
+    </group>
+</report>

__tests__/__fixtures__/reports/group/group_with_group.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Group with Group">
+    <group name="Group1">
+        <group name="Group2">
+            <counter type="INSTRUCTION" missed="1" covered="2"/>
+        </group>
+    </group>
+</report>

__tests__/__fixtures__/reports/group/group_with_package.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Group with Package">
+    <group name="Group1">
+        <package name="Package1">
+            <counter type="INSTRUCTION" missed="1" covered="2"/>
+        </package>
+    </group>
+</report>

__tests__/__fixtures__/reports/only_counter.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Counter">
+    <counter type="INSTRUCTION" missed="1" covered="2"/>
+</report>

__tests__/__fixtures__/reports/only_session.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Session">
+    <sessioninfo id="session1" start="1620000000" dump="1620003600"/>
+</report>

__tests__/__fixtures__/reports/package/class/class_with_counter.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Class with Counter">
+    <package name="com.example.package1">
+        <class name="com.example.package1.ExampleClass1">
+            <counter type="INSTRUCTION" missed="1" covered="2"/>
+        </class>
+    </package>
+</report>

__tests__/__fixtures__/reports/package/class/empty_class.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Empty Class">
+    <package name="com.example.package1">
+        <class name="com.example.package1.ExampleClass1"/>
+        <class name="com.example.package1.ExampleClass2" sourcefilename="ExampleClass2.kt"/>
+    </package>
+</report>

__tests__/__fixtures__/reports/package/class/only_method.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Method">
+    <package name="com.example.package1">
+        <class name="com.example.package1.ExampleClass1">
+            <method name="exampleMethod1" desc="()V"/>
+            <method name="&lt;init&gt;" desc="()V" line="3"/>
+            <method name="validate" desc="(Ljava/lang/String;)Z" line="8">
+                <counter covered="1" missed="2" type="INSTRUCTION" />
+                <counter covered="3" missed="4" type="LINE" />
+            </method>
+        </class>
+    </package>
+</report>

__tests__/__fixtures__/reports/package/empty_package.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Empty Package">
+    <package name="com.example.package1"/>
+</report>

__tests__/__fixtures__/reports/package/package_with_counter.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Package with Counter">
+    <package name="com.example.package1">
+        <counter type="INSTRUCTION" missed="1" covered="2"/>
+    </package>
+</report>

__tests__/__fixtures__/reports/package/sourcefile/empty_sourcefile.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Empty SourceFile">
+    <package name="com.example.package1">
+        <sourcefile name="ExampleFile1.java"/>
+    </package>
+</report>

__tests__/__fixtures__/reports/package/sourcefile/only_line.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only Line">
+    <package name="com.example.package1">
+        <sourcefile name="ExampleFile1.java">
+            <line nr="10"/>
+            <line nr="18" mi="1"/>
+            <line nr="18" mi="1" ci="2"/>
+            <line nr="18" mi="1" ci="2" mb="3"/>
+            <line nr="18" mi="1" ci="2" mb="3" cb="4"/>
+        </sourcefile>
+    </package>
+</report>

__tests__/__fixtures__/reports/package/sourcefile/sourcefile_with_counter.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="Only SourceFile with Counter">
+    <package name="com.example.package1">
+        <sourcefile name="ExampleFile1.java">
+            <counter type="INSTRUCTION" missed="1" covered="2"/>
+        </sourcefile>
+    </package>
+</report>

__tests__/process.test.ts

@@ -1,8 +1,9 @@
 import fs from 'fs'
-import parser from 'xml2js'
 import * as process from '../src/process'
 import {CHANGED_FILE, PROJECT} from './mocks.test'
 import {ChangedFile} from '../src/models/github'
+import {Report} from '../src/models/jacoco-types'
+import {parseToReport} from '../src/util'
 
 describe('process', function () {
   describe('get file coverage', function () {
@@ -400,14 +401,13 @@ describe('process', function () {
   })
 })
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
-async function getAggregateReport(): Promise<any[]> {
+async function getAggregateReport(): Promise<Report[]> {
   const reportPath = './__tests__/__fixtures__/aggregate-report.xml'
   const report = await getReport(reportPath)
   return [report]
 }
 
-async function getMultipleReports(): Promise<any[]> {
+async function getMultipleReports(): Promise<Report[]> {
   const testFolder = './__tests__/__fixtures__/multi_module'
   return Promise.all(
     fs.readdirSync(testFolder).map(async file => {
@@ -417,14 +417,13 @@ async function getMultipleReports(): Promise<any[]> {
   )
 }
 
-async function getSingleReport(): Promise<any[]> {
+async function getSingleReport(): Promise<Report[]> {
   const reportPath = './__tests__/__fixtures__/report.xml'
   const report = await getReport(reportPath)
   return [report]
 }
 
-async function getReport(path: string): Promise<any[]> {
+async function getReport(path: string): Promise<Report> {
   const reportXml = await fs.promises.readFile(path, 'utf-8')
-  const json = await parser.parseStringPromise(reportXml)
-  return json['report']
+  return parseToReport(reportXml)
 }

__tests__/util.test.ts

@@ -1,6 +1,7 @@
 import * as util from '../src/util'
 import * as fs from 'fs'
-import parser from 'xml2js'
+import {Report} from '../src/models/jacoco-types'
+import {parseToReport} from '../src/util'
 
 jest.mock('@actions/core')
 jest.mock('@actions/github')
@@ -56,7 +57,7 @@ describe('Util', function () {
   describe('getFilesWithCoverage', function () {
     it('should return valid output', async function () {
       const reports = await getSingleReport()
-      const packages = reports[0]['package']
+      const packages = reports[0]['package'] ?? []
       const files = util.getFilesWithCoverage(packages)
       expect(files).toEqual([
         {
@@ -239,15 +240,13 @@ describe('Util', function () {
   })
 })
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
-async function getSingleReport(): Promise<any[]> {
+async function getSingleReport(): Promise<Report[]> {
   const reportPath = './__tests__/__fixtures__/report.xml'
   const report = await getReport(reportPath)
   return [report]
 }
 
-async function getReport(path: string): Promise<any[]> {
+async function getReport(path: string): Promise<Report> {
   const reportXml = await fs.promises.readFile(path, 'utf-8')
-  const json = await parser.parseStringPromise(reportXml)
-  return json['report']
+  return parseToReport(reportXml)
 }