Add bolt_version function and use it in plans

functions/check_bolt_version.pp

@@ -0,0 +1,19 @@
+# Checks if the current Bolt version matches the SemVerRange defined in $supported_bolt_version
+# Fails the calling plan if false, does nothing if true.
+# Accepts a parameter for the $supported_bolt_version for unit testing purposes
+function peadm::check_bolt_version(
+  $supported_bolt_version = '>= 2.42.0 < 3.0.0'
+) {
+  $supported = (peadm::bolt_version() =~ SemVerRange($supported_bolt_version))
+
+  unless $supported {
+    fail(@("REASON"/L))
+      This version of puppetlabs-peadm requires Bolt version ${supported_bolt_version}.
+
+      You are using Bolt version ${peadm::bolt_version()}.
+
+      Please make sure you have a compatible Bolt version and try again.
+
+      | REASON
+  }
+}

lib/puppet/functions/peadm/bolt_version.rb

@@ -0,0 +1,8 @@
+require 'bolt'
+
+Puppet::Functions.create_function(:'peadm::bolt_version') do
+  def bolt_version
+    Bolt::VERSION
+  end
+end
+

plans/convert.pp

@@ -26,6 +26,8 @@
     'convert-node-groups',
     'finalize']] $begin_at_step = undef,
 ) {
+  peadm::check_bolt_version()
+
   # TODO: read and validate convertable PE version
 
   # Convert inputs into targets.

plans/provision.pp

@@ -49,6 +49,8 @@
   Optional[String]                  $stagingdir    = undef,
   Enum[direct,bolthost]             $download_mode = 'bolthost',
 ) {
+  peadm::check_bolt_version()
+
   peadm::validate_version($version)
 
   $install_result = run_plan('peadm::action::install',

plans/status.pp

@@ -14,6 +14,8 @@
   Boolean $summarize = true,
   Boolean $colors = $format ? { json => false, default => true }
 ) {
+  peadm::check_bolt_version()
+
   $results = run_task('peadm::infrastatus', $targets, { format => 'json'})
   # returns the data in a hash 
   $stack_status = $results.reduce({}) | $res, $item | {

plans/upgrade.pp

@@ -43,6 +43,8 @@
     'upgrade-replica-compilers',
     'finalize']] $begin_at_step = undef,
 ) {
+  peadm::check_bolt_version()
+
   peadm::validate_version($version)
 
   # Ensure input valid for a supported architecture

spec/functions/bolt_version_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'bolt'
+
+describe 'peadm::bolt_version' do
+
+  it 'should_return_bolt_version' do
+    is_expected.to run.and_return(Bolt::VERSION)
+  end
+
+end