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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
|
import Foundation
import SystemPackage
import WAT
import WasmParser
@testable import WasmKit
struct TestCase {
enum Error: Swift.Error {
case invalidPath
}
let content: Wast
let path: String
var relativePath: String {
// Relative path from the current working directory
let currentDirectory = FileManager.default.currentDirectoryPath
if path.hasPrefix(currentDirectory) {
return String(path.dropFirst(currentDirectory.count + 1))
}
return path
}
static func load(include: [String], exclude: [String], in path: [String], log: ((String) -> Void)? = nil) throws -> [TestCase] {
let fileManager = FileManager.default
var filePaths: [URL] = []
for path in path {
let filePath = FilePath(path)
if isDirectory(filePath) {
filePaths += try self.computeTestSources(inDirectory: filePath, fileManager: fileManager).map {
URL(fileURLWithPath: path).appendingPathComponent($0)
}
} else if fileManager.isReadableFile(atPath: path) {
let url = URL(fileURLWithPath: path)
filePaths += [url]
} else {
throw Error.invalidPath
}
}
guard !filePaths.isEmpty else {
return []
}
let matchesPattern: (URL) throws -> Bool = { filePath in
let fileName = filePath.lastPathComponent
// FIXME: Skip names.wast until we have .wat/.wast parser
// "names.wast" contains BOM in some test cases and they are parsed
// as empty string in JSONDecoder because there is no way to express
// it in UTF-8.
guard fileName != "names.wast" else { return false }
// FIXME: Skip SIMD proposal tests for now
guard !fileName.starts(with: "simd_") else { return false }
let patternPredicate = { pattern in filePath.path.hasSuffix(pattern) }
if !include.isEmpty {
return include.contains(where: patternPredicate)
}
guard !exclude.contains(where: patternPredicate) else { return false }
return true
}
var testCases: [TestCase] = []
for filePath in filePaths where try matchesPattern(filePath) {
guard let data = fileManager.contents(atPath: filePath.path) else {
assertionFailure("failed to load \(filePath)")
continue
}
let wast = try parseWAST(String(data: data, encoding: .utf8)!)
let spec = TestCase(content: wast, path: filePath.path)
testCases.append(spec)
}
return testCases
}
/// Returns list of `.json` paths recursively found under `rootPath`. They are relative to `rootPath`.
static func computeTestSources(inDirectory rootPath: FilePath, fileManager: FileManager) throws -> [String] {
return try fileManager.contentsOfDirectory(atPath: rootPath.string).filter {
$0.hasSuffix(".wast")
}
}
}
enum Result {
case passed
case failed(String)
case skipped(String)
var banner: String {
switch self {
case .passed:
return "[PASSED]"
case .failed:
return "[FAILED]"
case .skipped:
return "[SKIPPED]"
}
}
}
struct SpectestError: Error, CustomStringConvertible {
var description: String
init(_ description: String) {
self.description = description
}
}
class WastRunContext {
let store: Store
var engine: Engine { store.engine }
let rootPath: String
private var namedModuleInstances: [String: Instance] = [:]
var currentInstance: Instance?
var importsSpace = Imports()
init(store: Store, rootPath: String) {
self.store = store
self.rootPath = rootPath
}
func lookupInstance(_ name: String) -> Instance? {
return namedModuleInstances[name]
}
func register(_ name: String, instance: Instance) {
self.namedModuleInstances[name] = instance
}
}
extension TestCase {
func run(spectestModule: Module, configuration: EngineConfiguration, handler: @escaping (TestCase, Location, Result) -> Void) throws {
let engine = Engine(configuration: configuration)
let store = Store(engine: engine)
let spectestInstance = try spectestModule.instantiate(store: store)
let rootPath = FilePath(path).removingLastComponent().string
var content = content
let context = WastRunContext(store: store, rootPath: rootPath)
context.importsSpace.define(module: "spectest", spectestInstance.exports)
do {
while let (directive, location) = try content.nextDirective() {
do {
if let result = try context.run(directive: directive) {
handler(self, location, result)
}
} catch let error {
handler(self, location, .failed("\(error)"))
}
}
} catch let parseError as WatParserError {
if let location = parseError.location {
handler(self, location, .failed(parseError.message))
} else {
throw parseError
}
}
}
}
extension WastRunContext {
func instantiate(module: Module, name: String? = nil) throws -> Instance {
let instance = try module.instantiate(store: store, imports: importsSpace)
if let name {
register(name, instance: instance)
}
return instance
}
func deriveInstance(by name: String?) throws -> Instance {
let instance: Instance?
if let name {
instance = lookupInstance(name)
} else {
instance = currentInstance
}
guard let instance else {
throw SpectestError("no module to execute")
}
return instance
}
func deriveInstance(from execute: WastExecute) throws -> Instance? {
switch execute {
case .invoke(let invoke):
if let module = invoke.module {
return lookupInstance(module)
} else {
return currentInstance
}
case .wat(var wat):
let module = try parseModule(rootPath: rootPath, moduleSource: .binary(wat.encode()))
let instance = try instantiate(module: module)
return instance
case .get(let module, _):
if let module {
return lookupInstance(module)
} else {
return currentInstance
}
}
}
func run(directive: WastDirective) throws -> Result? {
switch directive {
case .module(let moduleDirective):
currentInstance = nil
let module: Module
do {
module = try parseModule(rootPath: rootPath, moduleSource: moduleDirective.source)
} catch {
return .failed("module could not be parsed: \(error)")
}
do {
currentInstance = try instantiate(module: module, name: moduleDirective.id)
} catch {
return .failed("module could not be instantiated: \(error)")
}
return .passed
case .register(let name, let moduleId):
let instance: Instance
if let moduleId {
guard let found = self.lookupInstance(moduleId) else {
return .failed("module \(moduleId) not found")
}
instance = found
} else {
guard let currentInstance else {
return .failed("no current module to register")
}
instance = currentInstance
}
importsSpace.define(module: name, instance.exports)
return nil
case .assertMalformed(let module, let message), .assertInvalid(let module, let message):
currentInstance = nil
do {
let module = try parseModule(rootPath: rootPath, moduleSource: module.source)
let instance = try instantiate(module: module)
// Materialize all functions to see all errors in the module
try instance.handle.withValue { try $0.compileAllFunctions(store: store) }
} catch {
return .passed
}
return .failed("module should not be parsed nor valid: expected \"\(message)\"")
case .assertTrap(execute: .wat(var wat), let message):
currentInstance = nil
let module: Module
do {
module = try parseModule(rootPath: rootPath, moduleSource: .binary(wat.encode()))
} catch {
return .failed("module could not be parsed: \(error)")
}
do {
_ = try instantiate(module: module)
} catch let error as Trap {
guard error.reason.description.contains(message) else {
return .failed("assertion mismatch: expected: \(message), actual: \(error.reason.description)")
}
} catch {
return .failed("\(error)")
}
return .passed
case .assertReturn(let execute, let results):
let expected = parseValues(args: results)
let actual = try wastExecute(execute: execute)
guard actual.isTestEquivalent(to: expected) else {
return .failed("invoke result mismatch: expected: \(expected), actual: \(actual)")
}
return .passed
case .assertTrap(let execute, let message):
do {
_ = try wastExecute(execute: execute)
return .failed("trap expected: \(message)")
} catch let trap as Trap {
guard trap.reason.description.contains(message) else {
return .failed("assertion mismatch: expected: \(message), actual: \(trap.reason.description)")
}
return .passed
} catch {
return .failed("\(error)")
}
case .assertExhaustion(let call, let message):
do {
_ = try wastInvoke(call: call)
return .failed("trap expected: \(message)")
} catch let trap as Trap {
guard trap.reason.description.contains(message) else {
return .failed("assertion mismatch: expected: \(message), actual: \(trap.reason.description)")
}
return .passed
}
case .assertUnlinkable(let wat, let message):
currentInstance = nil
let module: Module
do {
module = try parseModule(rootPath: rootPath, moduleSource: .text(wat))
} catch {
return .failed("module could not be parsed: \(error)")
}
do {
_ = try instantiate(module: module)
} catch let error as ImportError {
guard error.message.text.contains(message) else {
return .failed("assertion mismatch: expected: \(message), actual: \(error.message.text)")
}
} catch {
return .failed("\(error)")
}
return .passed
case .invoke(let invoke):
_ = try wastInvoke(call: invoke)
return .passed
}
}
private func wastExecute(execute: WastExecute) throws -> [Value] {
switch execute {
case .invoke(let invoke):
return try wastInvoke(call: invoke)
case .get(let module, let globalName):
let instance = try deriveInstance(by: module)
guard case let .global(global) = instance.export(globalName) else {
throw SpectestError("no global export with name \(globalName) in a module instance \(instance)")
}
return [global.value]
case .wat(var wat):
let module = try parseModule(rootPath: rootPath, moduleSource: .binary(wat.encode()))
_ = try instantiate(module: module)
return []
}
}
private func wastInvoke(call: WastInvoke) throws -> [Value] {
let instance = try deriveInstance(by: call.module)
guard let function = instance.exportedFunction(name: call.name) else {
throw SpectestError("function \(call.name) not exported")
}
return try function.invoke(call.args)
}
private func deriveFeatureSet(rootPath: FilePath) -> WasmFeatureSet {
var features = WasmFeatureSet.default
if rootPath.ends(with: "proposals/memory64") {
features.insert(.memory64)
}
return features
}
private func parseModule(rootPath: String, filename: String) throws -> Module {
let rootPath = FilePath(rootPath)
let path = rootPath.appending(filename)
let module = try parseWasm(filePath: path, features: deriveFeatureSet(rootPath: rootPath))
return module
}
private func parseModule(rootPath: String, moduleSource: ModuleSource) throws -> Module {
let rootPath = FilePath(rootPath)
let binary: [UInt8]
switch moduleSource {
case .text(var watModule):
binary = try watModule.encode()
case .quote(let text):
binary = try wat2wasm(String(decoding: text, as: UTF8.self))
case .binary(let bytes):
binary = bytes
}
let module = try parseWasm(bytes: binary, features: deriveFeatureSet(rootPath: rootPath))
return module
}
private func parseValues(args: [WastExpectValue]) -> [WasmKit.Value] {
return args.compactMap {
switch $0 {
case .value(let value): return value
case .f32CanonicalNaN, .f32ArithmeticNaN: return .f32(Float.nan.bitPattern)
case .f64CanonicalNaN, .f64ArithmeticNaN: return .f64(Double.nan.bitPattern)
}
}
}
}
extension Value {
func isTestEquivalent(to value: Self) -> Bool {
switch (self, value) {
case let (.i32(lhs), .i32(rhs)):
return lhs == rhs
case let (.i64(lhs), .i64(rhs)):
return lhs == rhs
case let (.f32(lhs), .f32(rhs)):
let lhs = Float32(bitPattern: lhs)
let rhs = Float32(bitPattern: rhs)
return lhs.isNaN && rhs.isNaN || lhs == rhs
case let (.f64(lhs), .f64(rhs)):
let lhs = Float64(bitPattern: lhs)
let rhs = Float64(bitPattern: rhs)
return lhs.isNaN && rhs.isNaN || lhs == rhs
case let (.ref(.extern(lhs)), .ref(.extern(rhs))):
return lhs == rhs
case let (.ref(.function(lhs)), .ref(.function(rhs))):
return lhs == rhs
default:
return false
}
}
}
extension Array where Element == Value {
func isTestEquivalent(to arrayOfValues: Self) -> Bool {
guard count == arrayOfValues.count else {
return false
}
for (i, value) in enumerated() {
if !value.isTestEquivalent(to: arrayOfValues[i]) {
return false
}
}
return true
}
}
extension Swift.Error {
var text: String {
if let error = self as? WasmParserError {
return error.description
}
return "unknown error: \(self)"
}
}
#if os(Windows)
import WinSDK
#endif
internal func isDirectory(_ path: FilePath) -> Bool {
#if os(Windows)
return path.withPlatformString {
let result = GetFileAttributesW($0)
return result != INVALID_FILE_ATTRIBUTES && result & DWORD(FILE_ATTRIBUTE_DIRECTORY) != 0
}
#else
let fd = try? FileDescriptor.open(path, FileDescriptor.AccessMode.readOnly, options: .directory)
let isDirectory = fd != nil
try? fd?.close()
return isDirectory
#endif
}
|