cem_acpt 0.7.3 → 0.8.1

data/lib/cem_acpt/utils/winrm_runner.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'winrm'
+require_relative '../logging'
+
+module CemAcpt
+  module Utils
+    module WinRMRunner
+      class WinRMExecutionError < StandardError; end
+
+      # A wrapper class for executing commands on a windows node
+      # Provides error handling and logging on each command being executed
+      class RunnerWrapper
+        include CemAcpt::Logging
+
+        def initialize(shell)
+          @shell = shell
+        end
+
+        def run(command)
+          output = @shell.run(command) do |stdout, stderr|
+            puts stdout
+            puts stderr
+          end
+
+          # At any point, if the exit code is not 0, we will raise an error and stop the test
+          # Because if one command fails, it will effect the rest of the test.
+          if output.exitcode != 0
+            raise WinRMExecutionError, "Command #{command} failed with exit code #{output.exitcode}. Error: #{output.stderr}"
+          end
+        end
+      end
+
+      # A class for setting up windows nodes for testing
+      # Applies puppet manifest on nodes and installs the cem_windows module
+      class WinNode
+        include CemAcpt::Logging
+
+        attr_reader :mod_name
+
+        def initialize(login_info, mod_name)
+          @login_info = login_info
+          @mod_name = mod_name
+        end
+
+        def run_winrm
+          logger.info('CemAcpt') { 'Setting up Windows nodes for test...' }
+
+          cem_windows_mod_dir = "C:\\ProgramData\\PuppetLabs\\code\\environments\\production\\modules\\cem_windows"
+
+          @login_info.each do |node_name, node_info|
+            username = node_info['username']
+            password = node_info['password']
+            test_name = node_info['test_name']
+            ip = node_info['ip']
+
+            opts = {
+              endpoint: "https://#{ip}:5986/wsman",
+              user: username,
+              password: password,
+              transport: :ssl,
+              no_ssl_peer_verification: true,
+              retry_limit: 5,
+              retry_delay: 20,
+            }
+
+            conn = WinRM::Connection.new(opts)
+            conn.shell(:powershell) do |shell|
+              # Instantiate the wrapper class
+              winrm_runner = RunnerWrapper.new(shell)
+              # The below steps for enabling long paths, installing Puppet and make cem_acpt directory will be a part of making the custom image.
+              # Enable long paths
+              logger.debug('CemAcpt') { 'Enabling long paths...' }
+              winrm_runner.run('Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1')
+              # Download Puppet and Install it
+              logger.info('CemAcpt') { 'Downloading and installing Puppet...' }
+              winrm_runner.run('Invoke-WebRequest -URI http://downloads.puppetlabs.com/windows/puppet7/puppet-agent-7.25.0-x64.msi -OutFile "C:\puppet-agent-7.25.0-x64.msi"')
+              winrm_runner.run("Start-process msiexec.exe -Wait -ArgumentList '/I C:\\puppet-agent-7.25.0-x64.msi PUPPET_AGENT_STARTUP_MODE=Disabled /qn /norestart'")
+              # Create our cem_acpt parent directory
+              logger.debug('CemAcpt') { 'Creating cem_acpt directory and downloading necessary files...' }
+              winrm_runner.run("mkdir C:\\cem_acpt")
+              # Download the cem_windows module from the bucket to cem_acpt directory
+              winrm_runner.run("gcloud storage cp gs://win_cem_acpt/#{@mod_name} C:\\cem_acpt")
+              # Install the cem_windows module
+              logger.info('CemAcpt') { 'Installing cem_windows module...' }
+              winrm_runner.run("Start-Process -FilePath 'C:\\Program Files\\Puppet Labs\\Puppet\\bin\\puppet.bat' -ArgumentList 'module install C:\\cem_acpt\\#{@mod_name}' -Wait -NoNewWindow")
+              # Download Goss and set it to alpha mode since it's on alpha for windows
+              logger.info('CemAcpt') { 'Downloading Goss...' }
+              winrm_runner.run("Invoke-WebRequest -URI https://github.com/goss-org/goss/releases/download/v0.3.23/goss-alpha-windows-amd64.exe -OutFile 'C:\\goss.exe'")
+              # Since we already installed the cem_windows module, we can unpack it to get the goss.yaml and the manifest.pp in spec/acceptance dir
+              # Due to the pain in the ass of trying to parse a string that is yaml dumped in ruby through powershell, I'm just gonna create the yaml
+              # in the cem_windows module itself and then move them to the directory at C:/cem_acpt for ease of access and use. The location for these two
+              # files will be at spec/files
+              winrm_runner.run("Move-Item -Path #{cem_windows_mod_dir}\\spec\\files\\puppet_idempotent.yaml -Destination C:\\cem_acpt")
+              winrm_runner.run("Move-Item -Path #{cem_windows_mod_dir}\\spec\\files\\puppet_noop.yaml -Destination C:\\cem_acpt")
+              # Grab the goss.yaml and the manifest.pp from the cem_windows module using the test_name from run_data and move to top level of C:/cem_acpt/
+              winrm_runner.run("Move-Item -Path #{cem_windows_mod_dir}\\spec\\acceptance\\#{test_name}\\goss.yaml -Destination C:\\cem_acpt")
+              winrm_runner.run("Move-Item -Path #{cem_windows_mod_dir}\\spec\\acceptance\\#{test_name}\\manifest.pp -Destination C:\\cem_acpt")
+              # Open up firewall ports
+              logger.debug('CemAcpt') { 'Opening up firewall ports...' }
+              winrm_runner.run('netsh advfirewall firewall add rule name="Goss in" dir=in action=allow protocol=TCP localport=8080')
+              winrm_runner.run('netsh advfirewall firewall add rule name="Idempotent in" dir=in action=allow protocol=TCP localport=8081')
+              winrm_runner.run('netsh advfirewall firewall add rule name="Noop in" dir=in action=allow protocol=TCP localport=8082')
+              winrm_runner.run('netsh advfirewall firewall add rule name="Goss out" dir=out action=allow protocol=TCP localport=8080')
+              winrm_runner.run('netsh advfirewall firewall add rule name="Idempotent out" dir=out action=allow protocol=TCP localport=8081')
+              winrm_runner.run('netsh advfirewall firewall add rule name="Noop out" dir=out action=allow protocol=TCP localport=8082')
+              logger.info('CemAcpt') { 'Setting up NSSM and starting Goss services...' }
+              # Download NSSM into cem_acpt directory
+              # NSSM is a tool that allows us to create services on windows without having to create a Windows service project.
+              # NSSM works with almost any executable. In our case, it will work with goss.exe
+              winrm_runner.run("Invoke-WebRequest -URI http://nssm.cc/ci/nssm-2.24-101-g897c7ad.zip -OutFile 'C:\\cem_acpt\\nssm-2.24.zip'")
+              # Extract NSSM into cem_acpt directory
+              winrm_runner.run("Expand-Archive -Path C:\\cem_acpt\\nssm-2.24.zip -DestinationPath C:\\cem_acpt")
+              winrm_runner.run("Rename-Item -Path C:\\cem_acpt\\nssm-2.24-101-g897c7ad -NewName nssm-2.24")
+              # Install NSSM Goss server and start it
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe install goss-server C:\\goss.exe')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set goss-server AppStdout C:\\cem_acpt\\goss-server.log')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set goss-server AppStderr C:\\cem_acpt\\goss-server-stderr.log')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set goss-server AppParameters "--use-alpha=1 -g C:\\cem_acpt\\goss.yaml serve -f json --endpoint /acpt --cache 10m"')
+              # There is a slight issue with starting through nssm, if the process took a bit too long, it will send an error but the process will still be running.
+              # winrm_runner.run(shell, 'C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe start goss-server')
+              winrm_runner.run('$GossServer= Get-Service "goss-server"')
+              winrm_runner.run('$GossServer.Start()')
+              winrm_runner.run('$WaitForGossServer = New-TimeSpan -Seconds 5')
+              winrm_runner.run('$GossServer.WaitForStatus([System.ServiceProcess.ServiceControllerStatus]::Running, $WaitForGossServer)')
+              # Install NSSM Idempotent server and start it
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe install idempotent-server C:\\goss.exe')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set idempotent-server AppStdout C:\\cem_acpt\\idempotent-server.log')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set idempotent-server AppStderr C:\\cem_acpt\\idempotent-server-stderr.log')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set idempotent-server AppParameters "--use-alpha=1 -g C:\\cem_acpt\\puppet_idempotent.yaml serve -f json -l :8081 --endpoint /idempotent --cache 10m"')
+              # winrm_runner.run(shell, 'C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe start idempotent-server')
+              winrm_runner.run('$IdmServer= Get-Service "idempotent-server"')
+              winrm_runner.run('$IdmServer.Start()')
+              winrm_runner.run('$WaitForIdmServer = New-TimeSpan -Seconds 5')
+              winrm_runner.run('$IdmServer.WaitForStatus([System.ServiceProcess.ServiceControllerStatus]::Running, $WaitForIdmServer)')
+              # Install NSSM Noop server and start it
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe install noop-server C:\\goss.exe')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set noop-server AppStdout C:\\cem_acpt\\noop-server.log')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set noop-server AppStderr C:\\cem_acpt\\noop-server-stderr.log')
+              winrm_runner.run('C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe set noop-server AppParameters "--use-alpha=1 -g C:\\cem_acpt\\puppet_noop.yaml serve -f json -l :8082 --endpoint /noop --cache 10m"')
+              # winrm_runner.run(shell, 'C:\\cem_acpt\\nssm-2.24\\win64\\nssm.exe start noop-server')
+              winrm_runner.run('$NoopServer= Get-Service "noop-server"')
+              winrm_runner.run('$NoopServer.Start()')
+              winrm_runner.run('$WaitForNoopServer = New-TimeSpan -Seconds 5')
+              winrm_runner.run('$NoopServer.WaitForStatus([System.ServiceProcess.ServiceControllerStatus]::Running, $WaitForNoopServer)')
+              # Run puppet apply
+              logger.info('CemAcpt') { 'Running puppet apply...' }
+              winrm_runner.run("Start-Process -FilePath 'C:\\Program Files\\Puppet Labs\\Puppet\\bin\\puppet.bat' -ArgumentList 'apply --verbose C:\\cem_acpt\\manifest.pp' -Wait -NoNewWindow -PassThru")
+              logger.info('CemAcpt') { 'Puppet apply finished...' }
+            end
+          end
+        end
+
+        def run
+          run_winrm
+        end
+      end
+    end
+  end
+end

data/lib/cem_acpt/utils.rb

@@ -1,10 +1,68 @@
 # frozen_string_literal: true
 
 require_relative 'utils/puppet'
+require_relative 'utils/shell'
 require_relative 'utils/ssh'
 require_relative 'utils/terminal'
+require_relative 'utils/winrm_runner'
+require_relative 'logging'
 
 module CemAcpt
   # Utility methods and modules for CemAcpt.
-  module Utils; end
+  module Utils
+    class << self
+      include CemAcpt::Logging
+
+      def package_win_module(module_dir)
+        # Path to the package file
+        package_file = File.join(module_dir, 'puppetlabs-cem_windows.tar.gz')
+
+        # Remove the old package file if it exists
+        FileUtils.rm_f(package_file)
+        `cd #{module_dir} && touch puppetlabs-cem_windows.tar.gz && tar -czf puppetlabs-cem_windows.tar.gz --exclude=puppetlabs-cem_windows.tar.gz *`
+        logger.info('CemAcpt') { "Windows module packaged at #{package_file}" }
+        package_file
+      end
+
+      def reset_password_readiness_polling(instance_name)
+        attempts = 0
+        last_error = nil
+        result = nil
+        begin
+          result = CemAcpt::Utils::Shell.run_cmd("echo Y | gcloud compute reset-windows-password #{instance_name} --zone=us-west1-b")
+        rescue StandardError => e
+          logger.debug('CemAcpt::Utils') { "Error polling for password readiness: #{e}" }
+          last_error = e
+        end
+        while result.nil? || result.empty?
+          raise "Instance not ready for password reset. Last error: #{last_error}" if attempts >= 60 # 10 minutes
+
+          logger.info('CemAcpt') { "Waiting for instance #{instance_name} to be ready for password reset..." }
+          sleep 10
+          begin
+            result = CemAcpt::Utils::Shell.run_cmd("echo Y | gcloud compute reset-windows-password #{instance_name} --zone=us-west1-b")
+          rescue StandardError => e
+            logger.debug('CemAcpt::Utils') { "Error polling for password readiness: #{e}" }
+            last_error = e
+          end
+          attempts += 1
+        end
+        result
+      end
+
+      def get_windows_login_info(instance_name, hash_of_instance)
+        password_and_username = {}
+        password_and_username[instance_name] = {}
+        info = reset_password_readiness_polling(instance_name).split(/\r?\n/)[1..2]
+        info.each do |line|
+          key_val = line.split(' ')
+          password_and_username[instance_name][key_val[0].strip.delete(':')] = key_val[1].strip
+        end
+
+        password_and_username[instance_name]['ip'] = hash_of_instance['ip']
+        password_and_username[instance_name]['test_name'] = hash_of_instance['test_name']
+        password_and_username
+      end
+    end
+  end
 end

data/lib/cem_acpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CemAcpt
-  VERSION = '0.7.3'
+  VERSION = '0.8.1'
 end

data/lib/cem_acpt.rb

@@ -22,6 +22,7 @@ module CemAcpt
     end
 
     def run(command, original_command, options)
+      set_up_signal_handlers
       case command
       when :version
         puts "#{original_command} v#{CemAcpt::VERSION}"
@@ -30,9 +31,9 @@ module CemAcpt
       when :print_explain_config
         print_config(options, command: original_command.to_sym, format: :explain)
       when :cem_acpt
-        run_cem_acpt(options)
+        trace_it(options[:trace], options[:trace_events]) { run_cem_acpt(options) }
       when :cem_acpt_image
-        run_cem_acpt_image(options)
+        trace_it(options[:trace], options[:trace_events]) { run_cem_acpt_image(options) }
       else
         raise "Command #{command} does not exist"
       end
@@ -78,41 +79,70 @@ module CemAcpt
       new_log
     end
 
+    TRACE_EVENTS = %i[line call b_call thread_begin thread_end].freeze
+
+    def trace_it(should_trace = false, trace_events = nil)
+      if should_trace
+        trace_events ||= TRACE_EVENTS
+        tracer = TracePoint.new(*trace_events.map(&:to_sym)) do |tp|
+          if tp&.path&.include?('lib/cem_acpt') && !tp&.path&.include?('lib/cem_acpt/logging')
+            begin
+              logger << "## TRACE ## #{tp.path}:#{tp.lineno}: #{tp.event} #{tp.method_id}\n"
+            rescue StandardError
+              # Trace will often run into the trap context problem before the signal handler call back
+              logger.trap_context = true
+              logger << "## TRACE ## #{tp.path}:#{tp.lineno}: #{tp.event}\n"
+            end
+          end
+        end
+        tracer.enable do
+          yield
+        end
+      else
+        yield
+      end
+    end
+
+    def signal_handlers
+      {
+        'INT' => proc do
+          @trap_context = true
+          logger.trap_context = @trap_context
+          logger.fatal('CemAcpt') { 'Received interrupt signal. Exiting.' }
+          exit 1
+        end,
+      }
+    end
+
+    def set_up_signal_handlers
+      signal_handlers.each do |signal, handler|
+        Signal.trap(signal, &handler)
+        logger.debug('CemAcpt') { "Signal handler set for #{signal}" }
+      end
+    end
+
     def run_cem_acpt(options)
       # Set up config, logger, and helper
       @config = new_config(options)
       initialize_logger!
+      logger.debug('CemAcpt') { 'Config set and logger initialized...' }
       runner = new_runner
-
-      # Set up signal handlers
-      Signal.trap('INT') do
-        @trap_context = true
-        logger.trap_context = @trap_context
-        logger.fatal('Signal Handler') { 'Received interrupt signal. Cleaning up test suite...' }
-        runner.clean_up(@trap_context)
-        logger.fatal('Signal Handler') { 'Exiting due to interrupt signal' }
-        exit 1
-      end
+      logger.debug('CemAcpt') { 'Runner initialized...' }
 
       # Run the test suite
+      logger.debug('CemAcpt') { 'Running test suite...' }
       runner.run
-
+      logger.debug('CemAcpt') { "Test suite run complete, exiting with code #{runner.exit_code}" }
       exit runner.exit_code
     end
 
     def run_cem_acpt_image(options)
       @config = new_config(options, command: :cem_acpt_image)
       initialize_logger!
-
-      # Set up signal handlers
-      Signal.trap('INT') do
-        @trap_context = true
-        logger.trap_context = @trap_context
-        logger.fatal('Signal Handler') { 'Received interrupt signal. Cleaning up test suite...' }
-        exit 1
-      end
+      logger.debug('CemAcptImage') { 'Config set and logger initialized...' }
 
       # Build the images
+      logger.debug('CemAcptImage') { 'Building images...' }
       CemAcpt::ImageBuilder.build_images(@config)
     end
   end

data/lib/terraform/gcp/windows/main.tf

@@ -27,6 +27,27 @@ variable "subnetwork" {
     type = string
 }
 
+# Just stub this out for now
+variable "username" {
+    type = string
+}
+
+# Just stub this out for now
+variable "private_key" {
+    type = string
+    sensitive = true
+}
+
+# Just stub this out for now
+variable "public_key" {
+    type = string
+}
+
+# Just stub this out for now
+variable "puppet_module_package" {
+    type = string
+}
+
 variable "node_data" {
     type = map(object({
         machine_type = string
@@ -71,6 +92,11 @@ resource "google_compute_instance" "acpt-test-node" {
         }
     }
 
+    service_account {
+        email = "cem-windows-acpt-test@team-sse.iam.gserviceaccount.com"
+        scopes = ["cloud-platform"]
+    }
+
     metadata = {
         "enable-oslogin" = "TRUE"
         "cem-acpt-test" = each.value.test_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.1
 platform: ruby
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -105,19 +105,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.1
 - !ruby/object:Gem::Dependency
-  name: ruby-terraform
+  name: winrm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +152,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Litmus-like library focusing on CEM Acceptance Tests
 email:
 - abide-team@puppet.com
@@ -170,6 +204,7 @@ files:
 - exe/cem_acpt
 - exe/cem_acpt_image
 - lib/cem_acpt.rb
+- lib/cem_acpt/action_result.rb
 - lib/cem_acpt/cli.rb
 - lib/cem_acpt/config.rb
 - lib/cem_acpt/config/base.rb
@@ -192,16 +227,20 @@ files:
 - lib/cem_acpt/provision/terraform.rb
 - lib/cem_acpt/provision/terraform/linux.rb
 - lib/cem_acpt/provision/terraform/os_data.rb
+- lib/cem_acpt/provision/terraform/terraform_cmd.rb
 - lib/cem_acpt/provision/terraform/windows.rb
 - lib/cem_acpt/puppet_helpers.rb
 - lib/cem_acpt/test_data.rb
 - lib/cem_acpt/test_runner.rb
 - lib/cem_acpt/test_runner/log_formatter.rb
+- lib/cem_acpt/test_runner/log_formatter/error_formatter.rb
 - lib/cem_acpt/test_runner/log_formatter/goss_action_response.rb
 - lib/cem_acpt/utils.rb
 - lib/cem_acpt/utils/puppet.rb
+- lib/cem_acpt/utils/shell.rb
 - lib/cem_acpt/utils/ssh.rb
 - lib/cem_acpt/utils/terminal.rb
+- lib/cem_acpt/utils/winrm_runner.rb
 - lib/cem_acpt/version.rb
 - lib/terraform/gcp/linux/goss/puppet_idempotent.yaml
 - lib/terraform/gcp/linux/goss/puppet_noop.yaml
@@ -238,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: CEM Acceptance Tests