Package com.tnsai.quality.security.harness

Class FileSystemPipelineStateStore

java.lang.Object

com.tnsai.quality.security.harness.FileSystemPipelineStateStore

All Implemented Interfaces:

PipelineStateStore

public final class FileSystemPipelineStateStore
extends Object
implements PipelineStateStore

Disk-backed PipelineStateStore (TNS-291 phase 2).

Lays out state as:

 <baseDir>/<projectId>/
 ├── project.json
 ├── files/<path-hash>.json     # one FileRecord per source file
 ├── runs/<run-id>.json         # one entry per stage execution
 └── reports/<name>             # exporter outputs
 

Idempotency / crash-safety:

• Writes go to <target>.tmp then Files.move(ATOMIC_MOVE) — a partially written file never replaces a good one.
• Per-path ReentrantLock serialises concurrent writers for the same FileRecord (run-log writes hold a single store-wide lock).
• The file name is the SHA-256 of the relative path; same path = same file regardless of OS-specific encoding quirks.

Since:

0.10.0 (TNS-291)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tnsai.quality.security.harness.PipelineStateStore

PipelineStateStore.RunMetadata

Constructor Summary

Constructors

Constructor	Description
FileSystemPipelineStateStore(Path baseDir)

Method Summary

Modifier and Type	Method	Description
void	appendRun(PipelineStateStore.RunMetadata run)	Append a stage-execution entry to the run log.
Optional<FileRecord>	getFile(Path path)	Look up a record by its relative path.
void	initProject(String projectId, Path projectRoot)	Initialise (or open) project state under projectId.
List<FileRecord>	listFiles()	All records currently stored for the project, in deterministic order.
List<PipelineStateStore.RunMetadata>	listRuns(String stage)	All run-log entries for stage, oldest first.
Path	projectDir()	Visible for tests — points at this store's project directory.
void	saveFile(FileRecord record)	Persist a FileRecord for the file at record.path().
void	writeReport(String name, byte[] content)	Write a binary report (findings.sarif, findings.md, …) under reports/.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileSystemPipelineStateStore

public FileSystemPipelineStateStore(Path baseDir)

Parameters:

baseDir - directory under which <projectId>/... layouts are created. Created lazily on initProject(java.lang.String, java.nio.file.Path).

Method Details

initProject

public void initProject(String projectId,
 Path projectRoot)

Description copied from interface: PipelineStateStore

Initialise (or open) project state under projectId. Creates the disk layout if missing; idempotent.

Specified by:

initProject in interface PipelineStateStore

saveFile

public void saveFile(FileRecord record)

Description copied from interface: PipelineStateStore

Persist a FileRecord for the file at record.path(). Subsequent reads return this record until the next write.

Specified by:

saveFile in interface PipelineStateStore

getFile

public Optional<FileRecord> getFile(Path path)

Description copied from interface: PipelineStateStore

Look up a record by its relative path.

Specified by:

getFile in interface PipelineStateStore

listFiles

public List<FileRecord> listFiles()

Description copied from interface: PipelineStateStore

All records currently stored for the project, in deterministic order.

Specified by:

listFiles in interface PipelineStateStore

appendRun

public void appendRun(PipelineStateStore.RunMetadata run)

Description copied from interface: PipelineStateStore

Append a stage-execution entry to the run log. Used by stages to record their StageResult for the report stage.

Specified by:

appendRun in interface PipelineStateStore

listRuns

public List<PipelineStateStore.RunMetadata> listRuns(String stage)

Description copied from interface: PipelineStateStore

All run-log entries for stage, oldest first.

Specified by:

listRuns in interface PipelineStateStore

writeReport

public void writeReport(String name,
 byte[] content)

Description copied from interface: PipelineStateStore

Write a binary report (findings.sarif, findings.md, …) under reports/. Overwrites any existing file with the same name.

Specified by:

writeReport in interface PipelineStateStore

projectDir

public Path projectDir()

Visible for tests — points at this store's project directory.