[sourcekit] Add global -module-cache-path to test executables

Add a global -module-cache-path option to `sourcekitd-test` and
`complete-test` and have lit provide the default module cache in its
substitutions. Previously many tests have explicitly provided the
`%mcp_opt` option, but this is easy to forget when writing new tests.

The module cache is inserted into the compiler arguments at the
beginning so that it's still possible for a test to override it with a
per-test cache if desired.

rdar://58752842

Author: benlangmuir

test/SourceKit/lit.local.cfg

@@ -14,8 +14,8 @@ elif 'swift_evolve' in config.available_features:
 else:
     sk_path_sanitize = os.path.join(os.path.dirname(__file__), 'Inputs', 'sourcekitd_path_sanitize.py')
 
-    config.substitutions.append( ('%sourcekitd-test', config.sourcekitd_test) )
-    config.substitutions.append( ('%complete-test', config.complete_test) )
+    config.substitutions.append( ('%sourcekitd-test', '%s -module-cache-path %r' % (config.sourcekitd_test, config.clang_module_cache_path)) )
+    config.substitutions.append( ('%complete-test', '%s -module-cache-path=%r' % (config.complete_test, config.clang_module_cache_path)) )
     config.substitutions.append( ('%swiftlib_dir', config.swiftlib_dir) )
     config.substitutions.append( ('%sed_clean', '%s %s' % (sys.executable, sk_path_sanitize) )
 )

test/lit.cfg

@@ -362,11 +362,11 @@ config.swift_driver_test_options += ' -Xfrontend'
 config.swift_driver_test_options += ' -ignore-module-source-info'
 config.sil_test_options = os.environ.get('SIL_TEST_OPTIONS', '')
 
-clang_module_cache_path = make_path(config.swift_test_results_dir, "clang-module-cache")
-shutil.rmtree(clang_module_cache_path, ignore_errors=True)
-mcp_opt = "-module-cache-path %r" % clang_module_cache_path
-clang_mcp_opt = "-fmodules-cache-path=%r" % clang_module_cache_path
-lit_config.note("Using Clang module cache: " + clang_module_cache_path)
+config.clang_module_cache_path = make_path(config.swift_test_results_dir, "clang-module-cache")
+shutil.rmtree(config.clang_module_cache_path, ignore_errors=True)
+mcp_opt = "-module-cache-path %r" % config.clang_module_cache_path
+clang_mcp_opt = "-fmodules-cache-path=%r" % config.clang_module_cache_path
+lit_config.note("Using Clang module cache: " + config.clang_module_cache_path)
 lit_config.note("Using test results dir: " + config.swift_test_results_dir)
 
 completion_cache_path = make_path(config.swift_test_results_dir, "completion-cache")

tools/SourceKit/tools/complete-test/complete-test.cpp

@@ -65,6 +65,7 @@ struct TestOptions {
   Optional<unsigned> fuzzyWeight;
   Optional<unsigned> popularityBonus;
   StringRef filterRulesJSON;
+  std::string moduleCachePath;
   bool rawOutput = false;
   bool structureOutput = false;
   ArrayRef<const char *> compilerArgs;
@@ -251,6 +252,8 @@ static bool parseOptions(ArrayRef<const char *> args, TestOptions &options,
         return false;
       }
       options.showTopNonLiteral = uval;
+    } else if (opt == "module-cache-path") {
+      options.moduleCachePath = value;
     }
   }
 
@@ -673,6 +676,10 @@ static bool codeCompleteRequest(sourcekitd_uid_t requestUID, const char *name,
       sourcekitd_request_array_set_string(args, SOURCEKITD_ARRAY_APPEND,"-sdk");
       sourcekitd_request_array_set_string(args, SOURCEKITD_ARRAY_APPEND, sdk);
     }
+    if (!options.moduleCachePath.empty()) {
+      sourcekitd_request_array_set_string(args, SOURCEKITD_ARRAY_APPEND, "-module-cache-path");
+      sourcekitd_request_array_set_string(args, SOURCEKITD_ARRAY_APPEND, options.moduleCachePath.c_str());
+    }
     // Add -- options.
     for (const char *arg : options.compilerArgs)
       sourcekitd_request_array_set_string(args, SOURCEKITD_ARRAY_APPEND, arg);

tools/SourceKit/tools/sourcekitd-test/Options.td

@@ -146,6 +146,9 @@ def optimize_for_ide : Joined<["-"], "for-ide=">,
 def suppress_config_request : Flag<["-"], "suppress-config-request">,
   HelpText<"Suppress the default global configuration request, that is otherwise sent before any other request (except for the global-config request itself)">;
 
+def module_cache_path: Separate<["-"], "module-cache-path">, HelpText<"module cache path">;
+def module_cache_path_EQ : Joined<["-"], "module-cache-path=">, Alias<module_cache_path>;
+
 def help : Flag<["-", "--"], "help">,
   HelpText<"Display available options">;
 

tools/SourceKit/tools/sourcekitd-test/TestOptions.cpp

@@ -385,6 +385,10 @@ bool TestOptions::parseArgs(llvm::ArrayRef<const char *> Args) {
       SuppressDefaultConfigRequest = true;
       break;
 
+    case OPT_module_cache_path:
+      ModuleCachePath = InputArg->getValue();
+      break;
+
     case OPT_UNKNOWN:
       llvm::errs() << "error: unknown argument: "
                    << InputArg->getAsString(ParsedArgs) << '\n'

tools/SourceKit/tools/sourcekitd-test/TestOptions.h

@@ -94,6 +94,7 @@ struct TestOptions {
   std::string CachePath;
   llvm::SmallVector<std::string, 4> RequestOptions;
   llvm::ArrayRef<const char *> CompilerArgs;
+  std::string ModuleCachePath;
   bool UsingSwiftArgs;
   std::string USR;
   std::string SwiftName;

tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp

@@ -403,6 +403,9 @@ static int handleTestInvocation(ArrayRef<const char *> Args,
   if (Opts.parseArgs(Args.slice(0, Optargc)))
     return 1;
 
+  if (!Opts.ModuleCachePath.empty())
+    InitOpts.ModuleCachePath = Opts.ModuleCachePath;
+
   if (Optargc < Args.size())
     Opts.CompilerArgs = Args.slice(Optargc+1);
 
@@ -515,6 +518,8 @@ static int handleTestInvocation(TestOptions Opts, TestOptions &InitOpts) {
       ByteOffset;
   }
 
+  bool compilerArgsAreClang = false;
+
   sourcekitd_object_t Req = sourcekitd_request_dictionary_create(nullptr,
                                                                  nullptr, 0);
   ActiveRequest = Opts.Request;
@@ -883,6 +888,8 @@ static int handleTestInvocation(TestOptions Opts, TestOptions &InitOpts) {
     } else {
       if (Opts.UsingSwiftArgs)
           sourcekitd_request_dictionary_set_int64(Req, KeyUsingSwiftArgs, true);
+      else
+        compilerArgsAreClang = true;
       sourcekitd_request_dictionary_set_uid(Req, KeyRequest,
                                             RequestEditorOpenHeaderInterface);
     }
@@ -978,6 +985,15 @@ static int handleTestInvocation(TestOptions Opts, TestOptions &InitOpts) {
 
   if (!Opts.CompilerArgs.empty()) {
     sourcekitd_object_t Args = sourcekitd_request_array_create(nullptr, 0);
+    if (!Opts.ModuleCachePath.empty()) {
+      if (compilerArgsAreClang) {
+        std::string opt = "-fmodules-cache-path=" + Opts.ModuleCachePath;
+        sourcekitd_request_array_set_string(Args, SOURCEKITD_ARRAY_APPEND, opt.c_str());
+      } else {
+        sourcekitd_request_array_set_string(Args, SOURCEKITD_ARRAY_APPEND, "-module-cache-path");
+        sourcekitd_request_array_set_string(Args, SOURCEKITD_ARRAY_APPEND, Opts.ModuleCachePath.c_str());
+      }
+    }
     for (auto Arg : Opts.CompilerArgs)
       sourcekitd_request_array_set_string(Args, SOURCEKITD_ARRAY_APPEND, Arg);
     sourcekitd_request_dictionary_set_value(Req, KeyCompilerArgs, Args);