RubyGems - pione - Versions diffs - 0.4.0 → 0.4.1 - Mend

pione 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

checksums.yaml +15 -0
data/.gitignore +1 -0
data/History.txt +7 -0
data/example/DeferredChoice/DeferredChoice.pione +14 -7
data/{misc → example/DeferredChoice/bin}/ui.xml +11 -6
data/example/DeferredChoice/pione-package.json +1 -1
data/example/DeferredChoiceWithPage/DeferredChoiceWithPage.pione +47 -0
data/example/DeferredChoiceWithPage/etc/index.html +22 -0
data/example/DeferredChoiceWithPage/pione-package.json +18 -0
data/example/Interaction/Interaction.pione +27 -0
data/example/Interaction/bin/show-environment.cgi +45 -0
data/example/Interaction/etc/.hidden-file.txt +1 -0
data/example/Interaction/etc/cgi.html +46 -0
data/example/Interaction/etc/create-files.html +51 -0
data/example/Interaction/etc/delete-files.html +31 -0
data/example/Interaction/etc/get-files.html +21 -0
data/example/Interaction/etc/index.html +18 -0
data/example/Interaction/etc/list-files.html +36 -0
data/example/Interaction/pione-package.json +24 -0
data/lib/pione/agent/job-manager.rb +19 -3
data/lib/pione/agent/logger.rb +9 -9
data/lib/pione/agent/messenger.rb +3 -2
data/lib/pione/agent/task-worker.rb +32 -10
data/lib/pione/command/option.rb +18 -0
data/lib/pione/command/pione-client.rb +51 -22
data/lib/pione/command/pione-interactive.rb +128 -55
data/lib/pione/command/pione-package-build.rb +3 -3
data/lib/pione/command/pione-task-worker.rb +23 -10
data/lib/pione/command/pione-tuple-space-provider.rb +8 -8
data/lib/pione/command/spawner.rb +28 -1
data/lib/pione/front/interactive-front.rb +76 -0
data/lib/pione/global/interactive-variable.rb +26 -0
data/lib/pione/log/message-log-receiver.rb +4 -2
data/lib/pione/model/task-worker-broker-model.rb +7 -1
data/lib/pione/package/package-archiver.rb +16 -9
data/lib/pione/package/package-handler.rb +6 -0
data/lib/pione/package/package-info.rb +4 -0
data/lib/pione/package/package-reader.rb +2 -4
data/lib/pione/package/package-scanner.rb +23 -3
data/lib/pione/rule-engine.rb +48 -19
data/lib/pione/rule-engine/action-handler.rb +29 -5
data/lib/pione/rule-engine/basic-handler.rb +27 -19
data/lib/pione/test-helper/command-helper.rb +1 -1
data/lib/pione/tuple-space/tuple-definition.yml +2 -3
data/lib/pione/tuple-space/tuple-space-server.rb +8 -0
data/lib/pione/util/cgi.rb +326 -0
data/lib/pione/version.rb +1 -1
data/lib/rootage/normalizer.rb +4 -0
data/lib/rootage/option.rb +11 -4
data/test/agent/spec_logger.rb +0 -1
data/test/agent/spec_messenger.rb +1 -1
data/test/command/spec_pione-client.rb +4 -4
data/test/log/spec_message-log.rb +1 -1
data/test/rule-engine/spec_action-handler.rb +25 -5
data/test/rule-engine/spec_empty-handler.rb +36 -3
data/test/rule-engine/spec_flow-handler.rb +90 -7
metadata +22 -72
data/misc/test-drb-stop-service.rb +0 -34
data/misc/test-many-waiters-client.rb +0 -56
data/misc/test-many-waiters-server.rb +0 -14

data/example/Interaction/etc/list-files.html ADDED

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Interaction Example: List files</title>
+  </head>
+  <body>
+    <h1>POST Method Example</h1>
+    <section>
+      <h2>List with no options</h2>
+      <form action="./" method="POST">
+	<input type="hidden" name="pione-action" value="list" />
+	<button type="submit">List files</button>
+      </form>
+    </section>
+    <section>
+      <h2>List with pione-show-all=true</h2>
+      <form action="./" method="POST">
+	<input type="hidden" name="pione-action" value="list" />
+	<input type="hidden" name="pione-show-all" value="true" />
+	<button type="submit">List files</button>
+      </form>
+    </section>
+    <section>
+      <h2>List with pione-show-all=false</h2>
+      <form action="./" method="POST">
+	<input type="hidden" name="pione-action" value="list" />
+	<input type="hidden" name="pione-show-all" value="false" />
+	<button type="submit">List files</button>
+      </form>
+    </section>
+  </body>
+</html>

data/example/Interaction/pione-package.json ADDED

@@ -0,0 +1,24 @@
+{
+  "PackageName": "Interaction",
+  "Parents": [
+  ],
+  "Documents": [
+    "Interaction.pione"
+  ],
+  "Scenarios": [
+  ],
+  "Bins": [
+    "bin/show-environment.cgi"
+  ],
+  "Etcs": [
+    "etc/create-files.html",
+    "etc/list-files.html",
+    "etc/get-files.html",
+    "etc/index.html",
+    "etc/delete-files.html",
+    "etc/cgi.html",
+    "etc/.hidden-file.txt"
+  ]
+}

data/lib/pione/agent/job-manager.rb CHANGED

@@ -54,6 +54,11 @@ module Pione
         # share my environment
         write(TupleSpace::EnvTuple.new(@env.dumpable)) # need to be dumpable
+        # collect tuple space attributes
+        @request_from = @tuple_space.attribute("request_from")
+        @session_id = @tuple_space.attribute("session_id")
+        @client_ui = @tuple_space.attribute("client_ui")
       end
       def transit_to_sleep
@@ -69,9 +74,20 @@ module Pione
         else
           # call root rule of the current package
           list.each do |env, inputs|
-            package_id = @env.current_package_id
-            handler = RuleEngine.make(@tuple_space, @env, package_id, "Root", inputs, Lang::ParameterSet.new, 'root', nil)
-            handler.handle
+            engine_param = {
+              :tuple_space  => @tuple_space,
+              :env          => @env,
+              :package_id   => @env.current_package_id,
+              :rule_name    => "Root",
+              :inputs       => inputs,
+              :param_set    => Lang::ParameterSet.new,
+              :domain_id    => 'root',
+              :caller_id    => nil,
+              :request_from => @request_from,
+              :session_id   => @session_id,
+              :client_ui    => @client_ui
+            }
+            RuleEngine.make(engine_param).handle
           end
         end

data/lib/pione/agent/logger.rb CHANGED

@@ -5,15 +5,15 @@ module Pione
     class Logger < TupleSpaceClient
       set_agent_type :logger, self
-      attr_reader :log_location    # location of log file
-      attr_reader :output_location # output location
+      attr_reader :log_location       # location of log file
+      attr_reader :temporary_location # temporary location
       # Create a logger agent.
       def initialize(tuple_space, location)
         super(tuple_space)
         @log_id = Time.now.iso8601(3)
         @log_location = location.directory? ? location + "pione-process.log" : location
-        @output_location = get_output_location
+        @temporary_location = get_temporary_location
       end
       #
@@ -40,7 +40,7 @@ module Pione
         end
       end
-      # Copy from output to log when log and output are different.
+      # Copy from temporary location to log location.
       def transit_to_terminate
         begin
           write_records(take_all!(TupleSpace::ProcessLogTuple.any))
@@ -48,8 +48,8 @@ module Pione
           # logger is terminated at last in termination processes, so tuple space may be closed
           Log::SystemLog.warn("logger agent failed to take process logs.", self, e)
         end
-        if @log_location != @output_location
-          @output_location.copy(@log_location)
+        if @log_location != @temporary_location
+          @temporary_location.copy(@log_location)
         end
         super
       end
@@ -63,13 +63,13 @@ module Pione
       # Write records with sorting.
       def write_records(tuples)
         tuples.sort{|a,b| a.timestamp <=> b.timestamp}.each do |tuple|
-          @output_location.append tuple.message.format(@log_id) + "\n"
+          @temporary_location.append tuple.message.format(@log_id) + "\n"
         end
       end
-      # Get the output location. If the log location is not suportted append
+      # Get the temporary location. If the log location doesn't suport append
       # writing, output location is in local filesystem.
-      def get_output_location
+      def get_temporary_location
         if @log_location.real_appendable?
           @log_location
         else

data/lib/pione/agent/messenger.rb CHANGED

@@ -8,11 +8,12 @@ module Pione
       #   tuple space
       # @param receiver [Log::MessageLogReceiver]
       #   message log receiver
-      def initialize(tuple_space, receiver)
+      def initialize(tuple_space, receiver, session_id)
         super(tuple_space)
         # message log receiver
         @receiver = receiver
+        @session_id = session_id
       end
       #
@@ -34,7 +35,7 @@ module Pione
         tuples.sort{|a,b| a.timestamp <=> b.timestamp}.each do |tuple|
           tuple.contents.tap do |contents|
             (contents.kind_of?(String) ? [contents] : contents).each do |msg|
-              @receiver.receive(msg, tuple.level, tuple.head, tuple.color)
+              @receiver.receive(msg, tuple.level, tuple.head, tuple.color, @session_id)
             end
           end
         end

data/lib/pione/agent/task-worker.rb CHANGED

@@ -12,6 +12,17 @@ module Pione
       attr_reader :execution_thread
       attr_accessor :once # the agent will be killed at task completion if true
+      # @param [Pione::TupleSpace::TupleSpaceServer] tuple_space
+      #   tuple space
+      # @param [String] features
+      #   features that the task worker has
+      # @param [Hash] option
+      # @option option [] :env
+      #   a environment object
+      # @option option [String] :session_id
+      #   session ID
+      # @option option [URI] :request_from
+      #   URI that a client requested from
       def initialize(tuple_space, features, env=nil)
         super(tuple_space)
         @tuple_space = tuple_space
@@ -43,6 +54,12 @@ module Pione
       # transitions
       #
+      def transit_to_init
+        @request_from = @tuple_space.attribute("request_from")
+        @session_id = @tuple_space.attribute("session_id")
+        @client_ui = @tuple_space.attribute("client_ui")
+      end
       # Take a task and turn it to foreground.
       def transit_to_take_task
         return take(TupleSpace::TaskTuple.new(features: @features))
@@ -122,16 +139,21 @@ module Pione
       # Make an engine from the task.
       def make_engine(task)
-        RuleEngine.make(
-          @tuple_space,
-          @env,
-          task.package_id,
-          task.rule_name,
-          task.inputs,
-          task.param_set,
-          task.domain_id,
-          task.caller_id
-        )
+        param = {
+          :tuple_space  => @tuple_space,
+          :env          => @env,
+          :package_id   => task.package_id,
+          :rule_name    => task.rule_name,
+          :inputs       => task.inputs,
+          :param_set    => task.param_set,
+          :domain_id    => task.domain_id,
+          :caller_id    => task.caller_id,
+          :request_from => @request_from,
+          :session_id   => @session_id,
+          :client_ui    => @client_ui
+        }
+        RuleEngine.make(param)
       end
       # Spawn child task worker. This method repeats to create a child agent

data/lib/pione/command/option.rb CHANGED

@@ -207,5 +207,23 @@ module Pione
         end
       end
     end
+    module SessionOption
+      extend Rootage::OptionCollection
+      define(:request_from) do |item|
+        item.type = :uri
+        item.long = "--request-from"
+        item.arg  = "URI"
+        item.desc = "URI that the client requested the job from"
+      end
+      define(:session_id) do |item|
+        item.type = :string
+        item.long = "--session-id"
+        item.arg  = "ID"
+        item.desc = "Session id of the job"
+      end
+    end
   end
 end

data/lib/pione/command/pione-client.rb CHANGED

@@ -49,6 +49,9 @@ module Pione
       option(NotificationOption.notification_targets)
       option(NotificationOption.notification_receivers)
+      option(SessionOption.request_from)
+      option(SessionOption.session_id)
       option(:input_location) do |item|
         item.type  = :location
         item.short = '-i'
@@ -57,23 +60,23 @@ module Pione
         item.desc  = 'Set input directory'
       end
-      option(:output_location) do |item|
+      option(:base_location) do |item|
         item.type  = :location
-        item.short = '-o'
-        item.long  = '--output'
+        item.short = '-b'
+        item.long  = '--base'
         item.arg   = 'LOCATION'
-        item.desc  = 'Set output directory'
-        item.init  = "local:./output/"
+        item.desc  = 'Set process base location'
+        item.init  = "local:./process/"
         item.process do |location|
-          model[:output_location] = location
+          model[:base_location] = location
           if location.scheme == "myftp"
             model[:myftp] = URI.parse(uri).normalize
           end
         end
         item.exception(ArgumentError) do |e, val|
-          raise OptionError.new(cmd, "output location '%s' is bad in %s" % [uri, cmd.name])
+          raise OptionError.new(cmd, "base location '%s' is bad in %s" % [uri, cmd.name])
         end
       end
@@ -135,7 +138,7 @@ module Pione
         item.arg  = '[SCENARIO]'
         item.desc = 'rehearse the scenario'
-        item.assign {|val| val.size != 0 ? val : :anything}
+        item.assign {|val| not(val.nil?) and val.size != 0 ? val : :anything}
       end
       option(:timeout) do |item|
@@ -145,6 +148,13 @@ module Pione
         item.desc = 'timeout processing after SEC'
       end
+      option(:client_ui) do |item|
+        item.type = :string
+        item.long = "--client-ui"
+        item.arg  = "TYPE"
+        item.desc = "Type of the client's user interface"
+      end
       option_post(:validate_task_worker_size) do |item|
         item.desc = "Validate task worker size"
         item.process do
@@ -173,7 +183,7 @@ module Pione
         seq << :spawner_thread_group
         seq << :ftp_server
         seq << :tuple_space
-        seq << :output_location
+        seq << :base_location
         seq << :lang_environment
         seq << :package
         seq << :scenario
@@ -217,18 +227,32 @@ module Pione
           # write tuples
           model[:tuple_space].write(TupleSpace::ProcessInfoTuple.new('standalone', 'Standalone'))
           model[:tuple_space].write(TupleSpace::DryRunTuple.new(model[:dry_run]))
+          if model[:request_from]
+            model[:tuple_space].write(TupleSpace::AttributeTuple.new("request_from", model[:request_from]))
+          end
+          if model[:session_id]
+            model[:tuple_space].write(TupleSpace::AttributeTuple.new("session_id", model[:session_id]))
+          end
+          if model[:client_ui]
+            model[:tuple_space].write(TupleSpace::AttributeTuple.new("client_ui", model[:client_ui]))
+          else
+            model[:tuple_space].write(TupleSpace::AttributeTuple.new("client_ui", "GUI"))
+          end
         end
       end
-      setup(:output_location) do |item|
-        item.desc = "Setup output location"
+      setup(:base_location) do |item|
+        item.desc = "Setup base location"
         # setup location
         item.process do
-          case model[:output_location]
+          case model[:base_location]
           when Location::LocalLocation
-            model[:output_location] = Location[model[:output_location].path.expand_path]
-            model[:output_location].path.mkpath
+            model[:base_location] = Location[model[:base_location].path.expand_path]
+            model[:base_location].path.mkpath
           when Location::DropboxLocation
             Location::DropboxLocation.setup_for_cui_client(tuple_space_server)
           end
@@ -236,13 +260,13 @@ module Pione
         # mkdir
         item.process do
-          test(not(model[:output_location].exist?))
-          model[:output_location].mkdir
+          test(not(model[:base_location].exist?))
+          model[:base_location].mkdir
         end
         # set base location into tuple space
         item.process do
-          model[:tuple_space].set_base_location(model[:output_location])
+          model[:tuple_space].set_base_location(model[:base_location])
         end
       end
@@ -270,7 +294,7 @@ module Pione
         # upload the package
         item.process do
-          model[:package_handler].upload(model[:output_location] + "package")
+          model[:package_handler].upload(model[:base_location] + "package")
         end
         item.exception(Package::InvalidPackage) do |e|
@@ -349,7 +373,7 @@ module Pione
             receiver = Log::CUIMessageLogReceiver.new
           end
-          Agent::Messenger.new(model[:tuple_space], receiver).start
+          Agent::Messenger.new(model[:tuple_space], receiver, model[:session_id]).start
         end
       end
@@ -358,7 +382,7 @@ module Pione
         item.desc = "Start a logger agent"
         item.assign(:logger) do
-          Agent::Logger.start(model[:tuple_space], model[:output_location])
+          Agent::Logger.start(model[:tuple_space], model[:base_location])
         end
       end
@@ -412,7 +436,12 @@ module Pione
         item.desc = "Spawn a task worker"
         item.process do
-          Command::PioneTaskWorker.spawn(model, Global.features, model[:tuple_space].uuid)
+          param = {
+            :features => Global.features,
+            :tuple_space_id => model[:tuple_space].uuid
+          }
+          Command::PioneTaskWorker.spawn(model, param)
         end
         item.exception(SpawnError) do |e|
@@ -506,7 +535,7 @@ module Pione
           pscenario = test(model[:package_handler].find_scenario(model[:rehearse]))
-          errors = pscenario.validate(model[:output_location])
+          errors = pscenario.validate(model[:base_location])
           if errors.empty?
             Log::SystemLog.info "Rehearsal Result: Succeeded"
           else

data/lib/pione/command/pione-interactive.rb CHANGED

@@ -1,3 +1,7 @@
+require 'pione/global/interactive-variable'
+require 'pione/front/interactive-front'
+require 'pione/util/cgi'
 module Pione
   module Command
     class PioneInteractive < BasicCommand
@@ -7,11 +11,6 @@ module Pione
       require 'rexml/document'
-      # debug mode only
-      unless ENV["PIONE_JOB_ID"]
-        require 'webrick'
-      end
       #
       # informations
       #
@@ -19,40 +18,43 @@ module Pione
       define(:toplevel, true)
       define(:name, "pione-interactive")
       define(:desc, "interactive action handler")
+      define(:front, Front::InteractiveFront)
       #
       # arguments
       #
-      argument(:xml) do |item|
-        item.type    = :location
-        item.desc    = "UI definition file"
-        item.missing = "There are no definition file."
+      argument(:type) do |item|
+        item.type = :symbol_downcase
+        item.desc = "View type"
       end
       #
       # options
       #
-      option(:ui) do |item|
-        item.type = :symbol_downcase
-        item.long = "--ui"
-        item.arg  = "NAME"
-        item.desc = "User interface name"
+      option(:public) do |item|
+        item.desc = "public directory for interactive operation pages"
+        item.type = :location
+        item.long = "--public"
+        item.arg  = "DIR"
+        item.init = "./public"
+        item.default = "./"
       end
-      option_post(:validate_ui) do |item|
-        item.desc = "Validate UI name"
-        item.process do
-          test(model[:ui].nil?)
-          raise Rootage::OptionError.new(cmd, "No UI name")
-        end
+      option(:output) do |item|
+        item.desc  = "Output file"
+        item.type  = :location
+        item.long  = "--output"
+        item.short = "-o"
+        item.arg   = "FILE"
+      end
-        item.process do
-          test(model[:ui] != :browser)
-          raise Rootage::OptionError.new(cmd, "Unknown UI name: %s" % model[:ui])
-        end
+      option(:timeout) do |item|
+        item.desc = "timeout after the second"
+        item.type = :integer
+        item.long = "--timeout"
+        item.arg  = "SEC"
       end
       #
@@ -60,49 +62,75 @@ module Pione
       #
       phase(:setup) do |seq|
-        seq << :ui_definition
+        seq << :session_id
+        seq << :interaction_id
       end
-      setup(:ui_definition) do |item|
-        item.desc = "Extract informations from UI definition"
+      setup(:session_id) do |item|
+        item.desc = "Setup session ID"
         item.process do
-          fm = REXML::Formatters::Default.new
-          # create a document
-          doc = REXML::Document.new(model[:xml].read)
-          # get the prefix of root element(e.g. "pione")
-          prefix = doc.root.prefix
-          prefix = prefix ? prefix + ":" : ""
-          # get embeded contents
-          content = REXML::XPath.first(doc, "/#{prefix}interactive/#{prefix}content")
-          model[:content] = ""
-          content.elements.each {|e| fm.write(e, model[:content])}
-          # get embeded script
-          script = REXML::XPath.first(doc, "/#{prefix}interactive/#{prefix}script")
-          model[:script] = script.text
+          if ENV["PIONE_SESSION_ID"]
+            model[:session_id] = ENV["PIONE_SESSION_ID"]
+            model[:request_from] = ENV["PIONE_REQUEST_FROM"]
+          else
+            # debug mode only
+            require 'webrick'
+          end
         end
       end
+      setup(:interaction_id) do |item|
+        item.desc = "Setup interaction ID"
+        item.assign { Util::UUID.generate }
+      end
       #
       # command lifecycle: execution phase
       #
       phase(:execution) do |seq|
-        if ENV["PIONE_JOB_ID"]
-          seq << :connect_webclient
-        else
-          # debug mode
-          seq << :debug_mode
-          seq << :print_result
-        end
+        seq << :render
+        seq << :print_result
       end
-      execution(:debug_mode) do |item|
-        item.desc = "Launch a debug server"
+      execution(:render) do |item|
+        item.desc = "Render a widget"
+        # this is called from webclient
+        item.process do
+          test(model[:session_id])
+          test(model[:request_from])
+          webclient = DRb::DRbObject.new_with_uri(model[:request_from])
+          case model[:type]
+          when :browser
+            result, status = webclient.request_interaction(
+              model[:session_id],
+              model[:interaction_id],
+              :browser,
+              {:front_address => model[:front].uri.to_s})
+          when :dialog
+            result, status = webclient.request_interaction(
+              model[:session_id],
+              model[:interaction_id],
+              :dialog,
+              {:content => model[:content], :script => model[:script]})
+          else
+            cmd.abort('Type "%s" is unknown.' % model[:type])
+          end
+          model[:result] = result
+          # command fails if the status is "failure"
+          if status == "failure"
+            self.exit_status = false
+          end
+        end
+        # this is called from the exception of webclient
         item.process do
+          test(not(model[:session_id] and model[:request_from]))
+          test(model[:definition])
           begin
             template = <<HTML
 <!DOCTYPE html>
@@ -174,13 +202,58 @@ HTML
             end
           end
         end
+        # this is called from the exception of webclient
+        item.process do
+          test(not(model[:session_id] and model[:request_from]))
+          test(model[:type] == :page)
+          begin
+            model[:debug_server] = WEBrick::HTTPServer.new(
+              :Port => 8080, :Logger => WEBrick::Log.new($stderr)
+            )
+            # page handler on '/'
+            model[:debug_server].mount("/", WEBrick::HTTPServlet::FileHandler, model[:public].path.to_s)
+            # finish
+            model[:debug_server].mount_proc("/finish") do |req, res|
+              model[:result] = req.query["result"]
+              model[:debug_server].shutdown
+            end
+            # shutdown handler on '/shutdown'
+            model[:debug_server].mount_proc("/shutdown") do |req, res|
+              model[:result] = req.body
+              model[:debug_server].shutdown
+            end
+            # `Kernel.trap` can take multiple INT handlers
+            trap("INT") { model[:debug_server].shutdown }
+            # show the location
+            $stderr.puts "See http://localhost:8080"
+            # start the debug server
+            model[:debug_server].start
+          ensure
+            if model[:debug_server]
+              model[:debug_server].shutdown
+            end
+          end
+        end
       end
       # Print a result string of interactive action to stdout.
       execution(:print_result) do |item|
         item.desc = "Print a result string."
         item.process do
-          $stdout.print model[:result]
+          if model[:output]
+            model[:output].write model[:result]
+          else
+            $stdout.print model[:result]
+          end
         end
       end
     end