kitchen-yansible-pusher 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa8a79886e6402a3e4a5c8c788ac05e7e2c1e7e156b0f112d8512055b30bc595
-  data.tar.gz: 7bc8189cd68321d3f9819caa02d0f8cc90800b8853043f8120e61d3345e97967
+  metadata.gz: 25785faaa8f4cf4b1e458db922a180ffcbfc3e90bf1a29be3cc8e7d6ba009a56
+  data.tar.gz: 399e8268e43f34498c1d14d14d0268d3e621f4411d01b2fa0203494af39aa248
 SHA512:
-  metadata.gz: 67185ace3c508dc785f86a40bfe4868b1fd735549a3ac25a001fe2b06eda89354afad72296a439661d610156ad9e094fe63ab4e9b06e196943fe7c1542cff650
-  data.tar.gz: 9ce899f9b3803df41c2a097bd8fdbe395769a2379d4dc395a0150650eb3857397594a011734c578f72de3917c22c2eb9f87910fb7f9a4f7a8aa123e9225c7461
+  metadata.gz: 43ae3f45fadb4ca31cbdf783c19d7c49ae7241a27118a3387ae8ef6eefc911b32433a1632b0afd75d27638b6b0f8be59c30c40e243f944a7a509333bf170cffd
+  data.tar.gz: 74e5bfe68ee3c9a6335b588751afed8e1ebfb5b32d241e0601ee8aef573048b68e0c93412a7b6e8a2a31f8adca9306d79b1e6784f0a578e2b9e0f4038aebb64f

data/CHANGELOG.md

@@ -1,5 +1,61 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2024-08-29
+## [v0.3.0](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.3.0) (2024-09-04)
 
-- Initial release
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- added chocolatey to reqs [\#13](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/13) ([jmtx1020](https://github.com/jmtx1020))
+- add winrm support [\#12](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/12) ([jmtx1020](https://github.com/jmtx1020))
+- added CHANGELOG update action [\#11](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/11) ([jmtx1020](https://github.com/jmtx1020))
+
+## [v0.2.0](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.2.0) (2024-08-31)
+
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.1.3...v0.2.0)
+
+**Merged pull requests:**
+
+- updated gem version [\#10](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/10) ([jmtx1020](https://github.com/jmtx1020))
+- Feature: Added support for extra flags [\#9](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/9) ([jmtx1020](https://github.com/jmtx1020))
+- rename `extra_vars` to `env_vars` since it's for setting environment variables [\#8](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/8) ([jmtx1020](https://github.com/jmtx1020))
+
+## [v0.1.3](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.1.3) (2024-08-31)
+
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.1.2...v0.1.3)
+
+**Merged pull requests:**
+
+- fixed issue where user had to submit a vault file, updated version, enable fix branches in integration tests [\#7](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/7) ([jmtx1020](https://github.com/jmtx1020))
+
+## [v0.1.2](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.1.2) (2024-08-31)
+
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.1.1...v0.1.2)
+
+**Merged pull requests:**
+
+- bumping version [\#6](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/6) ([jmtx1020](https://github.com/jmtx1020))
+
+## [v0.1.1](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.1.1) (2024-08-31)
+
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.1.0) (2024-08-31)
+
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.0.1pre...v0.1.0)
+
+**Merged pull requests:**
+
+- added allowed host push urls [\#5](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/5) ([jmtx1020](https://github.com/jmtx1020))
+- added better names, and release pipeline to rubygems [\#4](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/4) ([jmtx1020](https://github.com/jmtx1020))
+- Added Integration Tests [\#3](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/3) ([jmtx1020](https://github.com/jmtx1020))
+- additional-ruby-versions [\#2](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/2) ([jmtx1020](https://github.com/jmtx1020))
+- added github actions release pipeline [\#1](https://github.com/jmtx1020/kitchen-yansible-pusher/pull/1) ([jmtx1020](https://github.com/jmtx1020))
+
+## [v0.0.1pre](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/v0.0.1pre) (2024-08-30)
+
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/1bf46ae6cbbff66f85fd2d3857271c44af727b56...v0.0.1pre)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -68,6 +68,46 @@ suites:
 
 ```
 
+### Usage on Windows - Requirements
+
+To use this gem and with a Windows target you need to install [PyWinRM](https://pypi.org/project/pywinrm/) as it is not part of the standard Ansible core distributed when you install through any methods.
+
+```
+pip install pywinrm
+```
+
+This error is known to occur when using the WinRM gem on Mac OS hosts due to the way Python forking works.
+
+```
+objc[78682]: +[__NSCFConstantString initialize] may have been in progress in another thread when fork() was called. We cannot safely call it or ignore it in the fork() child process. Crashing instead. Set a breakpoint on objc_initializeAfterForkError to debug.
+```
+
+The solution is to run this command and then you should be able to run your role successfully.
+
+```
+export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
+```
+
+### Windows Usage - Configuration
+
+This provisoner infers the settings needed to connect to the box using the connection data from the instance, however if you need to overwrite any of these settings they are overwritable by specifying these values.
+
+```yaml
+provisioner:
+  name: yansible_pusher
+  winrm:
+    host: ""
+    port: 1234
+    user: username1
+    password: SuperSecurePassword!
+    connection: 'winrm'
+    server_cert_validation: 'ignore'
+    transport: 'ssl'
+    scheme: 'http'
+```
+
+More information about these settings can be found [here](https://docs.ansible.com/ansible/latest/os_guide/windows_winrm.html).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jmtx1020/kitchen-yansible-pusher.

data/lib/kitchen/provisioner/yansible_pusher.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'kitchen/provisioner/base'
+require 'kitchen/errors'
 require_relative '../yansible/pusher/version'
 require 'yaml'
 
@@ -35,6 +36,7 @@ module Kitchen
       default_config :vault_password_file, nil
       default_config :username, nil
       default_config :private_key, nil
+      default_config :windows_config, nil
 
       attr_reader :sandbox_path
 
@@ -62,6 +64,7 @@ module Kitchen
         ensure
           cleanup_sandbox
         end
+        ensure_windows_exit_code if windows_instance?
       end
 
       private
@@ -70,6 +73,7 @@ module Kitchen
         command = build_ansible_command
         info("Running Ansible Command: #{command}")
         system(command)
+        raise Kitchen::ActionFailed, 'Ansible playbook execution failed' unless $?.success?
       end
 
       def create_inventory
@@ -89,6 +93,14 @@ module Kitchen
       end
 
       def build_host_config(state)
+        if windows_instance?
+          build_windows_config(state)
+        else
+          build_linux_config(state)
+        end
+      end
+
+      def build_linux_config(state)
         {
           'ansible_host' => state[:hostname],
           'ansible_port' => state[:port],
@@ -96,6 +108,28 @@ module Kitchen
         }
       end
 
+      def build_windows_config(state)
+        uri = URI(state[:endpoint])
+        defaults = default_windows_config(state, uri)
+        user_windows_config(defaults)
+      end
+
+      def user_windows_config(defaults)
+        user_config = (config[:winrm_config] || {}).transform_keys { |key| "ansible_#{key}" }
+        defaults.merge(user_config.compact)
+      end
+
+      def default_windows_config(state, uri)
+        { 'ansible_host' => uri.host,
+          'ansible_port' => state[:port] || uri.port,
+          'ansible_user' => state[:user],
+          'ansible_password' => state[:password],
+          'ansible_connection' => 'winrm',
+          'ansible_winrm_server_cert_validation' => 'ignore',
+          'ansible_winrm_transport' => 'ssl',
+          'ansible_winrm_scheme' => uri.scheme }
+      end
+
       def write_inventory_file(inventory)
         inventory_file = File.join(sandbox_path, 'inventory.yml')
         File.write(inventory_file, inventory.to_yaml)
@@ -134,7 +168,7 @@ module Kitchen
       end
 
       def ansible_extra_flags(cmd)
-        cmd << "#{config[:extra_flags].join(" ")}" unless config[:extra_flags].empty?
+        cmd << config[:extra_flags].join(' ') unless config[:extra_flags].empty?
         cmd
       end
 
@@ -153,7 +187,7 @@ module Kitchen
           cmd << "--private-key #{config[:private_key]}"
         else
           state = instance.transport.instance_variable_get(:@connection_options)
-          cmd << "--private-key #{state[:keys][0]}"
+          cmd << "--private-key #{state[:keys][0]}" if state.key?(:keys)
         end
         cmd
       end
@@ -165,6 +199,7 @@ module Kitchen
 
       def ansible_verbosity(cmd)
         cmd << "-#{'v' * config[:verbosity]}" if config[:verbosity] >= 1
+        cmd
       end
 
       def create_sandbox
@@ -186,6 +221,25 @@ module Kitchen
         error("Failed to clean up sandbox: #{e.message}")
         raise
       end
+
+      def windows_instance?
+        instance.transport.instance_variable_get(:@connection_options).key?(:endpoint)
+      end
+
+      # Ensures proper exit code handling for Windows instances in Test Kitchen.
+      #
+      # @return [String] A PowerShell command string to be executed on the remote Windows system.
+      #
+      # This method is only called for Windows instances. It returns a PowerShell command that:
+      # 1. Outputs the status of the last command ($?)
+      # 2. Exits with 0 if the last command succeeded, or 1 if it failed
+      #
+      # This approach addresses a specific issue with Test Kitchen's WinRM transport,
+      # where it expects a command string to execute rather than a boolean result.
+      # It ensures that the correct exit code is returned to Test Kitchen.
+      def ensure_windows_exit_code
+        '$?; if($?) { exit 0 } else { exit 1 }'
+      end
     end
   end
 end

data/lib/kitchen/yansible/pusher/version.rb

@@ -3,7 +3,7 @@
 module Kitchen
   module Yansible
     module Pusher
-      VERSION = "0.2.0"
+      VERSION = "0.3.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-yansible-pusher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jose M. Tobar
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies: []
 description: A modern & minimalistic Ansible provisioner for Test Kitchen.
 email:
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A modern & minimalistic Ansible provisioner for Test Kitchen.