vop 0.3.5 → 0.3.6

data/lib/vop/vop.rb

@@ -10,7 +10,6 @@ require_relative "objects/entity"
 require_relative "objects/entities"
 require_relative "util/errors"
 require_relative "util/pluralizer"
-require_relative "util/worker"
 
 module Vop
 
@@ -26,11 +25,16 @@ module Vop
     attr_reader :filter_chain
 
     attr_reader :finder, :loader, :sorter
+    attr_reader :search_path
+    attr_reader :load_status
+
+    @search_path = []
 
     def initialize(options = {})
       @options = {
         config_path: "/etc/vop",
-        log_level: Logger::INFO
+        log_level: Logger::INFO,
+        no_init: false,
       }.merge(options)
       $logger.level = @options[:log_level]
 
@@ -42,6 +46,7 @@ module Vop
     end
 
     def clear
+      @load_status = {}
       @plugins = []
       @commands = {}
       @entities = {}
@@ -53,6 +58,7 @@ module Vop
     def _reset
       clear
       load
+      init unless @options[:no_init]
     end
 
     def to_s
@@ -79,30 +85,6 @@ module Vop
       File.join(lib_path, "core")
     end
 
-    def plugin_locations
-      result = []
-
-      # during development, we might find checkouts for "plugins" and "services"
-      # next to the core
-      vop_dir = Pathname.new(File.join(lib_path, "..", "..")).realpath
-      unless vop_dir.to_s.start_with? "/usr"
-        %w|plugins services|.each do |thing|
-          sibling_dir = File.join(vop_dir, thing)
-          result << sibling_dir
-        end
-      end
-
-      # for distribution packages (?)
-      result << "/usr/lib/vop-plugins"
-
-      # an extra path might have been passed in the options
-      if @options.has_key? :plugin_path
-        result << @options[:plugin_path]
-      end
-
-      result
-    end
-
     def config_path
       @options[:config_path]
     end
@@ -111,17 +93,56 @@ module Vop
       @plugin_config_path ||= File.join(config_path, "plugins.d")
     end
 
+    def search_path_config_dir
+      @search_path_config_dir ||= File.join(config_path, "search_path.d")
+    end
+
     def executor
       @executor ||= Executor.new(self)
     end
 
+    def search_path
+      unless @assembled_search_path
+        @assembled_search_path = self.class.search_path
+        unless ENV["VOP_IGNORE_PLUGINS"]
+          @assembled_search_path += Dir.glob("#{search_path_config_dir}/*").map { |x| File.readlink(x) }
+        end
+      end
+      @assembled_search_path
+    end
+
+    def unloaded
+      search_path.reject { |path| @load_status.key? path }
+    end
+
+    def load
+      load_from(core_location, { core: true })
+      load_from(@options[:plugin_path]) if @options.has_key?(:plugin_path)
+
+      while unloaded.any? do
+        unloaded.each do |path|
+          $logger.debug "loading from #{path}..."
+          load_from path
+          @load_status[path] = true
+        rescue => e
+          @load_status[path] = false
+          $logger.error "could not load plugins from #{path} : #{e.message}"
+          raise
+        end
+      end
+
+      # TODO: do we need this?
+      # call_global_hook :loading_finished
+      $logger.debug "loaded : #{@plugins.size} plugins, #{@commands.size} commands"
+    end
+
     def load_from(locations, load_options = {})
       found = finder.find(locations)
       plugins = loader.load(found, load_options)
       new_plugins = sorter.sort(plugins.loaded)
 
       new_plugins.each do |plugin|
-        plugin.init
+        plugin.load
         self << plugin
       end
 
@@ -129,14 +150,9 @@ module Vop
       $logger.debug plugins.loaded.map(&:name)
     end
 
-    def load
-      load_from(core_location, { core: true })
-      load_from(plugin_locations)
-      load_from(search_path)
-
-      call_global_hook :loading_finished
-
-      $logger.info "init complete : #{@plugins.size} plugins, #{@commands.size} commands"
+    def init
+      @plugins.select(&:auto_load?).each(&:init)
+      call_global_hook :init_complete
     end
 
     def <<(stuff)
@@ -149,13 +165,14 @@ module Vop
           @plugins << stuff
         elsif stuff.is_a? EntityDefinition
           entity = stuff
+          # TODO : auto-merge entities with the same name from multiple plugins?
           @entities[entity.short_name] = stuff
         elsif stuff.is_a? Command
           command = stuff
           unless command.dont_register
             $logger.debug "registering #{command.name}"
             if @commands.keys.include? command.short_name
-              $logger.warn "overriding previous declaration of #{command.short_name}"
+              $logger.debug "overriding previous declaration of #{command.short_name}"
             end
             @commands[command.short_name] = stuff
 
@@ -186,6 +203,19 @@ module Vop
       @hooks[hook_sym].each do |h|
         h.call(payload)
       end
+
+      @plugins.each do |plugin|
+        if plugin.has_hook? hook_sym
+          plugin.call_hook(hook_sym, payload)
+        end
+      end
+    end
+
+    def prepare_request(command_name, param_values = {}, extra = {}, origin_suffix = nil)
+      request = Request.new(self, command_name, param_values, extra)
+      request.origin = "#{@options[:origin]}"
+      request.origin += ":#{origin_suffix}" unless origin_suffix.nil?
+      request
     end
 
     def execute_request(request)
@@ -193,28 +223,24 @@ module Vop
       begin
         response = request.execute()
       rescue => e
-        response = ::Vop::Response.new(nil, {})
+        response = Response.new(nil, {})
         response.status = "error"
         raise e
       ensure
         call_global_hook(:after_execute, { request: request, response: response })
       end
 
-      #$logger.debug "executed : #{request.command.name}, response : #{response.pretty_inspect}"
       response
     end
 
     def execute(command_name, param_values = {}, extra = {})
-      request = Request.new(self, command_name, param_values, extra)
+      request = prepare_request(command_name, param_values, extra)
       response = execute_request(request)
-
       response.result
     end
 
-    def execute_async(request)
-      AsyncExecutorWorker.perform_async(request.to_json)
+    def self.search_path
+      @search_path
     end
-
   end
-
 end

data/lib/vop.rb

@@ -4,6 +4,13 @@ require_relative "vop/version"
 require_relative "vop/shell/shell"
 require_relative "vop/vop"
 
+begin
+  require "vop-plugins"
+rescue Exception => e
+  $stderr.puts "could not load plugins from gem : #{e.message}"
+  #raise
+end
+
 module Vop
 
   def self.setup(options = {})
@@ -14,11 +21,14 @@ module Vop
     if ENV["VOP_DEV_MODE"]
       sibling_lib_dir = Pathname.new(File.join(File.dirname(__FILE__), "..", "lib")).realpath
       if File.exists? sibling_lib_dir
-        #puts "adding local lib path #{sibling_lib_dir}"
         $: << sibling_lib_dir
       end
     end
 
+    if ENV["VOP_ORIGIN"]
+      options[:origin] = "#{ENV["VOP_ORIGIN"]}:#{Process.pid}@#{`hostname`.strip}"
+    end
+
     ::Vop.setup(options)
   end
 

data/vop.gemspec

@@ -2,6 +2,7 @@
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "vop/version"
+require "vop/search_path"
 
 Gem::Specification.new do |spec|
   spec.name          = "vop"
@@ -20,15 +21,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "net-ssh"
-  spec.add_dependency "net-scp"
-  spec.add_dependency "redis"
-  spec.add_dependency "sidekiq"
+  Vop.gem_dependencies.each do |dep|
+    spec.add_dependency dep
+  end unless ENV["VOP_IGNORE_PLUGINS"]
+
+  spec.add_dependency "json", "~> 2.3"
   spec.add_dependency "terminal-table"
   spec.add_dependency "xml-simple"
+  spec.add_dependency "byebug"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: vop
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Philipp T.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-scp
+  name: passgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: ed25519
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,33 +95,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '2.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,20 +229,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- bin/sidekiq.sh
 - bin/vop.sh
 - exe/vop
 - lib/boot.rb
+- lib/core/cache/cache.plugin
+- lib/core/cache/commands/invalidate_cache.rb
+- lib/core/meta/commands/list_commands.rb
+- lib/core/meta/commands/list_filters.rb
+- lib/core/meta/commands/list_plugins.rb
 - lib/core/meta/commands/new_command.rb
 - lib/core/meta/commands/new_plugin.rb
-- lib/core/meta/commands/search_gems_for_plugins.rb
-- lib/core/meta/commands/search_path.rb
 - lib/core/meta/commands/set.rb
 - lib/core/meta/commands/show.rb
 - lib/core/meta/commands/show_config.rb
@@ -180,6 +256,7 @@ files:
 - lib/core/meta/meta.plugin
 - lib/core/shell/commands/change_loglevel.rb
 - lib/core/shell/commands/clear_context.rb
+- lib/core/shell/commands/detail.rb
 - lib/core/shell/commands/edit.rb
 - lib/core/shell/commands/help.rb
 - lib/core/shell/commands/reset.rb
@@ -190,10 +267,9 @@ files:
 - lib/core/structure/commands/disable_contributor.rb
 - lib/core/structure/commands/generate_entity_commands.rb
 - lib/core/structure/commands/generate_invalidation_commands.rb
-- lib/core/structure/commands/list_commands.rb
+- lib/core/structure/commands/list_contribution_targets.rb
 - lib/core/structure/commands/list_contributors.rb
 - lib/core/structure/commands/list_entities.rb
-- lib/core/structure/commands/list_plugins.rb
 - lib/core/structure/commands/register_contributor.rb
 - lib/core/structure/structure.plugin
 - lib/vop.rb
@@ -215,6 +291,7 @@ files:
 - lib/vop/parts/filter_loader.rb
 - lib/vop/parts/plugin_finder.rb
 - lib/vop/parts/plugin_loader.rb
+- lib/vop/search_path.rb
 - lib/vop/shell/shell.rb
 - lib/vop/shell/shell_formatter.rb
 - lib/vop/shell/shell_input.rb
@@ -226,14 +303,13 @@ files:
 - lib/vop/syntax/plugin_syntax.rb
 - lib/vop/util/errors.rb
 - lib/vop/util/pluralizer.rb
-- lib/vop/util/worker.rb
 - lib/vop/version.rb
 - lib/vop/vop.rb
 - vop.gemspec
 homepage: http://virtualop.org
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -248,9 +324,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: The vop is a scripting framework.
 test_files: []

data/lib/core/meta/commands/search_gems_for_plugins.rb

@@ -1,38 +0,0 @@
-require "rubygems"
-require "find"
-require "digest"
-
-contribute to: "search_path" do |params|
-  gem_list = `gem list`.split("\n")
-  candidates = gem_list.select { |x| x =~ /vop-\w+/ }
-
-  # TODO cache which gems have already been inspected
-  # checksum = Digest::MD5.new
-  # candidates.map do |candidate|
-  #   checksum << [ candidate.name, candidate.version ].join(":")
-  # end
-  # puts "gemspec md5 : #{checksum.hexdigest}"
-
-  result = []
-
-  candidates.each do |candidate|
-    $logger.debug "inspecting #{candidate}"
-
-    matched = /(.+?)\s+\([\d\.]+\)/.match(candidate)
-    unless matched
-      $logger.warn("unexpected line format : #{candidate}")
-      next
-    end
-
-    name = matched.captures.first
-    version = matched.captures.last
-
-    contents = `gem contents #{name}`.split("\n")
-
-    plugin_files = contents.grep /\.plugin$/
-    result += plugin_files.map do |file_name|
-      file_name.split("/")[0..-2].join("/")
-    end
-  end
-  result
-end

data/lib/core/meta/commands/search_path.rb

@@ -1,6 +0,0 @@
-run do |params|
-  @op.collect_contributions(
-    "command_name" => "search_path",
-    "raw_params" => params
-  )
-end

data/lib/core/structure/commands/list_plugins.rb

@@ -1,3 +0,0 @@
-run do |plugin|
-  @op.plugins.map { |x| x.name }.sort
-end

data/lib/vop/util/worker.rb

@@ -1,24 +0,0 @@
-require "sidekiq"
-require "json"
-
-module Vop
-
-  class AsyncExecutorWorker
-    include Sidekiq::Worker
-
-    def perform(request_json)
-      begin
-        op = ::Vop.boot
-        request = ::Vop::Request::from_json(op, request_json)
-        puts "performing #{request.pretty_inspect}"
-        response = op.execute_request(request)
-        puts "response : #{response.status}"
-        puts response.result
-      rescue => e
-        puts "[ERROR] #{e.message}\n#{e.backtrace.join("\n")}"
-      end
-    end
-
-  end
-
-end