mir-php 0.85.0

Fast PHP static analyzer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

//! `<fileExtensions>` in `mir.xml` makes non-`.php` files (`.module`, `.inc`) part of every
//! discovery path: the plain walk, ignored/vendor dirs and the composer project walk.

use std::path::Path;
use std::process::{Command, Output};

use tempfile::TempDir;

const MODULE_AND_INC: &str = r#"<mir><fileExtensions>
    <extension name=".php"/><extension name=".module"/><extension name=".inc"/>
</fileExtensions></mir>"#;

fn run(dir: &Path) -> String {
    let mut cmd = Command::new(env!("CARGO_BIN_EXE_mir"));
    cmd.env_clear();
    cmd.current_dir(dir);
    cmd.args(["--no-cache", "--no-progress"]);
    cmd.arg(dir);
    let out: Output = cmd.output().expect("failed to run mir binary");
    format!(
        "{}{}",
        String::from_utf8_lossy(&out.stdout),
        String::from_utf8_lossy(&out.stderr)
    )
}

fn write(dir: &Path, rel: &str, content: &str) {
    let path = dir.join(rel);
    std::fs::create_dir_all(path.parent().unwrap()).unwrap();
    std::fs::write(path, content).unwrap();
}

#[test]
fn plain_walk_analyzes_configured_extensions() {
    let dir = TempDir::new().unwrap();
    write(dir.path(), "mir.xml", MODULE_AND_INC);
    write(
        dir.path(),
        "a.module",
        "<?php function a(): int { return b(); }\n",
    );
    write(
        dir.path(),
        "b.inc",
        "<?php function b(): int { return 'x'; }\n",
    );

    let out = run(dir.path());

    assert!(out.contains("b.inc"), "b.inc not analyzed:\n{out}");
    assert!(!out.contains("UndefinedFunction"), "got:\n{out}");
}

#[test]
fn plain_walk_ignores_non_php_without_config() {
    let dir = TempDir::new().unwrap();
    write(
        dir.path(),
        "a.module",
        "<?php function a(): int { return 'x'; }\n",
    );

    let out = run(dir.path());

    assert!(out.contains("No PHP files found"), "got:\n{out}");
}

#[test]
fn ignored_dirs_are_indexed_with_configured_extensions() {
    let dir = TempDir::new().unwrap();
    write(
        dir.path(),
        "mir.xml",
        r#"<mir><fileExtensions><extension name="php"/><extension name="inc"/></fileExtensions>
<ignoreFiles><directory name="lib"/></ignoreFiles></mir>"#,
    );
    write(
        dir.path(),
        "main.php",
        "<?php function m(): int { return lib_fn(); }\n",
    );
    write(
        dir.path(),
        "lib/helpers.inc",
        "<?php function lib_fn(): int { return 1; }\n",
    );

    let out = run(dir.path());

    assert!(!out.contains("UndefinedFunction"), "got:\n{out}");
    assert!(
        !out.contains("helpers.inc:"),
        "ignored dir was reported:\n{out}"
    );
}

#[test]
fn composer_walk_analyzes_configured_extensions() {
    let dir = TempDir::new().unwrap();
    write(dir.path(), "mir.xml", MODULE_AND_INC);
    write(
        dir.path(),
        "composer.json",
        r#"{"autoload":{"psr-4":{"App\\":"src/"}}}"#,
    );
    write(
        dir.path(),
        "src/Main.php",
        "<?php namespace App; class Main {}\n",
    );
    write(
        dir.path(),
        "src/legacy.module",
        "<?php function legacy(): int { return 'x'; }\n",
    );

    let out = run(dir.path());

    assert!(out.contains("legacy.module"), "got:\n{out}");
}