Add data loading test helpers for Swift Testing and draft contributor information about writing tests #1362
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,30 +8,31 @@ | |
| See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
| */ | ||
|
|
||
| import Testing | ||
| import Markdown | ||
| @testable import SwiftDocC | ||
| import SwiftDocCTestUtilities | ||
|
|
||
| struct NonInclusiveLanguageCheckerTests { | ||
| @Test | ||
| func testMatchTermInTitle() throws { | ||
| let source = """ | ||
| # A Whitelisted title | ||
| """ | ||
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 1) | ||
|
|
||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 1) | ||
| #expect(range.lowerBound.column == 5) | ||
| #expect(range.upperBound.line == 1) | ||
| #expect(range.upperBound.column == 16) | ||
| } | ||
|
|
||
| @Test | ||
| func testMatchTermWithSpaces() throws { | ||
| let source = """ | ||
| # A White listed title | ||
|
|
@@ -41,30 +42,31 @@ class NonInclusiveLanguageCheckerTests: XCTestCase { | |
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 3) | ||
|
|
||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 1) | ||
| #expect(range.lowerBound.column == 5) | ||
| #expect(range.upperBound.line == 1) | ||
| #expect(range.upperBound.column == 18) | ||
|
|
||
| let problemTwo = try #require(checker.problems.dropFirst(1).first) | ||
| let rangeTwo = try #require(problemTwo.diagnostic.range) | ||
| #expect(rangeTwo.lowerBound.line == 2) | ||
| #expect(rangeTwo.lowerBound.column == 5) | ||
| #expect(rangeTwo.upperBound.line == 2) | ||
| #expect(rangeTwo.upperBound.column == 20) | ||
|
|
||
| let problemThree = try #require(checker.problems.dropFirst(2).first) | ||
| let rangeThree = try #require(problemThree.diagnostic.range) | ||
| #expect(rangeThree.lowerBound.line == 3) | ||
| #expect(rangeThree.lowerBound.column == 5) | ||
| #expect(rangeThree.upperBound.line == 3) | ||
| #expect(rangeThree.upperBound.column == 17) | ||
| } | ||
|
|
||
| @Test | ||
| func testMatchTermInAbstract() throws { | ||
| let source = """ | ||
| # Title | ||
|
|
@@ -74,16 +76,17 @@ The blacklist is in the abstract. | |
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 1) | ||
|
|
||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 3) | ||
| #expect(range.lowerBound.column == 5) | ||
| #expect(range.upperBound.line == 3) | ||
| #expect(range.upperBound.column == 14) | ||
| } | ||
|
|
||
| @Test | ||
| func testMatchTermInParagraph() throws { | ||
| let source = """ | ||
| # Title | ||
|
|
@@ -98,16 +101,17 @@ master branch is the default. | |
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 1) | ||
|
|
||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 8) | ||
| #expect(range.lowerBound.column == 1) | ||
| #expect(range.upperBound.line == 8) | ||
| #expect(range.upperBound.column == 7) | ||
| } | ||
|
|
||
| @Test | ||
| func testMatchTermInList() throws { | ||
| let source = """ | ||
| - Item 1 is ok | ||
|
|
@@ -117,33 +121,35 @@ master branch is the default. | |
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 1) | ||
|
|
||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 2) | ||
| #expect(range.lowerBound.column == 13) | ||
| #expect(range.upperBound.line == 2) | ||
| #expect(range.upperBound.column == 24) | ||
| } | ||
|
|
||
| @Test | ||
| func testMatchTermInInlineCode() throws { | ||
| let source = """ | ||
| The name `MachineSlave` is unacceptable. | ||
| """ | ||
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 1) | ||
|
|
||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 1) | ||
| #expect(range.lowerBound.column == 18) | ||
| #expect(range.upperBound.line == 1) | ||
| #expect(range.upperBound.column == 23) | ||
| } | ||
|
|
||
| @Test | ||
| func testMatchTermInCodeBlock() throws { | ||
| let source = """ | ||
| A code block: | ||
|
|
@@ -158,13 +164,13 @@ func aBlackListedFunc() { | |
| let document = Document(parsing: source) | ||
| var checker = NonInclusiveLanguageChecker(sourceFile: nil) | ||
| checker.visit(document) | ||
| #expect(checker.problems.count == 1) | ||
| let problem = try #require(checker.problems.first) | ||
| let range = try #require(problem.diagnostic.range) | ||
| #expect(range.lowerBound.line == 5) | ||
| #expect(range.lowerBound.column == 7) | ||
| #expect(range.upperBound.line == 5) | ||
| #expect(range.upperBound.column == 18) | ||
| } | ||
|
|
||
| private let nonInclusiveContent = """ | ||
|
|
@@ -177,36 +183,32 @@ func aBlackListedFunc() { | |
| - item three | ||
| """ | ||
|
|
||
| @Test | ||
| func testDisabledByDefault() async throws { | ||
| // Create a test bundle with some non-inclusive content. | ||
| let catalog = Folder(name: "unit-test.docc", content: [ | ||
| TextFile(name: "Root.md", utf8Content: nonInclusiveContent) | ||
| ]) | ||
| let context = try await load(catalog: catalog) | ||
|
|
||
| #expect(context.problems.isEmpty) // Non-inclusive content is an info-level diagnostic, so it's filtered out. | ||
| } | ||
|
|
||
| @Test(arguments: [ | ||
| DiagnosticSeverity.hint: true, | ||
| DiagnosticSeverity.information: true, | ||
| DiagnosticSeverity.warning: false, | ||
| DiagnosticSeverity.error: false, | ||
| ]) | ||
| func testEnablingTheChecker(configuredDiagnosticSeverity: DiagnosticSeverity, expectsToIncludeANonInclusiveDiagnostic: Bool) async throws { | ||
| let catalog = Folder(name: "unit-test.docc", content: [ | ||
| TextFile(name: "Root.md", utf8Content: nonInclusiveContent) | ||
| ]) | ||
| var configuration = DocumentationContext.Configuration() | ||
| configuration.externalMetadata.diagnosticLevel = configuredDiagnosticSeverity | ||
| let context = try await load(catalog: catalog, diagnosticFilterLevel: configuredDiagnosticSeverity, configuration: configuration) | ||
|
|
||
| // Verify that checker diagnostics were emitted or not, depending on the diagnostic level set. | ||
| #expect(context.problems.contains(where: { $0.diagnostic.identifier == "org.swift.docc.NonInclusiveLanguage" }) == expectsToIncludeANonInclusiveDiagnostic) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,36 @@ | ||
| /* | ||
| This source file is part of the Swift.org open source project | ||
|
|
||
| Copyright (c) 2021-2025 Apple Inc. and the Swift project authors | ||
| Licensed under Apache License v2.0 with Runtime Library Exception | ||
|
|
||
| See https://swift.org/LICENSE.txt for license information | ||
| See https://swift.org/CONTRIBUTORS.txt for Swift project authors | ||
| */ | ||
|
|
||
| import Foundation | ||
| import Testing | ||
| import Markdown | ||
|
|
||
| @testable import SwiftDocC | ||
|
|
||
| struct ParseDirectiveArgumentsTests { | ||
| @Test(arguments: [ | ||
| // Missing quotation marks around string parameter | ||
| "@Directive(argument: multiple words)": "org.swift.docc.Directive.MissingExpectedCharacter", | ||
| // Missing quotation marks around string parameter in 2nd parameter | ||
| "@Directive(argumentA: value, argumentB: multiple words)": "org.swift.docc.Directive.MissingExpectedCharacter", | ||
| // Duplicate argument | ||
| "@Directive(argumentA: value, argumentA: value)": "org.swift.docc.Directive.DuplicateArgument", | ||
| ]) | ||
| func testEmitsWarningsForInvalidMarkup(invalidMarkup: String, expectedDiagnosticID: String) throws { | ||
| let document = Document(parsing: invalidMarkup, options: .parseBlockDirectives) | ||
| var problems = [Problem]() | ||
| _ = (document.child(at: 0) as? BlockDirective)?.arguments(problems: &problems) | ||
|
|
||
| let diagnostic = try #require(problems.first?.diagnostic) | ||
|
|
||
| #expect(diagnostic.identifier == expectedDiagnosticID) | ||
| #expect(diagnostic.severity == .warning) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe make this stronger? I wasn't sure how heavily you wanted to lean into swift-testing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what amount of assertiveness (if that's the correct word) is right for this messaging. That's precisely what I hoped to get feedback on in this PR.
The team has previously talked about using Swift Testing for new tests and to slowly and incrementally transition existing tests.