(GH-502) Auto detect PDK or Puppet-Agent

This commit modifies the extension to look in the default install
locations for the PDK, then for Puppet-Agent, before throwing an error
message that a valid source cannot be found. It does this by introducing
a new option for the `installType` setting called `auto`.

Co-authored-by: Tony Green <tgreen@bandcamp.tv>
Co-authored-by: Glenn Sarti <Glenn Sarti <glennsarti@users.noreply.github.com>

Author: 3 people

README.md

@@ -331,21 +331,22 @@ You can also install the extension without access to the internet by following t
 
 ## Configuration
 
-The Puppet VSCode extension can use the PDK or the Puppet Agent to provide advanced features, which can be set using two configuration options: `puppet.installType` and `puppet.installDirectory`.
+### Puppet Source Configuration
 
-- By default the `puppet.installType` is set to `agent`, and allows you to choose to use `pdk` or `agent`.
-- The `puppet.installDirectory` allows you to choose a custom path to either a PDK install or a Puppet-Agent install, and must match the correct setting in `puppet.installType`.
+The Puppet VSCode extension can use either the PDK or the Puppet Agent as a source to provide advanced features. Which source it uses, and what location to find them in, can be set using two configuration options: `puppet.installType` and `puppet.installDirectory`.
 
-If no settings are chosen, the extension will attempt to use the Puppet Agent, to force it to use the PDK you have to select `pdk` for `puppet.installType`.
+- The `puppet.installType` setting allows you to choose to use `auto`, `pdk` or `agent`, and is set to `auto` by default.
+- The `puppet.installDirectory` allows you to choose a custom path to either a PDK install or a Puppet-Agent install, and must match the correct setting in `puppet.installType`.
 
+> The default values for these settings will require no configuration by the user in order to use the extension if the PDK or Puppet Agent are installed in the default locations.
 
-> Note: The `puppet.installDirectory` setting name will be changed in the `0.12.0` release to `puppet.installDirectory`
+#### Automatic Configuration
 
-> Note: Only PDK v1.5.0 and above are supported.
+By default the extension attempts to automatically find a valid installation of the PDK on your system. If a PDK installation is not found, it attempts to find a Puppet Agent installation. The locations it looks for are the default install locations for each product. Exact default values for these locations can be found in the following sections for manually configuring the extension.
 
-### Configure extension to use PDK
+#### Configure extension to use PDK
 
-To ensure that the extension uses the PDK, set the `puppet.installType` setting to the `pdk` value like so:
+To ensure that the extension uses the `PDK`, set the `puppet.installType` setting to the `pdk` value like so:
 
 ```json
 {
@@ -379,15 +380,17 @@ Linux:
 }
 ```
 
-To use a custom install path for the PDK, set the `puppet.installDirectory` setting to the path you installed the PDK to:
+To use a custom install path for the `PDK`, set the `puppet.installDirectory` setting to the path you installed the `PDK` to:
 
 ```json
 {
   "puppet.installDirectory":"D:/programs/pdk"
 }
 ```
 
-The PDK has many versions of Puppet which can be used. Set the `puppet.editorService.puppet.version` setting to the version you would like to use, for example, if you wanted to use version 5.4.0, then set the configuration to:
+#### Configure Puppet Version in PDK 
+
+The `PDK` has many versions of Puppet which can be used. Set the `puppet.editorService.puppet.version` setting to the version you would like to use, for example, if you wanted to use version 5.4.0, then set the configuration to:
 
 ```json
 {
@@ -399,7 +402,7 @@ You can also change the version from the status bar in Visual Studio Code.  Clic
 
 ![changing_puppet_version](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/change-puppet-version.gif)
 
-### Configure extension to use Puppet-Agent
+#### Configure extension to use Puppet-Agent
 
 To ensure that the extension uses the Puppet-Agent, set the `puppet.installType` setting to the `puppet` value like so:
 

package-lock.json

@@ -402,9 +402,10 @@
         },
         "puppet.installType": {
           "type": "string",
-          "default": "pdk",
-          "description": "The type of Puppet installation. Either the Puppet Development Kit (pdk) or the Puppet Agent (agent)",
+          "default": "auto",
+          "description": "The type of Puppet installation. Either the Puppet Development Kit (pdk) or the Puppet Agent (agent). Choose 'auto' to have the extension detect which to use automatically based on default install locations",
           "enum": [
+            "auto",
             "pdk",
             "agent"
           ]

package.json

@@ -63,6 +63,20 @@ export class AggregateConfiguration implements IAggregateConfiguration {
   constructor(settings:ISettings) {
     this.workspace = settings;
 
+    // If the user has set the installType to 'auto' then we need
+    // to resolve which install type we will actually use
+    if (settings.installType === PuppetInstallType.AUTO) {
+      if (fs.existsSync(this.getPdkBasePath())) {
+        settings.installType = PuppetInstallType.PDK;
+      } else if(fs.existsSync(this.getAgentBasePath())) {
+        settings.installType = PuppetInstallType.PUPPET;
+      } else {
+        // We can't automatically figure it out so, assume PDK
+        // TODO: Should we log this?
+        settings.installType = PuppetInstallType.PDK;
+      }
+    }
+
     const puppetBaseDir = this.calculatePuppetBaseDir(settings);
     const puppetDir = this.safeJoin(puppetBaseDir, 'puppet');
     const facterDir = this.safeJoin(puppetBaseDir, 'facter');
@@ -180,32 +194,36 @@ export class AggregateConfiguration implements IAggregateConfiguration {
       return settings.installDirectory;
     }
 
-    let programFiles = PathResolver.getprogramFiles();
     switch (settings.installType) {
       case PuppetInstallType.PDK:
-        switch (process.platform) {
-          case 'win32':
-            return path.join(programFiles, 'Puppet Labs', 'DevelopmentKit');
-          default:
-            return path.join(programFiles, 'puppetlabs', 'pdk');
-        }
+        return this.getPdkBasePath();
       case PuppetInstallType.PUPPET:
-        switch (process.platform) {
-          case 'win32':
-            // On Windows we have a subfolder called 'Puppet' that has 
-            // every product underneath 
-            return path.join(programFiles, 'Puppet Labs', 'Puppet');
-          default:
-            // On *nix we don't have a sub folder called 'Puppet' 
-            return path.join(programFiles, 'puppetlabs');
-        }
+        return this.getAgentBasePath();
       default:
-        switch (process.platform) {
-          case 'win32':
-            return path.join(programFiles, 'Puppet Labs', 'DevelopmentKit');
-          default:
-            return path.join(programFiles, 'puppetlabs', 'pdk');
-        }
+        return this.getPdkBasePath();
+    }
+  }
+
+  private getAgentBasePath() {
+    let programFiles = PathResolver.getprogramFiles();
+    switch (process.platform) {
+      case 'win32':
+        // On Windows we have a subfolder called 'Puppet' that has 
+        // every product underneath 
+        return path.join(programFiles, 'Puppet Labs', 'Puppet');
+      default:
+        // On *nix we don't have a sub folder called 'Puppet' 
+        return path.join(programFiles, 'puppetlabs');
+    }
+  }
+
+  private getPdkBasePath() {
+    let programFiles = PathResolver.getprogramFiles();
+    switch (process.platform) {
+      case 'win32':
+        return path.join(programFiles, 'Puppet Labs', 'DevelopmentKit');
+      default:
+        return path.join(programFiles, 'puppetlabs', 'pdk');
     }
   }
 

src/configuration.ts

@@ -81,6 +81,8 @@ class PDKRubyInstances implements IPDKRubyInstances {
     if (!fs.existsSync(this.pdkDirectory)) { return this.rubyInstances; }
 
     var rubyDir = path.join(this.pdkDirectory, 'private', 'ruby');
+    if (!fs.existsSync(rubyDir)) { return this.rubyInstances; }
+
     fs.readdirSync(rubyDir).forEach( (item) => {
       this.rubyInstances.push(new PDKRubyInstance(
         this.pdkDirectory,

src/configuration/pdkResolver.ts

@@ -16,10 +16,9 @@ import { ConnectionHandler } from './handler';
 import { DockerConnectionHandler } from './handlers/docker';
 import { StdioConnectionHandler } from './handlers/stdio';
 import { TcpConnectionHandler } from './handlers/tcp';
-import { ConnectionType, ProtocolType } from './settings';
+import { ConnectionType, ProtocolType, PuppetInstallType } from './settings';
 import { ILogger } from './logging';
 import { OutputChannelLogger } from './logging/outputchannel';
-//import { PuppetStatusBar } from './PuppetStatusBar';
 import { legacySettings, SettingsFromWorkspace } from './settings';
 import { Reporter, reporter } from './telemetry/telemetry';
 
@@ -30,7 +29,6 @@ const debugType = 'Puppet';  // don't change this
 let extContext: vscode.ExtensionContext;
 let connectionHandler: ConnectionHandler;
 let logger: OutputChannelLogger;
-//let statusBar: PuppetStatusBar;
 let configSettings: IAggregateConfiguration;
 let extensionFeatures: IFeature[] = [];
 
@@ -43,14 +41,19 @@ export function activate(context: vscode.ExtensionContext) {
   context.subscriptions.push(new Reporter(extContext));
 
   const settings = SettingsFromWorkspace();
+  const previousInstallType = settings.installType;
+  configSettings = CreateAggregrateConfiguration(settings);
+  logger = new OutputChannelLogger(configSettings.workspace.editorService.loglevel);
+  if (configSettings.workspace.installType !== previousInstallType) {
+    logger.debug(`Installation type has changed from ${previousInstallType} to ${configSettings.workspace.installType}`);
+  }
+
   reporter.sendTelemetryEvent('config', {
-    'installType'   : settings.installType,
-    'protocol'      : settings.editorService.protocol,
-    'imageName'     : settings.editorService.docker.imageName
+    'installType'   : configSettings.workspace.installType,
+    'protocol'      : configSettings.workspace.editorService.protocol,
+    'imageName'     : configSettings.workspace.editorService.docker.imageName
   });
-  configSettings = CreateAggregrateConfiguration(settings);
 
-  logger          = new OutputChannelLogger(configSettings.workspace.editorService.loglevel);
   const statusBar = new PuppetStatusBarFeature([puppetLangID, puppetFileLangID], configSettings, logger, context);
 
   extensionFeatures = [
@@ -133,12 +136,25 @@ function checkInstallDirectory(config: IAggregateConfiguration, logger: ILogger)
 
   // we want to check directory if STDIO or Local TCP
   if (!fs.existsSync(config.ruby.puppetBaseDir)) {
-    showErrorMessage(
-      `Could not find a valid Puppet installation at '${
+    let message = '';
+    // Need to use SettingsFromWorkspace() here because the AggregateConfiguration
+    // changes the installType from Auto, to its calculated value
+    if (SettingsFromWorkspace().installType === PuppetInstallType.AUTO) {
+      let m = [
+        'The extension failed to find a Puppet installation automatically in the default locations for PDK and for Puppet Agent.',
+        'While syntax highlighting and grammar detection will still work, intellisense and other advanced features will not.',
+      ];
+      message = m.join(' ');
+    }else{
+      message = `Could not find a valid Puppet installation at '${
         config.ruby.puppetBaseDir
-      }'. While syntax highlighting and grammar detection will still work, intellisense and other advanced features will not.`,
-      'Troubleshooting Information',
-      'https://github.com/lingua-pupuli/puppet-vscode#experience-a-problem',
+      }'. While syntax highlighting and grammar detection will still work, intellisense and other advanced features will not.`;
+    }
+
+    showErrorMessage(
+      message,
+      'Configuration Information',
+      'https://github.com/lingua-pupuli/puppet-vscode#configuration',
       logger
     );
     return false;

src/extension.ts

@@ -5,6 +5,7 @@ import vscode = require("vscode");
 export enum PuppetInstallType{
   PDK    = "pdk",
   PUPPET = "agent",
+  AUTO   = "auto",
 }
 
 export enum ProtocolType {
@@ -163,7 +164,7 @@ export function DefaultWorkspaceSettings(): ISettings {
       enable: true
     },
     installDirectory: undefined,
-    installType: PuppetInstallType.PDK,
+    installType: PuppetInstallType.AUTO,
     lint: {
       enable: true,
     },