capistrano-asdf 0.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46324af703fd974f1dde1ddc31666fb73623ee8143f7d71b4f3dc30ee539c28d
-  data.tar.gz: d0b865987d6bdb2bc23480e89b7eae791ec2e99a9c54090555b01bc80c750a2e
+  metadata.gz: 277839d3d4ad728956156c2fec0afbcfdf73a755eaa2541aa17a467b98c01a3a
+  data.tar.gz: 2d8325ebea40c7a07c3fdf45769dd5ca8100f48843bb571ba2bd902dae377286
 SHA512:
-  metadata.gz: 607b4fbd945f5a33854220fbbffb69b1798cdd6b86edb61833e648fa5d66f14ef2d249b3d1004e664b950d08bef08c1d4d62a9dedba975702c1ce663ebceaa27
-  data.tar.gz: 3b33b6ae87a5de31f2e90e0281aa3add9d18c55b10edc5ee0e7b2e8ffa67f9738fcd65f33e577f8b45db379428bd4a1bc85614a60df2e110dcde54f8527a5538
+  metadata.gz: ce2a4e798d087ddcfda6755ab8e8ec22fbdee55d3449283c5030d468b2e910d0d81966601eb0ec16e6d8f4438ea8860907d09964b3c5859e550fdde00fe853ef
+  data.tar.gz: 9d9d82d1d05ad8f3211a3d1bee0adde946990ecd4e0bca2fffdc17b7d60ada50e14202275c63ca21c7afaa1b3b13419d4efb16d2d05b8d1b5699daddc1de9715

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.1.0
+
+Upload and use an ASDF wrapper to fully load ASDF environnement before executing commands.
+The wrapper is generated in `<shared_path>/asdf-wrapper` by default, but can be generated elsewhere by setting `:asdf_custom_wrapper_path` capistrano variable.
+
+## 1.0.0
+
+Add asdf:install and asdf:add_plugins tasks
+
 ## 0.0.3
 
 Add some configuration options:

data/README.md

@@ -84,6 +84,24 @@ This gem adds new tasks `asdf:map_*` before `deploy` task.
 It loads the ASDF tools environment for capistrano when it wants to run
 some tools related programs like `rake`, `gem`, `bundle`, `node`, `npm` ...
 
+## Generate and upload the ASDF commands wrapper
+
+The ASDF wrapper is needed to correctly run the mapped commands.
+Since the wrapper is an executable script, it can be used in Systemd units.
+
+    $ cap production asdf:upload_wrapper
+
+This task is automaticaly called before `asdf:check`
+
+## Install required tools
+
+If you want your tools (ruby, nodejs) to be installed, you can use the `asdf:install` task to
+preform plugins add and then install of required versions from your `.tool-versions`.
+`asdf:install` will automaticaly add necessary plugins running `asdf:add_plugins`.
+If you want to change the plugins to install you may set `:asdf_tools` accordingly.
+
+    $ cap production asdf:install
+
 ## Check your configuration
 
 If you want to check your configuration you can use the `asdf:check` task to

data/capistrano-asdf.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "capistrano-asdf"
-  gem.version       = '0.0.3'
+  gem.version       = '1.1.0'
   gem.licenses      = ['MIT']
   gem.authors       = ["Jean-Baptiste Poix"]
   gem.email         = ["jbpoix@inosophia.com"]

data/lib/capistrano/tasks/asdf.rake

@@ -5,18 +5,75 @@ ASDF_DEFAULT_RUBY_BINS = %w{rake gem bundle ruby rails}
 # Nodejs related bin
 ASDF_DEFAULT_NODEJS_BINS = %w{node npm yarn}
 
+ASDF_DEFAULT_WRAPPER_TEMPALTES = %{
+  #!/usr/bin/env bash
+
+  . @@ASDF_USER_PATH@@/asdf.sh
+  exec "$@"
+}
+
 namespace :asdf do
+  desc "Upload ASDF wrapper to the target host"
+  task :upload_wrapper do
+    on roles(fetch(:asdf_roles, :all)) do
+      wrapper_content = ASDF_DEFAULT_WRAPPER_TEMPALTES.gsub('@@ASDF_USER_PATH@@', fetch(:asdf_path))
+      need_to_upload_wrapper = true
+      # Check if the wrapper already exists
+      if test("[ -f #{fetch(:asdf_wrapper_path)} ]")
+        # Check if md5sum is available on the target host
+        if test("which md5sum")
+        else
+          info "md5sum is not available on the target host, we can't check the wrapper integrity"
+          need_to_upload_wrapper = false
+        end
+        # Check if the wrapper is the same as the one we want to upload using a md5 checksum
+        if capture("md5sum #{fetch(:asdf_wrapper_path)}").split.first == Digest::MD5.hexdigest(wrapper_content)
+          need_to_upload_wrapper = false
+        else
+          info "ASDF wrapper already exists on the target host but is different from the one we want to upload"
+        end
+      end
+      if need_to_upload_wrapper
+        upload! StringIO.new(wrapper_content), "#{fetch(:asdf_wrapper_path)}"
+        execute("chmod +x #{fetch(:asdf_wrapper_path)}")
+      else
+        info "ASDF wrapper already exists on the target host"
+      end
+    end
+  end
+
   desc "Prints the ASDF tools versions on the target host"
   task :check do
     on roles(fetch(:asdf_roles, :all)) do
-      execute("source #{fetch(:asdf_path)}/asdf.sh; asdf current")
+      execute("#{fetch(:asdf_wrapper_path)} asdf current")
     end
   end
-  
+
+  desc "Install ASDF tools versions based on the .tool-versions of your project"
+  task :install do
+    on roles(fetch(:asdf_roles, :all)) do
+      execute("#{fetch(:asdf_wrapper_path)} asdf install")
+    end
+  end
+
+  desc "Add ASDF plugins specified in :asdf_tools"
+  task :add_plugins do
+    on roles(fetch(:asdf_roles, :all)) do
+      already_installed_plugins = capture("#{fetch(:asdf_wrapper_path)} asdf plugin list")&.split
+      fetch(:asdf_tools)&.each do |asdf_tool|
+        if already_installed_plugins.include?(asdf_tool)
+          info "#{asdf_tool} Already installed"
+        else
+          execute("#{fetch(:asdf_wrapper_path)} asdf plugin add #{asdf_tool}")
+        end
+      end
+    end
+  end
+
   task :map_ruby_bins do
     if fetch(:asdf_tools).include?('ruby')
       fetch(:asdf_map_ruby_bins).each do |mapped_command|
-        SSHKit.config.command_map.prefix[mapped_command.to_sym].unshift("source #{fetch(:asdf_path)}/asdf.sh;")
+        SSHKit.config.command_map.prefix[mapped_command.to_sym].unshift("#{fetch(:asdf_wrapper_path)}")
       end
     end
   end
@@ -24,13 +81,17 @@ namespace :asdf do
   task :map_nodejs_bins do
     if fetch(:asdf_tools).include?('nodejs')
       fetch(:asdf_map_nodejs_bins).each do |mapped_command|
-        SSHKit.config.command_map.prefix[mapped_command.to_sym].unshift("source #{fetch(:asdf_path)}/asdf.sh;")
+        SSHKit.config.command_map.prefix[mapped_command.to_sym].unshift("#{fetch(:asdf_wrapper_path)}")
       end
     end
   end
   
 end
 
+before 'asdf:install', 'asdf:add_plugins'
+after 'deploy:check', 'asdf:check'
+before 'asdf:check', 'asdf:upload_wrapper'
+
 Capistrano::DSL.stages.each do |stage|
   after stage, 'asdf:map_ruby_bins'
   after stage, 'asdf:map_nodejs_bins'
@@ -42,6 +103,9 @@ namespace :load do
       asdf_path = fetch(:asdf_custom_path)
       asdf_path ||= ASDF_USER_PATH
     }
+    set :asdf_wrapper_path, -> {
+      fetch(:asdf_custom_wrapper_path) || "#{shared_path}/asdf-wrapper"
+    }
 
     set :asdf_tools, fetch(:asdf_tools, ASDF_DEFAULT_TOOLS)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-asdf
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jean-Baptiste Poix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ASDF integration for Capistrano