@fabasoad/sarif-to-slack 0.2.5 → 1.1.0

package/src/utils/ExtendedArray.ts

@@ -0,0 +1,11 @@
+/**
+ * This class is an extension for the {@link Array} class. It adds some additional
+ * useful methods.
+ * @internal
+ */
+export default class ExtendedArray<T> extends Array<T> {
+
+  public findByProperty<K extends keyof T>(prop: K, value: T[K]): T | undefined {
+    return this.find((v: T): boolean => v[prop] === value)
+  }
+}

package/src/utils/FileUtils.ts

@@ -0,0 +1,60 @@
+import fs from 'fs'
+import Logger from '../Logger'
+import { SarifFileExtension, SarifOptions } from '../types'
+import * as path from 'path'
+
+/**
+ * Traverse directory recursively and returns list of files with the requested
+ * extension.
+ * @param dir A root directory. Starting point.
+ * @param extension An instance of {@link SarifFileExtension} type.
+ * @param fileList Collected list of files.
+ * @private
+ */
+function listFilesRecursively(
+  dir: string,
+  extension: SarifFileExtension,
+  fileList: string[] = []
+): string[] {
+  const entries: string[] = fs.readdirSync(dir)
+  entries.forEach((entry: string): void => {
+    const fullPath: string = path.join(dir, entry)
+    if (fs.statSync(fullPath).isDirectory()) {
+      listFilesRecursively(fullPath, extension, fileList)
+    } else if (path.extname(fullPath).toLowerCase() === `.${extension}`) {
+      fileList.push(fullPath)
+    }
+  })
+  return fileList
+}
+
+/**
+ * Extract list of files based on the parameters from the given {@link SarifOptions}
+ * object.
+ * @param opts An instance of {@link SarifOptions} type.
+ * @internal
+ */
+export function extractListOfFiles(opts: SarifOptions): string[] {
+  if (!fs.existsSync(opts.path)) {
+    throw new Error(`Provided path does not exist: ${opts.path}`)
+  }
+
+  const stats: fs.Stats = fs.statSync(opts.path)
+
+  if (stats.isDirectory()) {
+    Logger.info(`Provided path is a directory: ${opts.path}`)
+    const files: string[] = opts.recursive
+      && listFilesRecursively(opts.path, opts.extension ?? 'sarif')
+      || fs.readdirSync(opts.path)
+    Logger.info(`Found ${files.length} files in ${opts.path} directory with ${opts.extension} extension`)
+    Logger.debug(`Found files: ${files.join(', ')}`)
+    return files
+  }
+
+  if (stats.isFile()) {
+    Logger.info(`Provided path is a file: ${opts.path}`)
+    return [opts.path]
+  }
+
+  throw new Error(`Provided path is neither a file nor a directory: ${opts.path}`)
+}

package/src/utils/SarifUtils.ts

@@ -1,87 +1,35 @@
-import type { ReportingDescriptor, Result, Run, ToolComponent } from "sarif";
+import type { Result, Run, ToolComponent } from 'sarif'
 
 /**
- * This function finds the respective tool for the given result.
- * @param run An instance of {@link Run} object.
- * @param result An instance of {@link Result} object.
- * @private
+ * Returns {@link ToolComponent} instance for the given {@link Run}. It does not
+ * count extensions but returns {@link ToolComponent} directly from "run.tool.driver",
+ * despite the fact if extension exists or not.
+ * @internal
  */
-function findToolComponentByResult(run: Run, result: Result): ToolComponent {
-  let tool: ToolComponent | undefined
-  if (result.rule?.toolComponent?.index != null) {
-    tool = run.tool.extensions?.[result.rule.toolComponent.index]
-  }
-
-  if (!tool) {
-    tool = run.tool.driver
-  }
-
-  return tool
+export function findToolComponentDriver(run: Run): ToolComponent {
+  return run.tool.driver
 }
 
 /**
- * This function tries to find the respective rule for the given result.
- * @param run An instance of {@link Run} object.
- * @param result An instance of {@link Result} object.
+ * Returns {@link ToolComponent} instance for the given {@link Run} from the extensions
+ * list if applicable. Returns {@linkcode undefined} if provided {@link Result}
+ * does not link to extension.
  * @internal
  */
-export function findRuleByResult(run: Run, result: Result): ReportingDescriptor | undefined {
-  const ruleData: { id?: string, index?: number } = {}
-
-  if (result.rule) {
-    if (result.rule?.index != null) {
-      ruleData.index = result.rule.index
-    }
-    if (result.rule?.id) {
-      ruleData.id = result.rule.id
-    }
-  }
-
-  if (ruleData.index == null && result.ruleIndex != null) {
-    ruleData.index = result.ruleIndex
-  }
-
-  if (!ruleData.id && result.ruleId) {
-    ruleData.id = result.ruleId
-  }
-
-  const tool: ToolComponent = findToolComponentByResult(run, result)
-
-  if (ruleData.index != null
-    && tool?.rules
-    && ruleData.index < tool.rules.length) {
-    return tool.rules[ruleData.index]
-  }
-
-  // If failed to find rule by index then try to find by ruleId
-  if (ruleData.id && tool?.rules) {
-    return tool.rules.find(
-      (r: ReportingDescriptor): boolean => r.id === ruleData.id
-    )
+export function tryFindToolComponentExtension(run: Run, result: Result): ToolComponent | undefined {
+  let tool: ToolComponent | undefined
+  if (result.rule?.toolComponent?.index != null) {
+    tool = run.tool.extensions?.[result.rule.toolComponent.index]
   }
-
-  return undefined
+  return tool
 }
 
 /**
- * Allowed property names that we can search for from the rule.
+ * It tries to find respective {@link ToolComponent} from the {@link Result}. At
+ * first, it tries to find it in the list of extensions if applicable, otherwise
+ * it gets it directly from "run.tool.driver".
  * @internal
  */
-export type RuleProperty = 'security-severity' | 'problem.severity'
-
-/**
- * This function searches respective rule for the given result, and then gets
- * the property of interest from it.
- * @param run An instance of {@link Run} object.
- * @param result An instance of {@link Result} object.
- * @param propertyName The property name that you want to get the value from.
- * @internal
- */
-export function tryGetRulePropertyByResult<T>(run: Run, result: Result, propertyName: RuleProperty): T | undefined {
-  const rule: ReportingDescriptor | undefined = findRuleByResult(run, result)
-  if (rule && rule.properties && propertyName in rule.properties) {
-    return rule.properties[propertyName] as T
-  }
-
-  return undefined
+export function findToolComponent(run: Run, result: Result): ToolComponent {
+  return tryFindToolComponentExtension(run, result) ?? findToolComponentDriver(run)
 }