Bumped test libs - setup CI for Sonar coverage (#8)

* Bumped test libs - setup CI for Sonar coverage
* Fixed lint issue
* Updated CI and Deno tasks

.github/workflows/master.yml

@@ -18,19 +18,25 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Deno v1.22.1
+      - name: Setup Deno v1.33.4
         uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.22.1
+          deno-version: v1.33.4
+
+      - name: Setup LCOV        
+        run: sudo apt install -y lcov
 
       - name: Verify formatting
-        run: deno fmt mod.ts src/ --check
+        run: deno task fmt
 
       - name: Run linter
         run: deno lint
 
-      - name: Run tests
-        run: deno test -A --unstable
+      - name: Run tests and coverage
+        run: deno task cover
+
+      - name: Fix LCOV output for SonarCloud        
+        run: sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage/report.lcov
 
       - name: SonarCloud Scan
         uses: sonarsource/sonarcloud-github-action@master

.gitignore

@@ -1,3 +1,4 @@
-*.vscode
 dist
-.scannerwork
+.scannerwork
+coverage
+cov_profile.lcov

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "deno.enable": true,
+  "deno.enablePaths": [],
+  "deno.unstable": true,
+  "[typescript]": {
+      "editor.defaultFormatter": "vscode.typescript-language-features"
+  },
+  "[typescriptreact]": {
+      "editor.defaultFormatter": "denoland.vscode-deno"
+  }
+}

deno.jsonc

@@ -0,0 +1,9 @@
+{
+  "tasks": {
+    "fmt": "deno fmt mod.ts src/ --check",
+    "test": "deno test --unstable --allow-read --allow-net --coverage=coverage",
+    "lcov": "deno coverage coverage --lcov --output=coverage/report.lcov",
+    "cover": "deno task clean && deno task test && deno task lcov && genhtml -o coverage/html coverage/report.lcov",
+    "clean": "rm -rf ./npm ./coverage"
+  }
+}

sonar-project.properties

@@ -1,10 +1,14 @@
 sonar.projectKey=petruki_skimming
 sonar.projectName=skimming
 sonar.organization=petruki
+sonar.projectVersion=1.0.9
+
+sonar.javascript.lcov.reportPaths=coverage/report.lcov
 
 sonar.sources=src
 sonar.tests=test
 sonar.language=typescript
+sonar.exclusions=example/**
 
 sonar.dynamicAnalysis=reuseReports
 # Encoding of the source code. Default is default system encoding

src/lib/cache.ts

@@ -27,24 +27,12 @@ export default class CacheHandler {
   ): Output[] {
     const { ignoreCase, previewLength, trimContent } = options;
 
-    const result = this.cache.filter((storedData) => {
-      if (storedData.query.length <= query.length) {
-        if (ignoreCase) {
-          if (!query.toLowerCase().startsWith(storedData.query.toLowerCase())) {
-            return false;
-          }
-        }
-
-        if (query.startsWith(storedData.query) && storedData.exp > Date.now()) {
-          return !this.checkOptions(storedData, {
-            previewLength,
-            ignoreCase,
-            trimContent,
-          });
-        }
-      }
-      return false;
-    });
+    const result = this.fetchCache(
+      query,
+      ignoreCase,
+      previewLength,
+      trimContent,
+    );
 
     if (result.length) {
       const cachedResult = result[0];
@@ -68,6 +56,9 @@ export default class CacheHandler {
     return [];
   }
 
+  /**
+   * Stores result in memory
+   */
   store(
     query: string,
     output: Output,
@@ -107,6 +98,41 @@ export default class CacheHandler {
     }
   }
 
+  /**
+   * Fetches cache based on query input and options provided
+   *
+   * @param query
+   * @param ignoreCase
+   * @param previewLength
+   * @param trimContent
+   * @returns
+   */
+  private fetchCache(
+    query: string,
+    ignoreCase: boolean | undefined,
+    previewLength: number | undefined,
+    trimContent: boolean | undefined,
+  ) {
+    return this.cache.filter((storedData) => {
+      if (storedData.query.length <= query.length) {
+        if (ignoreCase) {
+          if (!query.toLowerCase().startsWith(storedData.query.toLowerCase())) {
+            return false;
+          }
+        }
+
+        if (query.startsWith(storedData.query) && storedData.exp > Date.now()) {
+          return !this.checkOptions(storedData, {
+            previewLength,
+            ignoreCase,
+            trimContent,
+          });
+        }
+      }
+      return false;
+    });
+  }
+
   /**
    * Verifies if options has been changed, if so it will gather the content from the source again
    *

src/skimming.ts

@@ -155,7 +155,7 @@ export class Skimming {
    */
   private async readDocument(url: string, doc: string): Promise<string> {
     const result = await fetch(`${url}${doc}`);
-    if (result != null && result.body != null) {
+    if (result?.body != null) {
       if (result.status === 200) {
         return await result.text().then((data: string) => {
           return data;

test/cache_test.ts

@@ -1,4 +1,4 @@
-import { assertEquals } from "https://deno.land/[email protected]/testing/asserts.ts";
+import { assertEquals } from "./deps.ts";
 import CacheHandle from "../src/lib/cache.ts";
 
 const { test } = Deno;

test/deps.ts

@@ -0,0 +1,5 @@
+export {
+    assertEquals,
+    assertNotEquals,
+    assertThrows,
+  } from "https://deno.land/[email protected]/testing/asserts.ts";

test/mod_test.ts

@@ -2,7 +2,7 @@ import {
   assertEquals,
   assertNotEquals,
   assertThrows,
-} from "https://deno.land/[email protected]/testing/asserts.ts";
+} from "./deps.ts";
 import { Context, Skimming } from "../mod.ts";
 import { InvalidContext } from "../src/lib/exceptions.ts";