[test only] Combine many of the various SGF test helpers #955
Conversation
|
@swift-ci please test |
| pathComponents: [String], | ||
| docComment: String? = nil, | ||
| accessLevel: SymbolGraph.Symbol.AccessControl = .init(rawValue: "public"), // Defined internally in SwiftDocC | ||
| location: (position: SymbolGraph.LineList.SourceRange.Position, url: URL)? = (defaultSymbolPosition, defaultSymbolURL), |
There was a problem hiding this comment.
We're duplicating these defaults 3 times in this file, it would be nice if we only used them once. I think here we could make it a non-optional value and save us needing to have defaults later on:
https://github.com/apple/swift-docc/blob/64ec387cab27ce898f74df36eff2d0d548b77658/Sources/SwiftDocCTestUtilities/SymbolGraphCreation.swift#L108-L109
| location: (position: SymbolGraph.LineList.SourceRange.Position, url: URL)? = (defaultSymbolPosition, defaultSymbolURL), | |
| location: (position: SymbolGraph.LineList.SourceRange.Position, url: URL) = (defaultSymbolPosition, defaultSymbolURL), |
and then we won't need the defaults:
makeLineList(
docComment: $0,
startOffset: location.position,
url: location.url
)There was a problem hiding this comment.
There are some cases where real world data doesn't have a location, for example if the symbol graph was extracted from a binary instead of from source code.
I prefer to keep the ability to create such a value. The idea is that makeLineList, makeMixins, makeMetadata, makeModule, etc. all should be usable from any test. That's why each of them duplicate the default values so that the caller doesn't have to.
| private let start = SymbolGraph.LineList.SourceRange.Position(line: 7, character: 6) // an arbitrary non-zero start position | ||
| private let symbolURL = URL(fileURLWithPath: "/path/to/SomeFile.swift") | ||
| private let symbolURL = URL(fileURLWithPath: "/path/to/SomeFile.swift") |
There was a problem hiding this comment.
Does this still need to be explicitly defined for these tests or can we use makeSymbolGraph's defaults? I ask because this is very close to the default location values.
There was a problem hiding this comment.
My reason for this change is that by making the default values private variables, any test that wants to inspect and make assertions about these values would need to define customize the location and URL. If the test only needs a realistic value it can use the defaults. If the test has expectations about a specific value, it should define that value.
With this reasoning; it's intentional that this file uses a different URL than the default value. I'll update the default location as well so that it's not the same as this customized value.
|
@swift-ci please test |
# Conflicts: # Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
Also, make single-use helper function private
# Conflicts: # Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/PlistDetailsSectionTranslator.swift # Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
|
@swift-ci please test |
|
@swift-ci please test |
Bug/issue #, if applicable:
Summary
This is a test-only change that combined many of the test helpers for creating symbol graph files and symbols.
Dependencies
None
Testing
This is a test-only change.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
AddedUpdated tests./bin/testscript and it succeededUpdated documentation if necessaryNot applicable