mirror of
https://github.com/j178/prek.git
synced 2026-04-09 01:52:24 +02:00
b1f929a1b6
* warn unexpected keys. * Tweak --------- Co-authored-by: Jo <10510431+j178@users.noreply.github.com>
148 lines
4.1 KiB
Rust
148 lines
4.1 KiB
Rust
use assert_fs::fixture::{FileWriteStr, PathChild};
|
|
|
|
use crate::common::{TestContext, cmd_snapshot};
|
|
|
|
mod common;
|
|
|
|
#[test]
|
|
fn validate_config() -> anyhow::Result<()> {
|
|
let context = TestContext::new();
|
|
|
|
// No files to validate.
|
|
cmd_snapshot!(context.filters(), context.validate_config(), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
context.write_pre_commit_config(indoc::indoc! {r"
|
|
repos:
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: v5.0.0
|
|
hooks:
|
|
- id: trailing-whitespace
|
|
- id: end-of-file-fixer
|
|
- id: check-json
|
|
"});
|
|
// Validate one file.
|
|
cmd_snapshot!(context.filters(), context.validate_config().arg(".pre-commit-config.yaml"), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
context
|
|
.work_dir()
|
|
.child("config-1.yaml")
|
|
.write_str(indoc::indoc! {r"
|
|
repos:
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
"})?;
|
|
|
|
// Validate multiple files.
|
|
cmd_snapshot!(context.filters(), context.validate_config().arg(".pre-commit-config.yaml").arg("config-1.yaml"), @r#"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
error: Failed to parse `config-1.yaml`
|
|
caused by: repos: Invalid remote repo: missing field `rev` at line 2 column 3
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn validate_manifest() -> anyhow::Result<()> {
|
|
let context = TestContext::new();
|
|
|
|
// No files to validate.
|
|
cmd_snapshot!(context.filters(), context.validate_manifest(), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
context
|
|
.work_dir()
|
|
.child(".pre-commit-hooks.yaml")
|
|
.write_str(indoc::indoc! {r"
|
|
- id: check-added-large-files
|
|
name: check for added large files
|
|
description: prevents giant files from being committed.
|
|
entry: check-added-large-files
|
|
language: python
|
|
stages: [pre-commit, pre-push, manual]
|
|
minimum_pre_commit_version: 3.2.0
|
|
"})?;
|
|
// Validate one file.
|
|
cmd_snapshot!(context.filters(), context.validate_manifest().arg(".pre-commit-hooks.yaml"), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
"#);
|
|
|
|
context
|
|
.work_dir()
|
|
.child("hooks-1.yaml")
|
|
.write_str(indoc::indoc! {r"
|
|
- id: check-added-large-files
|
|
name: check for added large files
|
|
description: prevents giant files from being committed.
|
|
language: python
|
|
stages: [pre-commit, pre-push, manual]
|
|
minimum_pre_commit_version: 3.2.0
|
|
"})?;
|
|
|
|
// Validate multiple files.
|
|
cmd_snapshot!(context.filters(), context.validate_manifest().arg(".pre-commit-hooks.yaml").arg("hooks-1.yaml"), @r#"
|
|
success: false
|
|
exit_code: 1
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
error: Failed to parse `hooks-1.yaml`
|
|
caused by: .[0]: missing field `entry` at line 1 column 5
|
|
"#);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn unexpected_keys_warning() {
|
|
let context = TestContext::new();
|
|
|
|
context.write_pre_commit_config(indoc::indoc! {r"
|
|
repos:
|
|
- repo: local
|
|
hooks:
|
|
- id: test-hook
|
|
name: Test Hook
|
|
entry: echo test
|
|
language: system
|
|
unexpected_key_in_hook: some_value
|
|
unexpected_key: some_value
|
|
another_unknown: test
|
|
minimum_pre_commit_version: 1.0.0
|
|
"});
|
|
|
|
// TODO: warning about `unexpected_key_in_hook` currently not working
|
|
cmd_snapshot!(context.filters(), context.validate_config().arg(".pre-commit-config.yaml"), @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
|
|
----- stderr -----
|
|
warning: Ignored unexpected keys in `.pre-commit-config.yaml`: `unexpected_key`, `another_unknown`
|
|
"#);
|
|
}
|