Merge pull request #491 from glennsarti/use-alternate-puppet-version

(GH-489) Use alternate puppet version

Author: James Pogran

.travis.yml

@@ -2,6 +2,10 @@
 sudo: false
 language: cpp
 
+# Must be Trusty!
+# For some reason Xenial fails with exit code 1
+dist: trusty
+
 os:
   - linux
   - osx
@@ -24,6 +28,21 @@ before_install: true
 
 install:
   - "export BUILD_VERSION=0.7.0-travis.$TRAVIS_BUILD_NUMBER"
+  # Install PDK for Ubuntu 14.04 (Trusty)
+  - if [ $TRAVIS_OS_NAME == "linux" ]; then
+      wget https://apt.puppetlabs.com/puppet6-release-trusty.deb;
+      sudo dpkg -i puppet6-release-trusty.deb;
+      sudo apt-get update;
+      sudo apt-get install pdk;
+      pdk --version;
+    fi
+  # Install PDK for Mac (Disable homebrew auto-update)
+  # Uses an absolute path due to shell needing to be reloaded.
+  - if [ $TRAVIS_OS_NAME == "osx" ]; then
+      export HOMEBREW_NO_AUTO_UPDATE=1;
+      brew cask install puppetlabs/puppet/pdk;
+      /opt/puppetlabs/pdk/bin/pdk --version;
+    fi
   - if [ "$nodejs_version" != "" ]; then
       git clone --depth 1 https://github.com/creationix/nvm.git ./.nvm;
       source ./.nvm/nvm.sh;
@@ -41,6 +60,7 @@ install:
       npm install -g vsce --silent;
       npm install --silent;
       node node_modules/gulp/bin/gulp.js bump --version $BUILD_VERSION;
+      node node_modules/gulp/bin/gulp.js initial;
     fi
 
 script:

README.md

@@ -24,7 +24,7 @@
   - [Live Workspace Intellisense](#live-workspace-intellisense)
   - [Puppet Commands](#puppet-commands)
     - [Puppet Resource](#puppet-resource)
-    - [Puppet Node Graph](#puppet-node-graph)
+    - [Puppet Node Graph](#puppet-node-graph-preview)
   - [Puppet Development Kit Support](#puppet-development-kit-support)
     - [PDK Supported Versions](#pdk-supported-versions)
     - [PDK New Module](#pdk-new-module)
@@ -377,6 +377,18 @@ To use a custom install path for the PDK, set the `puppet.installDirectory` sett
 }
 ```
 
+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
+{
+  "puppet.editorService.puppet.version":"5.4.0"
+}
+```
+
+You can also change the version from the status bar in Visual Studio Code.  Click on the Puppet version text in the status bar and then select which Puppet version you would like to use. Note that this will require Visual Studio Code to be restarted to take effect.
+
+![changing_puppet_version](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/change-puppet-version.gif)
+
 ### 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:

appveyor.yml

@@ -36,7 +36,12 @@ install:
 
        Write-Host "Set the package.json version..."
        & node node_modules\gulp\bin\gulp.js bump --specific $ENV:APPVEYOR_BUILD_VERSION
+
+       Write-Host "Setting up initial configuration..."
+       & node node_modules\gulp\bin\gulp.js initial
      }
+- cmd: choco install pdk
+- ps: pdk --version
 
 build_script:
 - cmd: npm test --silent

docs/assets/change-puppet-version.gif

@@ -1,6 +1,6 @@
 {
   "editor-services": {
-    "release": "0.18.0"
+    "release": "0.19.0"
   },
   "editor-syntax": {
     "release": "1.3.0"

editor-components.json

@@ -365,6 +365,11 @@
           "default": "",
           "description": "The Puppet cache directory. See https://puppet.com/docs/puppet/latest/dirs_vardir.html for more information"
         },
+        "puppet.editorService.puppet.version": {
+          "type": "string",
+          "default": "",
+          "description": "The version of Puppet to use. For example '5.4.0'. This is generally only applicable when using the PDK installation type. If Puppet Editor Services is unable to use this version, it will default to the latest available version of Puppet."
+        },
         "puppet.editorService.tcp.address": {
           "type": "string",
           "description": "The IP address or hostname of the remote Puppet Editor Service to connect to, for example 'computer.domain' or '192.168.0.1'. Only applicable when the editorService.protocol is set to tcp"

package.json

@@ -33,7 +33,8 @@ interface IRubyConfiguration {
   readonly pdkGemDir:string;
   readonly pdkRubyDir:string;
   readonly pdkRubyBinDir:string;
-  readonly pdkGemVerDir:string; 
+  readonly pdkGemVerDir:string;
+  readonly pdkPuppetVersions: string[];
 }
 
 /** The IConnectionConfiguration interface describes the connection used to
@@ -68,11 +69,20 @@ export class AggregateConfiguration implements IAggregateConfiguration {
     const rubyDir = this.calculateRubyDir(puppetBaseDir);
 
     let pdkInstance: pdk.IPDKRubyInstance = pdk.emptyPDKInstance();
+    let puppetVersions: string[] = [];
     if (settings.installType === PuppetInstallType.PDK) {
-      const result = pdk.pdkInstances(puppetBaseDir).latest;
+      const pdkInfo = pdk.pdkInstances(puppetBaseDir);
+      let result: pdk.IPDKRubyInstance;
+      if (settings.editorService !== undefined && settings.editorService.puppet !== undefined && settings.editorService.puppet.version !== undefined) {
+        result = pdkInfo.InstanceForPuppetVersion(settings.editorService.puppet.version);
+      }
+      // If we can't find the PDK instance from the puppet version or it wasn't defined, assume the latest.
+      if (result === undefined) { result = pdkInfo.latest; }
+
       // An undefined instance means that either PDK isn't installed or that
       // the requested version doesn't exist.
       if (result !== undefined) { pdkInstance = result; }
+      puppetVersions = pdkInfo.allPuppetVersions;
     }
 
     this.ruby = {
@@ -91,7 +101,8 @@ export class AggregateConfiguration implements IAggregateConfiguration {
       pdkGemDir: pdkInstance.gemDir,
       pdkRubyDir: pdkInstance.rubyDir,
       pdkRubyBinDir: pdkInstance.rubyBinDir,
-      pdkGemVerDir: pdkInstance.gemVerDir
+      pdkGemVerDir: pdkInstance.gemVerDir,
+      pdkPuppetVersions: puppetVersions,
     };
 
     this.connection = {

src/PuppetConnectionMenuItem.ts

@@ -4,7 +4,15 @@ import * as path from 'path';
 export interface IPDKRubyInstances {
   pdkDirectory: string;
   instances: IPDKRubyInstance[];
+  allPuppetVersions: string[];
   latest: IPDKRubyInstance;
+
+  /**
+   * Finds the first PDK Instance that has Puppet version `puppetVersion`
+   * @param puppetVersion The puppet version string to search for
+   * @returns IPDKRubyInstance or undefined
+   */
+  InstanceForPuppetVersion(puppetVersion: string): IPDKRubyInstance;
 }
 
 export interface IPDKRubyInstance {
@@ -58,6 +66,7 @@ export function emptyPDKInstance(): IPDKRubyInstance {
 class PDKRubyInstances implements IPDKRubyInstances {
   pdkDirectory: string;
   private rubyInstances: IPDKRubyInstance[] = undefined;
+  private puppetVersions: string[] = undefined;
 
   constructor(
     pdkRootDirectory: string
@@ -82,6 +91,25 @@ class PDKRubyInstances implements IPDKRubyInstances {
     return this.rubyInstances;
   }
 
+  get allPuppetVersions(): string[] {
+    if (this.puppetVersions !== undefined) { return this.puppetVersions; }
+    this.puppetVersions = [];
+    // This searching method isn't the most performant but as the list will probably
+    // be very small (< 20 items) it's not a big deal and is cached anyway
+    this.instances.forEach( (instance) => {
+      instance.puppetVersions.forEach ( (puppetVersion) => {
+        if (this.puppetVersions.indexOf(puppetVersion) === -1) { this.puppetVersions.push(puppetVersion); }
+      });
+    });
+    return this.puppetVersions;
+  }
+
+  public InstanceForPuppetVersion(puppetVersion: string): IPDKRubyInstance {
+    return this.instances.find( (instance) => {
+      return instance.puppetVersions.includes(puppetVersion);
+    });
+  }
+
   // Override toString to make it look pretty
   toString(): string {
     return "[" + 
@@ -147,7 +175,7 @@ class PDKRubyInstance implements IPDKRubyInstance {
     // the gem cache is just as easy and doesn't need to spawn a ruby process per
     // ruby version.
     fs.readdirSync(gemdir).forEach( (item) => {
-      let pathMatch = item.match(/^puppet-(\d+\.\d+\.\d+)-/);
+      let pathMatch = item.match(/^puppet-(\d+\.\d+\.\d+)(?:(-|$))/);
       if (pathMatch !== null) { this._puppetVersions.push(pathMatch[1]); }
     });
 

src/configuration.ts

@@ -8,16 +8,18 @@ import { BoltFeature } from './feature/BoltFeature';
 import { DebuggingFeature } from './feature/DebuggingFeature';
 import { FormatDocumentFeature } from './feature/FormatDocumentFeature';
 import { NodeGraphFeature } from './feature/NodeGraphFeature';
+import { UpdateConfigurationFeature } from './feature/UpdateConfigurationFeature';
 import { PDKFeature } from './feature/PDKFeature';
 import { PuppetResourceFeature } from './feature/PuppetResourceFeature';
+import { PuppetStatusBarFeature } from './feature/PuppetStatusBarFeature';
 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 { ILogger } from './logging';
 import { OutputChannelLogger } from './logging/outputchannel';
-import { PuppetStatusBar } from './PuppetStatusBar';
+//import { PuppetStatusBar } from './PuppetStatusBar';
 import { legacySettings, SettingsFromWorkspace } from './settings';
 import { Reporter, reporter } from './telemetry/telemetry';
 
@@ -28,7 +30,7 @@ const debugType = 'Puppet';  // don't change this
 let extContext: vscode.ExtensionContext;
 let connectionHandler: ConnectionHandler;
 let logger: OutputChannelLogger;
-let statusBar: PuppetStatusBar;
+//let statusBar: PuppetStatusBar;
 let configSettings: IAggregateConfiguration;
 let extensionFeatures: IFeature[] = [];
 
@@ -48,12 +50,14 @@ export function activate(context: vscode.ExtensionContext) {
   });
   configSettings = CreateAggregrateConfiguration(settings);
 
-  logger         = new OutputChannelLogger(configSettings.workspace.editorService.loglevel);
-  statusBar      = new PuppetStatusBar([puppetLangID, puppetFileLangID], context, logger);
+  logger          = new OutputChannelLogger(configSettings.workspace.editorService.loglevel);
+  const statusBar = new PuppetStatusBarFeature([puppetLangID, puppetFileLangID], configSettings, logger, context);
 
   extensionFeatures = [
     new PDKFeature(extContext, logger),
     new BoltFeature(extContext),
+    new UpdateConfigurationFeature(logger, extContext),
+    statusBar
   ];
 
   if (configSettings.workspace.editorService.enable === false){