File: TransformEndToEndTests.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (163 lines) | stat: -rw-r--r-- 5,980 bytes parent folder | download
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//

import XCTest
import ArgumentParserTestHelpers
import ArgumentParser

final class TransformEndToEndTests: XCTestCase {
}

fileprivate enum FooBarError: Error {
  case outOfBounds
}

fileprivate protocol Convert {
  static func convert(_ str: String) throws -> Int
}

extension Convert {
  static func convert(_ str: String) throws -> Int {
  guard let converted = Int(argument: str) else { throw ValidationError("Could not transform to an Int.") }
  guard converted < 1000 else { throw FooBarError.outOfBounds }
  return converted
  }
}

// MARK: - Options

fileprivate struct FooOption: Convert, ParsableArguments {

  static var usageString: String = """
  Usage: foo_option --string <int_str>
    See 'foo_option --help' for more information.
  """
  static var help: String = "Help:  --string <int_str>  Convert string to integer\n"
  
  @Option(help: ArgumentHelp("Convert string to integer", valueName: "int_str"),
          transform: { try convert($0) })
  var string: Int
}

fileprivate struct BarOption: Convert, ParsableCommand {
    
  static var usageString: String = """
  Usage: bar-option [--strings <int_str> ...]
    See 'bar-option --help' for more information.
  """
  static var help: String = "Help:  --strings <int_str>  Convert a list of strings to an array of integers\n"
    
  @Option(help: ArgumentHelp("Convert a list of strings to an array of integers", valueName: "int_str"),
          transform: { try convert($0) })
  var strings: [Int] = []
}

extension TransformEndToEndTests {
    
  // MARK: Single Values
    
  func testSingleOptionTransform() throws {
    AssertParse(FooOption.self, ["--string", "42"]) { foo in
      XCTAssertEqual(foo.string, 42)
    }
  }
    
  func testSingleOptionValidation_Fail_CustomErrorMessage() throws {
    AssertFullErrorMessage(FooOption.self, ["--string", "Forty Two"], "Error: The value 'Forty Two' is invalid for '--string <int_str>': Could not transform to an Int.\n" + FooOption.help + FooOption.usageString)
  }

  func testSingleOptionValidation_Fail_DefaultErrorMessage() throws {
    AssertFullErrorMessage(FooOption.self, ["--string", "4827"], "Error: The value '4827' is invalid for '--string <int_str>': outOfBounds\n" + FooOption.help + FooOption.usageString)
  }

  // MARK: Arrays
  
  func testOptionArrayTransform() throws {
    AssertParse(BarOption.self, ["--strings", "42", "--strings", "72", "--strings", "99"]) { bar in
      XCTAssertEqual(bar.strings, [42, 72, 99])
    }
  }
  
  func testOptionArrayValidation_Fail_CustomErrorMessage() throws {
    AssertFullErrorMessage(BarOption.self, ["--strings", "Forty Two", "--strings", "72", "--strings", "99"], "Error: The value 'Forty Two' is invalid for '--strings <int_str>': Could not transform to an Int.\n" + BarOption.help + BarOption.usageString)
  }
  
  func testOptionArrayValidation_Fail_DefaultErrorMessage() throws {
    AssertFullErrorMessage(BarOption.self, ["--strings", "4827", "--strings", "72", "--strings", "99"], "Error: The value '4827' is invalid for '--strings <int_str>': outOfBounds\n" + BarOption.help + BarOption.usageString)
  }
}

// MARK: - Arguments

fileprivate struct FooArgument: Convert, ParsableArguments {

  static var usageString: String = """
  Usage: foo_argument <int_str>
    See 'foo_argument --help' for more information.
  """
  static var help: String = "Help:  <int_str>  Convert string to integer\n"
  
  enum FooError: Error {
      case outOfBounds
  }
  
  @Argument(help: ArgumentHelp("Convert string to integer", valueName: "int_str"),
            transform: { try convert($0) })
  var string: Int
}

fileprivate struct BarArgument: Convert, ParsableCommand {
    
  static var usageString: String = """
  Usage: bar-argument [<int_str> ...]
    See 'bar-argument --help' for more information.
  """
  static var help: String = "Help:  <int_str>  Convert a list of strings to an array of integers\n"
  
  @Argument(help: ArgumentHelp("Convert a list of strings to an array of integers", valueName: "int_str"),
            transform: { try convert($0) })
  var strings: [Int] = []
}

extension TransformEndToEndTests {
    
  // MARK: Single Values
  
  func testArgumentTransform() throws {
    AssertParse(FooArgument.self, ["42"]) { foo in
      XCTAssertEqual(foo.string, 42)
    }
  }
  
  func testArgumentValidation_Fail_CustomErrorMessage() throws {
    AssertFullErrorMessage(FooArgument.self, ["Forty Two"], "Error: The value 'Forty Two' is invalid for '<int_str>': Could not transform to an Int.\n" + FooArgument.help + FooArgument.usageString)
  }

  func testArgumentValidation_Fail_DefaultErrorMessage() throws {
    AssertFullErrorMessage(FooArgument.self, ["4827"], "Error: The value '4827' is invalid for '<int_str>': outOfBounds\n" + FooArgument.help + FooArgument.usageString)
  }
  
  // MARK: Arrays
  
  func testArgumentArrayTransform() throws {
    AssertParse(BarArgument.self, ["42", "72", "99"]) { bar in
      XCTAssertEqual(bar.strings, [42, 72, 99])
    }
  }
  
  func testArgumentArrayValidation_Fail_CustomErrorMessage() throws {
    AssertFullErrorMessage(BarArgument.self, ["Forty Two", "72", "99"], "Error: The value 'Forty Two' is invalid for '<int_str>': Could not transform to an Int.\n" + BarArgument.help + BarArgument.usageString)
  }
  
  func testArgumentArrayValidation_Fail_DefaultErrorMessage() throws {
    AssertFullErrorMessage(BarArgument.self, ["4827", "72", "99"], "Error: The value '4827' is invalid for '<int_str>': outOfBounds\n" + BarArgument.help + BarArgument.usageString)
  }
}