kitchen-yansible-pusher 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a2316e28c56274be79097ab094b02f9b220e41d7556439debb14a4535949dbf
-  data.tar.gz: b1a4322de10f2d04c10fdeba522a82df2dd85b44438126142ba1283bce8c5957
+  metadata.gz: aa8a79886e6402a3e4a5c8c788ac05e7e2c1e7e156b0f112d8512055b30bc595
+  data.tar.gz: 7bc8189cd68321d3f9819caa02d0f8cc90800b8853043f8120e61d3345e97967
 SHA512:
-  metadata.gz: 6a0a926457d832c0c99edcdd3280442597d5cbbc8a4cefa7f9b9b9f37a70f933a08437841603b1f6293d51b5aaf40cd42d258cc93c777420d64bbd461bb727bb
-  data.tar.gz: 87486c0d630a812f65933bb05f4beea0b210c972528ea21cfc3b984823d0109dcb77714a790cc53082e9a8a60e6c8223c6b9ad990035200f501626b016c80e6f
+  metadata.gz: 67185ace3c508dc785f86a40bfe4868b1fd735549a3ac25a001fe2b06eda89354afad72296a439661d610156ad9e094fe63ab4e9b06e196943fe7c1542cff650
+  data.tar.gz: 9ce899f9b3803df41c2a097bd8fdbe395769a2379d4dc395a0150650eb3857397594a011734c578f72de3917c22c2eb9f87910fb7f9a4f7a8aa123e9225c7461

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,22 +43,25 @@ 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

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,7 +27,8 @@ 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
@@ -112,9 +113,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 +128,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
 
@@ -148,10 +155,12 @@ module Kitchen
           state = instance.transport.instance_variable_get(:@connection_options)
           cmd << "--private-key #{state[:keys][0]}"
         end
+        cmd
       end
 
       def ansible_use_vault_password_file(cmd)
-        cmd << "--vault-password-file #{config[:vault_password_file]}" if config[:vault_password_file]
+        cmd << "--vault-password-file #{config[:vault_password_file]}" unless config[:vault_password_file].nil?
+        cmd
       end
 
       def ansible_verbosity(cmd)

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

@@ -3,7 +3,7 @@
 module Kitchen
   module Yansible
     module Pusher
-      VERSION = "0.1.2"
+      VERSION = "0.2.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-yansible-pusher
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jose M. Tobar