Add support for "cargo fmt"

plugin-rust-agent/src/main/kotlin/jetbrains/buildServer/rust/CargoCommandBuildSession.kt

@@ -99,6 +99,10 @@ class CargoCommandBuildSession(
             commands.add(createCommand(RustupComponentAddBuildService("clippy")))
         }
 
+        if (command == CargoConstants.COMMAND_FMT) {
+            commands.add(createCommand(RustupComponentAddBuildService("rustfmt")))
+        }
+
         if (command == CargoConstants.COMMAND_CUSTOM_CRATE) {
             val command = parameters[CargoConstants.PARAM_CUSTOM_CRATE_COMMAND_NAME]
             val version = parameters[CargoConstants.PARAM_CUSTOM_CRATE_COMMAND_VERSION]

plugin-rust-agent/src/main/kotlin/jetbrains/buildServer/rust/CargoRunnerBuildService.kt

@@ -32,6 +32,7 @@ class CargoRunnerBuildService(
             CargoConstants.COMMAND_CHECK to CheckArgumentsProvider(),
             CargoConstants.COMMAND_CLEAN to CleanArgumentsProvider(),
             CargoConstants.COMMAND_CLIPPY to ClippyArgumentsProvider(),
+            CargoConstants.COMMAND_FMT to FmtArgumentsProvider(),
             CargoConstants.COMMAND_DOC to DocArgumentsProvider(),
             CargoConstants.COMMAND_LOGIN to LoginArgumentsProvider(),
             CargoConstants.COMMAND_PACKAGE to PackageArgumentsProvider(),

plugin-rust-agent/src/main/kotlin/jetbrains/buildServer/rust/cargo/FmtArgumentsProvider.kt

@@ -0,0 +1,33 @@
+
+
+package jetbrains.buildServer.rust.cargo
+
+import jetbrains.buildServer.agent.BuildRunnerContext
+import jetbrains.buildServer.rust.ArgumentsProvider
+import jetbrains.buildServer.rust.CargoConstants
+import java.util.*
+
+/**
+ * Provides arguments to cargo clean command.
+ */
+class FmtArgumentsProvider : ArgumentsProvider {
+
+    override fun getArguments(runnerContext: BuildRunnerContext): List<String> {
+        val parameters = runnerContext.runnerParameters
+        val arguments = ArrayList<String>()
+        arguments.add(CargoConstants.COMMAND_FMT)
+
+        val checkValue = parameters[CargoConstants.PARAM_FMT_CHECK]
+        if ("true".equals(checkValue, ignoreCase = true)) {
+            arguments.add("--check")
+        }
+
+        val manifestValue = parameters[CargoConstants.PARAM_FMT_MANIFEST]
+        if (!manifestValue.isNullOrBlank()) {
+            arguments.add("--manifest-path")
+            arguments.add(manifestValue.trim())
+        }
+
+        return arguments
+    }
+}

plugin-rust-agent/src/test/kotlin/jetbrains/buildServer/rust/test/CargoRunnerBuildServiceTest.kt

@@ -71,6 +71,15 @@ class CargoRunnerBuildServiceTest {
         Assert.assertEquals(result, arguments)
     }
 
+    @Test(dataProvider = "testFmtArgumentsData")
+    fun testFmtArguments(parameters: Map<String, String>, arguments: List<String>) {
+        val context = getRunnerContext(parameters)
+        val argumentsProvider = FmtArgumentsProvider()
+        val result = argumentsProvider.getArguments(context)
+
+        Assert.assertEquals(result, arguments)
+    }
+
     @Test(dataProvider = "testPackageArgumentsData")
     fun testPackageArguments(parameters: Map<String, String>, arguments: List<String>) {
         val context = getRunnerContext(parameters)
@@ -270,6 +279,15 @@ class CargoRunnerBuildServiceTest {
                         CargoConstants.PARAM_DOC_MANIFEST, "/path/to/manifest"), listOf("doc", "--target", "name", "--manifest-path", "/path/to/manifest")))
     }
 
+    @DataProvider(name = "testFmtArgumentsData")
+    fun testFmtArgumentsData(): Array<Array<Any>> {
+        return arrayOf(arrayOf(CollectionsUtil.asMap(
+                CargoConstants.PARAM_FMT_CHECK, "true"), listOf("fmt", "--check")),
+
+                arrayOf(CollectionsUtil.asMap(
+                        CargoConstants.PARAM_FMT_MANIFEST, "/path/to/manifest"), listOf("fmt", "--manifest-path", "/path/to/manifest")))
+    }
+
     @DataProvider(name = "testPackageArgumentsData")
     fun testPackageArgumentsData(): Array<Array<Any>> {
         return arrayOf(arrayOf(CollectionsUtil.asMap(

plugin-rust-common/src/main/kotlin/jetbrains/buildServer/rust/CargoConstants.kt

@@ -27,6 +27,7 @@ object CargoConstants {
     const val COMMAND_CLEAN = "clean"
     const val COMMAND_CLIPPY = "clippy"
     const val COMMAND_DOC = "doc"
+    const val COMMAND_FMT = "fmt"
     const val COMMAND_LOGIN = "login"
     const val COMMAND_PACKAGE = "package"
     const val COMMAND_PUBLISH = "publish"
@@ -115,6 +116,9 @@ object CargoConstants {
     const val PARAM_DOC_MANIFEST = "cargo-doc-manifest"
     const val PARAM_DOC_PARALLEL = "cargo-doc-parallel"
 
+    const val PARAM_FMT_CHECK = "cargo-fmt-check"
+    const val PARAM_FMT_MANIFEST = "cargo-fmt-manifest"
+
     const val PARAM_PACKAGE_NO_VERIFY = "cargo-package-no-verify"
     const val PARAM_PACKAGE_NO_METADATA = "cargo-package-no-metadata"
     const val PARAM_PACKAGE_MANIFEST = "cargo-package-manifest"

plugin-rust-server/kotlin-dsl/CargoStep.xml

@@ -269,6 +269,21 @@
                 </param>
             </option>
 
+            <option name="fmt" value="fmt">
+                <param name="cargo-fmt-check" dslName="check">
+                    <description>
+                        Whether to run with --check
+                    </description>
+                </param>
+
+
+                <param name="cargo-fmt-manifest" dslName="manifest">
+                    <description>
+                        Path to the manifest to run cargo with
+                    </description>
+                </param>
+            </option>
+
             <option name="login" value="login">
                 <param name="cargo-login-token" dslName="token">
                     <deprecated replaceWith="tokenSecure"/>

plugin-rust-server/src/main/kotlin/jetbrains/buildServer/rust/CargoParametersProvider.kt

@@ -16,6 +16,7 @@ class CargoParametersProvider {
             CleanCommandType(),
             ClippyCommandType(),
             DocCommandType(),
+            FmtCommandType(),
             LoginCommandType(),
             PackageCommandType(),
             PublishCommandType(),
@@ -232,6 +233,12 @@ class CargoParametersProvider {
     val docParallelKey: String
         get() = CargoConstants.PARAM_DOC_PARALLEL
 
+    val fmtCheckKey: String
+        get() = CargoConstants.PARAM_FMT_CHECK
+
+    val fmtManifestKey: String
+        get() = CargoConstants.PARAM_FMT_MANIFEST
+
     val packageNoVerifyKey: String
         get() = CargoConstants.PARAM_PACKAGE_NO_VERIFY
 

plugin-rust-server/src/main/kotlin/jetbrains/buildServer/rust/commands/cargo/FmtCommandType.kt

@@ -0,0 +1,20 @@
+
+
+package jetbrains.buildServer.rust.commands.cargo
+
+import jetbrains.buildServer.rust.CargoConstants
+import jetbrains.buildServer.rust.commands.CommandType
+
+/**
+ * Provides parameters for cargo doc command.
+ */
+class FmtCommandType : CommandType {
+    override val name: String
+        get() = CargoConstants.COMMAND_FMT
+
+    override val editPage: String
+        get() = "editFmtParameters.jsp"
+
+    override val viewPage: String
+        get() = "viewFmtParameters.jsp"
+}

plugin-rust-server/src/main/resources/buildServerResources/cargo/editFmtParameters.jsp

@@ -0,0 +1,26 @@
+<%@ taglib prefix="forms" tagdir="/WEB-INF/tags/forms" %>
+<%@ taglib prefix="props" tagdir="/WEB-INF/tags/props" %>
+<%@ taglib prefix="l" tagdir="/WEB-INF/tags/layout" %>
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<%@ taglib prefix="bs" tagdir="/WEB-INF/tags" %>
+
+
+<jsp:useBean id="propertiesBean" scope="request" type="jetbrains.buildServer.controllers.BasePropertiesBean"/>
+<jsp:useBean id="params" class="jetbrains.buildServer.rust.CargoParametersProvider"/>
+
+<tr>
+    <th class="noBorder">Format</th>
+    <td>
+        <props:checkboxProperty name="${params.fmtCheckKey}"/>
+        <label for="${params.fmtCheckKey}">Run cargo fmt --check, reporting an error when current source code is not correctly formatted</label>
+    </td>
+</tr>
+
+<tr class="advancedSetting">
+    <th><label for="${params.fmtManifestKey}">Manifest:</label></th>
+    <td>
+        <props:textProperty name="${params.fmtManifestKey}" className="longField"/>
+        <span class="error" id="error_${params.fmtManifestKey}"></span>
+        <span class="smallNote">Path to the manifest to use cargo with.</span>
+    </td>
+</tr>

plugin-rust-server/src/main/resources/buildServerResources/cargo/viewFmtParameters.jsp

@@ -0,0 +1,18 @@
+<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
+<%@ taglib prefix="props" tagdir="/WEB-INF/tags/props" %>
+
+
+<jsp:useBean id="propertiesBean" scope="request" type="jetbrains.buildServer.controllers.BasePropertiesBean"/>
+<jsp:useBean id="params" class="jetbrains.buildServer.rust.CargoParametersProvider"/>
+
+<c:if test="${not empty propertiesBean.properties[params.fmtCheckKey]}">
+    <div class="parameter">
+        Check formatting and report an error: <strong>ON</strong>
+    </div>
+</c:if>
+
+<c:if test="${not empty propertiesBean.properties[params.fmtManifestKey]}">
+    <div class="parameter">
+        Manifest: <props:displayValue name="${params.fmtManifestKey}"/>
+    </div>
+</c:if>