Skip to content

Propagate method async-ness during test discovery #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions Sources/TSCUtility/IndexStore.swift
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,19 @@ import TSCBasic
public final class IndexStore {

public struct TestCaseClass {
public struct TestMethod: Hashable, Comparable {
public let name: String
public let isAsync: Bool

public static func < (lhs: IndexStore.TestCaseClass.TestMethod, rhs: IndexStore.TestCaseClass.TestMethod) -> Bool {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need full Comparable or just Equatable? Equatable should be fully synthesized.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lower down, we sort these, so I think we do actually need Comparable.

return (lhs.name, (lhs.isAsync ? 1 : 0)) < (rhs.name, (rhs.isAsync ? 1 : 0))
}
}

public var name: String
public var module: String
public var methods: [String]
public var testMethods: [TestMethod]
@available(*, deprecated, message: "use testMethods instead") public var methods: [String]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not too sure what the source compatibility requirement on this is. Let me know if this should be different!

}

fileprivate var impl: IndexStoreImpl { _impl as! IndexStoreImpl }
Expand Down Expand Up @@ -90,15 +100,16 @@ private final class IndexStoreImpl {
let recordReader = try api.call{ fn.record_reader_create(store, record, &$0) }

class TestCaseBuilder {
var classToMethods: [String: Set<String>] = [:]
var classToMethods: [String: Set<TestCaseClass.TestMethod>] = [:]

func add(klass: String, method: String) {
classToMethods[klass, default: []].insert(method)
func add(className: String, method: TestCaseClass.TestMethod) {
classToMethods[className, default: []].insert(method)
}

func build() -> [TestCaseClass] {
return classToMethods.map {
TestCaseClass(name: $0.key, module: "", methods: $0.value.sorted())
let testMethods = Array($0.value).sorted()
return TestCaseClass(name: $0.key, module: "", testMethods: testMethods, methods: testMethods.map(\.name))
}
}
}
Expand All @@ -112,9 +123,9 @@ private final class IndexStoreImpl {

// Get the symbol.
let sym = fn.occurrence_get_symbol(occ)

let symbolProperties = fn.symbol_get_properties(sym)
// We only care about symbols that are marked unit tests and are instance methods.
if fn.symbol_get_properties(sym) != UInt64(INDEXSTORE_SYMBOL_PROPERTY_UNITTEST.rawValue) {
if symbolProperties & UInt64(INDEXSTORE_SYMBOL_PROPERTY_UNITTEST.rawValue) == 0 {
return true
}
if fn.symbol_get_kind(sym) != INDEXSTORE_SYMBOL_KIND_INSTANCEMETHOD {
Expand All @@ -140,8 +151,9 @@ private final class IndexStoreImpl {
}

if !className.instance.isEmpty {
let testMethod = fn.symbol_get_name(sym).str
builder.instance.add(klass: className.instance, method: testMethod)
let methodName = fn.symbol_get_name(sym).str
let isAsync = symbolProperties & UInt64(INDEXSTORE_SYMBOL_PROPERTY_SWIFT_ASYNC.rawValue) != 0
builder.instance.add(className: className.instance, method: TestCaseClass.TestMethod(name: methodName, isAsync: isAsync))
}

return true
Expand Down
1 change: 1 addition & 0 deletions Sources/TSCclibc/include/indexstore_functions.h
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ typedef enum {
INDEXSTORE_SYMBOL_PROPERTY_GKINSPECTABLE = 1 << 6,
INDEXSTORE_SYMBOL_PROPERTY_LOCAL = 1 << 7,
INDEXSTORE_SYMBOL_PROPERTY_PROTOCOL_INTERFACE = 1 << 8,
INDEXSTORE_SYMBOL_PROPERTY_SWIFT_ASYNC = 1 << 16,
} indexstore_symbol_property_t;

typedef enum {
Expand Down