Merge pull request #481 from jpogran/GH-476-bolt-command-palatte

(GH-476)(GH-477) Add Bolt Feature Support

Author: James Pogran

CHANGELOG.md

@@ -6,6 +6,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## Unreleased
 
+### Added
+
+- ([GH-476](https://github.com/lingua-pupuli/puppet-vscode/issues/476)) Add Bolt commands
+- ([GH-477](https://github.com/lingua-pupuli/puppet-vscode/issues/477)) Add Bolt yaml snippets
+
 ## [0.16.0] - 2019-01-25
 
 ### Added

README.md

@@ -253,6 +253,14 @@ In Puppet VSCode Extension v0.17.0 release support for Puppet Bolt was added. Fu
 
 The first step in this is enabling parsing Bolt Plans. This means when opening a Puppet module with Puppet Bolt plans or a folder with a Puppet Bolt plan file the Puppet VSCode Extension will no longer log an error in the Problems Pane for failing to parse Puppet Bolt Plan keywords. You will get symbol support (OutlineView and Breadcrumbs) as well as syntax highlighting. Subsequent releases will focus on adding intellisense, autocompletion, hover support and other advanced editor features. This work is tracked in the [Puppet Bolt Support Github project](https://github.com/orgs/lingua-pupuli/projects/20)
 
+#### Puppet Bolt Commands and Snippets
+
+We have added support for VSCode Command Palatte commands for opening Bolt user config and inventory yaml files. We have also added support for yaml snippets for common operations in Bolt yaml files.
+
+![bolt_command_palatte](docs/assets/bolt_config_command.gif)
+
+![bolt_command_palatte](docs/assets/bolt_inventory_command.gif)
+
 ### Debugging Puppet manifests
 
 **Note - This is an experimental feature**

docs/assets/bolt_config_command.gif

@@ -63,7 +63,9 @@
     "onCommand:extension.pdkNewClass",
     "onCommand:extension.pdkNewTask",
     "onCommand:extension.pdkTestUnit",
-    "onCommand:extension.pdkValidate"
+    "onCommand:extension.pdkValidate",
+    "onCommand:puppet-bolt.OpenUserConfigFile",
+    "onCommand:puppet-bolt.OpenUserInventoryFile"
   ],
   "main": "./out/extension",
   "contributes": {
@@ -126,6 +128,10 @@
       {
         "language": "puppetfile",
         "path": "./snippets/puppetfile.snippets.json"
+      },
+      {
+        "language": "yaml",
+        "path": "./snippets/bolt.snippets.json"
       }
     ],
     "commands": [
@@ -176,6 +182,16 @@
           "light": "./media/PreviewOnRightPane_16x.svg",
           "dark": "./media/PreviewOnRightPane_16x_dark.svg"
         }
+      },
+      {
+        "command": "puppet-bolt.OpenUserConfigFile",
+        "title": "Open Bolt User Configuration File",
+        "category": "Puppet"
+      },
+      {
+        "command": "puppet-bolt.OpenUserInventoryFile",
+        "title": "Open Bolt User Inventory File",
+        "category": "Puppet"
       }
     ],
     "menus": {

docs/assets/bolt_inventory_command.gif

@@ -0,0 +1,67 @@
+{
+  "Bolt Config template": {
+    "prefix": "bolt-config",
+    "description": "A complete Bolt config template structure snippet",
+    "body": [
+      "modulepath: ${1:modulePath}",
+      "inventoryFile: ${2:inventoryFile}",
+      "concurrency: ${3:10}",
+      "format: ${4|human,json|}",
+      "color: ${6|true,false|}",
+      "\t${7|ssh,wirnm|}:${0}"
+    ]
+  },
+  "Bolt Inventory template": {
+    "prefix": "bolt-inventory",
+    "description": "A complete Bolt inventory template structure snippet",
+    "body": [
+      "groups:",
+      "- name: ${1:groupName}",
+      "\tgroups:",
+      "\t\t- name: ${2:nodeGroupName1}",
+      "\t\t\tnodes:",
+      "\t\t\t\t- ${3:node1}",
+      "\t\t- name: ${4:nodeGroupName2}",
+      "\t\t\tnodes:",
+      "\t\t\t\t- ${5:node2}",
+      "\tconfig:",
+      "\t\ttransport: ${6|ssh,wirnm|}",
+      "\t\t${6|ssh,wirnm|}:${0}"
+    ]
+  },
+  "Bolt Inventory groups": {
+    "prefix": "groups",
+    "description": "Adds new root group",
+    "body": [
+      "groups:",
+      " - name: ${1:groupName}"
+    ]
+  },
+  "Bolt Inventory node": {
+    "prefix": "node",
+    "description": "Adds new node",
+    "body": [
+      "- name: ${1:nodeName}",
+      " config:",
+      " transport: ${2|ssh,wirnm|}",
+      "  ${2|ssh,wirnm|}:${0}"
+    ]
+  },
+  "Bolt WinRM Transport template": {
+    "prefix": "winrm",
+    "description": "",
+    "body": [
+      "winrm:",
+      " user: ${1:userName}",
+      " password: ${2:passwd}",
+      " ssl: ${3|true,false|}${0}"
+    ]
+  },
+  "Bolt SSH Transport template": {
+    "prefix": "ssh",
+    "description": "",
+    "body": [
+      "ssh:${0}"
+    ]
+  }
+}

package.json

@@ -1,25 +1,25 @@
 'use strict';
 
-import * as vscode from 'vscode';
 import * as fs from 'fs';
-
+import * as vscode from 'vscode';
 import { ConnectionConfiguration } from './configuration';
-import { ConnectionHandler } from './handler';
-import { StdioConnectionHandler } from './handlers/stdio';
-import { TcpConnectionHandler } from './handlers/tcp';
 import { IFeature } from './feature';
+import { BoltFeature } from './feature/BoltFeature';
 import { DebuggingFeature } from './feature/DebuggingFeature';
 import { FormatDocumentFeature } from './feature/FormatDocumentFeature';
 import { NodeGraphFeature } from './feature/NodeGraphFeature';
 import { PDKFeature } from './feature/PDKFeature';
 import { PuppetResourceFeature } from './feature/PuppetResourceFeature';
-import { ProtocolType, ConnectionType, IConnectionConfiguration } from './interfaces';
+import { ConnectionHandler } from './handler';
+import { DockerConnectionHandler } from './handlers/docker';
+import { StdioConnectionHandler } from './handlers/stdio';
+import { TcpConnectionHandler } from './handlers/tcp';
+import { ConnectionType, IConnectionConfiguration, ProtocolType } from './interfaces';
 import { ILogger } from './logging';
 import { OutputChannelLogger } from './logging/outputchannel';
 import { PuppetStatusBar } from './PuppetStatusBar';
 import { ISettings, legacySettings, settingsFromWorkspace } from './settings';
 import { Reporter, reporter } from './telemetry/telemetry';
-import { DockerConnectionHandler } from './handlers/docker';
 
 export const puppetLangID = 'puppet'; // don't change this
 export const puppetFileLangID = 'puppetfile'; // don't change this
@@ -52,6 +52,11 @@ export function activate(context: vscode.ExtensionContext) {
   statusBar      = new PuppetStatusBar([puppetLangID, puppetFileLangID], context, logger);
   configSettings = new ConnectionConfiguration();
 
+  extensionFeatures = [
+    new PDKFeature(extContext, logger),
+    new BoltFeature(extContext),
+  ];
+
   if(settings.editorService.enable === false){
     notifyEditorServiceDisabled(extContext);
     reporter.sendTelemetryEvent('editorServiceDisabled');
@@ -78,13 +83,10 @@ export function activate(context: vscode.ExtensionContext) {
       break;
   }
 
-  extensionFeatures = [
-    new FormatDocumentFeature(puppetLangID, connectionHandler, settings, logger, extContext),
-    new NodeGraphFeature(puppetLangID, connectionHandler, logger, extContext),
-    new PDKFeature(extContext, logger),
-    new PuppetResourceFeature(extContext, connectionHandler, logger),
-    new DebuggingFeature(debugType, settings, configSettings, extContext, logger)
-  ];
+  extensionFeatures.push(new FormatDocumentFeature(puppetLangID, connectionHandler, settings, logger, extContext));
+  extensionFeatures.push(new NodeGraphFeature(puppetLangID, connectionHandler, logger, extContext));
+  extensionFeatures.push(new PuppetResourceFeature(extContext, connectionHandler, logger));
+  extensionFeatures.push(new DebuggingFeature(debugType, settings, configSettings, extContext, logger));
 }
 
 export function deactivate() {

snippets/bolt.snippets.json

@@ -0,0 +1,67 @@
+import { ExtensionContext, commands, window, Uri } from 'vscode';
+import { IFeature } from '../feature';
+import * as path from 'path';
+import * as fs from 'fs';
+import { reporter } from '../telemetry/telemetry';
+
+export class BoltFeature implements IFeature {
+  dispose() { }
+  constructor(context: ExtensionContext) {
+    context.subscriptions.push(
+      commands.registerCommand('puppet-bolt.OpenUserConfigFile', () => {
+        let userInventoryFile = path.join(process.env['USERPROFILE'] || '~', '.puppetlabs', 'bolt', 'bolt.yaml');
+
+        this.openOrCreateFile(
+          userInventoryFile,
+          `Default bolt config yml not present. Do you want to create it?`,
+          '# This is an empty bolt config file.\n# You can get started quickly by using the built-in bolt snippets'
+        );
+
+        if (reporter) {
+          reporter.sendTelemetryEvent('puppet-bolt.OpenUserConfigFile');
+        }
+      })
+    );
+
+    context.subscriptions.push(
+      commands.registerCommand('puppet-bolt.OpenUserInventoryFile', () => {
+        let userInventoryFile = path.join(process.env['USERPROFILE'] || '~', '.puppetlabs', 'bolt', 'inventory.yaml');
+
+        this.openOrCreateFile(
+          userInventoryFile,
+          `Default bolt inventory yml not present. Do you want to create it?`,
+          '# This is an empty bolt inventory file.\n# You can get started quickly by using the built-in bolt snippets or use bolt to generate an inventory file from PuppetDb'
+        );
+
+        if (reporter) {
+          reporter.sendTelemetryEvent('puppet-bolt.OpenUserInventoryFile');
+        }
+      })
+    );
+  }
+
+  private openOrCreateFile(file: string, message: string, template: string) {
+    if (!fs.existsSync(file)) {
+      window
+        .showQuickPick(['yes', 'no'], {
+          placeHolder: message,
+          canPickMany: false,
+          ignoreFocusOut: true
+        })
+        .then(answer => {
+          switch (answer) {
+            case 'no':
+              break;
+            case 'yes':
+              fs.writeFile(file, template, 'utf8', function (err) {
+                window.showErrorMessage(`Error creating file ${file}. Error: ${err.message}`);
+              });
+              commands.executeCommand('vscode.openFolder', Uri.file(file), false);
+          }
+        });
+    }
+    else {
+      commands.executeCommand('vscode.openFolder', Uri.file(file), false);
+    }
+  }
+}