[Batch] Added Get-AzBatchTaskSlotCounts cmdlet

Author: dpwatrous

src/Batch/Batch.Test/BatchTestHelpers.cs

@@ -712,20 +712,33 @@ public static AzureOperationResponse<
         /// <summary>
         /// Builds a TaskCountsGetResponse object
         /// </summary>
-        public static AzureOperationResponse<ProxyModels.TaskCounts, ProxyModels.JobGetTaskCountsHeaders> CreateTaskCountsGetResponse(
-            int active, int running, int succeeded, int failed)
+        public static AzureOperationResponse<ProxyModels.TaskCountsResult, ProxyModels.JobGetTaskCountsHeaders> CreateTaskCountsGetResponse(
+            int requiredTaskSlots, int activeTasks, int runningTasks, int succeededTasks, int failedTasks)
         {
-            var response = new AzureOperationResponse<ProxyModels.TaskCounts, ProxyModels.JobGetTaskCountsHeaders>();
+            var response = new AzureOperationResponse<ProxyModels.TaskCountsResult, ProxyModels.JobGetTaskCountsHeaders>();
             response.Response = new HttpResponseMessage(HttpStatusCode.OK);
 
+            var completedTasks = succeededTasks + failedTasks;
+
             ProxyModels.TaskCounts taskCounts = new ProxyModels.TaskCounts();
-            taskCounts.Active = active;
-            taskCounts.Running = running;
-            taskCounts.Succeeded = succeeded;
-            taskCounts.Failed = failed;
-            taskCounts.Completed = succeeded + failed;
+            taskCounts.Active = activeTasks;
+            taskCounts.Running = runningTasks;
+            taskCounts.Succeeded = succeededTasks;
+            taskCounts.Failed = failedTasks;
+            taskCounts.Completed = completedTasks;
+
+            ProxyModels.TaskSlotCounts slotCounts = new ProxyModels.TaskSlotCounts();
+            slotCounts.Active = requiredTaskSlots * activeTasks;
+            slotCounts.Running = requiredTaskSlots * runningTasks;
+            slotCounts.Succeeded = requiredTaskSlots * succeededTasks;
+            slotCounts.Failed = requiredTaskSlots * failedTasks;
+            slotCounts.Completed = requiredTaskSlots * completedTasks;
+
+            ProxyModels.TaskCountsResult result = new ProxyModels.TaskCountsResult();
+            result.TaskCounts = taskCounts;
+            result.TaskSlotCounts = slotCounts;
 
-            response.Body = taskCounts;
+            response.Body = result;
 
             return response;
         }

src/Batch/Batch.Test/Tasks/GetBatchTaskCountsCommandTests.cs

@@ -28,7 +28,7 @@ namespace Microsoft.Azure.Commands.Batch.Test.Tasks
 {
     public class GetBatchTaskCountsCommandTests
     {
-        private GetBatchTaskCountCommand cmdlet;
+        private GetBatchTaskCountsCommand cmdlet;
         private Mock<BatchClient> batchClientMock;
         private Mock<ICommandRuntime> commandRuntimeMock;
 
@@ -37,7 +37,7 @@ public GetBatchTaskCountsCommandTests(Xunit.Abstractions.ITestOutputHelper outpu
             ServiceManagement.Common.Models.XunitTracingInterceptor.AddToContext(new ServiceManagement.Common.Models.XunitTracingInterceptor(output));
             batchClientMock = new Mock<BatchClient>();
             commandRuntimeMock = new Mock<ICommandRuntime>();
-            cmdlet = new GetBatchTaskCountCommand()
+            cmdlet = new GetBatchTaskCountsCommand()
             {
                 CommandRuntime = commandRuntimeMock.Object,
                 BatchClient = batchClientMock.Object,
@@ -53,33 +53,37 @@ public void GetBatchTaskCountsTest()
             cmdlet.BatchContext = context;
             cmdlet.JobId = "job-1";
 
+            const int requiredSlots = 2;
             const int active = 3;
             const int running = 5;
             const int succeeded = 2;
             const int failed = 1;
 
             // Build a TaskCounts instead of querying the service on a Get TaskCounts call
-            AzureOperationResponse<ProxyModels.TaskCounts, ProxyModels.JobGetTaskCountsHeaders> response =
-                BatchTestHelpers.CreateTaskCountsGetResponse(active, running, succeeded, failed);
+            AzureOperationResponse<ProxyModels.TaskCountsResult, ProxyModels.JobGetTaskCountsHeaders> response =
+                BatchTestHelpers.CreateTaskCountsGetResponse(requiredSlots, active, running, succeeded, failed);
+
             RequestInterceptor interceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor<
                 ProxyModels.JobGetTaskCountsOptions,
-                AzureOperationResponse<ProxyModels.TaskCounts, ProxyModels.JobGetTaskCountsHeaders>>(response);
+                AzureOperationResponse<ProxyModels.TaskCountsResult, ProxyModels.JobGetTaskCountsHeaders>>(response);
 
             cmdlet.AdditionalBehaviors = new List<BatchClientBehavior>() { interceptor };
 
             // Setup the cmdlet to write pipeline output to a list that can be examined later
             PSTaskCounts taskCounts = null;
-            commandRuntimeMock.Setup(r =>
-                    r.WriteObject(It.IsAny<PSTaskCounts>()))
-                .Callback<object>(p => taskCounts = (PSTaskCounts)p);
+            commandRuntimeMock
+                .Setup(r => r.WriteObject(It.IsAny<PSTaskCounts>()))
+                .Callback<object>(p => {
+                    taskCounts = (PSTaskCounts)p;
+                });
 
             cmdlet.ExecuteCmdlet();
 
-            Assert.Equal(active, taskCounts.Active);
-            Assert.Equal(running, taskCounts.Running);
-            Assert.Equal(succeeded + failed, taskCounts.Completed);
-            Assert.Equal(succeeded, taskCounts.Succeeded);
-            Assert.Equal(failed, taskCounts.Failed);
+            Assert.Equal(3, taskCounts.Active);
+            Assert.Equal(5, taskCounts.Running);
+            Assert.Equal(3, taskCounts.Completed);
+            Assert.Equal(2, taskCounts.Succeeded);
+            Assert.Equal(1, taskCounts.Failed);
         }
     }
 }

src/Batch/Batch.Test/Tasks/GetBatchTaskSlotCountsCommandTests.cs

@@ -0,0 +1,89 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// 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.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.Azure.Batch;
+using Microsoft.Azure.Batch.Protocol;
+using Microsoft.Azure.Commands.Batch.Models;
+using Microsoft.Rest.Azure;
+using Microsoft.WindowsAzure.Commands.ScenarioTest;
+using Moq;
+using System.Collections.Generic;
+using System.Management.Automation;
+using Xunit;
+using BatchClient = Microsoft.Azure.Commands.Batch.Models.BatchClient;
+using ProxyModels = Microsoft.Azure.Batch.Protocol.Models;
+
+namespace Microsoft.Azure.Commands.Batch.Test.Tasks
+{
+    public class GetBatchTaskSlotCountsCommandTests
+    {
+        private GetBatchTaskSlotCountsCommand cmdlet;
+        private Mock<BatchClient> batchClientMock;
+        private Mock<ICommandRuntime> commandRuntimeMock;
+
+        public GetBatchTaskSlotCountsCommandTests(Xunit.Abstractions.ITestOutputHelper output)
+        {
+            ServiceManagement.Common.Models.XunitTracingInterceptor.AddToContext(new ServiceManagement.Common.Models.XunitTracingInterceptor(output));
+            batchClientMock = new Mock<BatchClient>();
+            commandRuntimeMock = new Mock<ICommandRuntime>();
+            cmdlet = new GetBatchTaskSlotCountsCommand()
+            {
+                CommandRuntime = commandRuntimeMock.Object,
+                BatchClient = batchClientMock.Object,
+            };
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void GetBatchTaskSlotCountsTest()
+        {
+            // Setup cmdlet to get task counts by job id
+            BatchAccountContext context = BatchTestHelpers.CreateBatchContextWithKeys();
+            cmdlet.BatchContext = context;
+            cmdlet.JobId = "job-1";
+
+            const int requiredSlots = 2;
+            const int active = 3;
+            const int running = 5;
+            const int succeeded = 2;
+            const int failed = 1;
+
+            // Build a TaskCountsResult instead of querying the service
+            AzureOperationResponse<ProxyModels.TaskCountsResult, ProxyModels.JobGetTaskCountsHeaders> response =
+                BatchTestHelpers.CreateTaskCountsGetResponse(requiredSlots, active, running, succeeded, failed);
+
+            RequestInterceptor interceptor = BatchTestHelpers.CreateFakeServiceResponseInterceptor<
+                ProxyModels.JobGetTaskCountsOptions,
+                AzureOperationResponse<ProxyModels.TaskCountsResult, ProxyModels.JobGetTaskCountsHeaders>>(response);
+
+            cmdlet.AdditionalBehaviors = new List<BatchClientBehavior>() { interceptor };
+
+            // Setup the cmdlet to write pipeline output to a list that can be examined later
+            PSTaskSlotCounts slotCounts = null;
+            commandRuntimeMock
+                .Setup(r => r.WriteObject(It.IsAny<PSTaskSlotCounts>()))
+                .Callback<object>(p => {
+                    slotCounts = (PSTaskSlotCounts)p;
+                });
+
+            cmdlet.ExecuteCmdlet();
+
+            Assert.Equal(6, slotCounts.Active);
+            Assert.Equal(10, slotCounts.Running);
+            Assert.Equal(6, slotCounts.Completed);
+            Assert.Equal(4, slotCounts.Succeeded);
+            Assert.Equal(2, slotCounts.Failed);
+        }
+    }
+}

…/Batch/Tasks/GetBatchTaskCountCommand.cs …Batch/Tasks/GetBatchTaskCountsCommand.cssrc/Batch/Batch/Tasks/GetBatchTaskCountCommand.cs renamed to src/Batch/Batch/Tasks/GetBatchTaskCountsCommand.cs src/Batch/Batch/Tasks/GetBatchTaskCountCommand.cs renamed to src/Batch/Batch/Tasks/GetBatchTaskCountsCommand.cs

@@ -20,10 +20,9 @@
 
 namespace Microsoft.Azure.Commands.Batch
 {
-    [GenericBreakingChange("Get-AzBatchTaskCounts alias will be removed in an upcoming breaking change release", "2.0.0")]
-    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzurePrefix + "BatchTaskCount"),OutputType(typeof(PSTaskCounts))]
-    [Alias("Get-AzBatchTaskCounts")]
-    public class GetBatchTaskCountCommand : BatchObjectModelCmdletBase
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzurePrefix + "BatchTaskCounts"), OutputType(typeof(PSTaskCounts))]
+    [Alias("Get-AzBatchTaskCount")]
+    public class GetBatchTaskCountsCommand : BatchObjectModelCmdletBase
     {
         [Parameter(Position = 0, ParameterSetName = Constants.IdParameterSet, Mandatory = true,
             ValueFromPipelineByPropertyName = true, HelpMessage = "The id of the job for which to get task counts.")]

src/Batch/Batch/Tasks/GetBatchTaskSlotCountsCommand.cs

@@ -0,0 +1,45 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// 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.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.Azure.Batch;
+using Microsoft.Azure.Commands.Batch.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+using System.Management.Automation;
+using Constants = Microsoft.Azure.Commands.Batch.Utils.Constants;
+
+namespace Microsoft.Azure.Commands.Batch
+{
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzurePrefix + "BatchTaskSlotCounts"),OutputType(typeof(PSTaskSlotCounts))]
+    [Alias("Get-AzBatchTaskSlotCount")]
+    public class GetBatchTaskSlotCountsCommand : BatchObjectModelCmdletBase
+    {
+        [Parameter(Position = 0, ParameterSetName = Constants.IdParameterSet, Mandatory = true,
+            ValueFromPipelineByPropertyName = true, HelpMessage = "The id of the job for which to get task slot counts.")]
+        [ValidateNotNullOrEmpty]
+        public string JobId { get; set; }
+
+        [Parameter(Position = 0, ParameterSetName = Constants.ParentObjectParameterSet, ValueFromPipeline = true)]
+        [ValidateNotNullOrEmpty]
+        public PSCloudJob Job { get; set; }
+
+        protected override void ExecuteCmdletImpl()
+        {
+            GetTaskCountsOptions options = new GetTaskCountsOptions(this.BatchContext, this.JobId, this.Job, this.AdditionalBehaviors);
+
+            PSTaskSlotCounts taskSlotCounts = BatchClient.GetTaskSlotCounts(options);
+
+            WriteObject(taskSlotCounts);
+        }
+    }
+}

src/Batch/Batch/help/Az.Batch.md

@@ -104,9 +104,12 @@ Gets Batch supported images for a Batch account.
 ### [Get-AzBatchTask](Get-AzBatchTask.md)
 Gets the Batch tasks for a job.
 
-### [Get-AzBatchTaskCount](Get-AzBatchTaskCount.md)
+### [Get-AzBatchTaskCounts](Get-AzBatchTaskCount.md)
 Gets the task counts for the specified job.
 
+### [Get-AzBatchTaskSlotCounts](Get-AzBatchTaskCount.md)
+Gets the task slot counts for the specified job.
+
 ### [New-AzBatchAccount](New-AzBatchAccount.md)
 Creates a Batch account.
 

…Batch/Batch/help/Get-AzBatchTaskCount.md …atch/Batch/help/Get-AzBatchTaskCounts.mdsrc/Batch/Batch/help/Get-AzBatchTaskCount.md renamed to src/Batch/Batch/help/Get-AzBatchTaskCounts.md src/Batch/Batch/help/Get-AzBatchTaskCount.md renamed to src/Batch/Batch/help/Get-AzBatchTaskCounts.md

@@ -1,11 +1,11 @@
 ---
 external help file: Microsoft.Azure.PowerShell.Cmdlets.Batch.dll-Help.xml
 Module Name: Az.Batch
-online version: https://docs.microsoft.com/powershell/module/az.batch/get-azbatchtaskcount
+online version: https://docs.microsoft.com/powershell/module/az.batch/get-azbatchtaskcounts
 schema: 2.0.0
 ---
 
-# Get-AzBatchTaskCount
+# Get-AzBatchTaskCounts
 
 ## SYNOPSIS
 Gets the task counts for the specified job.
@@ -14,26 +14,26 @@ Gets the task counts for the specified job.
 
 ### Id
 ```
-Get-AzBatchTaskCount [-JobId] <String> -BatchContext <BatchAccountContext>
+Get-AzBatchTaskCounts [-JobId] <String> -BatchContext <BatchAccountContext>
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### ParentObject
 ```
-Get-AzBatchTaskCount [[-Job] <PSCloudJob>] -BatchContext <BatchAccountContext>
+Get-AzBatchTaskCounts [[-Job] <PSCloudJob>] -BatchContext <BatchAccountContext>
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The **Get-AzBatchTaskCount** cmdlet gets the Azure Batch tasks count for a Batch job.
+The **Get-AzBatchTaskCounts** cmdlet gets the Azure Batch task counts for a Batch job.
 Specify a job by either the *JobId* parameter or the *Job* parameter.
 Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks.
 
 ## EXAMPLES
 
 ### Example 1: Get task counts by ID
 ```
-PS C:\> Get-AzBatchTaskCount -JobId "Job01" -Id "Task03" -BatchContext $Context
+PS C:\> Get-AzBatchTaskCounts -JobId "Job01" -Id "Task03" -BatchContext $Context
 Active              : 1
 Completed           : 0
 Failed              : 0