kitchen-yansible-pusher 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c2b21b1b1384736127c873d59e0466836e57f8fac7847040048be7a6bb9d7c1
-  data.tar.gz: c89fc1163a3674d93201650ef24f99c2e8b33edc6ad81cc93a7f299422c5531b
+  metadata.gz: b71ce84978f4c0c04f3bf960f22cb555ebd102da45854477215e8fec8c2dc030
+  data.tar.gz: f36dd7eb60a4e3ffb01990ca40cb6d6049503eaa47e3af751abedc4f0036aed4
 SHA512:
-  metadata.gz: b7d78b75e17df46a1767a184b7122c42dbf9b27b1edb4498588d3c86d6a695c4aed06d2cea7e65f59d2dbbd02b6bbf9a2d065806424a22be2b53b2a879c9e7d1
-  data.tar.gz: 3408cc60e8ebdc4f913ec4e20999fd9049d2ddd00ec1788b656482599d64f05f384fe59cdacc11fc7eb4215a5647a6d7abe69d240819b95b9b605813c274a34c
+  metadata.gz: e6cc7b7ba60df6febe0c8f96cf86a7349945483e049ad37e3ddbd27afd36f6ef9c621514d9321f256476a42220396da864a93459b98890ceb010805f29a02025
+  data.tar.gz: 50ec8b60ecc6595597a1ea6c4d7cb74eaead95719bd1308a5954e9a40a0bd2f7750a4f81289fefac27ec3e983ec957973fa7437ba73e76538e80ae1f322cf8ca

data/CHANGELOG.md

@@ -1,5 +1,61 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2024-08-29
+## [Unreleased](https://github.com/jmtx1020/kitchen-yansible-pusher/tree/HEAD)
 
-- Initial release
+[Full Changelog](https://github.com/jmtx1020/kitchen-yansible-pusher/compare/v0.2.0...HEAD)
+
+**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

@@ -8,7 +8,14 @@ The goal of this project was to make a modern and minimalistic test-kitchen prov
 
 From using Ansible for a while, I believe Gems like [kitchen-ansible](https://github.com/neillturner/kitchen-ansible) and [kitchen-ansiblepush](https://github.com/ahelal/kitchen-ansiblepush) both do too much, as well as seem to have been abandoned by their respective creators.
 
-By doing less, and expecting the user to install their own Ansible, provide their configuration in the form of environment variables, an `ansible.cfg` file or tags and running only in `push` mode(normal mode) we free ourselves from having to support all kinds of installation methods across platforms and in a way future proof ourselves.
+By doing less, and expecting the user to install their own Ansible, provide their configuration in the form of environment variables, an `ansible.cfg` file, tags, CLI flags and running only in `push` mode(normal mode) we free ourselves from having to support all kinds of installation methods across platforms and in a way future proof ourselves.
+
+With that in mind, if there's something you think is missing please feel free to submit an issue or pull request and I will do my best to accomodate but keep in mind the goals of this project.
+
+Additionally, these links to the documentation for `ansible-playbook` and `ansible.cfg` settings are here for convenience.
+
+* [ansible-playbook](https://docs.ansible.com/ansible/latest/cli/ansible-playbook.html)
+* [ansible-config](https://docs.ansible.com/ansible/latest/reference_appendices/config.html)
 
 ## Installation
 
@@ -21,7 +28,7 @@ gem 'kitchen-yansible-pusher',
     branch: 'main'
 
 # Install via RubyGems
-gem 'kitchen-yansible-pusher', '~> 0.1.0'
+gem 'kitchen-yansible-pusher', '~> 0.2.0'
 ```
 
 ## Usage
@@ -36,28 +43,71 @@ platforms:
   - name: ubuntu-22.04
 
 provisioner:
-    name: yansible_pusher
-    playbook: "/path/to/playbook.yaml"
-    config: "/path/to/ansible.cfg"
-    extra_vars:
-      MARIO: "MUSHROOM_KINGDOM"
-      LINK: "HYRULE_KINGDOM"
-    tags:
-      - tag1
-      - tag2
-    skip_tags:
-      - tag3
-      - tag4
-    verbosity: 1
-    vault_password_file: "/path/to/vault.password"
-    username: username
-    private_key: "/path/to/private.key"
+  name: yansible_pusher
+  playbook: "/path/to/playbook.yaml"
+  config: "/path/to/ansible.cfg"
+  env_vars:
+    MARIO: "MUSHROOM_KINGDOM"
+    LINK: "HYRULE_KINGDOM"
+  extra_flags:
+    - --flush-cache
+    - --timeout 60
+  tags:
+    - tag1
+    - tag2
+  skip_tags:
+    - tag3
+    - tag4
+  verbosity: 1
+  vault_password_file: "/path/to/vault.password"
+  username: username
+  private_key: "/path/to/private.key"
 
 suites:
   - name: default
 
 ```
 
+### 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

@@ -13,7 +13,7 @@ module Kitchen
     #   provisioner:
     #     name: yansible_pusher
     #     playbook: playbooks/playbook.yml
-    #     extra_vars:
+    #     env_vars:
     #       MARIO: "MUSHROOM_KINGDOM"
     #       LINK: "HYRULE_KINGDOM"
     #
@@ -27,13 +27,15 @@ module Kitchen
 
       default_config :playbook, nil
       default_config :config, nil
-      default_config :extra_vars, {}
+      default_config :env_vars, {}
+      default_config :extra_flags, []
       default_config :tags, []
       default_config :skip_tags, []
       default_config :verbosity, 1
       default_config :vault_password_file, nil
       default_config :username, nil
       default_config :private_key, nil
+      default_config :windows_config, nil
 
       attr_reader :sandbox_path
 
@@ -61,6 +63,7 @@ module Kitchen
         ensure
           cleanup_sandbox
         end
+        ensure_windows_exit_code if windows_instance?
       end
 
       private
@@ -88,6 +91,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],
@@ -95,6 +106,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)
@@ -112,9 +145,10 @@ module Kitchen
       def ansible_options
         %i[
           ansible_config
-          ansible_extra_vars
+          ansible_env_vars
           ansible_use_private_key
           ansible_use_vault_password_file
+          ansible_extra_flags
           ansible_tags
           ansible_skip_tags
           ansible_verbosity
@@ -126,18 +160,23 @@ module Kitchen
         cmd
       end
 
-      def ansible_extra_vars(cmd)
-        config[:extra_vars]&.each { |k, v| cmd.prepend("#{k}=\"#{v}\"") }
+      def ansible_env_vars(cmd)
+        config[:env_vars]&.each { |k, v| cmd.prepend("#{k}=\"#{v}\"") }
+        cmd
+      end
+
+      def ansible_extra_flags(cmd)
+        cmd << config[:extra_flags].join(' ') unless config[:extra_flags].empty?
         cmd
       end
 
       def ansible_tags(cmd)
-        cmd << "--tags \"#{config[:tags].join}\"" unless config[:tags].empty?
+        cmd << "--tags \"#{config[:tags].join(',')}\"" unless config[:tags].empty?
         cmd
       end
 
       def ansible_skip_tags(cmd)
-        cmd << "--skip-tags \"#{config[:skip_tags].join}\"" unless config[:skip_tags].empty?
+        cmd << "--skip-tags \"#{config[:skip_tags].join(',')}\"" unless config[:skip_tags].empty?
         cmd
       end
 
@@ -146,7 +185,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
@@ -158,6 +197,7 @@ module Kitchen
 
       def ansible_verbosity(cmd)
         cmd << "-#{'v' * config[:verbosity]}" if config[:verbosity] >= 1
+        cmd
       end
 
       def create_sandbox
@@ -179,6 +219,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.1.3"
+      VERSION = "0.3.0"
     end
   end
 end

data/sig/kitchen/yansible/pusher.rbs

@@ -23,7 +23,7 @@ module Kitchen
       def build_ansible_command: () -> String
       def ansible_options: () -> Array[Symbol]
       def ansible_config: (Array[String]) -> Array[String]
-      def ansible_extra_vars: (Array[String]) -> Array[String]
+      def ansible_env_vars: (Array[String]) -> Array[String]
       def ansible_tags: (Array[String]) -> Array[String]
       def ansible_skip_tags: (Array[String]) -> Array[String]
       def ansible_use_private_key: (Array[String]) -> Array[String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-yansible-pusher
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 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: