TestimoX

API Reference

Class

AuditPackageLayout

Edit on GitHub
Namespace TestimoX.AuditPackages.Serialization
Assembly TestimoX
Source TestimoX/AuditPackages/Serialization/AuditPackageLayout.cs:65
Modifiers static

Defines the canonical on-disk layout for audit packages.

Inheritance

  • Object
  • AuditPackageLayout

Methods

public static String GetPath(String rootDirectory, String relativePath) #
TestimoX/AuditPackages/Serialization/AuditPackageLayout.cs:65
Returns: String

Returns the absolute path to a package file.

Parameters

rootDirectory System.String requiredposition: 0
Package root directory.
relativePath System.String requiredposition: 1
Relative package path.

Returns

The absolute file path.

public static String GetRuleResultPath(String rootDirectory, String ruleId, String resultId) #
TestimoX/AuditPackages/Serialization/AuditPackageLayout.cs:79
Returns: String

Returns the absolute path for a per-rule result file.

Parameters

rootDirectory System.String requiredposition: 0
Package root directory.
ruleId System.String requiredposition: 1
Rule identifier.
resultId System.String requiredposition: 2
Per-execution result identifier.

Returns

The absolute file path.

Fields

public const String PackageManifestRelativePath #

Gets the relative path of the package manifest file.

Value: package.manifest.json
public const String RunManifestRelativePath #

Gets the relative path of the run manifest file.

Value: run/run.manifest.json
public const String EnvironmentRelativePath #

Gets the relative path of the environment document.

Value: run/environment.json
public const String SelectionRelativePath #

Gets the relative path of the selection document.

Value: run/selection.json
public const String RuleCatalogRelativePath #

Gets the relative path of the rule catalog document.

Value: run/rule-catalog.json
public const String SummaryRelativePath #

Gets the relative path of the summary document.

Value: results/summary.json
public const String AssessmentAreasRelativePath #

Gets the relative path of the assessment area summary document.

Value: results/assessment-areas.json
public const String ChecksumsRelativePath #

Gets the relative path of the checksums document.

Value: integrity/checksums.json
public const String RuleResultsDirectoryRelativePath #

Gets the relative directory for per-rule result documents.

Value: results/rules