taptrail
Pure MoonBit TAP13 parser, CI validation gate, and Markdown/JSON report renderer.
tap
tap13
test-report
ci
parser
markdown
moon add MX-ai-nb/taptrail@0.3.0
Download zipAuthor
Version
0.3.0
License
MIT
Repository
Last updated
3 hours ago
Downloads
10
README#TapAnnotation
pub(all) struct TapAnnotation {
suite : String
path : String
line : Int
end_line : Int
column : Int
level : TapAnnotationLevel
code : String
title : String
message : String
remediation : String
} derive(Eq, Debug)One issue annotation that can be rendered for CI systems.
#TapAnnotationLevel
Output level for CI annotations.
#TapArtifact
A simple named text artifact such as Markdown, JSON, XML, or properties.
#TapDiagnostic
A diagnostic comment line.
#TapDirective
A TAP directive attached to a test point.
#TapDocument
pub(all) struct TapDocument {
has_version : Bool
version : String
has_plan : Bool
plan_start : Int
plan_end : Int
points : Array[TapPoint]
diagnostics : Array[TapDiagnostic]
yaml_blocks : Array[TapYamlBlock]
bailed_out : Bool
bailout_reason : String
parse_issues : Array[TapIssue]
} derive(Eq, Debug)Parsed TAP stream with non-fatal parser issues.
#TapIssue
A parser or validation issue.
#TapIssueMeta
pub(all) struct TapIssueMeta {
code : String
severity : TapSeverity
category : String
title : String
remediation : String
} derive(Eq, Debug)Stable metadata for one known TapTrail issue code.
#TapNamedInput
A named TAP input stream for suite-level reporting.
#TapNamedReport
A parsed and validated named TAP stream.
#TapPoint
pub(all) struct TapPoint {
line : Int
number : Int
ok : Bool
name : String
directive : TapDirective
raw : String
} derive(Eq, Debug)One parsed TAP test point.
#TapPolicy
pub(all) struct TapPolicy {
name : String
require_version : Bool
require_plan : Bool
require_plan_match : Bool
require_monotonic_numbers : Bool
require_numbered_points : Bool
allow_bailout : Bool
allow_unknown_lines : Bool
allow_todo : Bool
allow_skip : Bool
max_failures : Int
max_parse_issues : Int
min_total : Int
min_passed : Int
} derive(Eq, Debug)A configurable CI policy for TAP reports.
#TapPolicyResult
Result of applying a policy to a report.
#TapProjectEvidence
pub(all) struct TapProjectEvidence {
package_name : String
version : String
repository : String
license : String
readme_present : Bool
readme_has_usage : Bool
readme_has_features : Bool
ci_configured : Bool
examples : Int
test_cases : Int
build_ok : Bool
mooncakes_published : Bool
mooncakes_version : String
mooncakes_build_ok : Bool
commit_count : Int
total_moonbit_lines : Int
effective_moonbit_lines : Int
has_changelog : Bool
has_design_doc : Bool
has_provenance_doc : Bool
has_acceptance_checklist : Bool
clean_tree : Bool
} derive(Eq, Debug)Evidence supplied by a project, script, or human review.
#TapReadinessCheck
pub(all) struct TapReadinessCheck {
id : String
category : String
title : String
required : Bool
passed : Bool
score : Int
max_score : Int
risk : TapReadinessRisk
evidence : String
remediation : String
} derive(Eq, Debug)One scored acceptance or release readiness check.
#TapReadinessLevel
High-level acceptance state for release and contest submission reviews.
#TapReadinessReport
pub(all) struct TapReadinessReport {
project : String
suite : TapSuiteReport
policy : TapPolicyResult
evidence : TapProjectEvidence
checks : Array[TapReadinessCheck]
score : Int
level : TapReadinessLevel
ok : Bool
} derive(Eq, Debug)Complete readiness report composed from TAP data and repository evidence.
#TapReadinessRisk
Risk level attached to one readiness check.
#TapReport
pub(all) struct TapReport {
document : TapDocument
summary : TapSummary
issues : Array[TapIssue]
ok : Bool
} derive(Eq, Debug)A validation report ready for CI gates and release notes.
#TapRunRecord
A timestamped TAP report record for trend analysis.
#TapSeverity
Severity used by CI policy checks and human-facing audit output.
#TapSeverityCounts
Aggregated issue counts by severity.
#TapSuiteReport
pub(all) struct TapSuiteReport {
name : String
reports : Array[TapNamedReport]
summary : TapSuiteSummary
ok : Bool
} derive(Eq, Debug)A CI-friendly suite report built from many TAP streams.
#TapSuiteSummary
Aggregate counters for a collection of named reports.
#TapSummary
Aggregate counts for one TAP stream.
#TapSummaryDelta
Difference between two TAP summaries.
#TapTrendKind
Trend classification for release notes.
#TapTrendReport
pub(all) struct TapTrendReport {
before : TapRunRecord
after : TapRunRecord
delta : TapSummaryDelta
kind : TapTrendKind
notes : Array[String]
} derive(Eq, Debug)Comparison between two records.
#TapYamlBlock
A YAMLish TAP diagnostic block.
#annotation_for_issue
Convert a report issue to an annotation.
#annotation_level_for_severity
Map issue severity to annotation level.
#annotation_level_label
Human-readable annotation level label.
#annotations_to_github_commands
Render annotations as GitHub workflow command lines.
#annotations_to_json
Render annotations as a compact JSON array.
#annotations_to_markdown
Render annotations as Markdown.
#audit_policy
Policy for exploratory runs where diagnostics are useful but failures should
still be visible.
#best_run
Return the best health-score record.
#blocking_readiness_checks
Return failed required checks.
#build_suite_report
Build a suite report from named reports.
#classify_trend
Classify a summary delta into a compact trend kind.
#code_scale_is_meaningful
Return true when source scale is meaningful even if still below reference.
#code_scale_matches_reference
Return true when the code scale is close to the contest reference range.
#compare_runs
Compare two timestamped records.
#compare_summaries
Compare two report summaries.
#count_blocking_failures
Count non-TODO failing test points.
#count_issue_severities
Count report issues by severity.
#count_parse_issues
Count parse issues before semantic validation issues are added.
#count_skip_points
Count test points with SKIP directives.
#count_todo_points
Count test points with TODO directives.
#count_unnumbered_points
Count test points without explicit test numbers.
#empty_project_evidence
Construct an empty evidence object for tests or incremental tools.
#evaluate_policy
Evaluate one report with a named policy.
#evaluate_suite_policy
Apply a policy to every suite member and aggregate the result.
#failed_readiness_checks
Return failed checks, including optional recommendations.
#failed_runs
Return records whose report failed validation.
#failing_reports
Return all failing reports.
#first_failing_report
Return the first failing report, if any.
#health_score
Calculate a simple 0-100 health score for dashboards.
#highest_readiness_risk
Return the highest risk present in a report.
#history_issue_codes
Return unique issue codes seen across a history.
#history_issue_count
Count issue occurrences across run history.
#history_issue_frequency_markdown
Render issue frequency as Markdown.
#history_to_json
Render a run history as compact JSON.
#history_to_markdown
Render a list of runs as Markdown history.
#history_trends_to_markdown
Render pairwise trends for adjacent run records.
#issue_catalog_markdown
fn issue_catalog_markdown() -> StringRender all known issue metadata as Markdown.
#issue_is_blocking
fn issue_is_blocking(code : String) -> BoolReturn true if the issue should block a normal CI gate.
#issue_is_format_related
fn issue_is_format_related(code : String) -> BoolReturn true if the issue came from parser or TAP shape concerns.
#issue_is_runtime_related
fn issue_is_runtime_related(code : String) -> BoolReturn true if the issue is about runtime execution outcome.
#issue_meta
Return stable metadata for a known issue code.
#known_issue_codes
Return issue codes currently produced by TapTrail validators.
#latest_run_improved
Return true if the last run improved from the previous run.
#latest_run_regressed
Return true if the last run regressed from the previous run.
#license_is_recognized
fn license_is_recognized(license : String) -> BoolReturn true when supplied evidence has a recognized open-source license.
#named_input
Construct a named input value.
#named_report
Construct a named report from already parsed data.
#optional_readiness_gaps
Return failed optional checks.
#package_name_has_namespace
fn package_name_has_namespace(package_name : String) -> BoolReturn true when a package name looks publishable to mooncakes.io.
#parse_and_report
Parse and validate a TAP stream in one call.
#parse_suite
Parse multiple TAP streams into a suite report.
#parse_tap
Parse a TAP13-ish stream. The parser is permissive and records unknown lines
as issues instead of aborting.
#passed_readiness_checks
Return checks that passed.
#passed_runs
Return records whose report passed validation.
#passing_reports
Return all passing reports.
#policy_audit_markdown
Convert a report and policy into a compact audit record.
#policy_passes
Return true when a policy accepts a report.
#policy_result_to_markdown
Render one policy result as Markdown.
#policy_status_line
Render a short one-line status for terminals.
#policy_to_markdown
Render policy settings so release notes can capture the gate definition.
#readiness_actions_markdown
Render remediation actions as Markdown bullets.
#readiness_badge_markdown
Render a Markdown badge for README or release dashboards.
#readiness_checks_to_markdown
Render checks as a Markdown table.
#readiness_earned_score
Sum earned points across checks.
#readiness_evidence_markdown
Render only the evidence section as Markdown.
#readiness_from_report
fn readiness_from_report(project : String, report_name : String, report : TapReport, evidence : TapProjectEvidence) -> TapReadinessReportEvaluate one TAP report by wrapping it as a single-member suite.
#readiness_from_suite
fn readiness_from_suite(project : String, suite : TapSuiteReport, evidence : TapProjectEvidence) -> TapReadinessReportEvaluate a full suite and repository evidence for release readiness.
#readiness_grade
fn readiness_grade(score : Int) -> StringReturn a compact grade for a readiness score.
#readiness_level_label
Return a stable label for the readiness level.
#readiness_max_score
Sum maximum points across checks.
#readiness_passes
Return true when the readiness report is suitable for submission.
#readiness_recommendations
Return concise human-readable recommendations.
#readiness_release_note
Render a short release note sentence.
#readiness_risk_count
Count checks with a given risk level.
#readiness_risk_label
Return a stable label for one readiness risk.
#readiness_risk_rank
Numeric risk order for dashboards and automation.
#readiness_score
Calculate normalized 0-100 readiness score.
#readiness_summary_line
Return a one-line summary for terminals and release notes.
#readiness_to_checklist
Render a checkbox list for manual release review.
#readiness_to_csv
Render one CSV row for spreadsheet-style tracking.
#readiness_to_env_lines
Render readiness values as GitHub environment lines.
#readiness_to_json
Render a compact JSON object for dashboards.
#readiness_to_markdown
Render a Markdown report suitable for GitHub job summaries.
#readiness_to_properties
Render readiness fields as .properties content.
#report_annotations
Build annotations for a single TAP report.
#report_artifacts
Package common report outputs in one call.
#report_badge_markdown
Render a Markdown badge link for GitHub README files.
#report_has_issue
Return true when a report contains the issue code.
#report_passes
fn report_passes(input : String) -> BoolReturn true when the report has no validation issues.
#report_review_markdown
Render a high-signal Markdown review for one report.
#report_to_checkstyle_xml
Render Checkstyle-compatible XML for issue dashboards.
#report_to_env_lines
Render one report as GitHub environment lines.
#report_to_properties
Render report key-value pairs for shell-independent CI artifact files.
#report_to_shields_json
Render a Shields endpoint JSON badge for a report.
#report_to_teamcity_messages
Render one report as TeamCity service messages.
#report_with_most_issues
Find the report with the most issues.
#reports_with_issue
Return reports containing a specific issue code.
#repository_link_present
fn repository_link_present(repository : String) -> BoolReturn true when a repository URL is present and public-looking.
#run_record
Construct a timestamped run record.
#severity_label
Turn a severity enum into a short stable label.
#severity_rank
Numeric order used by external tools that need sortable severity.
#suite_annotations
Build annotations for every member of a suite.
#suite_artifacts
Package common suite outputs in one call.
#suite_badge_markdown
Render a Markdown badge link for suite status.
#suite_blocking_failures
Count report-level blocking failures across the suite.
#suite_has_issue
Return true when any suite report contains the issue code.
#suite_health_score
Calculate suite-level health score.
#suite_issue_codes
Return unique issue codes in first-seen order.
#suite_issues_to_markdown
Render issue details as a Markdown table.
#suite_passes
Return true when every named report passes.
#suite_status_label
Return a stable status label for the suite.
#suite_to_checklist
Render a Markdown checklist useful for manual release reviews.
#suite_to_checkstyle_xml
Render Checkstyle-compatible XML for suite issues.
#suite_to_compact_json
Render a compact JSON object for suite dashboards.
#suite_to_csv
Render suite rows as CSV with a header.
#suite_to_env_lines
Render a compact status block for CI environment files.
#suite_to_junit_xml
Render one merged JUnit XML suite containing named reports.
#suite_to_markdown
Render a suite as Markdown for GitHub job summaries.
#suite_to_properties
Render suite key-value pairs for artifact files.
#suite_to_release_notes
Render release-note bullets from a suite.
#suite_to_shields_json
Render a Shields endpoint JSON badge for a suite.
#suite_to_tsv
Render suite rows as tab-separated values.
#summarize
Build aggregate counters for a parsed TAP document.
#summarize_suite
Aggregate suite-level counters.
#to_compact_json
Render a small JSON object without requiring a JSON dependency.
#to_junit_xml
Render a JUnit-style XML test suite for CI systems that can ingest XML.
#to_markdown
Render a compact Markdown report for CI logs or release artifacts.
#trend_kind_label
Human-readable trend kind label.
#trend_to_csv
Render a trend report as one CSV row with header.
#trend_to_json
Render a trend report as compact JSON.
#trend_to_markdown
Render a summary delta as Markdown.
#validate
Validate a parsed TAP document for release or CI gating.
#verified_project_evidence
fn verified_project_evidence(package_name : String, version : String, repository : String, license : String, examples : Int, test_cases : Int, total_moonbit_lines : Int, effective_moonbit_lines : Int, commit_count : Int) -> TapProjectEvidenceConstruct evidence for a repository that already passed local verification.
#worst_run
Return the worst health-score record.
Pure MoonBit TAP13 parser, CI validation gate, and Markdown/JSON report renderer.
taptap13test-reportciparsermarkdown
0.3.0
MIT
Updated 3 hours ago
10 downloads