Skip to content
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

Jump to bottom

Add linting for mismatching build configurations in a workspace #474

Merged
merged 5 commits into from Aug 4, 2019
Merged

Add linting for mismatching build configurations in a workspace #474

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e455131
Add linting for mismatching build configurations in a workspace
kwridan Jul 30, 2019
d51bee9
Update changelog
kwridan Aug 3, 2019
27df26a
undo comment formating
kwridan Aug 3, 2019
6919483
swift format
kwridan Aug 3, 2019
739ca47
correcting typo
kwridan Aug 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ Please, check out guidelines: https://keepachangelog.com/en/1.0.0/
- Adding ability to re-generate individual projects https://github.com/tuist/tuist/pull/457 by @kwridan
- Support multiple header paths https://github.com/tuist/tuist/pull/459 by @adamkhazi
- Allow specifying multiple configurations within project manifests https://github.com/tuist/tuist/pull/451 by @kwridan
- Add linting for mismatching build configurations in a workspace https://github.com/tuist/tuist/pull/474 by @kwridan

### Fixed

Expand Down
159 changes: 92 additions & 67 deletions Sources/TuistGenerator/Linter/GraphLinter.swift
View file
Open in desktop
Expand Up @@ -38,6 +38,7 @@ class GraphLinter: GraphLinting {
var issues: [LintingIssue] = []
issues.append(contentsOf: graph.projects.flatMap(projectLinter.lint))
issues.append(contentsOf: lintDependencies(graph: graph))
issues.append(contentsOf: lintMismatchingConfigurations(graph: graph))
return issues
}

Expand Down Expand Up @@ -148,6 +149,30 @@ class GraphLinter: GraphLinting {
return [issue]
}

private func lintMismatchingConfigurations(graph: Graphing) -> [LintingIssue] {
let entryNodeProjects = graph.entryNodes.compactMap { $0 as? TargetNode }.map { $0.project }

let knownConfgiruations = entryNodeProjects.reduce(into: Set()) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: knownConfgiruations

$0.formUnion(Set($1.settings.configurations.keys))
}

let projectBuildConfigurations = graph.projects.map {
(name: $0.name, buildConfigurations: Set($0.settings.configurations.keys))
}

let mismatchingBuildConfigurations = projectBuildConfigurations.filter {
!knownConfgiruations.isSubset(of: $0.buildConfigurations)
}

return mismatchingBuildConfigurations.map {
let expectedConfigurations = knownConfgiruations.sorted()
let configurations = $0.buildConfigurations.sorted()
let reason = "The project '\($0.name)' has missing or mismatching configurations. It has \(configurations), other projects have \(expectedConfigurations)"
return LintingIssue(reason: reason,
severity: .warning)
}
}

struct LintableTarget: Equatable, Hashable {
let platform: Platform
let product: Product
Expand All @@ -161,11 +186,11 @@ class GraphLinter: GraphLinting {
LintableTarget(platform: .iOS, product: .framework),
LintableTarget(platform: .iOS, product: .staticFramework),
LintableTarget(platform: .iOS, product: .bundle),
// LintableTarget(platform: .iOS, product: .appExtension),
// LintableTarget(platform: .iOS, product: .messagesExtension),
// LintableTarget(platform: .iOS, product: .stickerPack),
// LintableTarget(platform: .watchOS, product: .watch2App),
// LintableTarget(platform: .watchOS, product: .watchApp),
// LintableTarget(platform: .iOS, product: .appExtension),
// LintableTarget(platform: .iOS, product: .messagesExtension),
// LintableTarget(platform: .iOS, product: .stickerPack),
// LintableTarget(platform: .watchOS, product: .watch2App),
// LintableTarget(platform: .watchOS, product: .watchApp),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just double check you're happy with this new alignment, I think by formatting the file it's indented them by accident.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it was swiftformat - will push a revert, hopefully won't get flagged as an unformatted PR 🤐

Copy link
Collaborator Author

@kwridan kwridan Aug 3, 2019 •
edited

Choose a reason for hiding this comment

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

ouch, will have to re-apply those changes

Screen Shot 2019-08-03 at 11 55 38 AM

],
LintableTarget(platform: .iOS, product: .staticLibrary): [
LintableTarget(platform: .iOS, product: .staticLibrary),
Expand Down Expand Up @@ -203,33 +228,33 @@ class GraphLinter: GraphLinting {
LintableTarget(platform: .iOS, product: .bundle),
],
// LintableTarget(platform: .iOS, product: .appExtension): [
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .messagesApplication): [
// LintableTarget(platform: .iOS, product: .messagesExtension),
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .messagesExtension): [
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .stickerPack): [
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .messagesApplication): [
// LintableTarget(platform: .iOS, product: .messagesExtension),
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .messagesExtension): [
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// LintableTarget(platform: .iOS, product: .stickerPack): [
// LintableTarget(platform: .iOS, product: .staticLibrary),
// LintableTarget(platform: .iOS, product: .dynamicLibrary),
// LintableTarget(platform: .iOS, product: .framework),
// ],
// macOS
LintableTarget(platform: .macOS, product: .app): [
LintableTarget(platform: .macOS, product: .staticLibrary),
LintableTarget(platform: .macOS, product: .dynamicLibrary),
LintableTarget(platform: .macOS, product: .framework),
LintableTarget(platform: .iOS, product: .staticFramework),
// LintableTarget(platform: .macOS, product: .appExtension),
// LintableTarget(platform: .macOS, product: .appExtension),
],
LintableTarget(platform: .macOS, product: .staticLibrary): [
LintableTarget(platform: .macOS, product: .staticLibrary),
Expand Down Expand Up @@ -264,17 +289,17 @@ class GraphLinter: GraphLinting {
LintableTarget(platform: .iOS, product: .staticFramework),
],
// LintableTarget(platform: .macOS, product: .appExtension): [
// LintableTarget(platform: .macOS, product: .staticLibrary),
// LintableTarget(platform: .macOS, product: .dynamicLibrary),
// LintableTarget(platform: .macOS, product: .framework),
// ],
// LintableTarget(platform: .macOS, product: .staticLibrary),
// LintableTarget(platform: .macOS, product: .dynamicLibrary),
// LintableTarget(platform: .macOS, product: .framework),
// ],
// tvOS
LintableTarget(platform: .tvOS, product: .app): [
LintableTarget(platform: .tvOS, product: .staticLibrary),
LintableTarget(platform: .tvOS, product: .dynamicLibrary),
LintableTarget(platform: .tvOS, product: .framework),
LintableTarget(platform: .iOS, product: .staticFramework),
// LintableTarget(platform: .tvOS, product: .tvExtension),
// LintableTarget(platform: .tvOS, product: .tvExtension),
],
LintableTarget(platform: .tvOS, product: .staticLibrary): [
LintableTarget(platform: .tvOS, product: .staticLibrary),
Expand All @@ -299,42 +324,42 @@ class GraphLinter: GraphLinting {
LintableTarget(platform: .tvOS, product: .framework),
LintableTarget(platform: .iOS, product: .staticFramework),
],
// LintableTarget(platform: .tvOS, product: .tvExtension): [
// LintableTarget(platform: .tvOS, product: .staticLibrary),
// LintableTarget(platform: .tvOS, product: .dynamicLibrary),
// LintableTarget(platform: .tvOS, product: .framework),
// ],
// LintableTarget(platform: .tvOS, product: .tvExtension): [
// LintableTarget(platform: .tvOS, product: .staticLibrary),
// LintableTarget(platform: .tvOS, product: .dynamicLibrary),
// LintableTarget(platform: .tvOS, product: .framework),
// ],
// watchOS
// LintableTarget(platform: .watchOS, product: .watchApp): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// LintableTarget(platform: .watchOS, product: .watchExtension),
// ],
// LintableTarget(platform: .watchOS, product: .watch2App): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// LintableTarget(platform: .watchOS, product: .watch2Extension),
// ],
// LintableTarget(platform: .watchOS, product: .staticLibrary): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// ],
// LintableTarget(platform: .watchOS, product: .dynamicLibrary): [
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// ],
// LintableTarget(platform: .watchOS, product: .framework): [
// LintableTarget(platform: .watchOS, product: .framework),
// ],
// LintableTarget(platform: .watchOS, product: .watchExtension): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// ],
// LintableTarget(platform: .watchOS, product: .watch2Extension): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// ],
// LintableTarget(platform: .watchOS, product: .watchApp): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// LintableTarget(platform: .watchOS, product: .watchExtension),
// ],
// LintableTarget(platform: .watchOS, product: .watch2App): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// LintableTarget(platform: .watchOS, product: .watch2Extension),
// ],
// LintableTarget(platform: .watchOS, product: .staticLibrary): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// ],
// LintableTarget(platform: .watchOS, product: .dynamicLibrary): [
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// ],
// LintableTarget(platform: .watchOS, product: .framework): [
// LintableTarget(platform: .watchOS, product: .framework),
// ],
// LintableTarget(platform: .watchOS, product: .watchExtension): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// ],
// LintableTarget(platform: .watchOS, product: .watch2Extension): [
// LintableTarget(platform: .watchOS, product: .staticLibrary),
// LintableTarget(platform: .watchOS, product: .dynamicLibrary),
// LintableTarget(platform: .watchOS, product: .framework),
// ],
]
}
6 changes: 6 additions & 0 deletions Sources/TuistGenerator/Models/BuildConfiguration.swift
View file
Open in desktop
Expand Up @@ -54,3 +54,9 @@ extension BuildConfiguration: Comparable {
extension BuildConfiguration: XcodeRepresentable {
public var xcodeValue: String { return name }
}

extension BuildConfiguration: CustomStringConvertible {
public var description: String {
return "\(name) (\(variant.rawValue))"
}
}
7 changes: 6 additions & 1 deletion Tests/TuistGeneratorTests/Graph/TestData/Graph+TestData.swift
View file
Open in desktop
Expand Up @@ -45,14 +45,19 @@ extension Graph {
/// The `dependencies` property is used to define the dependencies explicitly.
/// All targets need to be listed even if they don't have any dependencies.
static func create(projects: [Project] = [],
entryNodes: [Target]? = nil,
dependencies: [(project: Project, target: Target, dependencies: [Target])]) -> Graph {
let targetNodes = createTargetNodes(dependencies: dependencies)

let entryNodes = entryNodes.map { entryNodes in
targetNodes.filter { entryNodes.contains($0.target) }
}

let cache = GraphLoaderCache()
let graph = Graph.test(name: projects.first?.name ?? "Test",
entryPath: projects.first?.path ?? "/test/path",
cache: cache,
entryNodes: targetNodes)
entryNodes: entryNodes ?? targetNodes)

targetNodes.forEach { cache.add(targetNode: $0) }
projects.forEach { cache.add(project: $0) }
Expand Down