adds support for creating new workspaces (#27)

* added workspace new

* renamed select test file

* moved to feature folder

* doc'd workspace new

overview.md

@@ -328,3 +328,15 @@ The task supports managing workspaces within pipelines. The following workspace
     workspaceSubCommand: select
     workspaceName: foo
 ```
+
+### Workspace New
+
+```yaml
+- task: TerraformCLI@0
+  displayName: select workspace foo
+  inputs:
+    workingDirectory: $(terraform_templates_dir)
+    command: workspace        
+    workspaceSubCommand: new
+    workspaceName: foo
+```

pipelines/pipeline-alpha.yml

@@ -27,4 +27,4 @@ stages:
       stage: alpha
       scenarios:
         - smoke_test.yml
-        - init_with_self_configured_backend.yml
+        - switch_workspaces.yml

pipelines/test/switch_workspaces.yml

@@ -27,6 +27,13 @@ jobs:
         backendAzureRmStorageAccountSku: Standard_RAGRS
         backendAzureRmContainerName: azure-pipelines-terraform
         backendAzureRmKey: workspace_switch.tfstate
+    - task: charleszipp.azure-pipelines-tasks-terraform-${{ parameters.stage }}.azure-pipelines-tasks-terraform-cli.TerraformCLI@0
+      displayName: new workspace foo
+      inputs:
+        workingDirectory: $(terraform_templates_dir)
+        command: workspace        
+        workspaceSubCommand: new
+        workspaceName: foo
     - task: charleszipp.azure-pipelines-tasks-terraform-${{ parameters.stage }}.azure-pipelines-tasks-terraform-cli.TerraformCLI@0
       displayName: select workspace default
       inputs:
@@ -37,4 +44,8 @@ jobs:
     - bash: |
         terraform workspace show
       displayName: show workspace
+      workingDirectory: $(terraform_templates_dir)
+    - bash: |
+        terraform workspace delete foo
+      displayName: delete new workspace
       workingDirectory: $(terraform_templates_dir)

tasks/terraform-cli/src/commands/index.ts

@@ -55,6 +55,7 @@ export { TerraformForceUnlock as ForceUnlockCommandHandler } from './tf-force-un
 export { TerraformShow as ShowCommandHandler } from './tf-show';
 export { TerraformFormat as FormatCommandHandler } from './tf-fmt';
 export { TerraformWorkspaceSelect as WorkspaceSelectCommandHandler } from './tf-workspace-select';
+export { TerraformWorkspaceNew as WorkspaceNewCommandHandler } from './tf-workspace-new';
 
 declare module '../runners'{
     interface RunnerResult{

tasks/terraform-cli/src/commands/tf-workspace-new.ts

@@ -0,0 +1,22 @@
+import { CommandResponse, ICommand } from ".";
+import { ITaskContext } from "../context";
+import { IRunner } from "../runners";
+import { RunWithTerraform } from "../runners/builders";
+
+export class TerraformWorkspaceNew implements ICommand {
+    constructor(
+        private readonly runner: IRunner
+        ) {
+    }
+
+    async exec(ctx: ITaskContext): Promise<CommandResponse> {
+        const options = await new RunWithTerraform(ctx, false, ctx.workspaceSubCommand, [ctx.name])
+            .withCommandOptions(ctx.commandOptions)
+            .withWorkspace(ctx.workspaceName)
+            .build();
+
+        const result = await this.runner.exec(options);
+
+        return result.toCommandResponse();
+    }
+}

tasks/terraform-cli/src/task.ts

@@ -115,6 +115,8 @@ export class Task {
         switch(this.ctx.workspaceSubCommand){
             case "select":
                 return new commands.WorkspaceSelectCommandHandler(this.runner);
+            case "new":
+                return new commands.WorkspaceNewCommandHandler(this.runner);
             default:
                 throw new Error(`Workspace sub-command "${this.ctx.workspaceSubCommand}" is not supported`);
         }        

tasks/terraform-cli/src/tests/features/workspace/stdout-new-workspace-bar.txt

@@ -0,0 +1 @@
+\u001b[0m\u001b[32m\u001b[1mCreated and switched to workspace \"bar\"!\u001b[0m\u001b[32m\n\nYou're now on a new, empty workspace. Workspaces isolate their state,\nso if you run \"terraform plan\" Terraform will not see any existing state\nfor this configuration.\u001b[0m\n

tasks/terraform-cli/src/tests/features/workspace/terraform-workspace-new.feature

@@ -0,0 +1,30 @@
+Feature: terraform workspace new
+
+    terraform workspace new [OPTIONS] [name] [DIR]
+
+    Scenario: new workspace                
+    Given terraform exists
+    And terraform command is "workspace"
+    And workspace command is "new" with name "bar"
+    And running command "terraform workspace new bar" returns successful result with stdout from file "./src/tests/features/workspace/stdout-new-workspace-bar.txt"
+    When the terraform cli task is run
+    Then the terraform cli task executed command "terraform workspace new bar"
+    And the terraform cli task is successful
+
+    Scenario: new workspace with command options               
+    Given terraform exists
+    And terraform command is "workspace" with options "-state=terraform.tfstate"
+    And workspace command is "new" with name "bar"
+    And running command "terraform workspace new -state=terraform.tfstate bar" returns successful result with stdout from file "./src/tests/features/workspace/stdout-new-workspace-bar.txt"
+    When the terraform cli task is run
+    Then the terraform cli task executed command "terraform workspace new -state=terraform.tfstate bar"
+    And the terraform cli task is successful
+
+    Scenario: new workspace already exists
+    Given terraform exists
+    And terraform command is "workspace"
+    And workspace command is "new" with name "bar"
+    And running command "terraform workspace new bar" fails with error "\u001b[31mWorkspace \"bar\" already exists\u001b[0m\u001b[0m\n"
+    When the terraform cli task is run
+    Then the terraform cli task executed command "terraform workspace new bar"
+    And the terraform cli task fails with message "\u001b[31mWorkspace \"bar\" already exists\u001b[0m\u001b[0m\n"