File: ExpectedIssue.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 (444 lines) | stat: -rw-r--r-- 18,199 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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 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
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Common

public struct ExpectedIssue: Equatable, Codable {
  public let applicableConfigs: Set<String>
  public let issueUrl: String
  public let path: String
  public let modification: String?
  public let issueDetail: IssueDetail

  public init(applicableConfigs: Set<String>, issueUrl: String, path: String,
              modification: String?, issueDetail: IssueDetail) {
    self.applicableConfigs = applicableConfigs
    self.issueUrl = issueUrl
    self.path = path
    self.modification = modification
    self.issueDetail = issueDetail
  }

  /// Checks if this expected issue matches the given issue
  ///
  /// - parameters:
  ///   - issue: the issue to match against
  /// - returns: true if the issue matches
  public func matches(_ issue: StressTesterIssue) -> Bool {
    switch issue {
    case .failed(let sourceKitError, _):
      return matches(sourceKitError.request)
    case .errored(let status, let file, let arguments):
      guard case .stressTesterCrash(let xStatus, let xArguments) = issueDetail else { return false }
      return match(file, against: path) &&
        match(status, against: xStatus) &&
        match(arguments, against: xArguments)
    }
  }

  private func matches(_ info: RequestInfo) -> Bool {
    func matchDocument(_ doc: DocumentInfo) -> Bool {
      return match(doc.path, against: path) &&
        match(doc.modificationSummaryCode, against: modification)
    }

    switch info {
    case .editorOpen(let document):
      guard case .editorOpen = issueDetail else { return false }
      return matchDocument(document)
    case .editorClose(let document):
      guard case .editorClose = issueDetail else { return false }
      return matchDocument(document)
    case .editorReplaceText(let document, let offset, let length, let text):
      guard case .editorReplaceText(let specOffset, let specLength, let specText) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset) &&
        match(length, against: specLength) &&
        match(text, against: specText)
    case .format(let document, let offset):
      guard case .format(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset)
    case .cursorInfo(let document, let offset, _):
      guard case .cursorInfo(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset)
    case .codeCompleteOpen(let document, let offset, _):
      guard case .codeCompleteOpen(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset)
    case .codeCompleteUpdate(let document, let offset, _):
      guard case .codeCompleteUpdate(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset)
    case .codeCompleteClose(let document, let offset):
      guard case .codeCompleteClose(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset)
    case .rangeInfo(let document, let offset, let length, _):
      guard case .rangeInfo(let specOffset, let specLength) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset) &&
        match(length, against: specLength)
    case .semanticRefactoring(let document, let offset, let refactoring, _):
      guard case .semanticRefactoring(let specOffset, let specRefactoring) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset) &&
        match(refactoring, against: specRefactoring)
    case .typeContextInfo(let document, let offset, _):
      guard case .typeContextInfo(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match(offset, against: specOffset)
    case .conformingMethodList(let document, let offset, _, _):
      guard case .conformingMethodList(let specOffset) = issueDetail else { return false }
      return matchDocument(document) &&
        match (offset, against: specOffset)
    case .collectExpressionType(let document, _):
      guard case .collectExpressionType = issueDetail else { return false }
      return matchDocument(document)
    case .writeModule(let document, _):
      guard case .writeModule = issueDetail else { return false }
      return matchDocument(document)
    case .interfaceGen(let document, _, _):
      guard case .interfaceGen = issueDetail else { return false }
      return matchDocument(document)
    case .statistics:
      return false
    }
  }

  /// Checks whether this expected failure could match a request made in the
  /// given file path
  func isApplicable(toPath path: String) -> Bool {
    return match(path, against: self.path)
  }

  private func match<T: Equatable>(_ input: T?, against specification: T?) -> Bool {
    guard let specification = specification else { return true }
    guard let input = input else { return false }
    return input == specification
  }

  private func match(_ input: String?, against specification: String?) -> Bool {
    guard let specification = specification else { return true }
    guard let input = input else { return false }
    guard specification.contains("*") else { return input == specification }

    let parts = specification.split(separator: "*")
    guard !parts.isEmpty else { return true }

    let anchoredStart = !specification.hasPrefix("*")
    let anchoredEnd = !specification.hasSuffix("*")
    var remaining = Substring(input)

    for (offset, part) in parts.enumerated() {
      guard let match = remaining.range(of: part, options: [.caseInsensitive]) else {
        return false
      }
      if offset == 0 && anchoredStart && match.lowerBound != input.startIndex {
        return false
      }
      if offset == parts.endIndex - 1 && anchoredEnd && match.upperBound != input.endIndex {
        return false
      }
      remaining = remaining[match.upperBound...]
    }
    return true
  }
}

public extension ExpectedIssue {

  init(matching stressTesterIssue: StressTesterIssue, issueUrl: String, config: String) {
    self.issueUrl = issueUrl
    self.applicableConfigs = [config]

    switch stressTesterIssue {
    case .errored(let status, let file, let arguments):
      path = file
      modification = nil
      issueDetail = .stressTesterCrash(status: status, arguments: arguments)
    case .failed(let failure, _):
      switch failure.request {
      case .editorOpen(let document):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .editorOpen
      case .editorClose(let document):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .editorClose
      case .editorReplaceText(let document, let offset, let length, let text):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .editorReplaceText(offset: offset, length: length, text: text)
      case .cursorInfo(let document, let offset, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .cursorInfo(offset: offset)
      case .format(let document, let offset):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .format(offset: offset)
      case .codeCompleteOpen(let document, let offset, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .codeCompleteOpen(offset: offset)
      case .codeCompleteUpdate(let document, let offset, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .codeCompleteUpdate(offset: offset)
      case .codeCompleteClose(let document, let offset):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .codeCompleteClose(offset: offset)
      case .rangeInfo(let document, let offset, let length, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .rangeInfo(offset: offset, length: length)
      case .semanticRefactoring(let document, let offset, let refactoring, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .semanticRefactoring(offset: offset, refactoring: refactoring)
      case .typeContextInfo(let document, let offset, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .typeContextInfo(offset: offset)
      case .conformingMethodList(let document, let offset, _, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .conformingMethodList(offset: offset)
      case .collectExpressionType(let document, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .collectExpressionType
      case .writeModule(let document, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .writeModule
      case .interfaceGen(let document, _, _):
        path = document.path
        modification = document.modificationSummaryCode
        issueDetail = .interfaceGen
      case .statistics:
        path = "<statistics>"
        modification = nil
        issueDetail = .statistics
      }
    }
  }

  enum IssueDetail: Equatable, Codable {
    case editorOpen
    case editorClose
    case editorReplaceText(offset: Int?, length: Int?, text: String?)
    case cursorInfo(offset: Int?)
    case format(offset: Int?)
    case codeCompleteOpen(offset: Int?)
    case codeCompleteUpdate(offset: Int?)
    case codeCompleteClose(offset: Int?)
    case rangeInfo(offset: Int?, length: Int?)
    case typeContextInfo(offset: Int?)
    case conformingMethodList(offset: Int?)
    case collectExpressionType
    case writeModule
    case interfaceGen
    case semanticRefactoring(offset: Int?, refactoring: String?)
    case stressTesterCrash(status: Int32?, arguments: String?)
    case statistics

    public init(from decoder: Decoder) throws {
      let container = try decoder.container(keyedBy: CodingKeys.self)
      switch try container.decode(RequestBase.self, forKey: .kind) {
      case .editorOpen:
        self = .editorOpen
      case .editorClose:
        self = .editorClose
      case .editorReplaceText:
        self = .editorReplaceText(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset),
          length: try container.decodeIfPresent(Int.self, forKey: .length),
          text: try container.decodeIfPresent(String.self, forKey: .text)
        )
      case .cursorInfo:
        self = .cursorInfo(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .format:
        self = .format(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .codeComplete:
        self = .codeCompleteOpen(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .codeCompleteUpdate:
        self = .codeCompleteUpdate(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .codeCompleteClose:
        self = .codeCompleteClose(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .rangeInfo:
        self = .rangeInfo(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset),
          length: try container.decodeIfPresent(Int.self, forKey: .length)
        )
      case .semanticRefactoring:
        self = .semanticRefactoring(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset),
          refactoring: try container.decodeIfPresent(String.self, forKey: .refactoring)
        )
      case .stressTesterCrash:
        self = .stressTesterCrash(
          status: try container.decodeIfPresent(Int32.self, forKey: .status),
          arguments: try container.decodeIfPresent(String.self, forKey: .arguments))
      case .typeContextInfo:
        self = .typeContextInfo(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .conformingMethodList:
        self = .conformingMethodList(
          offset: try container.decodeIfPresent(Int.self, forKey: .offset)
        )
      case .collectExpressionType:
        self = .collectExpressionType
      case .writeModule:
        self = .writeModule
      case .interfaceGen:
        self = .interfaceGen
      case .statistics:
        self = .statistics
      }
    }

    public func encode(to encoder: Encoder) throws {
      var container = encoder.container(keyedBy: CodingKeys.self)
      switch self {
      case .editorOpen:
        try container.encode(RequestBase.editorOpen, forKey: .kind)
      case .editorClose:
        try container.encode(RequestBase.editorClose, forKey: .kind)
      case .editorReplaceText(let offset, let length, let text):
        try container.encode(RequestBase.editorReplaceText, forKey: .kind)
        try container.encode(offset, forKey: .offset)
        try container.encode(length, forKey: .length)
        try container.encode(text, forKey: .text)
      case .cursorInfo(let offset):
        try container.encode(RequestBase.cursorInfo, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .format(let offset):
        try container.encode(RequestBase.format, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .codeCompleteOpen(let offset):
        try container.encode(RequestBase.codeComplete, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .codeCompleteUpdate(let offset):
        try container.encode(RequestBase.codeCompleteUpdate, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .codeCompleteClose(let offset):
        try container.encode(RequestBase.codeCompleteClose, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .rangeInfo(let offset, let length):
        try container.encode(RequestBase.rangeInfo, forKey: .kind)
        try container.encode(offset, forKey: .offset)
        try container.encode(length, forKey: .length)
      case .semanticRefactoring(let offset, let refactoring):
        try container.encode(RequestBase.semanticRefactoring, forKey: .kind)
        try container.encode(offset, forKey: .offset)
        try container.encode(refactoring, forKey: .refactoring)
      case .stressTesterCrash(let status, let arguments):
        try container.encode(RequestBase.stressTesterCrash, forKey: .kind)
        try container.encode(status, forKey: .status)
        try container.encode(arguments, forKey: .arguments)
      case .typeContextInfo(let offset):
        try container.encode(RequestBase.typeContextInfo, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .conformingMethodList(let offset):
        try container.encode(RequestBase.conformingMethodList, forKey: .kind)
        try container.encode(offset, forKey: .offset)
      case .collectExpressionType:
        try container.encode(RequestBase.collectExpressionType, forKey: .kind)
      case .writeModule:
        try container.encode(RequestBase.writeModule, forKey: .kind)
      case .interfaceGen:
        try container.encode(RequestBase.interfaceGen, forKey: .kind)
      case .statistics:
        try container.encode(RequestBase.statistics, forKey: .kind)
      }
    }

    private enum CodingKeys: String, CodingKey {
      case kind, offset, length, text, refactoring, status, arguments
    }

    private enum RequestBase: String, Codable {
      case editorOpen
      case editorClose
      case editorReplaceText
      case cursorInfo
      case codeComplete
      case codeCompleteUpdate
      case codeCompleteClose
      case rangeInfo
      case semanticRefactoring
      case typeContextInfo
      case conformingMethodList
      case collectExpressionType
      case format
      case writeModule
      case interfaceGen
      case statistics
      case stressTesterCrash
    }

    func enabledFor(request: RequestKind) -> Bool {
      switch self {
      case .editorOpen:
        return true
      case .editorClose:
        return true
      case .editorReplaceText:
        return true
      case .cursorInfo:
        return request == .cursorInfo
      case .format:
        return request == .format
      case .codeCompleteOpen:
        return request == .codeComplete
      case .codeCompleteUpdate:
        return request == .codeCompleteUpdate
      case .codeCompleteClose:
        return request == .codeCompleteClose
      case .rangeInfo:
        return request == .rangeInfo
      case .typeContextInfo:
        return request == .typeContextInfo
      case .conformingMethodList:
        return request == .conformingMethodList
      case .collectExpressionType:
        return request == .collectExpressionType
      case .writeModule:
        return request == .testModule
      case .interfaceGen:
        return request == .testModule
      case .semanticRefactoring:
        return request == .cursorInfo || request == .rangeInfo
      case .stressTesterCrash:
        return true
      case .statistics:
        return true
      }
    }
  }
}