test: provide an opaque-values testing mode

Introduces a new build-script flag `--test-optimize-none-with-opaque-values`
and build targets like `check-swift-optimize_none_with_opaque_values` that
runs the execution_test's while compiling them with -enable-sil-opaque-values.

This mode is quite useful while working to bring-up opaque values.

Author: kavon

test/CMakeLists.txt

@@ -348,6 +348,7 @@ set(profdata_merge_worker
 
 set(TEST_MODES
     optimize_none optimize optimize_unchecked optimize_size
+    optimize_none_with_opaque_values
     optimize_none_with_implicit_dynamic
     optimize_with_implicit_dynamic
     only_executable only_non_executable

test/lit.cfg

@@ -925,6 +925,11 @@ if swift_test_mode == 'optimize_none':
     # optimize mode for a cpu.
     config.available_features.add("swift_test_mode_optimize_none_" + run_cpu)
     swift_execution_tests_extra_flags = ''
+elif swift_test_mode == 'optimize_none_with_opaque_values':
+    config.available_features.add("executable_test")
+    config.limit_to_features.add("executable_test")
+    config.available_features.add("swift_test_mode_optimize_none_with_opaque_values")
+    swift_execution_tests_extra_flags = '-Xfrontend -enable-sil-opaque-values'
 elif swift_test_mode == 'optimize_none_with_implicit_dynamic':
     config.available_features.add("executable_test")
     config.limit_to_features.add("executable_test")

utils/build_swift/build_swift/driver_arguments.py

@@ -203,6 +203,9 @@ def _apply_default_arguments(args):
     if args.test_optimize_none_with_implicit_dynamic:
         args.test = True
 
+    if args.test_optimize_none_with_opaque_values:
+        args.test = True
+
     # If none of tests specified skip swift stdlib test on all platforms
     if not args.test and not args.validation_test and not args.long_test:
         args.test_linux = False
@@ -1143,6 +1146,12 @@ def create_argument_parser():
            help='run the test suite in optimize none with implicit dynamic'
                 'mode too (implies --test)')
 
+    # NOTE: this mode is meant to aid the bring-up of opaque values
+    # and once its enabled by default, we can remove this.
+    option('--test-optimize-none-with-opaque-values', toggle_true,
+           help='run the executable tests again, compiling them with '
+                '-enable-sil-opaque-values (implies --test)')
+
     option('--long-test', toggle_true,
            help='run the long test suite')
 

utils/build_swift/tests/build_swift/test_driver_arguments.py

@@ -605,6 +605,11 @@ def test_implied_defaults_test_optimize_none_with_implicit_dynamic(self):
             ['--test-optimize-none-with-implicit-dynamic'])
         self.assertTrue(namespace.test)
 
+    def test_implied_defaults_test_optimize_none_with_opaque_values(self):
+        namespace = self.parse_default_args(
+            ['--test-optimize-none-with-opaque-values'])
+        self.assertTrue(namespace.test)
+
     def test_implied_defaults_skip_all_tests(self):
         namespace = self.parse_default_args([
             '--test', '0',

utils/build_swift/tests/expected_options.py

@@ -313,6 +313,7 @@
     'test_linux_static': False,
     'test_optimize_for_size': None,
     'test_optimize_none_with_implicit_dynamic': None,
+    'test_optimize_none_with_opaque_values': False,
     'test_optimized': None,
     'test_osx': False,
     'test_paths': [],
@@ -544,6 +545,8 @@ class BuildScriptImplOption(_BaseOption):
     SetOption('-s', dest='test_optimize_for_size', value=True),
     SetOption('-y',
               dest='test_optimize_none_with_implicit_dynamic', value=True),
+    SetOption('--test-optimize-none-with-opaque-values',
+              dest='test_optimize_none_with_opaque_values', value=True),
     SetOption('-t', dest='test', value=True),
     SetOption('-a', dest='assertions', value=True),
 
@@ -707,6 +710,7 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--test'),
     EnableOption('--test-optimize-for-size'),
     EnableOption('--test-optimize-none-with-implicit-dynamic'),
+    EnableOption('--test-optimize-none-with-opaque-values'),
     EnableOption('--test-optimized'),
     EnableOption('--tvos'),
     EnableOption('--validation-test'),

utils/run-test

@@ -25,6 +25,7 @@ TEST_MODES = [
     'optimize_none',
     'optimize',
     'optimize_unchecked',
+    'optimize_none_with_opaque_values',
     'only_executable',
     'only_non_executable',
 ]

utils/swift_build_support/swift_build_support/host_specific_configuration.py

@@ -215,6 +215,11 @@ def __init__(self, host_target, args, stage_dependent_args=None):
                     self.swift_test_run_targets.append(
                         "check-swift{}-optimize_none_with_implicit_dynamic-{}"
                         .format(subset_suffix, name))
+                if args.test_optimize_none_with_opaque_values and \
+                        not test_host_only:
+                    self.swift_test_run_targets.append(
+                        "check-swift{}-optimize_none_with_opaque_values-{}"
+                        .format(subset_suffix, name))
 
             # Only pull in these flags when cross-compiling with
             # --cross-compile-hosts.