script_executor 1.6.0 → 1.7.0

data/CHANGES

@@ -100,4 +100,8 @@
 
 == Version 1.6.0
 
-* Upgrade net:ssh, small bug fix.
+* Upgrade net:ssh, small bug fix.
+
+== Version 1.7.0
+
+* Replace simple parsing with parslet-based parsing.

data/Gemfile

@@ -3,18 +3,20 @@ source "https://rubygems.org"
 group :default do
   gem "highline", "~>1.6"
   gem "net-ssh", "~>2.9"
-  gem "text-interpolator", "~>1.0"
+  gem "text-interpolator", "~>1.1"
   gem "json_pure", "~>1.8"
+  gem "parslet"
+  gem 'thor'
 end
 
 group :development do
   gem "gemspec_deps_gen", "~>1.1"
   gem "gemcutter", "~>0.7"
+  gem 'awesome_print'
 end
 
 group :test do
-  gem "rspec"
-  gem "mocha"
+  gem "rspec", "~>3.0"
 end
 
 # group :debug do

data/Gemfile.lock

@@ -1,7 +1,9 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    awesome_print (1.6.1)
+    blankslate (3.1.3)
+    diff-lcs (1.2.5)
     file_utils (1.0.7)
     gemcutter (0.7.1)
     gemspec_deps_gen (1.1.2)
@@ -9,32 +11,39 @@ GEM
       file_utils
     highline (1.6.15)
     json_pure (1.8.1)
-    metaclass (0.0.1)
-    mocha (0.13.1)
-      metaclass (~> 0.0.1)
     net-ssh (2.9.2)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    text-interpolator (1.0.0)
+    parslet (1.7.1)
+      blankslate (>= 2.0, <= 4.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    text-interpolator (1.1.6)
+    thor (0.19.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   gemcutter (~> 0.7)
   gemspec_deps_gen (~> 1.1)
   highline (~> 1.6)
   json_pure (~> 1.8)
-  mocha
   net-ssh (~> 2.9)
-  rspec
-  text-interpolator (~> 1.0)
+  parslet
+  rspec (~> 3.0)
+  text-interpolator (~> 1.1)
+  thor
 
 BUNDLED WITH
    1.10.6

data/lib/script_executor/base_provision.rb

@@ -42,7 +42,7 @@ class BaseProvision
     provision = self
 
     provision.script_list.each do |name, value|
-      title = provision.script_title(value)
+      title = value[:comment]
 
       title = title.nil? ? name : title
 
@@ -73,7 +73,7 @@ class BaseProvision
   end
 
   def run server_info, script_name, params
-    execute(server_info) { evaluate_script_body(script_list[script_name], params, :string) }
+    execute(server_info) { evaluate_script_body(script_list[script_name][:codeLines], params, :string) }
   end
 
   def run_command server_info, command

data/lib/script_executor/script_locator.rb

@@ -1,44 +1,45 @@
 require 'erb'
 require 'text_interpolator'
+require 'script_executor/scripts_parser'
 
 module ScriptLocator
 
   def scripts file
     data = extract_data file
 
-    locate_scripts(data)
+    scripts_parser = ScriptsParser.new
+
+    scripts_parser.parse data
   end
 
   def evaluate_script_body content, env, type=:erb
-    case type
-      when :erb
-        template = ERB.new content
-        template.result(env).strip
+    if content.class == Array
+      content.each_with_index do |el, index|
+        content[index] = evaluate_script_body el, env, type
+      end
+    else
+      case type
+        when :erb
+          template = ERB.new content
+          template.result(env).strip
 
-      when :string
-        interpolator = TextInterpolator.new
+        when :string
+          interpolator = TextInterpolator.new
 
-        result = interpolator.interpolate content, env
+          result = interpolator.interpolate content, env
 
-        puts interpolator.errors if interpolator.errors.size > 0
+          puts interpolator.errors if interpolator.errors.size > 0
 
-        result
-      else
-        interpolator = TextInterpolator.new
+          result
+        else
+          interpolator = TextInterpolator.new
 
-        result = interpolator.interpolate content, env
+          result = interpolator.interpolate content, env
 
-        puts interpolator.errors if interpolator.errors.size > 0
+          puts interpolator.errors if interpolator.errors.size > 0
 
-        result
-    end
-  end
-
-  def script_title script
-    if script[0] == '#'
-      StringIO.new(script[1..-1]).readline.strip
-    else
-      nil
+          result
+      end
     end
   end
 
@@ -52,29 +53,4 @@ module ScriptLocator
     index.nil? ? content : content[index+9..-1]
   end
 
-  def locate_scripts data
-    scripts = {}
-
-    current_key = nil
-
-    stream = StringIO.new data
-
-    stream.each_line do |line|
-      if line =~ /^(\s)*\[[\w\d\s\-\_]*\](\s)*$/
-        marker = line.strip.gsub(/\[[\w\d\s\-\_]*\]/).first
-
-        if !marker.nil? and marker.strip.length > 0
-          key = marker[1..marker.length-2]
-
-          scripts[key] = ""
-          current_key = key
-        end
-      else
-        scripts[current_key] += line if current_key
-      end
-    end
-
-    scripts
-  end
-
 end

data/lib/script_executor/scripts_parser.rb

@@ -0,0 +1,44 @@
+require 'parslet'
+
+require 'script_executor/scripts_transformer'
+
+class ScriptsParser < Parslet::Parser
+  root :language
+
+  # language
+  rule(:language)   { (shebang.as(:shebang).maybe >> ignored.as(:ignored).maybe >> scripts.as(:scripts)).as(:language) }
+
+  rule(:shebang)    { str('#') >> str('!') >> match['\w\d_/\s'].repeat(1) }
+  rule(:ignored)    { comment.repeat }
+  rule(:scripts)    { script.repeat }
+
+  rule(:script)     { emptyLines >> (name >> comment.maybe >> codeLines).as(:script) }
+  rule(:comment)    { emptyLines >> spaces >> (str('#') >> spaces >> (newline.absent? >> any).repeat.as(:comment)) >> newline }
+  rule(:name)       { spaces >> str('[') >> spaces >> spaces >> nameChars.as(:name) >> spaces >> str(']') >> spaces >> newline }
+
+  rule(:codeLines)  { (emptyLines >> codeLine.repeat.maybe >> emptyLines).as(:codeLines) }
+  rule(:codeLine)   { emptyLines >> codeChars.as(:codeLine) >> newline }
+
+  rule(:nameChars)  { match['\w\d_'].repeat(1) }
+  rule(:codeChars)  { match['(.*)\w\d $_#"<>{}\'\/\.%=!\-+/\*|:'].repeat(1) }
+
+  rule(:emptyLines) { emptyLine.repeat }
+  rule(:emptyLine)  { spaces >> newline }
+  rule(:newline)    { str("\n") >> str("\r").maybe }
+
+  rule(:spaces)     { str(' ').repeat }
+
+  def parse content
+    begin
+      parsed_content = super content + "\n"
+
+      # ap parsed_content
+
+      transformer = ScriptsTransformer.new
+
+      transformer.apply(parsed_content)[:scripts]
+    rescue Parslet::ParseFailed => failure
+      puts failure.cause.ascii_tree
+    end
+  end
+end

data/lib/script_executor/scripts_transformer.rb

@@ -0,0 +1,25 @@
+require 'parslet'
+
+class ScriptsTransformer < Parslet::Transform
+  rule(:language => subtree(:language)) do
+    language.delete(:ignored)
+
+    new_scripts = {}
+
+    language[:scripts].each do |script|
+      name = script[:script][:name].to_sym
+      comment = script[:script][:comment].to_s
+      code_lines = script[:script][:codeLines]
+
+      code_lines.each_with_index do |codeLine, index|
+        code_lines[index] = codeLine[:codeLine].to_s
+      end
+
+      new_scripts[name] = {comment: comment, codeLines: code_lines}
+    end
+
+    language[:scripts] = new_scripts
+
+    language
+  end
+end

data/lib/script_executor/version.rb

@@ -1,3 +1,3 @@
 class ScriptExecutor
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/script_executor.gemspec

@@ -19,10 +19,13 @@ Gem::Specification.new do |spec|
   
   spec.add_runtime_dependency "highline", ["~> 1.6"]
   spec.add_runtime_dependency "net-ssh", ["~> 2.9"]
-  spec.add_runtime_dependency "text-interpolator", ["~> 1.0"]
+  spec.add_runtime_dependency "text-interpolator", ["~> 1.1"]
   spec.add_runtime_dependency "json_pure", ["~> 1.8"]
+  spec.add_runtime_dependency "parslet", [">= 0"]
+  spec.add_runtime_dependency "thor", [">= 0"]
   spec.add_development_dependency "gemspec_deps_gen", ["~> 1.1"]
   spec.add_development_dependency "gemcutter", ["~> 0.7"]
+  spec.add_development_dependency "awesome_print", [">= 0"]
 
 end
 

data/spec/base_provision_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+require 'thor'
+require 'script_executor/base_provision'
+
+class ThorClass < Thor
+
+end
+
+describe BaseProvision do
+  describe "#parse" do
+    it "parses content from file" do
+      provision = BaseProvision.new ThorClass, 'spec/support/base.conf.json', ['spec/support/big_script.sh']
+
+      ap provision.script_list
+    end
+  end
+end

data/spec/executable_spec.rb

@@ -1,14 +1,10 @@
-require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'spec_helper'
+require 'rspec/mocks'
 
 require 'executable'
 
-class MyExecutable
-  include Executable
-end
-
-describe MyExecutable do
-
-  subject { MyExecutable.new }
+describe Executable do
+  subject { Object.new.extend Executable }
 
   before :all do
     @password ||= HighLine.new.ask("Enter password for #{ENV['USER']}:  ") { |q| q.echo = '*' }
@@ -114,6 +110,8 @@ describe MyExecutable do
     end
 
     it "should execute commands from :script parameter" do
+      expect_any_instance_of(RemoteCommand).to receive(:execute).and_return 'vagrant'
+
       result = subject.execute @remote_info.merge(:script => "whoami")
 
       expect(result).to eq "vagrant"

data/spec/script_locator_spec.rb

@@ -1,14 +1,10 @@
-require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'spec_helper'
 
 require 'script_locator'
 
-class MyScriptLocator
-  include ScriptLocator
-end
-
-describe MyScriptLocator do
+describe ScriptLocator do
 
-  subject { MyScriptLocator.new }
+  subject { Object.new.extend ScriptLocator }
 
   describe "#scripts" do
     it "reads after __END__" do
@@ -20,7 +16,7 @@ describe MyScriptLocator do
     end
 
     it "reads from file completely if it does not have __END__ tag" do
-      file = File.expand_path('test.conf', File.dirname(__FILE__))
+      file = File.expand_path('support/test.conf', File.dirname(__FILE__))
 
       scripts = subject.scripts(file)
 
@@ -34,22 +30,23 @@ describe MyScriptLocator do
 
       name = "alisa"
 
-      result = subject.evaluate_script_body(scripts['test1'], binding)
+      result = subject.evaluate_script_body(scripts[:test1][:codeLines], binding)
+
+      expect(result.first).to match /#{name}/
 
-      expect(result).to match /#{name}/
-      expect(subject.script_title(scripts['test1'])).to eq "Some description"
+      expect(scripts[:test1][:comment]).to eq "Some description"
     end
 
     it "locates script inside external file and evaluates it as string" do
-      file = File.expand_path('test.conf', File.dirname(__FILE__))
+      file = File.expand_path('support/test.conf', File.dirname(__FILE__))
 
       scripts = subject.scripts(file)
 
       env = {:name => "alisa"}
 
-      result = subject.evaluate_script_body(scripts['test1'], env, :string)
+      result = subject.evaluate_script_body(scripts[:test1][:codeLines], env, :string)
 
-      expect(result).to match /#{env[:name]}/
+      expect(result.first).to match /#{env[:name]}/
     end
   end
 
@@ -64,4 +61,4 @@ echo "<%= name %>"
 
 [test2]
 
-echo "test2"
+echo "test2"

data/spec/scripts_parser_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+require 'script_executor/scripts_parser'
+require 'script_executor/scripts_transformer'
+
+describe ScriptsParser do
+  describe "#parse" do
+    it "parses content from file" do
+      content = File.read('spec/support/big_script.sh')
+      #content = File.read('spec/support/test.conf')
+
+      parsed_content = subject.parse(content)
+
+      ap parsed_content
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
-$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'bundler/setup'
+require 'ap'

data/spec/support/base.conf.json

@@ -0,0 +1,16 @@
+{
+  "node": {
+    "domain": "22.22.22.22", // remote host, see "config.vm.synced_folder"
+    "port": "22",            // default ssh port
+    "user": "vagrant",       // vagrant user name
+    "password": "vagrant",   // vagrant user password
+    "home": "/home/vagrant",
+    "remote": true
+  },
+
+  "project": {
+    "home": "#{node.home}/acceptance_demo",
+    "ruby_version": "2.2.3",
+    "gemset": "acceptance_demo"
+  }
+}

data/spec/support/big_script.sh

@@ -0,0 +1,96 @@
+#!/usr/bin/env bash
+
+[test1]
+# Some description
+
+echo "<%= name %>"
+
+[test2]
+
+echo "test2"
+
+#######################################
+[echo]
+
+echo "Hello world!"
+
+
+#######################################
+[ubuntu_update]
+
+sudo apt-get update
+
+
+#######################################
+[prepare_linux]
+# Updates linux core packages
+
+sudo apt-get update
+
+sudo apt-get install -y curl
+sudo apt-get install -y g++
+sudo apt-get install -y subversion
+sudo apt-get install -y git
+
+# to support rvm
+
+sudo apt-get install -y libreadline6-dev
+sudo apt-get install -y zlib1g-dev
+sudo apt-get install -y libssl-dev
+sudo apt-get install -y libyaml-dev
+sudo apt-get install -y libsqlite3-dev
+sudo apt-get install -y sqlite3
+sudo apt-get install -y autoconf
+sudo apt-get install -y libgdbm-dev
+sudo apt-get install -y libncurses5-dev
+sudo apt-get install -y automake
+sudo apt-get install -y libtool
+sudo apt-get install -y bison
+sudo apt-get install -y pkg-config
+sudo apt-get install -y libffi-dev
+
+
+#######################################
+[rvm]
+# Installs rvm
+
+curl -L https://get.rvm.io | bash
+
+#sudo chown -R vagrant /opt/vagrant_ruby
+
+
+#######################################
+[ruby]
+# Installs ruby
+
+source /usr/local/rvm/scripts/rvm
+
+rvm install ruby-2.2.3
+
+
+#######################################
+[node]
+# Installs node
+
+sudo apt-get install -y node
+
+
+#######################################
+[rbenv]
+# Installs node
+
+sudo apt-get install -y rbenv
+git clone git://github.com/jf/rbenv-gemset.git $HOME/.rbenv/plugins/rbenv-gemset
+
+
+#######################################
+[prepare]
+# to support nokogiri
+sudo apt-get install -y libgmp-dev
+
+# to support capybara-webkit
+sudo apt-get install -y libqt4-dev
+sudo apt-get install -y libqtwebkit-dev
+
+# to support headless
+sudo apt-get install -y xvfb

data/spec/support/test2.conf

@@ -0,0 +1,8 @@
+[test1]
+# Some description
+
+echo "<%= name %>"
+
+[test2]
+
+echo "test2"