Skip to content

Adopt swift-testing for status tests #2049

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.

Sign up for GitHub

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 2 commits into from
Sep 9, 2024
Merged

Adopt swift-testing for status tests #2049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b353869
Motivation:
glbrntt Sep 9, 2024
6f6d691
Merge branch 'main' into v2/swift-testing-status-tests
glbrntt Sep 9, 2024
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
12 changes: 12 additions & 0 deletions Package@swift-6.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ let packageDependencies: [Package.Dependency] = [
url: "https://github.com/apple/swift-distributed-tracing.git",
from: "1.0.0"
),
.package(
url: "https://github.com/swiftlang/swift-testing.git",
branch: "release/6.0"
),
].appending(
.package(
url: "https://github.com/apple/swift-nio-ssl.git",
Expand Down Expand Up @@ -147,6 +151,13 @@ extension Target.Dependency {
static var dequeModule: Self { .product(name: "DequeModule", package: "swift-collections") }
static var atomics: Self { .product(name: "Atomics", package: "swift-atomics") }
static var tracing: Self { .product(name: "Tracing", package: "swift-distributed-tracing") }
static var testing: Self {
.product(
name: "Testing",
package: "swift-testing",
condition: .when(platforms: [.linux]) // Already included in the toolchain on Darwin
)
}

static var grpcCore: Self { .target(name: "GRPCCore") }
static var grpcInProcessTransport: Self { .target(name: "GRPCInProcessTransport") }
Expand Down Expand Up @@ -401,6 +412,7 @@ extension Target {
.grpcInProcessTransport,
.dequeModule,
.protobuf,
.testing,
],
swiftSettings: [.swiftLanguageMode(.v6), .enableUpcomingFeature("ExistentialAny")]
)
Expand Down
19 changes: 19 additions & 0 deletions Sources/GRPCCore/RPCError.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,25 @@ extension RPCError {
public var description: String {
String(describing: self.wrapped)
}

package static let all: [Self] = [
.cancelled,
.unknown,
.invalidArgument,
.deadlineExceeded,
.notFound,
.alreadyExists,
.permissionDenied,
.resourceExhausted,
.failedPrecondition,
.aborted,
.outOfRange,
.unimplemented,
.internalError,
.unavailable,
.dataLoss,
.unauthenticated,
]
}
}

Expand Down
20 changes: 20 additions & 0 deletions Sources/GRPCCore/Status.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,26 @@ extension Status {
public var description: String {
String(describing: self.wrapped)
}

package static let all: [Self] = [
.ok,
.cancelled,
.unknown,
.invalidArgument,
.deadlineExceeded,
.notFound,
.alreadyExists,
.permissionDenied,
.resourceExhausted,
.failedPrecondition,
.aborted,
.outOfRange,
.unimplemented,
.internalError,
.unavailable,
.dataLoss,
.unauthenticated,
]
}
}

Expand Down
125 changes: 40 additions & 85 deletions Tests/GRPCCoreTests/StatusTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,105 +13,60 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import GRPCCore
import XCTest

final class StatusTests: XCTestCase {
private static let statusCodeRawValue: [(Status.Code, Int)] = [
(.ok, 0),
(.cancelled, 1),
(.unknown, 2),
(.invalidArgument, 3),
(.deadlineExceeded, 4),
(.notFound, 5),
(.alreadyExists, 6),
(.permissionDenied, 7),
(.resourceExhausted, 8),
(.failedPrecondition, 9),
(.aborted, 10),
(.outOfRange, 11),
(.unimplemented, 12),
(.internalError, 13),
(.unavailable, 14),
(.dataLoss, 15),
(.unauthenticated, 16),
]

func testCustomStringConvertible() {
XCTAssertDescription(Status(code: .ok, message: ""), #"ok: """#)
XCTAssertDescription(Status(code: .dataLoss, message: "message"), #"dataLoss: "message""#)
XCTAssertDescription(Status(code: .unknown, message: "message"), #"unknown: "message""#)
XCTAssertDescription(Status(code: .aborted, message: "message"), #"aborted: "message""#)
}
import GRPCCore
import Testing

func testStatusCodeRawValues() {
for (code, expected) in Self.statusCodeRawValue {
XCTAssertEqual(code.rawValue, expected, "\(code) had unexpected raw value")
@Suite("Status")
struct StatusTests {
@Suite("Code")
struct Code {
@Test("rawValue", arguments: zip(Status.Code.all, 0 ... 16))
func rawValueOfStatusCodes(code: Status.Code, expected: Int) {
#expect(code.rawValue == expected)
}
}

func testStatusCodeFromErrorCode() throws {
XCTAssertEqual(Status.Code(RPCError.Code.cancelled), .cancelled)
XCTAssertEqual(Status.Code(RPCError.Code.unknown), .unknown)
XCTAssertEqual(Status.Code(RPCError.Code.invalidArgument), .invalidArgument)
XCTAssertEqual(Status.Code(RPCError.Code.deadlineExceeded), .deadlineExceeded)
XCTAssertEqual(Status.Code(RPCError.Code.notFound), .notFound)
XCTAssertEqual(Status.Code(RPCError.Code.alreadyExists), .alreadyExists)
XCTAssertEqual(Status.Code(RPCError.Code.permissionDenied), .permissionDenied)
XCTAssertEqual(Status.Code(RPCError.Code.resourceExhausted), .resourceExhausted)
XCTAssertEqual(Status.Code(RPCError.Code.failedPrecondition), .failedPrecondition)
XCTAssertEqual(Status.Code(RPCError.Code.aborted), .aborted)
XCTAssertEqual(Status.Code(RPCError.Code.outOfRange), .outOfRange)
XCTAssertEqual(Status.Code(RPCError.Code.unimplemented), .unimplemented)
XCTAssertEqual(Status.Code(RPCError.Code.internalError), .internalError)
XCTAssertEqual(Status.Code(RPCError.Code.unavailable), .unavailable)
XCTAssertEqual(Status.Code(RPCError.Code.dataLoss), .dataLoss)
XCTAssertEqual(Status.Code(RPCError.Code.unauthenticated), .unauthenticated)
}

func testStatusCodeFromValidRawValue() {
for (expected, rawValue) in Self.statusCodeRawValue {
XCTAssertEqual(
Status.Code(rawValue: rawValue),
expected,
"\(rawValue) didn't convert to expected code \(expected)"
@Test(
"Initialize from RPCError.Code",
arguments: zip(
RPCError.Code.all,
Status.Code.all.dropFirst() // Drop '.ok', there is no '.ok' error code.
)
)
func initFromRPCErrorCode(errorCode: RPCError.Code, expected: Status.Code) {
#expect(Status.Code(errorCode) == expected)
}
}

func testStatusCodeFromInvalidRawValue() {
// Internally represented as a `UInt8`; try all other values.
for rawValue in UInt8(17) ... UInt8.max {
XCTAssertNil(Status.Code(rawValue: Int(rawValue)))
@Test("Initialize from rawValue", arguments: zip(0 ... 16, Status.Code.all))
func initFromRawValue(rawValue: Int, expected: Status.Code) {
#expect(Status.Code(rawValue: rawValue) == expected)
}

// API accepts `Int` so try invalid `Int` values too.
XCTAssertNil(Status.Code(rawValue: -1))
XCTAssertNil(Status.Code(rawValue: 1000))
XCTAssertNil(Status.Code(rawValue: .max))
@Test("Initialize from invalid rawValue", arguments: [-1, 17, 100, .max])
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure it's really important, but we're not testing for all values from 17 to UInt8.max anymore

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, not sure it really matters tbh. The UInt8 is an implementation detail so a bit odd to do all of those values given the parameter is an Int.

func initFromInvalidRawValue(rawValue: Int) {
#expect(Status.Code(rawValue: rawValue) == nil)
}
}

func testEquatableConformance() {
XCTAssertEqual(Status(code: .ok, message: ""), Status(code: .ok, message: ""))
XCTAssertEqual(Status(code: .ok, message: "message"), Status(code: .ok, message: "message"))

XCTAssertNotEqual(
Status(code: .ok, message: ""),
Status(code: .ok, message: "message")
)
@Test("CustomStringConvertible conformance")
func customStringConvertible() {
#expect("\(Status(code: .ok, message: ""))" == #"ok: """#)
#expect("\(Status(code: .dataLoss, message: "oh no"))" == #"dataLoss: "oh no""#)
}

XCTAssertNotEqual(
Status(code: .ok, message: "message"),
Status(code: .internalError, message: "message")
)
@Test("Equatable conformance")
func equatable() {
let ok = Status(code: .ok, message: "")
let okWithMessage = Status(code: .ok, message: "message")
let internalError = Status(code: .internalError, message: "")

XCTAssertNotEqual(
Status(code: .ok, message: "message"),
Status(code: .ok, message: "different message")
)
#expect(ok == ok)
#expect(ok != okWithMessage)
#expect(ok != internalError)
}

func testFitsInExistentialContainer() {
XCTAssertLessThanOrEqual(MemoryLayout<Status>.size, 24)
@Test("Fits in existential container")
func fitsInExistentialContainer() {
#expect(MemoryLayout<Status>.size <= 24)
}
}
Loading