Switch to python script and add asserts baselines

Author: Azoy

Diff for: test/abi/Inputs/macOS/arm64/stdlib/baseline-asserts

@@ -0,0 +1,43 @@
+// RUN: %empty-directory(%t)
+// RUN: nm -g --defined-only -f just-symbols %stdlib_dir/arm64/libswiftCore.dylib > %t/symbols
+// RUN: %abi-symbol-checker %s %t/symbols
+// RUN: diff -u %S/../../Inputs/macOS/arm64/stdlib/baseline-asserts %t/symbols
+
+// REQUIRES: swift_stdlib_asserts
+// REQUIRES: STDLIB_VARIANT=macosx-arm64
+
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment below.)
+
+// Welcome, Build Wrangler!
+//
+// This file lists APIs that have recently changed in a way that potentially
+// indicates an ABI- or source-breaking problem.
+//
+// A failure in this test indicates that there is a potential breaking change in
+// the Standard Library. If you observe a failure outside of a PR test, please
+// reach out to the Standard Library team directly to make sure this gets
+// resolved quickly! If your own PR fails in this test, you probably have an
+// ABI- or source-breaking change in your commits. Please go and fix it.
+//
+// Please DO NOT DISABLE THIS TEST. In addition to ignoring the current set of
+// ABI breaks, XFAILing this test also silences any future ABI breaks that may
+// land on this branch, which simply generates extra work for the next person
+// that picks up the mess.
+//
+// Instead of disabling this test, you'll need to extend the list of expected
+// changes at the bottom. (You'll also need to do this if your own PR triggers
+// false positives, or if you have special permission to break things.) You can
+// find a diff of what needs to be added in the output of the failed test run.
+// The order of lines doesn't matter, and you can also include comments to refer
+// to any bugs you filed.
+//
+// Thank you for your help ensuring the stdlib remains compatible with its past!
+//                                            -- Your friendly stdlib engineers
+
+// Standard Library Symbols
+
+Added: _$ss15_getRetainCountySuyXlF
+Added: _$ss19_getWeakRetainCountySuyXlF
+Added: _$ss22_getUnownedRetainCountySuyXlF
+
+// Runtime Symbols

Diff for: test/abi/Inputs/macOS/x86_64/stdlib/baseline-asserts

@@ -1,9 +1,6 @@
 // RUN: %empty-directory(%t)
 // RUN: nm -g --defined-only -f just-symbols %stdlib_dir/arm64/libswiftCore.dylib > %t/symbols
-// RUN: { grep -Ev "^/|^$" %s || true; } > %t/changes
-// RUN: cat %t/changes | while read line; do if [[ $line =~ ^Added:\ (.*)$ ]]; then sed -i "" "/${BASH_REMATCH[1]}/d" %t/symbols; fi done
-// RUN: cat %t/changes | while read line; do if [[ $line =~ ^Removed:\ (.*)$ ]]; then echo "${BASH_REMATCH[1]}" >> %t/symbols; fi done
-// RUN: sort %t/symbols -o %t/symbols
+// RUN: %abi-symbol-checker %s %t/symbols
 // RUN: diff -u %S/../../Inputs/macOS/arm64/stdlib/baseline %t/symbols
 
 // REQUIRES: swift_stdlib_no_asserts

Diff for: test/abi/macOS/arm64/stdlib-asserts.swift

@@ -0,0 +1,43 @@
+// RUN: %empty-directory(%t)
+// RUN: nm -g --defined-only -f just-symbols %stdlib_dir/x86_64/libswiftCore.dylib > %t/symbols
+// RUN: %abi-symbol-checker %s %t/symbols
+// RUN: diff -u %S/../../Inputs/macOS/x86_64/stdlib/baseline-asserts %t/symbols
+
+// REQUIRES: swift_stdlib_asserts
+// REQUIRES: STDLIB_VARIANT=macosx-x86_64
+
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment below.)
+
+// Welcome, Build Wrangler!
+//
+// This file lists APIs that have recently changed in a way that potentially
+// indicates an ABI- or source-breaking problem.
+//
+// A failure in this test indicates that there is a potential breaking change in
+// the Standard Library. If you observe a failure outside of a PR test, please
+// reach out to the Standard Library team directly to make sure this gets
+// resolved quickly! If your own PR fails in this test, you probably have an
+// ABI- or source-breaking change in your commits. Please go and fix it.
+//
+// Please DO NOT DISABLE THIS TEST. In addition to ignoring the current set of
+// ABI breaks, XFAILing this test also silences any future ABI breaks that may
+// land on this branch, which simply generates extra work for the next person
+// that picks up the mess.
+//
+// Instead of disabling this test, you'll need to extend the list of expected
+// changes at the bottom. (You'll also need to do this if your own PR triggers
+// false positives, or if you have special permission to break things.) You can
+// find a diff of what needs to be added in the output of the failed test run.
+// The order of lines doesn't matter, and you can also include comments to refer
+// to any bugs you filed.
+//
+// Thank you for your help ensuring the stdlib remains compatible with its past!
+//                                            -- Your friendly stdlib engineers
+
+// Standard Library Symbols
+
+Added: _$ss15_getRetainCountySuyXlF
+Added: _$ss19_getWeakRetainCountySuyXlF
+Added: _$ss22_getUnownedRetainCountySuyXlF
+
+// Runtime Symbols

Diff for: test/abi/macOS/arm64/stdlib.swift

@@ -1,9 +1,6 @@
 // RUN: %empty-directory(%t)
 // RUN: nm -g --defined-only -f just-symbols %stdlib_dir/x86_64/libswiftCore.dylib > %t/symbols
-// RUN: { grep -Ev "^/|^$" %s || true; } > %t/changes
-// RUN: cat %t/changes | while read line; do if [[ $line =~ ^Added:\ (.*)$ ]]; then sed -i "" "/${BASH_REMATCH[1]}/d" %t/symbols; fi done
-// RUN: cat %t/changes | while read line; do if [[ $line =~ ^Removed:\ (.*)$ ]]; then echo "${BASH_REMATCH[1]}" >> %t/symbols; fi done
-// RUN: sort %t/symbols -o %t/symbols
+// RUN: %abi-symbol-checker %s %t/symbols
 // RUN: diff -u %S/../../Inputs/macOS/x86_64/stdlib/baseline %t/symbols
 
 // REQUIRES: swift_stdlib_no_asserts

Diff for: test/abi/macOS/x86_64/stdlib-asserts.swift

@@ -360,6 +360,7 @@ config.swift_libexec_dir = make_path(config.swift, '..', '..', 'libexec')
 config.swift_share_dir = make_path(config.swift, '..', '..', 'share')
 config.round_trip_syntax_test = make_path(config.swift_utils, 'round-trip-syntax-test')
 config.refactor_check_compiles = make_path(config.swift_utils, 'refactor-check-compiles.py')
+config.abi_symbol_checker = make_path(config.swift_utils, 'swift-abi-symbol-checker.py')
 
 config.link = lit.util.which('link', config.environment.get('PATH', '')) or      \
               lit.util.which('lld-link', config.environment.get('PATH', ''))
@@ -2598,6 +2599,7 @@ config.substitutions.append(('%scale-test',
                              '{} {} --swiftc-binary={} --tmpdir=%t --exclude-timers'.format(
                                  shell_quote(sys.executable), config.scale_test,
                                  config.swiftc)))
+config.substitutions.append(('%abi-symbol-checker', '%s %s' % (shell_quote(sys.executable), config.abi_symbol_checker)))
 config.substitutions.append(('%target-sil-opt\(mock-sdk:([^)]+)\)',
                              SubstituteCaptures(r'%s \1 %s' % (
                                  escape_for_substitute_captures(subst_target_sil_opt_mock_sdk),

Diff for: test/abi/macOS/x86_64/stdlib.swift

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+
+import argparse
+import sys
+
+def checkSymbols(changesFile, symbolsFile):
+  changesF = open(changesFile)
+  # We need to write back to the temporary symbol file for diffing
+  symbolsF = open(symbolsFile, 'r+')
+
+  changes = changesF.read()
+  symbols = symbolsF.read().splitlines()
+
+  changesF.close()
+
+  # Get rid of lines that start with either '//' or a newline
+  changes = [c for c in changes.splitlines() if not c.startswith('//') and c != '']
+
+  # Filter the changes for lines that start with Added
+  additions = [a for a in changes if a.startswith('Added')]
+  # Filter the changes for lines that start with Removed
+  removals = [r for r in changes if r.startswith('Removed')]
+
+  # Map the additions by removing the 'Added: ' prefix to get just the symbol
+  additions = list(map(lambda a: a.removeprefix('Added: '), additions))
+  # Map the removals by removing the 'Removed: ' prefix to get just the symbol
+  removals = list(map(lambda r: r.removeprefix('Removed: '), removals))
+
+  # Check for added symbols that are not actually in the just built dylib.
+  notInDylib = [a for a in additions if not a in symbols]
+
+  # If there were symbols marked as 'Added' in the changes file, but they didn't
+  # actually appear in the dylib then print those symbols out and fail.
+  if notInDylib:
+    for symbol in notInDylib:
+      print('{} was marked as \'Added:\', but it was not found in the just built library'.format(symbol))
+
+    sys.exit(-1)
+
+  # Filter the built symbols for the additions because we're removing them to
+  # get back to the baseline
+  symbols = [s for s in symbols if not s in additions]
+
+  # Append the removals into the symbol list to get back to the baseline
+  symbols.extend(removals)
+
+  # Sort the end result to write back
+  symbols.sort()
+
+  # Go back to beginning of the file and purge everything
+  symbolsF.seek(0)
+  symbolsF.truncate()
+
+  # Append a newline to each symbol (because writelines doesn't do that for us)
+  symbols = list(map(lambda s: s + '\n', symbols))
+
+  # Write all of our symbols back into the symbols file
+  symbolsF.writelines(symbols)
+
+  # Done
+  symbolsF.close()
+
+def main(arguments):
+  parser = argparse.ArgumentParser(
+    description='Change absolute install names to use @rpath')
+
+  parser.add_argument('changes', help='the changes file')
+  parser.add_argument('symbols', help='the symbols file')
+
+  args = parser.parse_args(arguments)
+
+  checkSymbols(args.changes, args.symbols)
+
+sys.exit(main(sys.argv[1:]))