capistrano-karaf 1.2.6 → 1.3

data/lib/capistrano-karaf/core.rb

@@ -0,0 +1,258 @@
+# Core functionality of capistrano-karaf.
+# This should only provide functions that map directly to karaf commands.
+
+require 'sshkit'
+
+SSHKit.config.command_map[:features_addurl] = 'features:addurl'
+SSHKit.config.command_map[:features_listurl] = 'features:listurl'
+SSHKit.config.command_map[:features_removeurl] = 'features:removeurl'
+SSHKit.config.command_map[:features_refreshurl] = 'features:refreshurl'
+SSHKit.config.command_map[:features_install] = 'features:install'
+SSHKit.config.command_map[:features_uninstall] = 'features:uninstall'
+SSHKit.config.command_map[:features_list] = 'features:list'
+SSHKit.config.command_map[:features_info] = 'features:info'
+SSHKit.config.command_map[:headers] = 'headers'
+SSHKit.config.command_map[:list] = 'osgi:list -t 0'
+SSHKit.config.command_map[:log_set] = 'log:set'
+SSHKit.config.command_map[:stop] = 'osgi:stop'
+SSHKit.config.command_map[:start] = 'osgi:start'
+SSHKit.config.command_map[:uninstall] = 'osgi:uninstall --force'
+
+module Capistrano_Karaf
+  # Add a feature url to the karaf server
+  #
+  # url - the string containing the url
+  # 
+  # Examples
+  #   add_url "mvn:com.melexis.esb/eventstore-feature/#{eventStoreVersion}/xml/features"
+  #   # => nil
+  #
+  # Returns nothing
+  def add_url (url)
+    execute(:features_addurl, url)
+  end
+
+  # Remove a feature url from the karaf server
+  #
+  # url - the string containing the url
+  # 
+  # Examples
+  #   remove_url "mvn:repository/eventstore-feature/1.0.0/xml/features"
+  #   # => nil
+  #
+  # Returns nothing
+  def remove_url (url)
+    execute(:features_removeurl, url)
+  end
+
+  # Refresh the urls containing the feature repositories on the karaf server 
+  #
+  # Examples
+  #   features_refreshurl
+  #   # => nil
+  #
+  # Returns nothing
+  def features_refreshurl
+    execute(:features_refreshurl)
+  end
+
+  # Install a feature on the karaf server
+  #
+  # name - the string containing the feature name
+  #
+  # Examples
+  #   feature_install "hello"
+  #   # => nil
+  #
+  # Returns nothing
+  def feature_install (name)
+    execute(:features_install, name)
+  end
+
+  # Uninstall a feature on the karaf server
+  #
+  # name - the string containing the feature name
+  #
+  # Examples
+  #   feature_uninstall "hello"
+  #   # => nil
+  #
+  # Returns nothing
+  def feature_uninstall (name)
+    execute(:features_uninstall, name)
+  end
+
+  # Set the log level on the karaf server
+  #
+  # level - the string containing the level
+  #
+  # Examples
+  #   log_set "debug"
+  #   # => nil
+  #
+  # Returns nothing
+  def log_set (level)
+    execute(:log_set, level)
+  end
+
+  # Start a bundle with the specified bundleId on the karaf server
+  #
+  # bundleId - a number containing the id of the bundle
+  #
+  # Examples
+  #   start 100
+  #   # => nil
+  #
+  # Returns nothing
+  def start (bundleId)
+    execute(:start, bundleId)
+  end
+
+  # Stop a bundle with the specified bundleId on the karaf server
+  #
+  # bundleId - a number containing the id of the bundle
+  #
+  # Examples
+  #   stop 100
+  #   # => nil
+  #
+  # Returns nothing
+  def stop (bundleId)
+    execute(:stop, bundleId)
+  end
+
+  # Uninstall a bundle with the specified bundleId from the karaf server
+  #
+  # bundleId - a number containing the id of the bundle
+  #
+  # Examples
+  #   start 100
+  #   # => nil
+  #
+  # Returns nothing
+  def uninstall (bundleId)
+    execute(:uninstall, bundleId)
+  end
+
+  # List all feature urls on the karaf server
+  #
+  # Examples
+  #   list_urls
+  #   # => [{:status => "Installed", :groupID => "repository", :artifactID => "repository", :version => "1.0.0"}]
+  #
+  # Returns a list of hashmaps containing all feature repositories
+  def list_urls
+    url_line_matcher = %r{        (?<status> \w+){0}
+				(?<groupID> [\d\w\.\-]+){0}
+				(?<artifactID> [\w\.\-]+){0}
+				(?<version> [\w\.\-]+){0} 
+
+			\s*\g<status>\s*mvn\:\g<groupID>\/\g<artifactID>\/\g<version>.*
+			}x
+
+    data = capture(:features_listurl)
+    matcher_to_hash(url_line_matcher, data)
+  end
+
+  # List all features on the karaf server
+  #
+  # Examples
+  #   list_features
+  #   # => [{:status => "Installed", :name => "camel-core", :repository => "repository", :version => "1.0.0"}]
+  #
+  # Returns a list of hashmaps containing all available features
+  def list_features
+    feature_line_matcher = %r{    (?<status> \w+){0}
+				(?<version> [\d\w\-\.\s]+){0}
+				(?<name> [\w\-\:]+){0}
+				(?<repository> [\w\-\s\:\.]+){0}
+
+			^\[\s*\g<status>\s*\]\s\[\s*\g<version>\s*\]\s*\g<name>\s*\g<repository>
+                           }x
+
+    data = capture(:features_list)
+    matcher_to_hash(feature_line_matcher, data)
+  end
+
+  # List all bundles on the karaf server
+  #
+  # Examples
+  #   list_bundles
+  #   # => [{:id => "10", :status => "INSTALLED", :blueprint => "", :context => "", :level => "60", :name => "camel-core", :version => "1.0.0"}]
+  #
+  # Returns a list of hashmaps containing the installed bundles
+  def list_bundles
+    bundle_line_matcher = %r{(?<id> \d+){0}
+                           (?<status> \w+){0}
+                           (?<blueprint> \w*){0}
+                           (?<context> \w*){0}
+                           (?<level> \d+){0}
+                           (?<name> [\w\s\-\:]+){0}
+                           (?<version> .+){0}
+
+                           ^\[\s*\g<id>\]\s\[\s*\g<status>\s*\]\s\[\s*\g<blueprint>\s*\]\s\[\s*\g<context>\s*\]\s\[\s*\g<level>\s*\]\s\g<name>\s\(\g<version>\)
+                          }x
+    
+    data = capture(:list)
+    matcher_to_hash(bundle_line_matcher, data)
+  end
+
+  # Get the headers for a bundle
+  #
+  # bundleId - A number containing the bundle id
+  #
+  # Examples
+  #   headers 10
+  #   # => "..."
+  #
+  # Returns the string containing the headers information for the bundle.
+  def headers (bundle)
+    data = capture(:headers, bundle)
+    extract_bundle_headers(data)
+  end
+
+  # List all bundles provided by a feature
+  #
+  # name - A string containing the name of the feature
+  # 
+  # Examples
+  #   feature_bundles "camel-core"
+  #   # => [{:groupId => "org.apache.camel", :artifactId => "camel-core", :version => "2.18"}]
+  #
+  # Returns a list containing the hashes with the bundle information
+  def feature_bundles (name)
+    data = capture(:features_info, name)
+    extract_bundles_from_feature(data)
+  end
+
+  private
+
+  def matcher_to_hash (matcher,data)
+    breaklist = []
+    data.lines.each do |line|
+      m = matcher.match(line)
+      breaklist.push(m) unless m.nil?
+    end
+    breaklist.collect {|m| Hash[m.names.zip(m.captures)]}
+  end
+
+  def extract_bundles_from_feature (data)
+    bundles = []
+    data.lines.each do |l|
+      m = l.match(/.*mvn:(?<GroupId>[\w\.]+)\/(?<ArtifactId>[-\w\.]+)\/(?<Version>[-\d\w\.]+)/)
+      if m then 
+        bundles.push({:groupId 	=> m['GroupId'],
+                       :artifactId	=> m['ArtifactId'],
+                       :version	=> m['Version']})
+      end
+    end
+    bundles
+  end
+
+  def extract_bundle_headers (headers)
+    re = /(.+) = (.+)/
+    header =  {}
+    headers.lines.map {|l| m = l.match(re); if m then header[m[1].strip!] = m[2] end}
+    header
+  end
+end

data/lib/capistrano-karaf/extended.rb

@@ -0,0 +1,125 @@
+# Functions that build on capistrano-karaf/core to provide extra functionality
+require 'capistrano-karaf/core'
+
+module Capistrano_Karaf
+
+  # Remove all feature repositories with a given groupID and artifactID
+  #
+  # groupID - a string containing the groupID
+  # artifactID - a string containing the artifactID
+  # 
+  # Examples
+  #   remove_artifact_urls("repository", "blaat")
+  #   # => nil
+  #
+  # Returns nothing
+  def remove_artifact_urls (groupID, artifactID)
+    urlsToRemove=list_urls.select {|url| url['groupID'] == groupID && url['artifactID'] == artifactID}	
+    urlsToRemove.each do |url|   	
+      remove_url "mvn:#{url["groupID"]}/#{url["artifactID"]}/#{url["version"]}/xml/features"
+    end
+  end
+
+  # Remove a feature in a safe way
+  #
+  # This function verifies if the feature is installed before uninstalling it.  This 
+  # way it tries to avoid an exception on the karaf server.
+  #
+  # name - a string containing the feature name
+  # 
+  # Examples
+  #   feature_uninstall_safe "test"
+  #   # => nil
+  #
+  # Returns nothing  
+  def feature_uninstall_safe (name)
+    feature_uninstall name unless !feature_installed? name
+  end
+
+  # Verify if a bundle is a fragment bundle
+  #
+  # bundleId - a number containing the bundleId
+  # 
+  # Examples
+  #   fragment_bundle? 101
+  #   # => false
+  #
+  # Returns a boolean
+  def fragment_bundle? (bundleId)
+    headers(bundleId).lines.any? {|l| l.match('^Fragment-Host.*')}
+  end
+
+  # Wait till all bundle return true for the specified predicate ( or the timeout is exceeded )
+  #
+  # pred - a block that can be used as predicate
+  #
+  # Optional parameters:
+  # :timeout - a number containing the timeout in seconds ( defaults to 60 )
+  # :sleeptime - a number containing the timeout between tries in seconds ( defaults to 5 )
+  # 
+  # Examples
+  #   wait_for_all_bundles {|b| b[:context] == "STARTED"}
+  #   # => nil
+  #
+  # Returns nothing
+  def wait_for_all_bundles (args={}, &pred)
+    args = {:timeout => 60, :sleeptime => 5}.merge(args)
+    timeout = Time.now + args[:timeout]
+    
+    until Time.now > timeout or list_bundles.all? { |b| pred.call b} 
+      puts "Some bundles are still failing the predicate"
+      sleep args[:sleeptime]
+    end
+  end
+
+  # Wait till the predicate passes for a bundle
+  #
+  # pred - a block that can be used as predicate
+  #
+  # Optional parameters:
+  # :timeout - a number containing the timeout in seconds ( defaults to 60 )
+  # :sleeptime - a number containing the timeout between tries in seconds ( defaults to 5 )
+  # 
+  # Examples
+  #   wait_for_all_bundle {|b| b[:context] == "STARTED"}
+  #   # => nil
+  #
+  # Returns nothing
+  def wait_for_bundle (args={}, &pred)
+    args = {:timeout => 60, :sleeptime => 5}.merge(args)
+    timeout = Time.now + args[:timeout]
+    
+    while Time.now < timeout and list_bundles.none? { |b| pred.call b} 
+      puts "Bundle not yet started"
+      sleep args[:sleeptime]
+    end
+  end
+
+  # Verify if a feature is installed
+  #
+  # name - a string containing the name of the feature
+  # 
+  # Examples
+  #   feature_installed? "camel-core"
+  #   # => true
+  #
+  # Returns true if the feature is installed
+  def feature_installed? (name)
+    feature = list_features.find {|f| f['name']==name}
+    feature['status'] == 'installed' unless feature.nil?
+  end
+
+  # Verify if a the bundle context is started
+  #
+  # name - a string containing the name of the bundle
+  # 
+  # Examples
+  #   started? "camel-core"
+  #   # => true
+  #
+  # Returns true if the bundle is started
+  def started? (name)
+    bundle = list_bundles.find {|b| b[:name] == name}
+    bundle[0][:context] == 'Started'
+  end
+end

data/lib/capistrano-karaf.rb

@@ -1,202 +1,17 @@
-require 'sshkit'
+require 'capistrano-karaf/core'
+require 'capistrano-karaf/extended'
 
-SSHKit.config.command_map[:features_addurl] = 'features:addurl'
-SSHKit.config.command_map[:features_listurl] = 'features:listurl'
-SSHKit.config.command_map[:features_removeurl] = 'features:removeurl'
-SSHKit.config.command_map[:features_refreshurl] = 'features:refreshurl'
-SSHKit.config.command_map[:features_install] = 'features:install'
-SSHKit.config.command_map[:features_uninstall] = 'features:uninstall'
-SSHKit.config.command_map[:features_list] = 'features:list'
-SSHKit.config.command_map[:features_info] = 'features:info'
-SSHKit.config.command_map[:headers] = 'headers'
-SSHKit.config.command_map[:list] = 'osgi:list'
-SSHKit.config.command_map[:log_set] = 'log:set'
-SSHKit.config.command_map[:stop] = 'osgi:stop'
-SSHKit.config.command_map[:start] = 'osgi:start'
-SSHKit.config.command_map[:uninstall] = 'osgi:uninstall'
+include Capistrano_Karaf
 
-def add_url (url)
-    execute(:features_addurl, url)
-end
 
 
-def remove_artifact_urls (groupID, artifactID)
-   urlsToRemove=list_urls.select {|url| url['groupID']==groupID&&url['artifactID']==artifactID}	
-   urlsToRemove.each do |url|   	
-	remove_url ("mvn:#{url["groupID"]}/#{url["artifactID"]}/#{url["version"]}/xml/features")
-   end
-end
 
-def remove_url (url)
-    execute(:features_removeurl, url)
-end
 
-def features_refreshurl
-    execute(:features_refreshurl)
-end
 
-def feature_install (name)
-    execute(:features_install, name)
-end
 
-def feature_uninstall_safe (name)
-    if (feature_installed? (name))
-	execute(:features_uninstall, name)
-    else
-	puts "features:#{name} is not installed so does not need to uninstall it"
-    end
-end
 
-def feature_uninstall (name)
-	execute(:features_uninstall, name)
-end
 
-def log_set (level)
-    execute(:log_set, level)
-end
 
-def start (bundleId)
-    execute(:start, bundleId)
-end
 
-def stop (bundleId)
-    execute(:stop, bundleId)
-end
 
-def uninstall (bundleId)
-    execute(:uninstall, bundleId)
-end
 
-def fragment_bundle? (bundleId)
-    headers = capture(:headers)
-    headers.lines.any? {|l| l.match('^Fragment-Host.*')}
-end
-
-def break_listing (matcher,data)
-    breaklist = []
-  data.lines.each do |line|
-    m = matcher.match(line)
-    if m then
-      breaklist.push(m)
-    end
-  end
-  breaklist.collect {|m| Hash[m.names.zip(m.captures)]}
-end
-
-def list_urls ()
-  url_line_matcher = %r{
-				(?<status> \w+){0}
-				(?<groupID> [\d\w\.\-]+){0}
-				(?<artifactID> [\w\.\-]+){0}
-				(?<version> [\w\.\-]+){0} 
-			\s*\g<status>\s*mvn\:\g<groupID>\/\g<artifactID>\/\g<version>.*
-				}x
-  data=capture(:features_listurl)
-  break_listing url_line_matcher,data
-end
-
-def list_features ()
-  feature_line_matcher = %r{
-				(?<status> \w+){0}
-				(?<version> [\d\w\-\.\s]+){0}
-				(?<name> [\w\-\:]+){0}
-				(?<repository> [\w\-\s\:\.]+){0}
-			^\[\s*\g<status>\s*\]\s\[\s*\g<version>\s*\]\s*\g<name>\s*\g<repository>}x
-  data=capture(:features_list)
-  break_listing feature_line_matcher,data
-end
-
-def list_bundles ()
-  bundle_line_matcher = %r{(?<id> \d+){0}
-                           (?<status> \w+){0}
-                           (?<blueprint> \w*){0}
-                           (?<context> \w*){0}
-                           (?<level> \d+){0}
-                           (?<name> [\w\s\-\:]+){0}
-                           (?<version> .+){0}
-
-                           ^\[\s*\g<id>\]\s\[\s*\g<status>\s*\]\s\[\s*\g<blueprint>\s*\]\s\[\s*\g<context>\s*\]\s\[\s*\g<level>\s*\]\s\g<name>\s\(\g<version>\)
-                          }x
-      
-  data = capture(:list)
-
-  break_listing bundle_line_matcher,data
-end
-
-def wait_for_all_bundles (args={}, &pred)
-  args = {:timeout => 60, :sleeptime => 1}.merge(args)
-  timeout = Time.now + args[:timeout]
-  
-  until Time.now > timeout or list_bundles.all? { |b| pred.call b} 
-    puts "Some bundles are still failing the predicate"
-    sleep args[:sleeptime]
-  end
-end
-
-def feature_installed? (name)
-  feature=list_features.find {|f| f['name']==name}
-  feature['status']=='installed' unless feature.nil?
-end
-
-def wait_for_bundle (args={}, &pred)
-  args = {:timeout => 60, :sleeptime => 1}.merge(args)
-  timeout = Time.now + args[:timeout]
-
-  while Time.now < timeout and list_bundles.none? { |b| pred.call b} 
-    puts "Bundle not yet started"
-    sleep args[:sleeptime]
-  end
-end
-
-
-def started? (name)
-  bundle = list_bundles.find {|b| b[:name] == name}
-  bundle[0][:context] == 'Started'
-end
-
-def list ()
-    capture(:features_list)
-end
-
-def headers (bundle)
-    data = capture(:headers, bundle)
-    extract_bundle_headers(data)
-end
-
-def feature_bundles (name)
-    data = capture(:features_info, name)
-    extract_bundles_from_feature(data)
-end
-
-def feature_bundles_numbers (name)
-  bundles = list_bundles
-  bundleIds = bundles.map {|bundle| bundle[:id]}
-  bundleHeaders = bundleIds.map {|bundleId| headers(bundleId).store(:bundleId, bundleId)}
-  featureBundles = feature_bundles(name)
-  bundlesInFeature = bundles.select {|b| find_feature_bundle(featureBundles, b[:artifactId], b[:version] != nil)}
-  bundlesInFeature.map {|b| b[:id]}  					  
-end
-
-def find_feature_bundle (featureBundles, name, version)
-  featureBundles.select {|fb| fb["Bundle-SymbolicName"] == name && fb["Bundle-Version"] == version }
-end
-
-def extract_bundle_headers (headers)
-  re = /(.+) = (.+)/
-  header =  {}
-  headers.lines.map {|l| m = l.match(re); if m then header[m[1].strip!] = m[2] end}
-  header
-end
-
-def extract_bundles_from_feature (data)
-  bundles = []
-  data.lines.each do |l|
-    m = l.match(/.*mvn:(?<GroupId>[\w\.]+)\/(?<ArtifactId>[-\w\.]+)\/(?<Version>[-\d\w\.]+)/)
-    if m then 
-      bundles.push({:groupId 	=> m['GroupId'],
-		    :artifactId	=> m['ArtifactId'],
-		    :version	=> m['Version']})
-    end
-  end
-  bundles
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-karaf
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: '1.3'
   prerelease: 
 platform: ruby
 authors:
@@ -18,6 +18,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/capistrano-karaf.rb
+- lib/capistrano-karaf/core.rb
+- lib/capistrano-karaf/extended.rb
 homepage: http://github.com/bhoflack/capistrano-karaf
 licenses:
 - bsd