Skip to content

Commit

Permalink
test imports directly
Browse files Browse the repository at this point in the history
  • Loading branch information
rnro committed Jan 6, 2025
1 parent a968d3c commit ec55cd5
Show file tree
Hide file tree
Showing 7 changed files with 212 additions and 164 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ struct IDLToStructuredSwiftTranslator: Translator {
return StructuredSwiftRepresentation(file: file)
}

private func makeImports(
internal func makeImports(
dependencies: [Dependency],
accessLevel: SourceGenerator.Config.AccessLevel,
accessLevelOnImports: Bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import Testing

@testable import GRPCCodeGen

extension StructuedSwiftTests {
extension StructuredSwiftTests {
@Suite("Client")
struct Client {
@Test(
Expand Down
200 changes: 200 additions & 0 deletions Tests/GRPCCodeGenTests/Internal/StructuredSwift+ImportTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
/*
* Copyright 2024, gRPC Authors All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import Testing

@testable import GRPCCodeGen

extension StructuredSwiftTests {
@Suite("Import")
struct Import {
static let translator = IDLToStructuredSwiftTranslator()

static let allAccessLevels: [SourceGenerator.Config.AccessLevel] = [
.internal, .public, .package,
]

@Test(
"import rendering",
arguments: allAccessLevels
)
func imports(accessLevel: SourceGenerator.Config.AccessLevel) throws {
var dependencies = [Dependency]()
dependencies.append(Dependency(module: "Foo", accessLevel: .public))
dependencies.append(
Dependency(
item: .init(kind: .typealias, name: "Bar"),
module: "Foo",
accessLevel: .internal
)
)
dependencies.append(
Dependency(
item: .init(kind: .struct, name: "Baz"),
module: "Foo",
accessLevel: .package
)
)
dependencies.append(
Dependency(
item: .init(kind: .class, name: "Bac"),
module: "Foo",
accessLevel: .package
)
)
dependencies.append(
Dependency(
item: .init(kind: .enum, name: "Bap"),
module: "Foo",
accessLevel: .package
)
)
dependencies.append(
Dependency(
item: .init(kind: .protocol, name: "Bat"),
module: "Foo",
accessLevel: .package
)
)
dependencies.append(
Dependency(
item: .init(kind: .let, name: "Baq"),
module: "Foo",
accessLevel: .package
)
)
dependencies.append(
Dependency(
item: .init(kind: .var, name: "Bag"),
module: "Foo",
accessLevel: .package
)
)
dependencies.append(
Dependency(
item: .init(kind: .func, name: "Bak"),
module: "Foo",
accessLevel: .package
)
)

let expected =
"""
\(accessLevel.level) import GRPCCore
public import Foo
internal import typealias Foo.Bar
package import struct Foo.Baz
package import class Foo.Bac
package import enum Foo.Bap
package import protocol Foo.Bat
package import let Foo.Baq
package import var Foo.Bag
package import func Foo.Bak
"""

let imports = try StructuredSwiftTests.Import.translator.makeImports(
dependencies: dependencies,
accessLevel: accessLevel,
accessLevelOnImports: true
)

#expect(render(imports) == expected)
}

@Test(
"preconcurrency import rendering"
)
func preconcurrencyImports() throws {
var dependencies = [Dependency]()
dependencies.append(
Dependency(
module: "Foo",
preconcurrency: .required,
accessLevel: .internal
)
)
dependencies.append(
Dependency(
item: .init(kind: .enum, name: "Bar"),
module: "Foo",
preconcurrency: .required,
accessLevel: .internal
)
)
dependencies.append(
Dependency(
module: "Baz",
preconcurrency: .requiredOnOS(["Deq", "Der"]),
accessLevel: .internal
)
)

let expected =
"""
public import GRPCCore
@preconcurrency internal import Foo
@preconcurrency internal import enum Foo.Bar
#if os(Deq) || os(Der)
@preconcurrency internal import Baz
#else
internal import Baz
#endif
"""

let imports = try StructuredSwiftTests.Import.translator.makeImports(
dependencies: dependencies,
accessLevel: .public,
accessLevelOnImports: true
)

#expect(render(imports) == expected)
}

@Test(
"SPI import rendering"
)
func spiImports() throws {
var dependencies = [Dependency]()
dependencies.append(
Dependency(module: "Foo", spi: "Secret", accessLevel: .internal)
)
dependencies.append(
Dependency(
item: .init(kind: .enum, name: "Bar"),
module: "Foo",
spi: "Secret",
accessLevel: .internal
)
)

let expected =
"""
public import GRPCCore
@_spi(Secret) internal import Foo
@_spi(Secret) internal import enum Foo.Bar
"""

let imports = try StructuredSwiftTests.Import.translator.makeImports(
dependencies: dependencies,
accessLevel: .public,
accessLevelOnImports: true
)

#expect(render(imports) == expected)
}

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import Testing

@testable import GRPCCodeGen

extension StructuedSwiftTests {
extension StructuredSwiftTests {
@Suite("Metadata")
struct Metadata {
@Test("typealias Input = <Name>", arguments: AccessModifier.allCases)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import Testing

@testable import GRPCCodeGen

extension StructuedSwiftTests {
extension StructuredSwiftTests {
@Suite("Server")
struct Server {
@Test(
Expand Down
10 changes: 8 additions & 2 deletions Tests/GRPCCodeGenTests/Internal/StructuredSwiftTestHelpers.swift
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ import Testing
@testable import GRPCCodeGen

// Used as a namespace for organising other structured swift tests.
@Suite("Structued Swift")
struct StructuedSwiftTests {}
@Suite("Structured Swift")
struct StructuredSwiftTests {}

func render(_ declaration: Declaration) -> String {
let renderer = TextBasedRenderer(indentation: 2)
Expand All @@ -40,6 +40,12 @@ func render(_ blocks: [CodeBlock]) -> String {
return renderer.renderedContents()
}

func render(_ imports: [ImportDescription]) -> String {
let renderer = TextBasedRenderer(indentation: 2)
renderer.renderImports(imports)
return renderer.renderedContents()
}

enum RPCKind: Hashable, Sendable, CaseIterable {
case unary
case clientStreaming
Expand Down
Loading

0 comments on commit ec55cd5

Please sign in to comment.