# core/adapters/tool.brakeman.adapter.ts

> 30 lines of code and 9 definitions.

Tree: GovLab Quality
Language: typescript
Layer: infrastructure
Canonical: https://banes-lab.com/anatomy/quality#file-quality-core-adapters-tool-brakeman-adapter-ts
Source text: https://banes-lab.com/source/quality/core/adapters/tool.brakeman.adapter.ts.txt

Listed in [core/adapters](https://banes-lab.com/api/source/quality/core/adapters.md), after [core/adapters/tool.bandit.adapter.ts](https://banes-lab.com/source/quality/core/adapters/tool.bandit.adapter.ts.md) and before [core/adapters/tool.checkov.adapter.ts](https://banes-lab.com/source/quality/core/adapters/tool.checkov.adapter.ts.md).

## Definitions

- `runBrakeman` (lexical_declaration, line 21)
- `TOOL` (lexical_declaration, line 12)
- `NO_WARNINGS_EXIT` (lexical_declaration, line 13)
- `OK_STATUSES` (lexical_declaration, line 14)
- `NOT_RAILS_NOTICE` (lexical_declaration, line 15)
- `isRailsless` (lexical_declaration, line 17)
- `advisory` (lexical_declaration, line 22)
- `emptyFailure` (lexical_declaration, line 23)
- `spec` (lexical_declaration, line 24)

## Contained in

- [core/adapters](https://banes-lab.com/anatomy/quality/folder-quality-core-adapters.md)

## Uses

- [core/adapters/tool.adapter.ts](https://banes-lab.com/source/quality/core/adapters/tool.adapter.ts.md)
- [core/resolvers/scope.resolver.ts](https://banes-lab.com/source/quality/core/resolvers/scope.resolver.ts.md)

## Linked from

- [core/adapters](https://banes-lab.com/anatomy/quality/folder-quality-core-adapters.md)
- [core/resolvers](https://banes-lab.com/anatomy/quality/folder-quality-core-resolvers.md)

## Source

```typescript
import type { RunnerContext, ScanSpec, ToolSpawn } from "#types/tool.types";
import { passTool, scanTargets } from "#core/adapters/tool.adapter";
import type { RunResult } from "#types/finding.types";
import { defineTool } from "#core/registries/tool.registry";
import { failedWhenEmpty } from "#core/classifiers/invocation.classifier";
import { installHint } from "#configuration/strings/tool.strings";
import { parseBrakemanOutput } from "#core/parsers/tool.brakeman.parser";
import { scopeTargets } from "#core/resolvers/scope.resolver";
import { toolAdvisory } from "#core/factories/tool.factory";
import { toolError } from "#core/factories/finding.factory";

const TOOL = "brakeman";
const NO_WARNINGS_EXIT = 3;
const OK_STATUSES: ReadonlySet<number> = new Set([0, NO_WARNINGS_EXIT]);
const NOT_RAILS_NOTICE = "supply the path to a Rails application";

const isRailsless = function isRailsless(result: ToolSpawn): boolean {
    return `${result.stdout}${result.stderr}`.includes(NOT_RAILS_NOTICE);
};

const runBrakeman = function runBrakeman(context: RunnerContext): RunResult {
    const advisory = toolAdvisory(context, TOOL, installHint(TOOL));
    const emptyFailure = failedWhenEmpty(OK_STATUSES);
    const spec: ScanSpec = {
        failed: (result, findings) => !isRailsless(result) && emptyFailure(result, findings),
        failure: (exit) => toolError(advisory, exit),
        parse: (result) => (isRailsless(result) ? [] : parseBrakemanOutput(result.stdout, context.ecosystem)),
    };
    return scanTargets(scopeTargets(context.root, context.paths), (target) =>
        passTool(advisory, { args: ["-f", "json", "-q", target], bin: TOOL, cwd: context.root }, spec),
    );
};

defineTool({ ecosystems: ["ruby"], run: runBrakeman, tool: TOOL });
```