Support #if/#elseif/#endif conditional compilation in mock generation#597
Draft
DominatorVbN wants to merge 1 commit into
Draft
Support #if/#elseif/#endif conditional compilation in mock generation#597DominatorVbN wants to merge 1 commit into
DominatorVbN wants to merge 1 commit into
Conversation
Uses SwiftIfConfig (part of swift-syntax) to evaluate #if blocks in crawled source files. Only the active branch is visited, so conditionally compiled methods and properties are included or excluded correctly. Users specify active custom conditions via `build_conditions` in Cuckoofile.toml (e.g. `build_conditions = ["DEBUG", "MY_FEATURE"]`). Platform/arch/os queries default to false when not explicitly modelled. Fixes Brightify#471.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #471 — conditional compilation blocks (
#if/#elseif/#else/#endif) in protocols and classes are now correctly handled by the mock generator.SwiftIfConfig(already included in theswift-syntaxpackage dependency) to evaluate#ifconditions against a configurable build configuration.// TODO: Implement #if functionality.stub inCrawler.visit(_:IfConfigDeclSyntax)with proper active-clause evaluation — only the active branch's members are crawled.build_conditionsfield toCuckoofile.tomlmodule configuration so users can declare which custom conditions are active during mock generation:os(iOS)) default to false (inactive), matching the safest behaviour — only explicitly declared conditions are active.Changes
Package.swiftSwiftIfConfigproduct toCuckooGeneratortarget dependenciesGenerator/Project.swiftGenerator/Sources/Internal/Crawlers/CuckooGeneratorBuildConfiguration.swiftBuildConfigurationprotocol for use withSwiftIfConfigGenerator/Sources/Internal/Crawlers/Crawler.swiftSwiftIfConfigto evaluate#ifconditions; propagatebuildConfigurationthrough sub-crawlersGenerator/Sources/CLI/Module.swiftbuildConditions: Set<String>property andbuild_conditionsTOML keyGenerator/Sources/CLI/Generator.swiftCuckooGeneratorBuildConfigurationfrom module'sbuildConditionsand pass toCrawler.crawlTest plan
#if MY_FLAGblock: whenMY_FLAGis inbuild_conditions, the flagged methods appear in the generated mock; when absent, they are excluded#elseifand#elsebranches are resolved to the correct active clause#ifblocks inside#ifblocks work correctly#if os(iOS)produce no members by default (not crashing or including both branches)#ifblocks are unaffected