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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

// (C) Copyright 2019-2020 Hewlett Packard Enterprise Development LP

use std::convert::TryFrom;

use crate::dockerfile_parser::Instruction;
use crate::error::*;
use crate::parser::{Pair, Rule};
use crate::splicer::Span;

use enquote::unquote;
use snafu::ResultExt;

/// A Dockerfile [`ARG` instruction][arg].
///
/// [arg]: https://docs.docker.com/engine/reference/builder/#arg
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ArgInstruction {
  pub span: Span,

  /// The argument key
  pub name: String,

  pub name_span: Span,

  /// An optional argument value.
  ///
  /// This may be unset when passing arguments through to later stages in a
  /// [multi-stage build][build].
  ///
  /// [build]: https://docs.docker.com/develop/develop-images/multistage-build/
  pub value: Option<String>,

  pub value_span: Option<Span>,
}

impl ArgInstruction {
  pub(crate) fn from_record(record: Pair) -> Result<ArgInstruction> {
    let span = Span::from_pair(&record);
    let mut name = None;
    let mut value = None;

    for field in record.into_inner() {
      match field.as_rule() {
        Rule::arg_name => name = Some((field.as_str(), Span::from_pair(&field))),
        Rule::arg_quoted_value => {
          let v = unquote(field.as_str()).context(UnescapeError)?;

          value = Some((v, Span::from_pair(&field)));
        },
        Rule::arg_value => value = Some((
          field.as_str().to_string(),
          Span::from_pair(&field)
        )),
        Rule::comment => continue,
        _ => return Err(unexpected_token(field))
      }
    }

    let (name, name_span) = match name {
      Some((name, name_span)) => (name.to_string(), name_span),
      _ => return Err(Error::GenericParseError {
        message: "arg name is required".into()
      })
    };

    let (value, value_span) = match value {
      Some((value, value_span)) => (Some(value), Some(value_span)),
      None => (None, None)
    };

    Ok(ArgInstruction {
      span,
      name,
      name_span,
      value,
      value_span,
    })
  }
}

impl<'a> TryFrom<&'a Instruction> for &'a ArgInstruction {
 type Error = Error;

 fn try_from(instruction: &'a Instruction) -> std::result::Result<Self, Self::Error> {
   if let Instruction::Arg(a) = instruction {
     Ok(a)
   } else {
     Err(Error::ConversionError {
       from: format!("{:?}", instruction),
       to: "ArgInstruction".into()
     })
   }
 }
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::Dockerfile;
  use crate::test_util::*;

  #[test]
  fn arg_strings() -> Result<()> {
    assert_eq!(
      parse_single(r#"arg foo=bar"#, Rule::arg)?,
      ArgInstruction {
        span: Span::new(0, 11),
        name: "foo".into(),
        name_span: Span::new(4, 7),
        value: Some("bar".into()),
        value_span: Some(Span::new(8, 11)),
      }.into()
    );

    assert_eq!(
      parse_single(r#"arg foo="bar""#, Rule::arg)?,
      ArgInstruction {
        span: Span::new(0, 13),
        name: "foo".into(),
        name_span: Span::new(4, 7),
        value: Some("bar".into()),
        value_span: Some(Span::new(8, 13)),
      }.into()
    );

    assert_eq!(
      parse_single(r#"arg foo='bar'"#, Rule::arg)?,
      ArgInstruction {
        span: Span::new(0, 13),
        name: "foo".into(),
        name_span: Span::new(4, 7),
        value: Some("bar".into()),
        value_span: Some(Span::new(8, 13)),
      }.into()
    );

    assert!(Dockerfile::parse(r#"arg foo="bar"bar"#).is_err());
    assert!(Dockerfile::parse(r#"arg foo='bar'bar"#).is_err());

    Ok(())
  }
}