wdl-analysis 0.19.1

Analysis of Workflow Description Language (WDL) documents.
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
110
111
112

//! Validation of `env` declarations.

use wdl_ast::AstNode;
use wdl_ast::AstToken;
use wdl_ast::Diagnostic;
use wdl_ast::Span;
use wdl_ast::SupportedVersion;
use wdl_ast::v1;
use wdl_ast::version::V1;

use crate::Diagnostics;
use crate::VisitReason;
use crate::Visitor;
use crate::document::Document;

/// Creates an "env type not primitive" diagnostic.
fn env_type_not_primitive(env_span: Span, ty: &v1::Type, ty_span: Span) -> Diagnostic {
    Diagnostic::error("environment variable modifier can only be used on primitive types")
        .with_label(
            format!("type `{ty}` cannot be used as an environment variable"),
            ty_span,
        )
        .with_label(
            "declaration is an environment variable due to this modifier",
            env_span,
        )
}

/// Checks the type to see if it is legal as an environment variable.
///
/// Returns `None` if the type is legal otherwise it returns the span of the
/// type.
fn check_type(ty: &v1::Type) -> Option<Span> {
    match ty {
        v1::Type::Map(ty) => Some(ty.span()),
        v1::Type::Array(ty) => Some(ty.span()),
        v1::Type::Pair(ty) => Some(ty.span()),
        v1::Type::Object(ty) => Some(ty.span()),
        v1::Type::Ref(ty) => Some(ty.span()),
        v1::Type::Primitive(_) => None,
    }
}

/// An AST visitor that ensures that environment variable modifiers only exist
/// on primitive type declarations.
#[derive(Debug, Default)]
pub struct EnvVisitor {
    /// The version of the document we're currently visiting.
    version: Option<SupportedVersion>,
}

impl Visitor for EnvVisitor {
    fn reset(&mut self) {
        *self = Default::default();
    }

    fn document(
        &mut self,
        _: &mut Diagnostics,
        _: VisitReason,
        _: &Document,
        version: SupportedVersion,
    ) {
        self.version = Some(version);
    }

    fn bound_decl(
        &mut self,
        diagnostics: &mut Diagnostics,
        reason: VisitReason,
        decl: &v1::BoundDecl,
    ) {
        // Only visit decls for WDL >=1.2
        if self.version.expect("should have a version") < SupportedVersion::V1(V1::Two) {
            return;
        }

        if reason == VisitReason::Exit {
            return;
        }

        if let Some(env_span) = decl.env().map(|t| t.span()) {
            let ty = decl.ty();
            if let Some(span) = check_type(&ty) {
                diagnostics.add(env_type_not_primitive(env_span, &ty, span));
            }
        }
    }

    fn unbound_decl(
        &mut self,
        diagnostics: &mut Diagnostics,
        reason: VisitReason,
        decl: &v1::UnboundDecl,
    ) {
        // Only visit decls for WDL >=1.2
        if self.version.expect("should have a version") < SupportedVersion::V1(V1::Two) {
            return;
        }

        if reason == VisitReason::Exit {
            return;
        }

        if let Some(env_span) = decl.env().map(|t| t.span()) {
            let ty = decl.ty();
            if let Some(span) = check_type(&ty) {
                diagnostics.add(env_type_not_primitive(env_span, &ty, span));
            }
        }
    }
}