[build-script] Extract logic determining whether to test/install a product to separate function

Previously, you were to check if a build/test/install is necessary in
the builds/test/install method which is easy to miss. This gives the
check more visibility.

Author: ahoppen

utils/build-script

@@ -790,9 +790,12 @@ class BuildScriptInvocation(object):
                     source_dir=self.workspace.source_dir(product_source),
                     build_dir=self.workspace.build_dir(
                         host_target, product_name))
-                product.build(host_target)
-                product.test(host_target)
-                product.install(host_target)
+                if product.shall_build(host_target):
+                    product.build(host_target)
+                if product.shall_test(host_target):
+                    product.test(host_target)
+                if product.shall_install(host_target):
+                    product.install(host_target)
 
         # Extract symbols...
         for host_target in all_hosts:

utils/swift_build_support/swift_build_support/products/benchmarks.py

@@ -28,9 +28,15 @@ def product_source_name(cls):
     def is_build_script_impl_product(cls):
         return False
 
+    def shall_build(self, host_target):
+        return True
+
     def build(self, host_target):
         run_build_script_helper(host_target, self, self.args)
 
+    def shall_test(self, host_target):
+        return True
+
     def test(self, host_target):
         """Just run a single instance of the command for both .debug and
            .release.
@@ -45,6 +51,9 @@ def test(self, host_target):
         bench_Osize = os.path.join(self.build_dir, 'bin', 'Benchmark_Osize')
         shell.call([bench_Osize] + cmdline)
 
+    def shall_install(self, host_target):
+        return False
+
     def install(self, host_target):
         pass
 

utils/swift_build_support/swift_build_support/products/indexstoredb.py

@@ -27,12 +27,20 @@ def product_source_name(cls):
     def is_build_script_impl_product(cls):
         return False
 
+    def shall_build(self, host_target):
+        return True
+
     def build(self, host_target):
         run_build_script_helper('build', host_target, self, self.args)
 
+    def shall_test(self, host_target):
+        return self.args.test_indexstoredb
+
     def test(self, host_target):
-        if self.args.test and self.args.test_indexstoredb:
-            run_build_script_helper('test', host_target, self, self.args)
+        run_build_script_helper('test', host_target, self, self.args)
+
+    def shall_install(self, host_target):
+        return False
 
     def install(self, host_target):
         pass

utils/swift_build_support/swift_build_support/products/product.py

@@ -42,20 +42,41 @@ def is_build_script_impl_product(cls):
         """
         return True
 
+    def shall_build(self, host_target):
+        """shall_build() -> Bool
+
+        Whether or not this product shall be built with the given arguments.
+        """
+        raise NotImplementedError
+
     def build(self, host_target):
         """build() -> void
 
         Perform the build, for a non-build-script-impl product.
         """
         raise NotImplementedError
 
+    def shall_test(self, host_target):
+        """shall_test() -> Bool
+
+        Whether or not this product shall be tested with the given arguments.
+        """
+        raise NotImplementedError
+
     def test(self, host_target):
         """test() -> void
 
         Run the tests, for a non-build-script-impl product.
         """
         raise NotImplementedError
 
+    def shall_install(self, host_target):
+        """shall_install() -> Bool
+
+        Whether or not this product shall be installed with the given arguments
+        """
+        raise NotImplementedError
+
     def install(self, host_target):
         """install() -> void
 

utils/swift_build_support/swift_build_support/products/sourcekitlsp.py

@@ -23,16 +23,23 @@ def product_source_name(cls):
     def is_build_script_impl_product(cls):
         return False
 
+    def shall_build(self, host_target):
+        return True
+
     def build(self, host_target):
         indexstoredb.run_build_script_helper(
             'build', host_target, self, self.args)
 
+    def shall_test(self, host_target):
+        return self.args.test_sourcekitlsp
+
     def test(self, host_target):
-        if self.args.test_sourcekitlsp:
-            indexstoredb.run_build_script_helper(
-                'test', host_target, self, self.args)
+        indexstoredb.run_build_script_helper(
+            'test', host_target, self, self.args)
+
+    def shall_install(self, host_target):
+        return self.args.install_sourcekitlsp
 
     def install(self, host_target):
-        if self.args.install_sourcekitlsp:
-            indexstoredb.run_build_script_helper(
-                'install', host_target, self, self.args)
+        indexstoredb.run_build_script_helper(
+            'install', host_target, self, self.args)

utils/swift_build_support/swift_build_support/products/tsan_libdispatch.py

@@ -29,6 +29,9 @@ def product_source_name(cls):
     def is_build_script_impl_product(cls):
         return False
 
+    def shall_build(self, host_target):
+        return True
+
     def build(self, host_target):
         """Build TSan runtime (compiler-rt)."""
         rt_source_dir = join_path(self.source_dir, os.pardir, 'compiler-rt')
@@ -59,6 +62,9 @@ def build(self, host_target):
             shell.call(config_cmd)
             shell.call(build_cmd)
 
+    def shall_test(self, host_target):
+        return True
+
     def test(self, host_target):
         """Run check-tsan target with a LIT filter for libdispatch."""
         cmd = ['ninja', 'check-tsan']
@@ -67,5 +73,8 @@ def test(self, host_target):
         with shell.pushd(self.build_dir):
             shell.call(cmd, env=env)
 
+    def shall_install(self, host_target):
+        return False
+
     def install(self, host_target):
         pass