odania 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 873375ded1a7a7134b41490f71ac169daff40d22
-  data.tar.gz: 583057469c6cb16fb84bee391f0a0b5784ff9107
+  metadata.gz: d27b77aee7f7a7879b1bbee2a376f58f1654b812
+  data.tar.gz: c5ceaebf77e1071d407805175c951b16d46d5e3a
 SHA512:
-  metadata.gz: 588cc513d44e2d505a7475685aa428aeb5ce91508faa55f02708e02155b262704372b7a8f5d915f8c551ece85df639507b70546b3706e51f75193a7fe0ab9718
-  data.tar.gz: c2d6875df759483ca33e007fdbddacd157c00ea6a0ddf04512460707a9038b951c10797e48ea3adfd6012bebb0b8f41869136c60de9530257ebdf55c6ba0189b
+  metadata.gz: 1c1e8c3902d96ce0b74998f7755a71e4874e7597fcaba907842ce4227ef621fb0046415892249f067a58046555a0cabd927362d50b1ecf348a0a72495b709f9f
+  data.tar.gz: 0e8a2a31c990c247c550d224e2ff95c669d56df085c2993adabfa043d243029ca81db6cf04a39cdf722ada8da8da4a3181e7454bb86795a4333984025f82e3e2

data/Gemfile.lock

@@ -1,20 +1,37 @@
 PATH
   remote: .
   specs:
-    odania (0.0.15)
+    odania (0.0.16)
       diplomat
+      erubis
+      public_suffix
 
 GEM
   remote: https://rubygems.org/
   specs:
+    builder (3.2.2)
+    cucumber (2.1.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.3.0)
+      diff-lcs (>= 1.1.3)
+      gherkin3 (~> 3.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.3.0)
+      gherkin3 (~> 3.1.0)
     diff-lcs (1.2.5)
     diplomat (0.14.0)
       faraday (~> 0.9)
       json (~> 1.8)
+    erubis (2.7.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
+    gherkin3 (3.1.2)
     json (1.8.3)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
     multipart-post (2.0.0)
+    public_suffix (1.5.2)
     rake (10.4.2)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
@@ -35,6 +52,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.5)
+  cucumber
   odania!
   rake
   rspec

data/config/varnish_config.json

@@ -0,0 +1,5 @@
+{
+	"name": "odania-varnish",
+	"default": false,
+	"domains": {}
+}

data/features/plugin.feature

@@ -0,0 +1,35 @@
+Feature: Plugins
+	I can register and query all available plugins for the odania portal.
+
+	Scenario: Registering a new plugin
+		Given I initialize the gem
+		When I registered the plugin "test-plugin"
+		Then I should see "1" instances of the plugin "test-plugin"
+
+	Scenario: Registering multiple instances of one plugin
+		Given I initialize the gem
+		When I registered the plugin "test-plugin"
+			And I registered the plugin "test-plugin"
+			And I registered the plugin "test-plugin"
+		Then I should see "3" instances of the plugin "test-plugin"
+
+	Scenario: Registering multiple plugins
+		Given I initialize the gem
+		When I registered the plugin "test-plugin"
+			And I registered the plugin "test-plugin"
+			And I registered the plugin "test-plugin-2"
+		Then I should see "2" instances of the plugin "test-plugin"
+			And I should see "1" instances of the plugin "test-plugin-2"
+
+	Scenario: Retrieving plugin instance name
+		Given I initialize the gem
+		When I retrieve plugin instance name for "test-plugin"
+			And I retrieve plugin instance name for "test-plugin"
+		Then I should retrieve "test-plugin_1"
+
+	Scenario: Build new joined plugin config
+		Given I initialize the gem
+		When I registered the plugin "test-plugin"
+			And I generate the joined plugin config
+		Then I have a joined plugin config
+			And The joined plugin config contains the plugin "test-plugin"

data/features/step_definitions/plugin_steps.rb

@@ -0,0 +1,79 @@
+$instances = Hash.new(0)
+
+Given(/^I initialize the gem$/) do
+	$instances = Hash.new(0)
+	`rm -f #{Odania::Plugin::INSTANCE_FILES_PATH}*`
+
+	Odania.plugin.get_all.each_pair do |name, instances|
+		instances.each do |instance|
+			if instance.ServiceName.start_with? 'test-plugin'
+				puts "Deregister: #{instance}" if $debug
+				Odania.plugin.deregister instance.ServiceID
+			end
+		end
+	end
+end
+
+Given(/^I registered the plugin "([^"]*)"$/) do |plugin_name|
+	plugin_cfg = {
+		'name' => plugin_name,
+		'ip' => '127.0.0.1',
+		'port' => 80,
+		'tags' => ["plugin-#{plugin_name}"],
+		'default_subdomains' => {
+			'_general' => 'default_sub'
+		},
+		'domains' => {
+			'odania.com' => {
+				'contents' => {
+				},
+				'assets' => {
+				},
+				'config' => {
+					'asset_url' => 'assets.odania.com',
+					'languages' => %w(de en),
+					'layout' => 'simple',
+					'language_selector' => 'prefix',
+					'default_subdomain' => 'page_sub',
+					'redirects' => {
+						'^/test' => '/games'
+					}
+				},
+				'public_pages' => {
+				}
+			}
+		},
+		'layouts' => {
+		}
+	}
+
+	$instances[plugin_name] += 1
+	plugin_instance_name = "#{plugin_name}_#{$instances[plugin_name]}"
+	Odania.plugin.register plugin_instance_name, plugin_cfg
+end
+
+Then(/^I should see "([^"]*)" instances of the plugin "([^"]*)"$/) do |amount, plugin_name|
+	plugins = Odania.plugin.get_all
+	expect(plugins[plugin_name].count).to eq(amount.to_i)
+end
+
+When(/^I retrieve plugin instance name for "([^"]*)"$/) do |plugin_name|
+	@plugin_instance_name = Odania.plugin.get_plugin_instance_name plugin_name
+end
+
+Then(/^I should retrieve "([^"]*)"$/) do |plugin_instance_name|
+	expect(plugin_instance_name).to eq(@plugin_instance_name)
+end
+
+When(/^I generate the joined plugin config$/) do
+	Odania.plugin.plugin_config.load_from_consul
+	Odania.plugin.plugin_config.generate
+end
+
+Then(/^I have a joined plugin config$/) do
+	pending # Write code here that turns the phrase above into concrete actions
+end
+
+Then(/^The joined plugin config contains the plugin "([^"]*)"$/) do |arg1|
+	pending # Write code here that turns the phrase above into concrete actions
+end

data/features/step_definitions/varnish_steps.rb

@@ -0,0 +1,7 @@
+When(/^I generate the varnish config$/) do
+	Odania.varnish.generate('/tmp/varnish')
+end
+
+Then(/^I have a valid varnish config$/) do
+	pending # Write code here that turns the phrase above into concrete actions
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'odania'

data/features/varnish.feature

@@ -0,0 +1,8 @@
+Feature: Varnish
+	Configuration for varnish. It is the gateway from the web to the plugin infrastructure.
+
+	Scenario: Generate config
+		Given I initialize the gem
+		When I registered the plugin "test-plugin"
+			And I generate the varnish config
+		Then I have a valid varnish config

data/lib/odania/consul.rb

@@ -1,12 +1,122 @@
 module Odania
 	class Consul
-		protected
+		attr_accessor :service, :config, :event, :health
 
-		def retrieve_value(plugin_path)
-			begin
-				Diplomat::Kv.get(plugin_path, :recurse => true)
-			rescue Diplomat::KeyNotFound
-				[]
+		def initialize(consul_url)
+			consul_url = "http://#{ENV['CONSUL_PORT_8500_TCP_ADDR']}:#{ENV['CONSUL_PORT_8500_TCP_PORT']}" if consul_url.nil?
+			puts "Consul URL: #{consul_url}" if $debug
+			Diplomat.configure do |config|
+				# Set up a custom Consul URL
+				config.url = consul_url
+			end
+
+			@service = Service.new
+			@config = Config.new
+			@event = Event.new
+			@health = Health.new
+		end
+
+		class Config
+			def get(path)
+				begin
+					JSON.parse Diplomat::Kv.get path
+				rescue Diplomat::KeyNotFound
+					nil
+				end
+			end
+
+			def get_all(path)
+				retrieve_value path
+			end
+
+			def set(key, value)
+				Diplomat::Kv.put(key, JSON.dump(value))
+			end
+
+			def delete(key)
+				Diplomat::Kv.delete(key)
+			end
+
+			protected
+
+			def retrieve_value(plugin_path)
+				begin
+					result = {}
+					Diplomat::Kv.get(plugin_path, :recurse => true).each do |data|
+						result[data[:key]] = JSON.parse data[:value]
+					end
+					result
+				rescue Diplomat::KeyNotFound
+					{}
+				end
+			end
+		end
+
+		class Service
+			def get_all
+				services = {}
+				Diplomat::Service.get_all.each_pair do |key, value|
+					services[key.to_s] = get_all_for(key)
+				end
+				puts "SERVICES: #{JSON.pretty_generate services}" if $debug
+				services
+			end
+
+			def get_all_for(plugin_name)
+				instances = get(plugin_name, :all)
+				instances.is_a?(Array) ? instances : [instances]
+			end
+
+			def get(key, scope=:first)
+				Diplomat::Service.get(key, scope)
+			end
+
+			def register(consul_config)
+				if Diplomat::Service.register consul_config
+					puts 'Service registered' if $debug
+				else
+					puts 'Error registering service' if $debug
+				end
+			end
+
+			def deregister(name)
+				Diplomat::Service.deregister name
+			end
+
+			def build_config(plugin_name, plugin_instance_name, ip, tags=[], port=80)
+				{
+					'id' => plugin_instance_name,
+					'name' => plugin_name,
+					'tags' => tags,
+					'address' => ip,
+					'port' => port,
+					'token' => plugin_instance_name,
+					'checks' => [
+						{
+							'id' => plugin_name,
+							'name' => "HTTP on port #{port}",
+							'http' => "http://#{ip}:#{port}/health",
+							'interval' => '10s',
+							'timeout' => '1s'
+						}
+					]
+				}
+			end
+		end
+
+		class Event
+			def fire(key, value)
+				Diplomat::Event.fire key, value
+			end
+		end
+
+		class Health
+			def state(state=:any)
+				Diplomat::Health.state(state)
+			end
+
+			def service(name)
+				Diplomat::Health.service(name)
 			end
 		end
 	end

data/lib/odania/plugin.rb

@@ -1,56 +1,82 @@
-module Odania
-	class Plugin < Odania::Consul
-		def plugins_config
-			configs = retrieve_value 'plugins'
-			configs = [configs] unless configs.kind_of?(Array)
+require_relative 'plugin_config/plugin_config'
 
-			result = []
-			configs.each do |json_data|
-				begin
-					result << JSON.parse(json_data[:value])
-				rescue => e
-					puts "Can not parse config: #{e} \n\n #{json_data.inspect}"
-				end
-			end
+module Odania
+	class Plugin
+		INSTANCE_FILES_PATH = '/tmp/plugin_instance_name_'
 
-			result
+		def initialize(consul)
+			@consul = consul
+			@plugin_config = PluginConfig::Base.new
 		end
 
-		def add_plugin(plugin_config)
+		def register(plugin_instance_name, plugin_config)
 			plugin_name = plugin_config['name']
-			plugin_instance_name = get_plugin_instance_name plugin_name
 
-			puts "Writing plugin instance config: #{plugin_instance_name}"
-			Diplomat::Kv.put("#{get_plugin_path(plugin_name)}#{plugin_instance_name}", JSON.dump(plugin_config))
+			# Write configuration of the plugin
+			@consul.config.set(get_plugin_config_path_for(plugin_name), plugin_config)
 
-			consul_config = Odania.service.consul_service_config(plugin_name, plugin_instance_name, plugin_config['ip'], plugin_config['tags'], plugin_config['port'])
-			Odania.service.register_service(consul_config)
+			# Register service
+			consul_config = @consul.service.build_config(plugin_name, plugin_instance_name, plugin_config['ip'], plugin_config['tags'], plugin_config['port'])
+			@consul.service.register(consul_config)
 
-			Diplomat::Event.fire('updated_plugin_config', "#{plugin_name}|#{plugin_instance_name}")
+			# Fire event
+			@consul.event.fire 'service-registered', "#{plugin_name}|#{plugin_instance_name}"
 		end
 
-		private
+		def deregister(plugin_instance_name)
+			@consul.service.deregister(plugin_instance_name)
+		end
+
+		def get_all
+			@consul.service.get_all
+		end
 
-		def get_plugin_path(plugin_name)
-			"plugins/#{plugin_name}/"
+		def config_for(plugin_name)
+			@consul.config.get get_plugin_config_path_for(plugin_name)
 		end
 
 		# Generate a unique number for this instance of the plugin
 		def get_plugin_instance_name(plugin_name)
-			puts 'Detecting plugin instance name'
-			plugin_instance_name_file = '/tmp/plugin_instance_name'
+			plugin_instance_name_file = "#{INSTANCE_FILES_PATH}#{plugin_name}"
 
 			plugin_instance_name = nil
 			plugin_instance_name = File.read plugin_instance_name_file if File.exists? plugin_instance_name_file
 			return plugin_instance_name unless plugin_instance_name.nil?
 
-			available_plugins = retrieve_value(get_plugin_path(plugin_name))
-			puts 'Current plugins'
-			puts available_plugins.inspect
-
-			plugin_instance_name = "#{plugin_name}_#{available_plugins.length + 1}"
+			available_instances = @consul.service.get_all_for plugin_name
+			plugin_instance_name = "#{plugin_name}_#{available_instances.length + 1}"
 			File.write plugin_instance_name_file, plugin_instance_name
 			plugin_instance_name
 		end
+
+		def plugin_config
+			@plugin_config
+		end
+
+		def set_global_config(config)
+			@consul.config.set get_global_plugin_config_path, config
+		end
+
+		def get_global_config
+			@consul.config.get get_global_plugin_config_path
+		end
+
+		def health
+			@consul.health
+		end
+
+		private
+
+		def get_global_plugin_config_path
+			'global_plugins_config'
+		end
+
+		def get_plugin_config_path
+			'plugins_config'
+		end
+
+		def get_plugin_config_path_for(plugin_name)
+			"#{get_plugin_config_path}/#{plugin_name}"
+		end
 	end
 end

data/lib/odania/plugin_config/models/backend.rb

@@ -0,0 +1,31 @@
+module Odania
+	module PluginConfig
+		class Backend
+			attr_accessor :service_name, :instance_name, :host, :port
+
+			def initialize(service_name, instance_name, host, port)
+				self.service_name = service_name
+				self.instance_name = instance_name
+				self.host = host
+				self.port = port
+			end
+
+			def dump
+				{
+					'service_name' => service_name,
+					'instance_name' => instance_name,
+					'host' => host,
+					'port' => port
+				}
+			end
+
+			def load(data)
+				self.service_name = data['service_name']
+				self.instance_name = data['instance_name']
+				self.host = data['host']
+				self.port = data['port']
+				self
+			end
+		end
+	end
+end

data/lib/odania/plugin_config/models/backend_group.rb

@@ -0,0 +1,38 @@
+module Odania
+	module PluginConfig
+		class BackendGroup
+			attr_accessor :name, :backends
+
+			def initialize(name, backends=[])
+				self.name = name
+				self.backends = backends
+			end
+
+			def add_backend(backend)
+				self.backends << backend
+			end
+
+			def dump
+				backend_data = []
+				backends.each do |backend|
+					backend_data << backend.dump
+				end
+
+				{
+					'name' => name,
+					'backends' => backend_data
+				}
+			end
+
+			def load(data)
+				self.name = data['name']
+
+				unless data['backends'].nil?
+					data['backends'].each do |data|
+						self.backends << Backend.new.load(data)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/odania/plugin_config/models/domain.rb

@@ -0,0 +1,38 @@
+module Odania
+	module PluginConfig
+		class Domain
+			attr_accessor :name, :subdomains
+
+			def initialize(name)
+				self.name = name
+				self.subdomains = Hash.new { |hash, key| hash[key] = SubDomain.new(key) }
+			end
+
+			def add_subdomain(subdomain_name)
+				self.subdomains[subdomain_name]
+			end
+
+			def dump
+				subdomain_data = {}
+				subdomains.each_pair do |name, subdomain|
+					subdomain_data[name] = subdomain.dump
+				end
+
+				{
+					'name' => name,
+					'subdomains' => subdomain_data
+				}
+			end
+
+			def load(data)
+				self.name = data['name']
+
+				unless data['subdomains'].nil?
+					data['subdomains'].each_pair do |name, data|
+						self.subdomains[name].load(data)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/odania/plugin_config/models/layout.rb

@@ -0,0 +1,31 @@
+module Odania
+	module PluginConfig
+		class Layout
+			attr_accessor :config
+
+			def initialize
+				@plugins = []
+			end
+
+			def set_config(config, plugin_name)
+				result = true
+				self.config = config
+				result = false unless @plugins.empty?
+				@plugins << plugin_name
+				result
+			end
+
+			def plugins
+				@plugins
+			end
+
+			def dump
+				config
+			end
+
+			 def load(data)
+				 self.config = data
+			 end
+		end
+	end
+end

data/lib/odania/plugin_config/models/page.rb

@@ -0,0 +1,23 @@
+module Odania
+	module PluginConfig
+		class Page
+			attr_accessor :group_name, :plugin_url
+
+			def dump
+				{
+					'group_name' => group_name,
+					'plugin_url' => plugin_url
+				}
+			end
+
+			def load(data)
+				self.group_name = data['group_name']
+				self.plugin_url = data['plugin_url']
+			end
+
+			 def director
+				 "#{Odania.varnish_sanitize(group_name)}_director"
+			 end
+		end
+	end
+end

data/lib/odania/plugin_config/models/redirect.rb

@@ -0,0 +1,20 @@
+module Odania
+	module PluginConfig
+		class Redirect
+			attr_accessor :src, :target, :plugins
+
+			def initialize(src)
+				self.src = src
+				self.plugins = []
+			end
+
+			def add(target, plugin_name)
+				self.target = target
+				self.plugins << plugin_name
+
+				return false if self.plugins.count > 1
+				true
+			end
+		end
+	end
+end