kitchen-yansible-pusher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cce6eccb4c8e13802da1576823bd80d4462d651eb383e0e8fedd0c2d9e9dc6e8
+  data.tar.gz: 96617f42c8b05043a26ded3e6e27b4301e74c10583ba0e7d410c6210f7343d22
+SHA512:
+  metadata.gz: b2840c16a19b82f02de62d911875d3dd5f76b210cff316b558b6b165ca6ff4b2a683bea92c0ce3d6cf8d4ff69191144c5a6dc1133a86f133060a136ac21ed250
+  data.tar.gz: f3f7e6afee0f76826fc77a1f2704855267c6aef89348f470748e1ec76a8d534ab6d4bb62d15ff2065007f2956d104372e57063ac34a0d71c3f9c9a34baa44c93

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jose M. Tobar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# kitchen-yansible-pusher
+
+![main](https://github.com/jmtx1020/kitchen-yansible-pusher/actions/workflows/main.yml/badge.svg)
+![main](https://github.com/jmtx1020/kitchen-yansible-pusher/actions/workflows/release.yml/badge.svg)
+![main](https://github.com/jmtx1020/kitchen-yansible-pusher/actions/workflows/integration.yml/badge.svg)
+
+The goal of this project was to make a modern and minimalistic test-kitchen provisioner for Ansible, that works in push mode instead of pull mode.
+
+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.
+
+## Installation
+
+Edit your gem file to look like this:
+
+```ruby
+# Install from Github
+gem 'kitchen-yansible-pusher',
+    git: 'https://github.com/jmtx1020/kitchen-yansible-pusher.git',
+    branch: 'main'
+```
+
+## Usage
+
+Keeping simplicity in mind, this kitchen-provisioner has minimal options to get going.
+```yaml
+provisioner:
+    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"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmtx1020/kitchen-yansible-pusher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/kitchen/provisioner/yansible_pusher.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'kitchen/provisioner/base'
+require_relative '../yansible/pusher/version'
+require 'yaml'
+
+module Kitchen
+  module Provisioner
+    # YansiblePusher is a Kitchen provisioner plugin for Ansible.
+    # It allows you to use Ansible playbooks to provision test instances in Test Kitchen.
+    #
+    # @example Using YansiblePusher in your kitchen.yml
+    #   provisioner:
+    #     name: yansible_pusher
+    #     playbook: playbooks/playbook.yml
+    #     extra_vars:
+    #       MARIO: "MUSHROOM_KINGDOM"
+    #       LINK: "HYRULE_KINGDOM"
+    #
+    # @author <MY_NAME>
+    # @version 0.1.0
+    # @see https://github.com/jmtx1020/kitchen-yansible-pusher Documentation/Homepage
+    # @see https://github.com/jmtx1020/kitchen-yansible-pusher/issues For bug reports and feature requests
+    class YansiblePusher < Kitchen::Provisioner::Base # rubocop:disable Metrics/ClassLength
+      kitchen_provisioner_api_version 2
+      plugin_version Kitchen::Yansible::Pusher::VERSION
+
+      default_config :playbook, nil
+      default_config :config, nil
+      default_config :extra_vars, {}
+      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
+
+      attr_reader :sandbox_path
+
+      def install_command
+        # No initialization command needed on the remote instance
+        nil
+      end
+
+      def init_command
+        # No initialization command needed on the remote instance
+        nil
+      end
+
+      def prepare_command
+        # No preparation command needed on the remote instance
+        nil
+      end
+
+      def run_command
+        info("Running Ansible Playbook: #{config[:playbook]}")
+        begin
+          create_sandbox
+          run_ansible
+          info('Ansible Playbook Complete!')
+        ensure
+          cleanup_sandbox
+        end
+      end
+
+      private
+
+      def run_ansible
+        command = build_ansible_command
+        info("Running Ansible Command: #{command}")
+        system(command)
+      end
+
+      def create_inventory
+        inventory = build_inventory
+        write_inventory_file(inventory)
+      end
+
+      def build_inventory
+        state = instance.transport.instance_variable_get(:@connection_options)
+        {
+          'all' => {
+            'hosts' => {
+              instance.name => build_host_config(state)
+            }
+          }
+        }
+      end
+
+      def build_host_config(state)
+        {
+          'ansible_host' => state[:hostname],
+          'ansible_port' => state[:port],
+          'ansible_user' => config[:username] || state[:username]
+        }
+      end
+
+      def write_inventory_file(inventory)
+        inventory_file = File.join(sandbox_path, 'inventory.yml')
+        File.write(inventory_file, inventory.to_yaml)
+        inventory_file
+      end
+
+      def build_ansible_command
+        cmd = ['ansible-playbook']
+        ansible_options.each { |option| cmd = send(option, cmd) }
+        cmd << "--inventory #{create_inventory}"
+        cmd << config[:playbook]
+        cmd.join(' ')
+      end
+
+      def ansible_options
+        %i[
+          ansible_config
+          ansible_extra_vars
+          ansible_use_private_key
+          ansible_use_vault_password_file
+          ansible_tags
+          ansible_skip_tags
+          ansible_verbosity
+        ]
+      end
+
+      def ansible_config(cmd)
+        cmd.prepend("ANSIBLE_CONFIG=#{config[:config]}") if config[:config]
+        cmd
+      end
+
+      def ansible_extra_vars(cmd)
+        config[:extra_vars]&.each { |k, v| cmd.prepend("#{k}=\"#{v}\"") }
+        cmd
+      end
+
+      def ansible_tags(cmd)
+        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
+      end
+
+      def ansible_use_private_key(cmd)
+        if config[:private_key]
+          cmd << "--private-key #{config[:private_key]}"
+        else
+          state = instance.transport.instance_variable_get(:@connection_options)
+          cmd << "--private-key #{state[:keys][0]}"
+        end
+      end
+
+      def ansible_use_vault_password_file(cmd)
+        cmd << "--vault-password-file #{config[:vault_password_file]}" if config[:vault_password_file]
+      end
+
+      def ansible_verbosity(cmd)
+        cmd << "-#{'v' * config[:verbosity]}" if config[:verbosity] >= 1
+      end
+
+      def create_sandbox
+        @sandbox_path = Dir.mktmpdir('kitchen-yansible-pusher')
+        info("Sandbox created at: #{@sandbox_path}")
+      rescue StandardError => e
+        error("Failed to create sandbox: #{e.message}")
+        raise
+      end
+
+      def cleanup_sandbox
+        if sandbox_path && Dir.exist?(sandbox_path)
+          FileUtils.remove_entry(sandbox_path)
+          info("Sandbox cleaned up: #{sandbox_path}")
+        else
+          info('No sandbox to clean up or sandbox already removed')
+        end
+      rescue StandardError => e
+        error("Failed to clean up sandbox: #{e.message}")
+        raise
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kitchen
+  module Yansible
+    module Pusher
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/kitchen-yansible-pusher.rb

@@ -0,0 +1 @@
+require 'kitchen/provisioner/yansible_pusher'

data/sig/kitchen/yansible/pusher.rbs

@@ -0,0 +1,53 @@
+module Kitchen
+  module Provisioner
+    class YansiblePusher < Kitchen::Provisioner::Base
+      extend Kitchen::Configurable::ClassMethods
+
+      @sandbox_path: String
+
+      def self.kitchen_provisioner_api_version: () -> Integer
+      def self.plugin_version: () -> String
+
+      def install_command: () -> nil
+      def init_command: () -> nil
+      def prepare_command: () -> nil
+      def run_command: () -> void
+
+      private
+
+      def run_ansible: () -> void
+      def create_inventory: () -> String
+      def build_inventory: () -> Hash[String, Hash[String, Hash[String, Hash[String, String | Integer]]]]
+      def build_host_config: (Hash[Symbol, String | Integer]) -> Hash[String, String | Integer]
+      def write_inventory_file: (Hash[String, Hash[String, Hash[String, Hash[String, String | Integer]]]]) -> String
+      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_tags: (Array[String]) -> Array[String]
+      def ansible_skip_tags: (Array[String]) -> Array[String]
+      def ansible_use_private_key: (Array[String]) -> Array[String]
+      def ansible_use_vault_password_file: (Array[String]) -> Array[String]
+      def ansible_verbosity: (Array[String]) -> Array[String]
+      def create_sandbox: () -> void
+      def cleanup_sandbox: () -> void
+    end
+  end
+
+  module Yansible
+    module Pusher
+      VERSION: String
+    end
+  end
+
+  class Instance
+    def name: () -> String
+    def transport: () -> untyped
+  end
+
+  module Configurable
+    module ClassMethods
+      def default_config: (Symbol, untyped) -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-yansible-pusher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose M. Tobar
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-31 00:00:00.000000000 Z
+dependencies: []
+description: A modern & minimalistic Ansible provisioner for Test Kitchen.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kitchen-yansible-pusher.rb
+- lib/kitchen/provisioner/yansible_pusher.rb
+- lib/kitchen/yansible/pusher/version.rb
+- sig/kitchen/yansible/pusher.rbs
+homepage: https://github.com/jmtx1020/kitchen-yansible-pusher
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jmtx1020/kitchen-yansible-pusher
+  source_code_uri: https://github.com/jmtx1020/kitchen-yansible-pusher/tree/main
+  changelog_uri: https://github.com/jmtx1020/kitchen-yansible-pusher/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A modern & minimalistic Ansible provisioner for Test Kitchen.
+test_files: []