(SIMP-7305) Update HighLine packaged by simp-cli (#150)

* Updated SIMP-packaged HighLine 1.7.8 to HighLine 2.0.3.
* Updated the simp-cli code and unit tests to work with the new HighLine
  version.
  * Minimal changes
* Updated Rakefile.
  * Updated the pkg:gem target (used by the pkg:rpm target) to exclude
    HighLine's optional gems in the 'code_quality" group from the bundle
    used to build the gem.
    * One dependency of those gems requires 'cmake' to be installed on the
      system. We don't need extra cruft when we are building simp-cli RPMs.
  * Reworked spec-related Rake tasks, as puppet-provided spec,
    spec_standalone, etc are no longer included in the dependency chain.
  * Added in simp:ci_* rake tasks so I could validate .gitlab-ci.yml changes.
* Updated Gemfile.
  * Updated to the latest simp-beaker-helpers to pick up the FIPS-mode test
    fixes and then re-enabled FIPS-mode acceptance tests.
* Updated acceptance tests.
  * Fixed unreliable password setting acceptance test.
    * Now uses an expect script.
  * Set ClientAlive* sshd settings in an attempt to minimize beaker ssh
    failures connection on slow GitLab servers.
* Updated versions of Puppet and Ruby in CI to better match SIMP-6.5.0.

SIMP-7305 #close
SIMP-8406 #close

Author: lnemsick-simp

.fixtures.yml

@@ -10,6 +10,10 @@ fixtures:
     simplib: https://github.com/simp/pupmod-simp-simplib
     stdlib: https://github.com/simp/puppetlabs-stdlib
 
+    # To set ClientAlive* settings for sshd_config
+    augeasproviders_core: https://github.com/simp/augeasproviders_core
+    augeasproviders_ssh: https://github.com/simp/augeasproviders_ssh
+
     # Other assets
     # - WARNING: rsync data does not remain intact through the fixtures copy
     #   process...Required empty directories are removed!

.gitlab-ci.yml

@@ -1,13 +1,14 @@
 # The testing matrix considers ruby/puppet versions supported by SIMP and PE:
 #
-# https://puppet.com/docs/pe/2019.0/component_versions_in_recent_pe_releases.html
+# https://puppet.com/docs/pe/2019.8/component_versions_in_recent_pe_releases.html
 # https://puppet.com/misc/puppet-enterprise-lifecycle
 # https://puppet.com/docs/pe/2018.1/overview/getting_support_for_pe.html
 # ------------------------------------------------------------------------------
 # Release       Puppet   Ruby   EOL
-# SIMP 6.3      5.5.16   2.4.5  TBD***
-# PE 2018.1     5.5.16   2.4.5  2020-05 (LTS)***
-# PE 2019.0     6.0      2.5.1  2019-08-31^^^
+# SIMP 6.4      5.5      2.4.10 TBD***
+# SIMP 6.5      6.18     2.5.8
+# PE 2018.1     5.5      2.4.10 2021-01
+# PE 2019.8.1   6.17     2.5.8  2021-11 (LTS)
 #
 # *** = Modules created for SIMP 6.3+ are not required to support Puppet < 5.5
 ---
@@ -69,10 +70,10 @@ variables:
     BEAKER_PUPPET_COLLECTION: 'puppet5'
     MATRIX_RUBY_VERSION: '2.4'
 
-.pup_5_5_16: &pup_5_5_16
+.pup_5_5_20: &pup_5_5_20
   image: 'ruby:2.4'
   variables:
-    PUPPET_VERSION: '5.5.16'
+    PUPPET_VERSION: '5.5.20'
     BEAKER_PUPPET_COLLECTION: 'puppet5'
     MATRIX_RUBY_VERSION: '2.4'
 
@@ -83,6 +84,14 @@ variables:
     BEAKER_PUPPET_COLLECTION: 'puppet6'
     MATRIX_RUBY_VERSION: '2.5'
 
+.pup_6_18_0: &pup_6_18_0
+  image: 'ruby:2.5'
+  variables:
+    PUPPET_VERSION: '6.18.0'
+    BEAKER_PUPPET_COLLECTION: 'puppet6'
+    MATRIX_RUBY_VERSION: '2.5'
+
+
 # Testing Environments
 #-----------------------------------------------------------------------
 
@@ -126,33 +135,35 @@ pup5-unit:
   <<: *pup_5
   <<: *unit_tests
 
-pup5.5.16-unit:
-  <<: *pup_5_5_16
+pup5.5.20-unit:
+  <<: *pup_5_5_20
   <<: *unit_tests
 
 pup6-unit:
   <<: *pup_6
   <<: *unit_tests
 
+pup6.18.0-unit:
+  <<: *pup_6_18_0
+  <<: *unit_tests
+
+
 # Acceptance tests
 # ==============================================================================
-pup5.5.16:
-  <<: *pup_5_5_16
+pup5.5.20:
+  <<: *pup_5_5_20
   <<: *acceptance_base
   script:
     - 'bundle exec rake beaker:suites[default,default]'
 
-# Re-enable after SIMP-8406 and SIMP-7305 are fixed. We don't even
-# want to run with allowed failure, because the attempt to reconnect
-# after reboot during FIPS setup can take more than an hour to timeout!
-#pup5.5.16-fips:
-#  <<: *pup_5_5_16
-#  <<: *acceptance_base
-#  script:
-#    - 'BEAKER_fips=yes bundle exec rake beaker:suites[default,default]'
-
-pup5.5.16_simp_kv:
-  <<: *pup_5_5_16
+pup5.5.20-fips:
+  <<: *pup_5_5_20
+  <<: *acceptance_base
+  script:
+    - 'BEAKER_fips=yes bundle exec rake beaker:suites[default,default]'
+
+pup5.5.20_simp_kv:
+  <<: *pup_5_5_20
   <<: *acceptance_base
   script:
     - 'bundle exec rake beaker:suites[simp_kv,default]'
@@ -163,14 +174,11 @@ pup6:
   script:
     - 'bundle exec rake beaker:suites[default,default]'
 
-# Re-enable after SIMP-8406 and SIMP-7305 are fixed. We don't even
-# want to run with allowed failure, because the attempt to reconnect
-# after reboot during FIPS setup can take more than an hour to timeout!
-#pup6-fips:
-#  <<: *pup_6
-#  <<: *acceptance_base
-#  script:
-#    - 'BEAKER_fips=yes bundle exec rake beaker:suites[default,default]'
+pup6-fips:
+  <<: *pup_6
+  <<: *acceptance_base
+  script:
+    - 'BEAKER_fips=yes bundle exec rake beaker:suites[default,default]'
 
 pup6_simp_kv:
   <<: *pup_6

.travis.yml

@@ -31,7 +31,7 @@ jobs:
   include:
     - stage: check
       name: 'Syntax, style, and validation checks'
-      rvm: 2.4.5
+      rvm: 2.4.9
       script:
         - bundle exec rake pkg:compare_latest_tag
         - bundle exec rake pkg:create_tag_changelog
@@ -40,7 +40,7 @@ jobs:
     # Test with Ruby versions packaged with standard Puppet All-in-one installs
     - stage: spec
       name: 'Ruby packaged with Puppet 5.x'
-      rvm: 2.4.5
+      rvm: 2.4.9
       env:
         - PUPPET_VERSION="~> 5.5"
         - SIMP_SKIP_NON_SIMPOS_TESTS=1
@@ -49,15 +49,15 @@ jobs:
 
     - stage: spec
       name: 'Ruby packaged with Puppet 6.x'
-      rvm: 2.5.1
+      rvm: 2.5.8
       env:
         - PUPPET_VERSION="~> 6.0"
         - SIMP_SKIP_NON_SIMPOS_TESTS=1
       script:
         - bundle exec rake spec
 
     - stage: deploy
-      rvm: 2.4.5
+      rvm: 2.4.9
       script:
         - true
       before_deploy:

Gemfile

@@ -13,9 +13,7 @@ gem 'puppet', ENV.fetch('PUPPET_VERSION',  '~>5')
 gem 'rake'
 gem 'simp-rake-helpers', ENV.fetch('SIMP_RAKE_HELPERS_VERSION', ['>= 5.6', '< 6.0'])
 
-#FIXME SIMP-8406
-#gem 'simp-beaker-helpers', ENV['SIMP_BEAKER_HELPERS_VERSION'] || ['>= 1.18.7', '< 2']
-gem 'simp-beaker-helpers', ENV.fetch('SIMP_BEAKER_HELPERS_VERSION', '~> 1.12')
+gem 'simp-beaker-helpers', ENV['SIMP_BEAKER_HELPERS_VERSION'] || ['>= 1.18.7', '< 2']
 gem 'r10k', ENV.fetch('R10k_VERSION',  '~>3')
 
 # FIXME Use released version when available.  This version has more robust

Rakefile

@@ -7,9 +7,12 @@ require 'rspec/core/rake_task'
 require 'rubygems'
 require 'simp/rake'
 require 'simp/rake/beaker'
+require 'simp/rake/ci'
 require 'simp/cli/version'
 
+# Create pkg:* and simp:ci_* Rake tasks
 Simp::Rake::Pkg.new(File.dirname(__FILE__))
+Simp::Rake::Ci.new(File.dirname(__FILE__))
 
 @package='simp-cli'
 @rakefile_dir=File.dirname(__FILE__)
@@ -27,7 +30,7 @@ Find.find( @rakefile_dir ) do |path|
   end
 end
 
-# Acceptance Tests
+# Create beaker:* acceptance test Rake tasks
 Simp::Rake::Beaker.new(File.dirname(__FILE__))
 
 desc 'Ensure gemspec-safe permissions on all files'
@@ -53,10 +56,7 @@ SIMP_RPM_BUILD     when set, alters the gem produced by pkg:gem to be RPM-safe.
   }
 end
 
-# This project has unit tests in nonstandard locations, so redefine the
-# underlying Rake task to pick up its tests
-Rake::Task[:spec_standalone].clear if Rake::Task.task_defined?(:spec_standalone)
-RSpec::Core::RakeTask.new(:spec_standalone) do |t|
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ['--color']
   t.exclude_pattern = '**/{acceptance,fixtures,files}/**/*_spec.rb'
   t.pattern = 'spec/{lib,bin}/**/*_spec.rb'
@@ -84,18 +84,20 @@ namespace :pkg do
     gem_dirs.each do |gem_dir|
       Dir.chdir gem_dir do
         Dir['*.gemspec'].each do |spec_file|
+          # highline optional (development-related) gems require cmake, so
+          # exclude them in the bundle
+          opts = (File.basename(gem_dir) == 'highline') ? '--without=code_quality' : ''
           cmd = %Q{SIMP_RPM_BUILD=1 bundle exec gem build "#{spec_file}" &> /dev/null}
-
-         if ::Bundler.respond_to?(:with_unbundled_env)
+          if ::Bundler.respond_to?(:with_unbundled_env)
             # Use Bundler 2.x API
             ::Bundler.with_unbundled_env do
-              %x{bundle install}
+              %x{bundle install #{opts}}
               sh cmd
             end
           else
             # Use deprecated Bundler 1.x API
             ::Bundler.with_clean_env do
-              %x{bundle install}
+              %x{bundle install #{opts}}
               sh cmd
             end
           end

build/rubygem-simp-cli.spec

@@ -3,7 +3,7 @@
 %global gemdir /usr/share/simp/ruby
 %global geminstdir %{gemdir}/gems/%{gemname}-%{version}
 %global cli_version 6.0.2
-%global highline_version 1.7.8
+%global highline_version 2.0.3
 
 # gem2ruby's method of installing gems into mocked build roots will blow up
 # unless this line is present:
@@ -134,6 +134,7 @@ EOM
   proceed because the environment to configure already exists.
 - Fixed a bug in `simp environment new` in which the actual failure
   messages from a failed `setfacl --restore` execution are not logged.
+- Updated HighLine from version 1.7.8 to 2.0.3.
 
 * Tue Sep 01 2020 Jeanne Greulich <jeanne.greulich@onyxpoint.com> - 6.0.1
 - In Rakefile check if task spec_standalone exists before trying to

ext/gems/highline/.gitignore

@@ -1,2 +1,7 @@
 doc
 pkg
+.DS_Store
+coverage
+Gemfile.lock
+*.swp
+*.swo

ext/gems/highline/.rubocop.yml

@@ -0,0 +1,84 @@
+# Bellow the changes to default Rubocop behavior.
+
+# See options at:
+# https://github.com/bbatsov/rubocop/tree/master/config
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+# General
+
+# Multi-line method chaining should be done with leading dots.
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  SupportedStyles:
+    - leading
+    - trailing
+
+# Enabling
+# --------
+
+Style/CollectionMethods:
+  Description: 'Preferred collection methods.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size'
+  Enabled: true
+
+Style/StringMethods:
+  Description: 'Checks if configured preferred methods are used over non-preferred.'
+  Enabled: true
+
+# Disabling
+# ---------
+
+# Modifying
+# ---------
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: snake_case, camelCase
+Naming/MethodName:
+  EnforcedStyle: snake_case
+  Exclude:
+    - 'test/**/*'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AutoCorrectEncodingComment.
+# SupportedStyles: when_needed, always, never
+Style/Encoding:
+  Enabled: true
+
+# If we fix this, it will change method signature.
+# Save it for major release.
+Style/OptionalArguments:
+  Exclude:
+    - 'lib/highline/list_renderer.rb'
+
+# TemplateRenderer should never fail on method missing.
+Style/MethodMissing:
+  Exclude:
+    - 'lib/highline/template_renderer.rb'
+
+# This is a breaking change for MRI 1.9.
+# Revoke when updating to MRI 2.0 as minimum.
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, SupportedStyles.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'examples/page_and_wrap.rb'
+    - 'highline.gemspec'
+    - 'test/acceptance/acceptance.rb'
+
+# Cop supports --auto-correct.
+Lint/ScriptPermission:
+  Enabled: false

ext/gems/highline/.simplecov

@@ -0,0 +1,5 @@
+unless SimpleCov.running
+  SimpleCov.start do
+    add_filter "test_"
+  end
+end