rubysdk 0.0.1.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b68c1b1d1dd1f48ea982f1f78a1a2f9faf9bf4757cdd8b6e0abba92b1b408ca4
+  data.tar.gz: 24c597c5ce8ccc0e2c4fc8993e2644f0e730e1bc64559bb36dbb9c4f704bec71
+SHA512:
+  metadata.gz: 3d06348ec15a34af4294e5697a26980a42aaa2bd5a939d7a9f3286bfa7e3b44bed6172cdf7bb445082ea41aa4e11d08e936f05c782045113d066d8519ec841de
+  data.tar.gz: 06750cacb7b562dc4b03195442928a8bde0b365bb43e8f733b4ad8a158d0e7782e433c6eafcb527bee14c7af6f56687a50ef6936ea19a7a250f37ff919363ed5

data/lib/interface/interface.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+module Interface
+  class Job
+    attr_accessor :handler, :title, :desc, :dependson, :args, :interaction
+    
+    def initialize(handler=nil, title="", desc="", dependson=[], args=[], interaction=nil)
+      @handler = handler
+      @title = title
+      @desc = desc
+      @dependson = dependson
+      @args = args
+      @interaction = interaction
+    end
+  end
+
+  class Argument
+    attr_accessor :desc, :type, :key, :value
+    
+    def initialize(desc="", type=nil, key="", value="")
+      @desc = desc
+      @type = type
+      @key = key
+      @value = value
+    end
+  end
+
+  class ManualInteraction
+    attr_accessor :desc, :type, :value
+    
+    def initialize(desc="", type=nil, value="")
+      @desc = desc
+      @type = type
+      @value = value
+    end
+  end
+
+  class JobsWrapper 
+    attr_accessor :handler, :job
+    
+    def initialize(handler=nil, job=nil)
+      @handler = handler
+      @job = job
+    end
+  end
+
+  class ErrorExitPipeline < StandardError
+  end
+end
+

data/lib/proto/plugin_pb.rb

@@ -0,0 +1,42 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: plugin.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "proto.Job" do
+    optional :unique_id, :uint32, 1
+    optional :title, :string, 2
+    optional :description, :string, 3
+    repeated :dependson, :uint32, 4
+    repeated :args, :message, 5, "proto.Argument"
+    optional :interaction, :message, 6, "proto.ManualInteraction"
+  end
+  add_message "proto.Argument" do
+    optional :description, :string, 1
+    optional :type, :string, 2
+    optional :key, :string, 3
+    optional :value, :string, 4
+  end
+  add_message "proto.ManualInteraction" do
+    optional :description, :string, 1
+    optional :type, :string, 2
+    optional :value, :string, 3
+  end
+  add_message "proto.JobResult" do
+    optional :unique_id, :uint32, 1
+    optional :failed, :bool, 2
+    optional :exit_pipeline, :bool, 3
+    optional :message, :string, 4
+  end
+  add_message "proto.Empty" do
+  end
+end
+
+module Proto
+  Job = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.Job").msgclass
+  Argument = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.Argument").msgclass
+  ManualInteraction = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.ManualInteraction").msgclass
+  JobResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.JobResult").msgclass
+  Empty = Google::Protobuf::DescriptorPool.generated_pool.lookup("proto.Empty").msgclass
+end

data/lib/proto/plugin_services_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: plugin.proto for package 'proto'
+# Original file comments:
+# plugin.proto
+# Defines the gRPC interface between gaia and the user defined
+# pipelines (plugins). All rpc Methods are called from Gaia and
+# executed in the plugin. 
+#
+
+require 'grpc'
+require 'plugin_pb'
+
+module Proto
+  module Plugin
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'proto.Plugin'
+
+      # GetJobs returns a stream of Job objects.
+      # Used to expose jobs to gaia.
+      rpc :GetJobs, Empty, stream(Job)
+      # ExecuteJob signals the plugin to execute the given job.
+      # Used to execute one job from a pipeline.
+      rpc :ExecuteJob, Job, JobResult
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/rubysdk.rb

@@ -0,0 +1,169 @@
+this_dir = File.expand_path(File.dirname(__FILE__))
+proto_dir = File.join(this_dir, 'proto')
+interface_dir = File.join(this_dir, 'interface')
+$LOAD_PATH.unshift(proto_dir) unless $LOAD_PATH.include?(proto_dir)
+$LOAD_PATH.unshift(interface_dir) unless $LOAD_PATH.include?(interface_dir)
+
+require 'grpc'
+require 'fnv'
+require 'plugin_services_pb'
+require 'interface'
+
+module RubySDK
+  # GRPCServer provides an implementation of the Plugin service.
+  class GRPCServer < Proto::Plugin::Service
+    def initialize(cached_jobs)
+      @cached_jobs = cached_jobs
+    end
+
+    # GetJobs returns all registered jobs.
+    def GetJobs(empty)
+      @cached_jobs.each { |job| yield job.job }
+    end
+
+    # ExecuteJob executes the given job and returns a result.
+    def ExecuteJob(job)
+      cjob = nil
+      @cached_jobs.each do |cached_job|
+        cjob = cached_job unless cached_job.unique_id == job.unique_id
+      end
+      if cjob == nil
+        JobResult.new(failed: true,
+                      exit_pipeline: true,
+                      message: "job not found in plugin " + job.title)
+        return
+      end
+
+      # Transform arguments
+      args = []
+      job.args.each do |arg|
+        new_arg = Proto::Argument.new(key: arg.key,
+                               value: arg.value)
+        args.push new_arg
+      end
+
+      # Execute job
+      job_result = JobResult.new
+      begin
+        job.handler.call(args)
+      rescue => e
+        # Check if job wants to force exit pipeline.
+        # We will exit the pipeline but not mark it as 'failed'.
+        job_result.failed = true unless e == ErrorExitPipeline
+
+        # Set log message and job id
+        job_result.exit_pipeline = true
+        job_result.message = e.message
+        job_result.unique_id = job.job.unique_id
+      end
+    end
+  end
+
+  # Serve caches the given jobs and starts the gRPC server.
+  # This function should be last called in the plugin main function.
+  def Serve(jobs)
+    include Interface
+
+    # Cache the jobs for later processing.
+    # We have to transform given jobs into suitable proto models.
+    cached_jobs = []
+    jobs.each do |job|
+      # Transform manual interaction
+      manual_interaction = nil
+      if job.interaction != nil
+        manual_interaction = ManualInteraction.new(description: job.interaction.desc,
+                                                   type: job.interaction.type,
+                                                   value: job.interaction.value)
+      end
+
+      # Transform arguments
+      args = []
+      if job.args != nil
+        job.args.each do |arg|
+          trans_arg = Proto::Argument.new(description: arg.desc,
+                                          type: arg.type,
+                                          key: arg.key,
+                                          value: arg.value)
+
+          args.push trans_arg
+        end
+      end
+
+      # Create proto job object
+      proto_job = Proto::Job.new(unique_id: FNV.new.fnv1a_32(job.title),
+                                 title: job.title,
+                                 description: job.title,
+                                 args: args,
+                                 interaction: manual_interaction)
+
+      # Resolve job dependencies
+      if job.dependson != nil
+        proto_job.dependson = Google::Protobuf::RepeatedField.new(:uint32, [])
+        job.dependson.each do |dep_job|
+          dep_found = false
+          jobs.each do |curr_job|
+            if curr_job.title.casecmp(dep_job) == 0
+              proto_job.dependson += FNV.new.fnv1a_32(curr_job.title)
+              dep_found = true
+              break
+            end
+          end
+          
+          raise "job #{job.title} has dependency #{dep_job} which is not declared" unless dep_found == true
+        end
+      end
+
+      # Create wrapper object
+      wrapper_job = JobsWrapper.new(handler: job.handler,
+                                    job: proto_job)
+      cached_jobs.push wrapper_job
+    end
+
+    # Check if two jobs have the same title which is restricted.
+    #dup_map = {}
+    cached_jobs.each do |job|
+      #dup_map[job.job.unique_id] = (map[job.job.unique_id] || 0) + 1
+
+      #if dup_map[job.job.unique_id] > 1
+      #  raise "duplicate job with the title #{job.title} found which is not allowed"
+      #end
+    end
+
+    # Get certificates path from env variables.
+    cert_path = ENV["GAIA_PLUGIN_CERT"]
+    key_path = ENV["GAIA_PLUGIN_KEY"]
+    root_ca_path = ENV["GAIA_PLUGIN_CA_CERT"]
+
+    # Check if all certs are available.
+    raise "cannot find path to certificate" unless File.file?(cert_path)
+    raise "cannot find path to key" unless File.file?(key_path)
+    raise "cannot find path to root CA certificate" unless File.file?(root_ca_path)
+
+    # Implement health service.
+    #health_svc = GRPC::Health::Checker.new
+    #health_svc.add_status("plugin", GRPC::Core::StatusCodes::SERVING)
+
+    # Load certificates and create credentials.
+    credentials = GRPC::Core::ServerCredentials.new(
+      File.read(root_ca_path),
+      [{
+        private_key: File.read(key_path),
+        cert_chain: File.read(cert_path)
+      }],
+      true # force client authentication.
+    )
+
+    # Register gRPC server and handle.
+    host = 'localhost'
+    s = GRPC::RpcServer.new
+    port = s.add_http2_port(host+':0', credentials)
+    s.handle(GRPCServer.new(cached_jobs))
+
+    # Output the address and service name to stdout.
+    # hashicorp go-plugin will use that to establish a connection.
+    puts "1|2|tcp|#{host}:#{port}|grpc"
+    STDOUT.sync = true
+
+    s.run_till_terminated
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rubysdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre1
+platform: ruby
+authors:
+- Michel Vocks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: fnv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 
+email: michelvocks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/interface/interface.rb
+- lib/proto/plugin_pb.rb
+- lib/proto/plugin_services_pb.rb
+- lib/rubysdk.rb
+homepage: https://gaia-pipeline.io
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Gaia pipelines (https://gaia-pipeline.io).
+test_files: []