use std::path::Path;
use ast_grep_config::{CombinedScan, RuleCollection};
use ast_grep_core::tree_sitter::LanguageExt;
use ast_grep_language::SupportLang;
use thiserror::Error;
use crate::fix::fix_snippet;
use crate::metric::{self, Metric};
use crate::rule::{self, Rule, RuleId, RuleTests};
use crate::scanner::{compile_ast_grep_rule, AstGrepRule};
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RuleTestStatus {
Pass,
Fail { failures: Vec<TestFailure> },
NoTests,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TestFailure {
pub kind: TestFailureKind,
pub snippet: String,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum TestFailureKind {
ShouldMatchDidNot,
ShouldNotMatchDid,
FixMismatch {
actual: String,
},
}
#[derive(Debug, Clone)]
pub struct RuleTestResult {
pub rule_id: RuleId,
pub status: RuleTestStatus,
}
#[derive(Debug)]
pub struct TestSummary {
pub results: Vec<RuleTestResult>,
pub total_tested: usize,
pub passed: usize,
pub failed: usize,
pub no_tests: usize,
}
#[derive(Debug, Error)]
pub enum TestError {
#[error("failed to compile rule '{id}': {reason}")]
CompileError { id: RuleId, reason: String },
#[error("rule '{id}': fixture '{path}': {reason}")]
Fixture {
id: RuleId,
path: String,
reason: String,
},
}
fn lang_ext(lang: SupportLang) -> &'static str {
match lang {
SupportLang::Rust => "test.rs",
SupportLang::TypeScript => "test.ts",
SupportLang::Tsx => "test.tsx",
_ => "test.rs",
}
}
fn count_matches(
source: &str,
lang: SupportLang,
collection: &RuleCollection<SupportLang>,
) -> usize {
let root = lang.ast_grep(source);
let applicable = collection.get_rule_from_lang(Path::new(lang_ext(lang)), lang);
let combined = CombinedScan::new(applicable);
let result = combined.scan(&root, false);
result.matches.iter().map(|(_, m)| m.len()).sum()
}
fn metric_cases(
rule: &Rule,
inline: &[String],
fixtures: &[String],
) -> Result<Vec<(String, String)>, TestError> {
let mut cases: Vec<(String, String)> = inline
.iter()
.map(|snippet| (snippet.clone(), snippet.clone()))
.collect();
for path in fixtures {
let content = rule::read_fixture(rule, path).map_err(|e| TestError::Fixture {
id: rule.id.clone(),
path: path.clone(),
reason: e.to_string(),
})?;
cases.push((path.clone(), content));
}
Ok(cases)
}
fn test_metric_rule(
rule: &Rule,
metric: Metric,
threshold: f64,
tests: &RuleTests,
) -> Result<RuleTestResult, TestError> {
let lang = rule.language.ast_grep_langs()[0];
let fires = |content: &str| {
if let Some(floor) = rule.min_lines {
if content.lines().count() < floor {
return false;
}
}
let root = lang.ast_grep(content);
metric::exceeds(
metric::compute(metric, &rule.language, &root, content, None),
threshold,
)
};
let mut failures = Vec::new();
for (label, content) in metric_cases(rule, &tests.should_match, &tests.should_match_files)? {
if !fires(&content) {
failures.push(TestFailure {
kind: TestFailureKind::ShouldMatchDidNot,
snippet: label,
});
}
}
for (label, content) in
metric_cases(rule, &tests.should_not_match, &tests.should_not_match_files)?
{
if fires(&content) {
failures.push(TestFailure {
kind: TestFailureKind::ShouldNotMatchDid,
snippet: label,
});
}
}
let status = if failures.is_empty() {
RuleTestStatus::Pass
} else {
RuleTestStatus::Fail { failures }
};
Ok(RuleTestResult {
rule_id: rule.id.clone(),
status,
})
}
fn test_one_rule(rule: &Rule) -> Result<RuleTestResult, TestError> {
if rule.is_cross_file() || rule.is_resolution() {
return Ok(RuleTestResult {
rule_id: rule.id.clone(),
status: RuleTestStatus::NoTests,
});
}
let tests = match &rule.tests {
Some(t) => t,
None => {
return Ok(RuleTestResult {
rule_id: rule.id.clone(),
status: RuleTestStatus::NoTests,
});
}
};
if let Some((metric, threshold)) = rule.metric_spec() {
return test_metric_rule(rule, metric, threshold, tests);
}
if rule.is_metric() {
return Err(TestError::CompileError {
id: rule.id.clone(),
reason: "metric rule is missing a threshold".to_string(),
});
}
let lang = rule.language.ast_grep_langs()[0];
let ast_grep_rule = AstGrepRule {
id: rule.id.as_str(),
language: lang,
severity: &rule.severity,
message: &rule.message,
note: rule.note.as_deref(),
rule: &rule.rule,
constraints: (!rule.constraints.is_null()).then_some(&rule.constraints),
fix: None,
files: None,
ignores: None,
};
let config = compile_ast_grep_rule(&ast_grep_rule).map_err(|e| TestError::CompileError {
id: rule.id.clone(),
reason: e.to_string(),
})?;
let collection =
RuleCollection::try_new(vec![config]).map_err(|e| TestError::CompileError {
id: rule.id.clone(),
reason: e.to_string(),
})?;
let mut failures = Vec::new();
for snippet in &tests.should_match {
if count_matches(snippet, lang, &collection) == 0 {
failures.push(TestFailure {
kind: TestFailureKind::ShouldMatchDidNot,
snippet: snippet.clone(),
});
}
}
for snippet in &tests.should_not_match {
if count_matches(snippet, lang, &collection) > 0 {
failures.push(TestFailure {
kind: TestFailureKind::ShouldNotMatchDid,
snippet: snippet.clone(),
});
}
}
for case in &tests.should_fix {
let actual = fix_snippet(rule, &case.before).map_err(|e| TestError::CompileError {
id: rule.id.clone(),
reason: e.to_string(),
})?;
if actual != case.after {
failures.push(TestFailure {
kind: TestFailureKind::FixMismatch { actual },
snippet: case.before.clone(),
});
}
}
let status = if failures.is_empty() {
RuleTestStatus::Pass
} else {
RuleTestStatus::Fail { failures }
};
Ok(RuleTestResult {
rule_id: rule.id.clone(),
status,
})
}
pub fn test_rules(rules: &[Rule]) -> Result<TestSummary, TestError> {
let mut results = Vec::with_capacity(rules.len());
let mut passed = 0;
let mut failed = 0;
let mut no_tests = 0;
let mut total_tested = 0;
for rule in rules {
let result = test_one_rule(rule)?;
match &result.status {
RuleTestStatus::Pass => {
passed += 1;
total_tested += 1;
}
RuleTestStatus::Fail { .. } => {
failed += 1;
total_tested += 1;
}
RuleTestStatus::NoTests => {
no_tests += 1;
}
}
results.push(result);
}
Ok(TestSummary {
results,
total_tested,
passed,
failed,
no_tests,
})
}
#[cfg(test)]
mod tests;