Repository files navigation

This project aims to provide stress testing utilities to help find reproducible crashes and other failures in tools that process Swift source code, such as the Swift compiler and SourceKit. These utilities will ideally be written in Swift and make use the SwiftSyntax and/or SwiftLang libraries to parse, generate and modify Swift source inputs.

The tools in this repository can be built in several different ways:

If you want to build the tools to use a locally built sourcekitd and SwiftLang, use the Swift repository's build-script to build and test the stress tester by passing--skstresstester, its dependencies and the desired tools' flags as extra options. To build and run tests, for example, you would run:

$ ./swift/utils/build-script --test --skip-build-benchmark --skip-test-cmark --skip-test-swift --install-swift --llbuild --install-llbuild --skip-test-llbuild --swiftpm --install-swiftpm --skip-test-swiftpm --skstresstester --swiftevolve --release

For local development, you'll first need to download and install a recentswift.org development snapshot toolchain that matches the latest commit on main in theSwiftSyntax. This is because the Stress Tester depends on the latest version of SwiftSyntax and SwiftSyntax integrates into the latest version of the compiler.

The toolchain is installed into/Library/Developer/Toolchains/ if installed for all users. Note that the$TOOLCHAIN_DIR variables below should include/usr at the end of their path, eg.TOOLCHAIN_DIR=/Library/Developer/Toolchains/swift-DEVELOPMENT-SNAPSHOT-<...>.xctoolchain/usr.

To generate an Xcode project that's set up correctly, runbuild-script-helper.py, passing the path to the downloaded toolchain via the--toolchain option, the tool's package name in the--package-dir option, and thegenerate-xcodeproj action:

$ ./build-script-helper.py --package-dir SourceKitStressTester --toolchain $TOOLCHAIN_DIR generate-xcodeproj --no-local-deps

If you have theSwiftSyntax andSwiftPM repositories already checked out next to the stress tester's repository, you can omit the--no-local-deps option to use the existing checkouts instead of fetching the dependencies using SwiftPM.

This will generateSourceKitStressTester/SourceKitStressTester.xcodeproj. Open it and select the toolchain you installed from the Xcode > Toolchains menu, before building theSourceKitStressTester-Package scheme.

To build, runbuild-script-helper.py, passing the path to the downloaded toolchain via the--toolchain option and the tool's package name in the--package-dir option.

$ ./build-script-helper.py --package-dir SourceKitStressTester --toolchain $TOOLCHAIN_DIR

If you have theSwiftSyntax andSwiftPM repositories already checked out next to the stress tester's repository, you can omit the--no-local-deps option to use the existing checkouts instead of fetching the dependencies using SwiftPM.

To run the tests, repeat the above command, but additionally, pass thetest action:

$ ./Utilities/build-script-helper.py test --package-dir SourceKitStressTester --toolchain $TOOLCHAIN_DIR

Building will create either one or two executables, depending on the package you build. These will be in the package directory's.build/debug subdirectory if building on the command line or via the Swift repo's build-script, and underProducts/Debug in the Xcode project'sDerivedData directory if building there. They are also available in theusr/bin directory of the recent trunk and swift 5.0 development toolchains from swift.org, if you're just interested in running them, rather than building them locally.

See the individual packages' README files for information about how to run and use their executables.

Seehttp://swift.org/LICENSE.txt for license information.