tamtam-vagrant-reload 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4d967b9fcf3fd7aa2ceac86c97a94541ca00bc6a
-  data.tar.gz: 141be090dda8397347c1cfa8a525698d9967d34f
+SHA256:
+  metadata.gz: a8511874f446fe024e44e563fa201fe48dd15425b3907249df4c6f38b4a55728
+  data.tar.gz: 6a78776ab0b1482e6b706100e2e685dad436b2b2d6bb375e744de09223436ccb
 SHA512:
-  metadata.gz: ee86005a51fd3ca669cc879da141de4009587a6d7a0ba1c1fd538b0f432da0c6342fbf22c3822e02e46f675d05cd6553685d90dfc2baff8a748de936160612e7
-  data.tar.gz: 10f1839095bc87825e7f2e1430cda2130ffbad3ba2d03bd33ff97d7a68ccab92644b2c0f3511c998c2f911a5d0d5e16c10407bcf074e2ba3f591fe4a80e3e74c
+  metadata.gz: 319d97f31099fbc5720d364a770f0637e917f12f67457ef5c4736fb45f96b227682c42d7a9708ae4eb604404f06fb7a4ec5612c26dc50a5b9876a49451a2a395
+  data.tar.gz: 0d16bf1147b794f4ef7e013717107a4525986705da9c5d23715257cd8dff49601c02e6a4066137d666bc46d4a042efc432d6db668fdefe153e81a7b4f50827de

data/.gitignore

@@ -2,6 +2,9 @@
 .idea
 .DS_Store
 
+# editors
+*.swp
+
 # Bundler/Rubygems
 *.gem
 .bundle
@@ -9,7 +12,13 @@ pkg/*
 tags
 Gemfile.lock
 vendor
+venv
 
 # Vagrant
 .vagrant
 Vagrantfile
+!example_box/Vagrantfile
+
+# RVM files for gemset/ruby setting
+.ruby-*
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--format doc --order random --color --fail-fast

data/.test_conf~

@@ -0,0 +1,8 @@
+[default]
+check_file=./reload-file-ENV_file-default_region
+reboot_file=/var/run/reboot-required-ENV_file-default_region
+
+[nom_test]
+check_file=./reload-file-ENV_file-vm_region 
+reboot_file=/var/run/reboot-required-ENV_file-vm_region 
+

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - ruby-head
+  - 2.3
+  - 2.2

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
@@ -6,5 +6,9 @@ group :development do
   # We depend on Vagrant for development, but we don't add it as a
   # gem dependency because we expect to be installed within the
   # Vagrant environment itself using `vagrant plugin`.
-  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => "v1.3.4"
-end
+  gem "vagrant", :git => "https://github.com/hashicorp/vagrant.git"
+end
+
+#group :plugins do
+#  gem "tamtam-vagrant-reload", path: "."
+#end

data/LICENSE.txt

@@ -1,22 +1 @@
-Copyright (c) 2016 Vincent Zimmer
-
-MIT License
-
-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.
+Copyright (c) 2023 TAM TAM Luxembourg S.A.

data/README.md

@@ -12,16 +12,44 @@ Note : Check file using to specify a reload necessity will be automatically remo
 
 ## Usage
 
-Add `config.vm.provision :tamtam-reload` to your `Vagrantfile` to reload your VM during provisioning.
+Add `config.vm.provision 'reload'` to your `Vagrantfile` to reload your VM after provisioning.
 
 
 Set the parameter `check_file` to the filename you want to check with a absolute path to reload vagrant conditionally.
-
-
+Set the parameter `reboot_file` to the guest system filename (which notify a restart requirement) to check with a absolute path to reload vagrant conditionally.
 For example :
 
 ```
-web.vm.provision :tamtam-reload do |reload|
+web.vm.provision 'reload' do |reload|
     reload.check_file = "/tmp/check_file_name"
+    reload.reboot_file = "/var/run/reboot-required"
 end
-```
+```
+
+These parameters can also be defined by ENV variables:
+- TAMTAM_VAGRANT_RELOAD_CHECK_FILE
+- TAMTAM_VAGRANT_RELOAD_RELOAD_FILE
+
+Or, these parameters can be defined in an INI file like:
+
+```
+[default]
+check_file="/tmp/check_file_name"
+reboot_file="/var/run/reboot-required"
+
+[vm_name]
+check_file="/tmp/specific_check_file_name"
+reboot_file="/var/run/specific-reboot-required"
+```
+
+Default values are:
+- check_file: './require_restart' (on host machine)
+- reboot_file: '/var/run/reboot-required' (on guest machine)
+
+When defined, the INI file is attempted to be stored in `~/.config/tamtam-vagrant-reload/config.ini`
+But you can override this attempted location by defining `conf_file` parameter in the Vagrantfile or TAMTAM_VAGRANT_RELOAD_CONFIG_FILE environment variable. 
+
+Priority of parameters definition:
+- conf_file: Vagrantfile (provision section), then ENV var, then default to `~/.config/tamtam-vagrant-reload/config.ini`
+- check_file: Vagrantfile (provision section), then ENV var, then INI file (vm_name section), then INI file (default section), then default to './require_restart'
+- reboot_file: Vagrantfile (provision section), then ENV var, then INI file (vm_name section), then INI file (default section), then default to '/var/run/reboot-required'

data/Rakefile

@@ -1,9 +1,22 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
 
 # This installs the tasks that help with gem creation and
 # publishing.
 Bundler::GemHelper.install_tasks
 
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--order defined"
+end
 # Default task is to run the unit tests
-task :default => "build"
+task :default => :spec

data/lib/tamtam-vagrant-reload/config.rb

@@ -0,0 +1,201 @@
+require "vagrant"
+require "iniparse"
+
+module VagrantPlugins
+  module TamtamVagrantReload
+    class Config < Vagrant.plugin("2", :config)
+
+      def initialize(machine)
+        @machine = machine
+      end
+
+      # The path of file to check (trigger reboot if file is present)
+      #
+      # @return [String]
+      attr_accessor :check_file
+
+      # The path of file which mark the restart requirement into
+      # guest machine (trigger reboot if file is present)
+      #
+      # @return [String]
+      attr_accessor :reboot_file
+
+      def initialize()
+        @check_file       = UNSET_VALUE
+        @reboot_file      = UNSET_VALUE
+        @conf_file        = UNSET_VALUE
+        @set_by_conf_file = []
+        @conf_reader      = UNSET_VALUE
+
+        # Internal state (prefix with __ so they aren't automatically
+        # merged)
+        @__finalized = false
+      end
+
+      def finalize!
+        # If check_file/reboot_file was not specified in Vagrantfile
+        # then try to read from environment variables first, and if it fails from
+        # the ".tamtam-vagrant-reload" folder.
+        set_conf_file()
+
+        if @check_file == UNSET_VALUE or @reboot_file == UNSET_VALUE
+          @conf_reader = ReadConf.new
+          check_file, reboot_file, @set_by_conf_file = @conf_reader.get_reload_info(@conf_file)
+          set_attribute_if_not_defined(check_file, reboot_file)
+        end
+
+        if !@check_file.is_a?(String)
+          @check_file = './require_restart'
+        end
+
+        if !@reboot_file.is_a?(String)
+          # Set the default value
+          @reboot_file = '/var/run/reboot-required'
+        end
+
+        # Mark that we finalized
+        @__finalized = true
+      end
+
+      def set_attribute_if_not_defined(check_file, reboot_file)
+        @check_file  = check_file.to_s if (@check_file == UNSET_VALUE or @check_file.to_s == '') and check_file.to_s != ''
+        @reboot_file = reboot_file.to_s if (@reboot_file == UNSET_VALUE or @reboot_file.to_s == '') and reboot_file.to_s != ''
+      end
+
+      def validate(machine)
+        machine_name = machine.config.vm.hostname
+        errors       = _detected_errors
+
+        # Try to read conf value from specific ini file region
+        if @conf_reader != UNSET_VALUE and @conf_file.to_s != '' and @conf_file != UNSET_VALUE
+          region_check_file, region_reboot_file = @conf_reader.read_from_file(@conf_file, machine_name)
+
+          if region_check_file.to_s != '' and (@check_file.to_s == '' or @set_by_conf_file.include? 'check_file')
+            @check_file = region_check_file
+          end
+
+          if region_reboot_file.to_s != '' and (@reboot_file.to_s == '' or @set_by_conf_file.include? 'reboot_file')
+            @reboot_file = region_reboot_file
+          end
+        end
+
+        if @conf_file.to_s == ''
+          msg_conf_file = ENV['HOME'].to_s + '/.config/tamtam-vagrant-reload/config.ini'
+        else
+          msg_conf_file = @conf_file
+        end
+
+        if @check_file.to_s == ''
+          errors << I18n.t(
+            "vagrant_reload.config.check_file_required",
+            :conf_file => @conf_file,
+            :machine_name => machine_name
+          )
+        end
+
+        if @reboot_file.to_s == ''
+          errors << I18n.t(
+            "vagrant_reload.config.reboot_file_not_empty",
+            :conf_file => @conf_file,
+            :machine_name => machine_name
+          )
+        end
+
+        { "tamtam-vagrant-reload plugin" => errors }
+      end
+
+      def set_conf_file
+        if @conf_file == UNSET_VALUE or @conf_file.to_s == '' or !File.exist?(@conf_file.to_s)
+          if ENV['TAMTAM_VAGRANT_RELOAD_CONFIG_FILE'].to_s != '' and File.exist?(ENV['TAMTAM_VAGRANT_RELOAD_CONFIG_FILE'].to_s)
+            @conf_file = ENV['TAMTAM_VAGRANT_RELOAD_CONFIG_FILE'].to_s
+          elsif ENV['HOME'].to_s != '' and File.exist?(ENV['HOME'].to_s + '/.config/tamtam-vagrant-reload')
+            @conf_file = ENV['HOME'].to_s + '/.config/tamtam-vagrant-reload/config.ini'
+          else
+            @conf_file = nil
+          end
+        end
+      end
+    end
+
+
+    class ReadConf < Vagrant.plugin("2", :config)
+      # This module reads config as following (stopping at the first successful case):
+      # 1) read config from environment variables
+      # 2) read config from file at location defined by environment variables
+      # 3) read config from file at default location
+      #
+      # It also allows choosing the [default] profile and an "info"
+      # directory $HOME/.tamtam-vagrant-reload.
+      # Supported information: check_file.
+
+      def get_reload_info(location)
+        set_by_conf_file = []
+        # Read from environment variables
+        check_file, reboot_file = read_from_environment()
+
+        # If any missing in environment, then read from files
+        if check_file.to_s == '' or reboot_file.to_s == ''
+          # Check the configuration file to use
+          conf_check_file  = nil
+          conf_reboot_file = nil
+
+          conf_check_file, conf_reboot_file = read_from_file(location.to_s)
+
+          if check_file.to_s == '' and conf_check_file.to_s != ''
+            check_file  = conf_check_file
+            set_by_conf_file.append('check_file')
+          end
+
+          if reboot_file.to_s == '' and conf_reboot_file.to_s != ''
+            reboot_file = conf_reboot_file
+            set_by_conf_file.append('reboot_file')
+          end
+        end
+
+        return check_file, reboot_file, set_by_conf_file
+      end
+
+      # Get info from config ini file for selected profile
+      def read_from_file(location, region = 'default')
+        check_file  = nil
+        reboot_file = nil
+
+        if location.to_s != '' and File.exist?(location.to_s)
+          data        = File.read(location)
+          doc_cfg     = IniParse.parse(data)
+
+          begin
+            check_file = doc_cfg[region]['check_file'].to_s if doc_cfg[region]['check_file'].to_s != ''
+          rescue
+            check_file = nil
+          end
+
+          begin
+            reboot_file = doc_cfg[region]['reboot_file'].to_s if doc_cfg[region]['reboot_file'].to_s != ''
+          rescue
+            reboot_file = nil
+          end
+        end
+
+        return check_file, reboot_file
+      end
+
+      def read_from_environment()
+        check_file  = nil
+        reboot_file = nil
+
+        if ENV['TAMTAM_VAGRANT_RELOAD_CHECK_FILE'].to_s != ''
+          check_file = ENV['TAMTAM_VAGRANT_RELOAD_CHECK_FILE'].to_s
+        end
+
+        if ENV['TAMTAM_VAGRANT_RELOAD_RELOAD_FILE'].to_s != ''
+          reboot_file = ENV['TAMTAM_VAGRANT_RELOAD_RELOAD_FILE'].to_s
+        end
+
+        return check_file, reboot_file
+      end
+
+    end
+
+  end
+end

data/lib/tamtam-vagrant-reload/plugin.rb

@@ -0,0 +1,76 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The TAM TAM Vagrant reload plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.2.1"
+  raise "The TamTam Vagrant Reload plugin is only compatible with Vagrant 1.2+"
+end
+
+module VagrantPlugins
+  module TamtamVagrantReload
+    class Plugin < Vagrant.plugin("2")
+
+      name "TamtamVagrantReload"
+      description <<-DESC
+      Reload vagrant VM as a provisioning step.
+      Reload can be conditional, base on file presence.
+      DESC
+
+      config(:reload, :provisioner) do
+        require_relative "config"
+        Config
+      end
+
+      # When explicitly configured in Vagrantfile
+      provisioner(:reload) do
+        # Setup logging and i18n
+        setup_logging
+        setup_i18n
+
+        # Return the provisioner
+        require_relative "provision"
+        Provision
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", TamtamVagrantReload.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new("tamtam_vagrant_reload")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+
+    end
+  end
+end

data/lib/tamtam-vagrant-reload/provision.rb

@@ -0,0 +1,108 @@
+require "log4r"
+require "vagrant"
+
+module VagrantPlugins
+  module TamtamVagrantReload
+    class Provision < Vagrant.plugin("2", :provisioner)
+
+      def initialize(machine, plugin)
+        @machine = machine
+        @plugin  = plugin
+      end
+
+      def provision
+
+        machine_name = @machine.config.vm.hostname
+        reload       = false
+        info         = ''
+
+        if @plugin.check_file.is_a?(String)
+          check_file = @plugin.check_file.strip
+        else
+          check_file = nil
+        end
+
+        # Checking VM require restart file existence
+        if @plugin.check_file.is_a?(String) and @plugin.reboot_file != ''
+          begin
+            @machine.communicate.sudo("test -e #{@plugin.reboot_file} && echo 'exists' || echo 'miss'") do |type, data|
+              if data.to_s.strip == 'exists'
+                reload = true
+                info   = I18n.t(
+                  "vagrant_reload.reload_due_to_guest",
+                  :reboot_file => @plugin.reboot_file,
+                  :machine_name => machine_name
+                )
+              end
+            end
+          rescue
+            output_on_host(:stderr, I18n.t("vagrant_reload.warning_error_checking_reboot", :reboot_file => @plugin.reboot_file,));
+          end
+        else
+          output_on_host(:stderr, I18n.t("vagrant_reload.warning_no_reboot_file"))
+        end
+
+        if reload == false
+          if check_file == nil
+            output_on_host(:stderr, I18n.t("vagrant_reload.warning_no_check_file"))
+          else
+            if File.exist?(check_file)
+              reload = true
+              info   = I18n.t(
+                "vagrant_reload.reload_due_to_host_marker",
+                :check_file => @plugin.check_file,
+                :machine_name => machine_name
+              )
+              system('rm ' + check_file)
+            end
+          end
+        else
+          if check_file != nil and File.exist?(check_file)
+              system('rm ' + check_file)
+          end
+        end
+
+        if reload
+          options = {}
+          options[:provision_ignore_sentinel] = false
+
+          if info.length > 0
+            output_on_host(:stdout, info)
+          end
+
+          @machine.action(:halt, options)
+          @machine.action(:up, options)
+          begin
+            sleep 5
+          end until @machine.communicate.ready?
+        else
+          output_on_host(
+            :stdout,
+            I18n.t(
+              "vagrant_reload.skip_reload",
+              :reboot_file => @plugin.reboot_file,
+              :check_file => @plugin.check_file,
+              :machine_name => machine_name
+            )
+          )
+        end
+
+      end
+
+      private
+
+      # This handles outputting the communication data back to the UI
+      def output_on_host(type, data)
+        if [:stderr, :stdout].include?(type)
+          # Output the data with the proper color based on the stream.
+          if type == :stderr
+            @machine.ui.error(data);
+          else
+            @machine.ui.info(data)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/tamtam-vagrant-reload/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module TamtamVagrantReload
-    VERSION = "1.1.3"
+    VERSION = "1.2.1"
   end
-end
+end

data/lib/tamtam-vagrant-reload.rb

@@ -1,33 +1,19 @@
-begin
-  require "vagrant"
-rescue LoadError
-  raise "The Vagrant AWS plugin must be run within Vagrant."
-end
+require "pathname"
 
-# This is a sanity check to make sure no one is attempting to install
-# this into an early Vagrant version.
-if Vagrant::VERSION < "1.2.0"
-  raise "The TamTam Vagrant Reload plugin is only compatible with Vagrant 1.2+"
-end
+require "tamtam-vagrant-reload/plugin"
 
 module VagrantPlugins
   module TamtamVagrantReload
-    class Plugin < Vagrant.plugin("2")
-      name "TamtamVagrantReload"
-      description <<-DESC
-      Reload vagrant VM as a provisioning step.
-      Reload can be conditional, base on file presence.
-      DESC
-
-      config(:reload, :provisioner) do
-        require File.expand_path("../tamtam-vagrant-reload-config", __FILE__)
-        TamtamVagrantReloadConfig
-      end
+    lib_path = Pathname.new(File.expand_path("../tamtam-vagrant-reload", __FILE__))
+    autoload :Plugin, lib_path.join("plugin")
 
-      provisioner(:reload) do
-        require File.expand_path("../tamtam-vagrant-reload-provisioner", __FILE__)
-        TamtamVagrantReloadProvisioner
-      end
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
     end
+
+
   end
-end
+end

data/locales/en.yml

@@ -0,0 +1,59 @@
+en:
+  vagrant_reload:
+    already_status: |-
+      The machine is already %{status}.
+
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    starting: |-
+      Starting the instance...
+    stopping: |-
+      Stopping the instance...
+    terminating: |-
+      Terminating the instance...
+    waiting_for_ready: |-
+      Waiting for instance to become "ready"...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+
+    config:
+      reboot_file_not_empty: |-
+        Bad reboot file path (specified as 'reboot_path' parameter). It cannot be empty!
+        Note:
+        You can specify parameter 'reboot_path' in Vagrantfile, 
+        or by 'TAMTAM_VAGRANT_RELOAD_RELOAD_FILE' environment variable
+        or by variable 'reboot_path' (in profile '[default]' or '[%{machine_name}]') in '%{conf_file}'.
+        Note2:
+        The INI configuration file path can be overridden by setting the 'conf_file' parameter in Vagrantfile
+        or 'TAMTAM_VAGRANT_RELOAD_CONFIG_FILE' environment variable.
+      check_file_required: |-
+        Check file path (specified as "check_file" parameter) must be specified!
+        In addition, no 'TAMTAM_VAGRANT_RELOAD_CHECK_FILE' environment variable was set
+        nor variable 'check_file' (in profile '[default]' or '[%{machine_name}]') 
+        exists at '%{conf_file}'
+        Note: 
+        The INI configuration file path can be overridden by setting the 'conf_file' parameter in Vagrantfile
+        or 'TAMTAM_VAGRANT_RELOAD_CONFIG_FILE' environment variable.
+
+    reload_due_to_guest:
+      The file '%{reboot_file}' was found on guest VM '%{machine_name}'.
+      Reloading Vagrant VM...
+    reload_due_to_host_marker:
+      The marker file '%{check_file}' was found on host.
+      Reloading Vagrant VM '%{machine_name}'...
+    skip_reload:
+      The file '%{reboot_file}' (on guest VM '%{machine_name}') nor
+      the marker file '%{check_file}' (on host) were found.
+      Skip Vagrant VM reload!
+    warning_no_reboot_file:
+      WARNING
+      No reboot file ('reboot_file' parameter) specify.
+      Vagrant VM reloading on marker file presence (on guest) skipped...
+    warning_no_check_file:
+      WARNING
+      No check file ('check_file' parameter) specify.
+      Vagrant VM reloading on marker file presence (on host) skipped...
+    warning_error_checking_reboot:
+      WARNING
+      An unattempted error occurs while checking '%{reboot_file}' (on guest)
+      Vagrant VM reloading on marker file presence (on guest) skipped...