Add basic rust module support

Junpeng Qiu · facebook-github-bot · commit 2ea986134745 · 2021-10-12T11:13:00.000-07:00
Summary: This handles source folders and deps. The feature is controlled by the `intellij.enable_rust_module=true` config.

Reviewed By: ardavank

fbshipit-source-id: cdc37e9382280c04dbcf7ef818cc227884bab2e1
diff --git a/build.xml b/build.xml
@@ -804,13 +804,14 @@
     </build-buck-module-jar>
   </target>
 
-  <target name="build-module-intellij" depends="compile, build-module-python, build-module-filegroup, build-module-ziprules">
+  <target name="build-module-intellij" depends="compile, build-module-python, build-module-rust, build-module-filegroup, build-module-ziprules">
     <build-buck-module-jar-with-resources module-name="intellij">
       <module-javac-params>
         <include name="com/facebook/buck/features/project/intellij/**/*.java" />
       </module-javac-params>
       <additional-classpath-entries>
         <include name="python.jar"/>
+        <include name="rust.jar"/>
         <include name="filegroup.jar" />
         <include name="ziprules.jar" />
       </additional-classpath-entries>
diff --git a/src/com/facebook/buck/command/config/ConfigIgnoredByDaemon.java b/src/com/facebook/buck/command/config/ConfigIgnoredByDaemon.java
@@ -73,6 +73,7 @@ private static ImmutableMap<String, ImmutableSet<String>> getIgnoreFieldsForDaem
             "auto_generate_android_facet_sources",
             "buck_out_path_for_generated_files",
             "default_min_android_sdk_version",
+            "enable_rust_module",
             "flatten_android_generated_files_path_with_hash",
             "generate_module_info_binary_index",
             "keep_module_files_in_module_dirs",
diff --git a/src/com/facebook/buck/features/project/intellij/BUCK b/src/com/facebook/buck/features/project/intellij/BUCK
@@ -11,6 +11,7 @@ buck_module(
     ),
     module_deps = [
         "//src/com/facebook/buck/features/python:module",
+        "//src/com/facebook/buck/features/rust:rust",
         "//src/com/facebook/buck/features/filegroup:filegroup",
         "//src/com/facebook/buck/features/zip/rules:rules",
     ],
diff --git a/src/com/facebook/buck/features/project/intellij/IjBuckModule.java b/src/com/facebook/buck/features/project/intellij/IjBuckModule.java
@@ -19,8 +19,15 @@
 import com.facebook.buck.core.module.BuckModule;
 import com.facebook.buck.features.filegroup.FilegroupModule;
 import com.facebook.buck.features.python.PythonModule;
+import com.facebook.buck.features.rust.RustModule;
 import com.facebook.buck.features.zip.rules.ZipRulesModule;
 
 /** Module with project generator for IntelliJ. */
-@BuckModule(dependencies = {FilegroupModule.class, PythonModule.class, ZipRulesModule.class})
+@BuckModule(
+    dependencies = {
+      FilegroupModule.class,
+      PythonModule.class,
+      RustModule.class,
+      ZipRulesModule.class
+    })
 public class IjBuckModule {}
diff --git a/src/com/facebook/buck/features/project/intellij/IjProjectBuckConfig.java b/src/com/facebook/buck/features/project/intellij/IjProjectBuckConfig.java
@@ -197,7 +197,9 @@ static IjProjectConfig.Builder createBuilder(BuckConfig buckConfig) {
             buckConfig.getPath(
                 INTELLIJ_BUCK_CONFIG_SECTION, "kotlin_java_runtime_library_template_path"))
         .setBuckOutPathForGeneratedProjectFiles(
-            buckConfig.getValue(INTELLIJ_BUCK_CONFIG_SECTION, "buck_out_path_for_generated_files"));
+            buckConfig.getValue(INTELLIJ_BUCK_CONFIG_SECTION, "buck_out_path_for_generated_files"))
+        .setRustModuleEnabled(
+            buckConfig.getBooleanValue(INTELLIJ_BUCK_CONFIG_SECTION, "enable_rust_module", false));
   }
 
   private static String getModuleGroupName(String moduleGroupName, BuckConfig buckConfig) {
diff --git a/src/com/facebook/buck/features/project/intellij/SupportedTargetTypeRegistry.java b/src/com/facebook/buck/features/project/intellij/SupportedTargetTypeRegistry.java
@@ -39,13 +39,17 @@
 import com.facebook.buck.features.project.intellij.lang.kotlin.KotlinTestModuleRule;
 import com.facebook.buck.features.project.intellij.lang.python.PythonLibraryModuleRule;
 import com.facebook.buck.features.project.intellij.lang.python.PythonTestModuleRule;
+import com.facebook.buck.features.project.intellij.lang.rust.RustBinaryModuleRule;
+import com.facebook.buck.features.project.intellij.lang.rust.RustLibraryModuleRule;
 import com.facebook.buck.features.project.intellij.lang.scala.ScalaLibraryModuleRule;
 import com.facebook.buck.features.project.intellij.lang.scala.ScalaTestModuleRule;
 import com.facebook.buck.features.project.intellij.model.IjModuleFactoryResolver;
 import com.facebook.buck.features.project.intellij.model.IjModuleRule;
 import com.facebook.buck.features.project.intellij.model.IjProjectConfig;
 import com.facebook.buck.features.python.PythonLibraryDescription;
 import com.facebook.buck.features.python.PythonTestDescription;
+import com.facebook.buck.features.rust.RustBinaryDescription;
+import com.facebook.buck.features.rust.RustLibraryDescription;
 import com.facebook.buck.io.filesystem.ProjectFilesystem;
 import com.facebook.buck.jvm.core.JavaPackageFinder;
 import com.facebook.buck.jvm.groovy.GroovyLibraryDescription;
@@ -84,7 +88,9 @@ public class SupportedTargetTypeRegistry {
               PythonLibraryDescription.class,
               PythonTestDescription.class,
               ScalaLibraryDescription.class,
-              ScalaTestDescription.class);
+              ScalaTestDescription.class,
+              RustLibraryDescription.class,
+              RustBinaryDescription.class);
 
   public static boolean isTargetTypeSupported(Class<?> descriptionClass) {
     return SUPPORTED_MODULE_DESCRIPTION_CLASSES.contains(descriptionClass);
@@ -163,6 +169,12 @@ public SupportedTargetTypeRegistry(
     addToIndex(
         new ScalaTestModuleRule(
             projectFilesystem, moduleFactoryResolver, depsQueryResolver, projectConfig));
+    addToIndex(
+        new RustLibraryModuleRule(
+            projectFilesystem, moduleFactoryResolver, depsQueryResolver, projectConfig));
+    addToIndex(
+        new RustBinaryModuleRule(
+            projectFilesystem, moduleFactoryResolver, depsQueryResolver, projectConfig));
     Preconditions.checkState(areTargetTypesEqual(moduleRuleIndex.keySet()));
   }
 
diff --git a/src/com/facebook/buck/features/project/intellij/lang/rust/RustBinaryModuleRule.java b/src/com/facebook/buck/features/project/intellij/lang/rust/RustBinaryModuleRule.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.buck.features.project.intellij.lang.rust;
+
+import com.facebook.buck.core.model.targetgraph.TargetNode;
+import com.facebook.buck.core.rules.DescriptionWithTargetGraph;
+import com.facebook.buck.features.project.intellij.BaseIjModuleRule;
+import com.facebook.buck.features.project.intellij.ModuleBuildContext;
+import com.facebook.buck.features.project.intellij.depsquery.IjDepsQueryResolver;
+import com.facebook.buck.features.project.intellij.model.IjModuleFactoryResolver;
+import com.facebook.buck.features.project.intellij.model.IjModuleType;
+import com.facebook.buck.features.project.intellij.model.IjProjectConfig;
+import com.facebook.buck.features.rust.RustBinaryDescription;
+import com.facebook.buck.features.rust.RustBinaryDescriptionArg;
+import com.facebook.buck.io.filesystem.ProjectFilesystem;
+
+/** Support for transforming a rust_binary declaration to an intellij module */
+public class RustBinaryModuleRule extends BaseIjModuleRule<RustBinaryDescriptionArg> {
+
+  public RustBinaryModuleRule(
+      ProjectFilesystem projectFilesystem,
+      IjModuleFactoryResolver moduleFactoryResolver,
+      IjDepsQueryResolver depsQueryResolver,
+      IjProjectConfig projectConfig) {
+    super(projectFilesystem, moduleFactoryResolver, depsQueryResolver, projectConfig);
+  }
+
+  @Override
+  public Class<? extends DescriptionWithTargetGraph<?>> getDescriptionClass() {
+    return RustBinaryDescription.class;
+  }
+
+  @Override
+  public void apply(TargetNode<RustBinaryDescriptionArg> target, ModuleBuildContext context) {
+    if (projectConfig.isRustModuleEnabled()) {
+      addDepsAndSources(target, false /* wantsPackagePrefix */, context);
+    }
+  }
+
+  @Override
+  public IjModuleType detectModuleType(TargetNode<RustBinaryDescriptionArg> targetNode) {
+    return projectConfig.isRustModuleEnabled()
+        ? IjModuleType.RUST_MODULE
+        : IjModuleType.UNKNOWN_MODULE;
+  }
+}
diff --git a/src/com/facebook/buck/features/project/intellij/lang/rust/RustLibraryModuleRule.java b/src/com/facebook/buck/features/project/intellij/lang/rust/RustLibraryModuleRule.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.facebook.buck.features.project.intellij.lang.rust;
+
+import com.facebook.buck.core.model.targetgraph.TargetNode;
+import com.facebook.buck.core.rules.DescriptionWithTargetGraph;
+import com.facebook.buck.features.project.intellij.BaseIjModuleRule;
+import com.facebook.buck.features.project.intellij.ModuleBuildContext;
+import com.facebook.buck.features.project.intellij.depsquery.IjDepsQueryResolver;
+import com.facebook.buck.features.project.intellij.model.IjModuleFactoryResolver;
+import com.facebook.buck.features.project.intellij.model.IjModuleType;
+import com.facebook.buck.features.project.intellij.model.IjProjectConfig;
+import com.facebook.buck.features.rust.RustLibraryDescription;
+import com.facebook.buck.features.rust.RustLibraryDescriptionArg;
+import com.facebook.buck.io.filesystem.ProjectFilesystem;
+
+/** Support for transforming a rust_library declaration to an intellij module */
+public class RustLibraryModuleRule extends BaseIjModuleRule<RustLibraryDescriptionArg> {
+
+  public RustLibraryModuleRule(
+      ProjectFilesystem projectFilesystem,
+      IjModuleFactoryResolver moduleFactoryResolver,
+      IjDepsQueryResolver depsQueryResolver,
+      IjProjectConfig projectConfig) {
+    super(projectFilesystem, moduleFactoryResolver, depsQueryResolver, projectConfig);
+  }
+
+  @Override
+  public Class<? extends DescriptionWithTargetGraph<?>> getDescriptionClass() {
+    return RustLibraryDescription.class;
+  }
+
+  @Override
+  public void apply(TargetNode<RustLibraryDescriptionArg> target, ModuleBuildContext context) {
+    if (projectConfig.isRustModuleEnabled()) {
+      addDepsAndSources(target, false /* wantsPackagePrefix */, context);
+    }
+  }
+
+  @Override
+  public IjModuleType detectModuleType(TargetNode<RustLibraryDescriptionArg> targetNode) {
+    return projectConfig.isRustModuleEnabled()
+        ? IjModuleType.RUST_MODULE
+        : IjModuleType.UNKNOWN_MODULE;
+  }
+}
diff --git a/src/com/facebook/buck/features/project/intellij/model/IjModuleType.java b/src/com/facebook/buck/features/project/intellij/model/IjModuleType.java
@@ -112,6 +112,18 @@ public String getSdkType(IjProjectConfig projectConfig) {
     }
   },
 
+  RUST_MODULE("RUST_MODULE") {
+    @Override
+    public Optional<String> getSdkName(IjProjectConfig projectConfig) {
+      return Optional.empty();
+    }
+
+    @Override
+    public String getSdkType(IjProjectConfig projectConfig) {
+      return SDK_TYPE_JAVA;
+    }
+  },
+
   UNKNOWN_MODULE("JAVA_MODULE") {
     @Override
     public Optional<String> getSdkName(IjProjectConfig projectConfig) {
diff --git a/src/com/facebook/buck/features/project/intellij/model/IjProjectConfig.java b/src/com/facebook/buck/features/project/intellij/model/IjProjectConfig.java
@@ -137,6 +137,8 @@ public boolean isAutogenerateAndroidFacetSourcesEnabled() {
 
   public abstract Optional<String> getBuckOutPathForGeneratedProjectFiles();
 
+  public abstract boolean isRustModuleEnabled();
+
   public static Builder builder() {
     return new Builder();
   }
diff --git a/src/com/facebook/buck/features/rust/BUCK b/src/com/facebook/buck/features/rust/BUCK
@@ -55,7 +55,9 @@ buck_module(
         "//test/com/facebook/buck/features/rust:rust",
     ],
     visibility = [
+        "//test/com/facebook/buck/crosscell:crosscell",
         "//test/com/facebook/buck/features/rust/...",
+        "//src/com/facebook/buck/features/project/intellij/...",
         "//test/com/facebook/buck/rules/modern:subclass_exclusion",
     ],
 )
diff --git a/test/com/facebook/buck/crosscell/BUCK b/test/com/facebook/buck/crosscell/BUCK
@@ -39,6 +39,7 @@ standard_java_test(
         "//src/com/facebook/buck/features/js:js",
         "//src/com/facebook/buck/features/project/intellij:intellij",
         "//src/com/facebook/buck/features/python:python",
+        "//src/com/facebook/buck/features/rust:rust",
         "//src/com/facebook/buck/io:executable-finder",
         "//src/com/facebook/buck/io:io",
         "//src/com/facebook/buck/io/file:file",
diff --git a/test/com/facebook/buck/features/project/intellij/BUCK b/test/com/facebook/buck/features/project/intellij/BUCK
@@ -132,6 +132,7 @@ java_test(
         "//src/com/facebook/buck/features/zip/rules:rules",
         "//src/com/facebook/buck/features/go:go",
         "//src/com/facebook/buck/features/python:module",
+        "//src/com/facebook/buck/features/rust:rust",
     ],
     resources = glob(["testdata/**"]),
     deps = [
diff --git a/test/com/facebook/buck/features/project/intellij/ProjectIntegrationTest.java b/test/com/facebook/buck/features/project/intellij/ProjectIntegrationTest.java
@@ -400,6 +400,11 @@ public void testPythonLibrary() throws IOException {
     runBuckProjectAndVerify("python_library");
   }
 
+  @Test
+  public void testRustRules() throws IOException {
+    runBuckProjectAndVerify("rust_rules");
+  }
+
   @Test
   public void testTwoConfigurations() throws IOException {
     runBuckProjectAndVerify("two_configurations");
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/deps_query/.idea/modules/dep1.iml.expected b/test/com/facebook/buck/features/project/intellij/testdata/deps_query/.idea/modules/dep1.iml.expected
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/deps_query/.idea/modules/dep2.iml.expected b/test/com/facebook/buck/features/project/intellij/testdata/deps_query/.idea/modules/dep2.iml.expected
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/.buckconfig b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/.buckconfig
@@ -0,0 +1,6 @@
+[project]
+  ide = intellij
+[intellij]
+  default_android_manifest_path = manifest/AndroidManifest.xml
+  keep_module_files_in_module_dirs = true
+  enable_rust_module = true
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/.idea/modules.xml.expected b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/.idea/modules.xml.expected
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_binary/BUCK.fixture b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_binary/BUCK.fixture
@@ -0,0 +1,6 @@
+rust_binary(
+    name = "rust_binary",
+    srcs = glob(["*.rs"]),
+    deps = ["//rust_library:rust_library"],
+    visibility = ["PUBLIC"],
+)
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_binary/foo.rs b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_binary/foo.rs
@@ -0,0 +1 @@
+
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_binary/rust_binary.iml.expected b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_binary/rust_binary.iml.expected
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUST_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="module" module-name="rust_library" scope="COMPILE" />
+  </component>
+</module>
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_library/BUCK.fixture b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_library/BUCK.fixture
@@ -0,0 +1,5 @@
+rust_library(
+    name = "rust_library",
+    srcs = glob(["*.rs"]),
+    visibility = ["PUBLIC"],
+)
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_library/foo.rs b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_library/foo.rs
@@ -0,0 +1 @@
+
diff --git a/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_library/rust_library.iml.expected b/test/com/facebook/buck/features/project/intellij/testdata/rust_rules/rust_library/rust_library.iml.expected
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUST_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,8 @@ public boolean isAutogenerateAndroidFacetSourcesEnabled() {`
`137`	`137`
`138`	`138`	`public abstract Optional<String> getBuckOutPathForGeneratedProjectFiles();`
`139`	`139`
	`140`	`+ public abstract boolean isRustModuleEnabled();`
	`141`	`+`
`140`	`142`	`public static Builder builder() {`
`141`	`143`	`return new Builder();`
`142`	`144`	`}`