envful 1.0.1

A tool to verify the presence of environment variables before running a process
Documentation 
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

mod check_spec {
    use assert_cmd::prelude::*;
    use predicates::prelude::*;
    use std::process::Command;

    #[test]
    fn succeeds_with_required() -> Result<(), Box<dyn std::error::Error>> {
        run_check("success", true, "All variables are present", None)
    }

    #[test]
    fn fails_with_missing() -> Result<(), Box<dyn std::error::Error>> {
        run_check("missing", false, "Missing", None)
    }

    #[test]
    fn warns_on_undeclared() -> Result<(), Box<dyn std::error::Error>> {
        run_check("undeclared", true, "not declared", None)
    }

    #[test]
    fn warns_on_optional_missing() -> Result<(), Box<dyn std::error::Error>> {
        run_check(
            "optional_missing",
            true,
            "Some optional variables are missing",
            None,
        )
    }

    #[test]
    fn fails_if_env_file_missing() -> Result<(), Box<dyn std::error::Error>> {
        let mut cmd = Command::cargo_bin("envful")?;
        let file = format!("tests/fixtures/success/nonexistent");
        let manifest = format!("tests/fixtures/success/.env.example");
        cmd.args(["check", "-f", file.as_str(), "-m", manifest.as_str()]);

        cmd.assert()
            .failure()
            .stderr(predicate::str::contains("Could not find environment file"));
        Ok(())
    }

    #[test]
    fn fails_if_manifest_file_missing() -> Result<(), Box<dyn std::error::Error>> {
        let mut cmd = Command::cargo_bin("envful")?;
        let file = format!("tests/fixtures/success/.env");
        let manifest = format!("tests/fixtures/success/nonexistent");
        cmd.args(["check", "-f", file.as_str(), "-m", manifest.as_str()]);

        cmd.assert()
            .failure()
            .stderr(predicate::str::contains("Could not find manifest file"));
        Ok(())
    }

    #[test]
    fn succeeds_if_found_in_env() -> Result<(), Box<dyn std::error::Error>> {
        // Set SENGRID_API_KEY in env
        let env_vars = vec![("SENDGRID_API_KEY", "12345")];
        let result = run_check(
            "missing_but_in_env",
            true,
            "All variables are present",
            Some(env_vars),
        );
        result
    }

    #[test]
    fn displays_correct_optional() -> Result<(), Box<dyn std::error::Error>> {
        let mut cmd = Command::cargo_bin("envful")?;
        let fixture = "two_optional";
        let file = format!("tests/fixtures/{}/.env", fixture);
        let manifest = format!("tests/fixtures/{}/.env.example", fixture);
        cmd.args(["check", "-f", file.as_str(), "-m", manifest.as_str()]);

        let has_first = predicate::str::contains("Missing optional variable: SENDGRID_API_KEY");
        let has_second = predicate::str::contains("Missing optional variable: STRIPE_SK");
        cmd.assert().success().stdout(has_first).stdout(has_second);
        Ok(())
    }

    fn run_check(
        fixture: &str,
        should_succeed: bool,
        expected_output: &str,
        env_vars: Option<Vec<(&str, &str)>>,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let mut cmd = Command::cargo_bin("envful")?;
        let file = format!("tests/fixtures/{}/.env", fixture);
        let manifest = format!("tests/fixtures/{}/.env.example", fixture);
        cmd.args(["check", "-f", file.as_str(), "-m", manifest.as_str()]);

        if env_vars.is_some() {
            for (key, value) in env_vars.unwrap() {
                cmd.env(key, value);
            }
        }

        let predicate = predicate::str::contains(expected_output);
        if should_succeed {
            cmd.assert().success().stdout(predicate);
        } else {
            cmd.assert().failure().stderr(predicate);
        }
        Ok(())
    }
}