Skip to content

Test Query Operator Descriptions #796

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

Open
btoms20 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Test Query Operator Descriptions #796

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63b42a1
use DummyDatabase from XCTFluent
btoms20 Feb 11, 2026
5226e9f
ensure the description matches the operator
btoms20 Feb 11, 2026
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
106 changes: 43 additions & 63 deletions Tests/FluentTests/OperatorTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,61 @@ import Fluent
import Testing
import Vapor
import VaporTesting
import XCTFluent

@Suite
struct OperatorTests {
@Test
func customOperators() throws {
// TODO: What does this test...?
let db = DummyDatabase()

// name contains string anywhere, prefix, suffix
_ = Planet.query(on: db)
.filter(\.$name ~~ "art")
_ = Planet.query(on: db)
.filter(\.$name =~ "art")
_ = Planet.query(on: db)
.filter(\.$name ~= "art")
#expect(
Planet.query(on: db)
.filter(\.$name ~~ "art").query.description
== #"query read planets filters=[planets[name] contains "art"]"#
)
#expect(
Planet.query(on: db)
.filter(\.$name =~ "art").query.description
== #"query read planets filters=[planets[name] startswith "art"]"#
)
#expect(
Planet.query(on: db)
.filter(\.$name ~= "art").query.description
== #"query read planets filters=[planets[name] endswith "art"]"#
)

// name doesn't contain string anywhere, prefix, suffix
_ = Planet.query(on: db)
.filter(\.$name !~ "art")
_ = Planet.query(on: db)
.filter(\.$name !=~ "art")
_ = Planet.query(on: db)
.filter(\.$name !~= "art")
#expect(
Planet.query(on: db)
.filter(\.$name !~ "art").query.description
== #"query read planets filters=[planets[name] !contains "art"]"#
)
#expect(
Planet.query(on: db)
.filter(\.$name !=~ "art").query.description
== #"query read planets filters=[planets[name] !startswith "art"]"#
)
#expect(
Planet.query(on: db)
.filter(\.$name !~= "art").query.description
== #"query read planets filters=[planets[name] !endswith "art"]"#
)

// name in array
_ = Planet.query(on: db)
.filter(\.$name ~~ ["Earth", "Mars"])
#expect(
Planet.query(on: db)
.filter(\.$name ~~ ["Earth", "Mars"]).query.description
== #"query read planets filters=[planets[name] ~~ ["Earth", "Mars"]]"#
)

// name not in array
_ = Planet.query(on: db)
.filter(\.$name !~ ["Earth", "Mars"])
#expect(
Planet.query(on: db)
.filter(\.$name !~ ["Earth", "Mars"]).query.description
== #"query read planets filters=[planets[name] !~~ ["Earth", "Mars"]]"#
)
}
}

Expand All @@ -43,49 +69,3 @@ private final class Planet: Model, @unchecked Sendable {
@Field(key: "name")
var name: String
}

private struct DummyDatabase: Database {
var inTransaction: Bool {
false
}

var context: DatabaseContext {
.init(configuration: DummyDatabaseConfiguration(), logger: Logger(label: "fluent"), eventLoop: MultiThreadedEventLoopGroup.singleton.any())
}

func execute(query: DatabaseQuery, onOutput: @escaping @Sendable (any DatabaseOutput) -> Void) -> EventLoopFuture<Void> {
fatalError()
}

func execute(schema: DatabaseSchema) -> EventLoopFuture<Void> {
fatalError()
}

func execute(enum: DatabaseEnum) -> EventLoopFuture<Void> {
fatalError()
}

func withConnection<T>(_ closure: @escaping @Sendable (any Database) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
fatalError()
}

func transaction<T>(_ closure: @escaping @Sendable (any Database) -> EventLoopFuture<T>) -> EventLoopFuture<T> {
fatalError()
}
}

private struct DummyDatabaseConfiguration: DatabaseConfiguration {
var middleware: [any FluentKit.AnyModelMiddleware] = []

func makeDriver(for databases: FluentKit.Databases) -> any FluentKit.DatabaseDriver {
DummyDatabaseDriver()
}
}

private struct DummyDatabaseDriver: DatabaseDriver {
func makeDatabase(with context: FluentKit.DatabaseContext) -> any FluentKit.Database {
DummyDatabase()
}

func shutdown() {}
}