odania 0.0.16 → 0.0.17

data/spec/fixtures/global_config.json

@@ -0,0 +1,142 @@
+{
+	"config": {
+		"title": "This is my awesome title",
+		"default_backend_groups": [
+			"odania-static"
+		]
+	},
+	"plugin-config": {
+		"odania-static": {
+			"name": "odania-core",
+			"default": true,
+			"author": [
+				"Mike Petersen <mike@odania-it.com>"
+			],
+			"url": "http://www.odania.com",
+			"sites": [
+				"www.domain.de"
+			]
+		}
+	},
+	"default_subdomains": {
+		"_general": "www"
+	},
+	"domains": {
+		"_general": {
+			"_general": {
+				"config": {
+				},
+				"redirects": {
+					"odania.com$": "www.odania.com",
+					"odania.de$": "www.odania.com/de"
+				},
+				"internal": {
+					"layouts": {
+					},
+					"partials": {
+					}
+				}
+			}
+		},
+		"example.com": {
+			"_general": {
+				"config": {
+				},
+				"direct": {
+					"/imprint": {
+						"group_name": "static-content",
+						"plugin_url": "/contents/my-awesome-imprint"
+					}
+				},
+				"internal": {
+					"layouts": {
+					},
+					"partials": {
+					}
+				}
+			},
+			"www": {
+				"dynamic": {
+					"/de/openhab/2015-09-17-testing-openhab2": {
+						"group_name": "static-content",
+						"plugin_url": "/contents/www.example.com/web/de/openhab/2015-09-17-testing-openhab2.html",
+						"cacheable": true,
+						"expires": 60
+					},
+					"/de": {
+						"group_name": "static-content",
+						"plugin_url": "/contents/www.example.com/web/de/index.html"
+					}
+				},
+				"direct": {
+					"/favicon.ico": {
+						"group_name": "odania-core",
+						"plugin_url": "/admin/favicon.ico"
+					},
+					"/assets/admin/js/admin.js": {
+						"group_name": "odania-core",
+						"plugin_url": "/assets/admin/js/admin.js"
+					},
+					"hamster.jpeg": {
+						"group_name": "static-content",
+						"plugin_url": "/contents/www.example.com/assets/hamster.jpeg"
+					},
+					"imprint": {
+						"group_name": "static-content",
+						"plugin_url": "/contents/my-special-imprint"
+					}
+				},
+				"internal": {
+					"layouts": {
+						"main": {
+							"styles": {
+								"_general": {
+									"entry_point": "application.html.erb",
+									"direct": {
+										"layouts/mac-beath/img/favicon/favicon.png": {
+											"group_name": "static-content",
+											"plugin_url": "layouts/mac-beath/img/favicon/favicon.png",
+											"cacheable": true,
+											"expires": 60
+										},
+										"layouts/mac-beath/img/photos/t12.jpg": {
+											"group_name": "static-content",
+											"plugin_url": "layouts/mac-beath/img/photos/t12.jpg"
+										}
+									},
+									"dynamic": {
+										"layouts/simple/application_part1.html": {
+											"group_name": "static-content",
+											"plugin_url": "layouts/simple/application_part1.html.erb",
+											"cacheable": true,
+											"expires": 60
+										}
+									}
+								},
+								"left_menu": {
+									"entry_point": "application.html.erb",
+									"direct": {},
+									"dynamic": {}
+								}
+							}
+						}
+					},
+					"partials": {
+						"footer": {
+							"name": "footer",
+							"group_name": "static-content",
+							"plugin_url": "partials/footer.html",
+							"cacheable": true,
+							"expires": 60
+						},
+						"tracking": {
+							"name": "tracking",
+							"group_name": "static-content",
+							"plugin_url": "partials/tracking.html"
+						}
+					}
+				}
+			}
+		}
+	}
+}

data/spec/fixtures/plugin_config_1.json

@@ -0,0 +1,93 @@
+{
+	"plugin-config": {
+		"name": "odania-core",
+		"default": true,
+		"author": [
+			"Mike Petersen <mike@odania-it.com>"
+		],
+		"url": "http://www.odania.com",
+		"sites": [
+			"www.domain.de"
+		]
+	},
+	"config": {
+		"title": "This is my awesome title"
+	},
+	"default_subdomains": {
+		"_general": "www"
+	},
+	"domains": {
+		"_general": {
+			"_general": {
+				"redirects": {},
+				"config": {},
+				"direct": {},
+				"dynamic": {},
+				"internal": {
+					"layouts": {
+						"main": {
+							"styles": {
+								"_general": {
+									"entry_point": "application.html.erb",
+									"direct": {
+										"layouts/mac-beath/img/favicon/favicon.png": {
+											"plugin_url": "layouts/mac-beath/img/favicon/favicon.png",
+											"cacheable": true,
+											"expires": 60
+										},
+										"layouts/mac-beath/img/photos/t12.jpg": {
+											"plugin_url": "layouts/mac-beath/img/photos/t12.jpg"
+										}
+									},
+									"dynamic": {
+										"layouts/simple/application_part1.html": {
+											"plugin_url": "layouts/simple/application_part1.html.erb",
+											"cacheable": true,
+											"expires": 60
+										}
+									}
+								},
+								"left_menu": {
+									"entry_point": "application.html.erb",
+									"direct": {},
+									"dynamic": {}
+								}
+							}
+						}
+					},
+					"partials": {
+						"footer": {
+							"plugin_url": "partials/footer.html",
+							"cacheable": true,
+							"expires": 60
+						}
+					}
+				}
+			}
+		},
+		"example.com": {
+			"www": {
+				"redirects": {
+					"^/test": "/test2"
+				},
+				"config": {},
+				"direct": {
+					"/imprint": {
+						"plugin_url": "/my-imprint",
+						"cacheable": true,
+						"expires": 60
+					},
+					"/": {
+						"plugin_url": "/my-home",
+						"cacheable": false
+					}
+				},
+				"dynamic": {},
+				"internal": {
+					"layouts": {},
+					"partials": {}
+				}
+			}
+		}
+	}
+}

data/spec/lib/odania/config/global_config_spec.rb

@@ -0,0 +1,67 @@
+describe Odania::Config::GlobalConfig do
+	let(:cfg1) {
+		JSON.parse File.read("#{BASE_DIR}/spec/fixtures/plugin_config_1.json")
+	}
+	let(:global_cfg) {
+		JSON.parse File.read("#{BASE_DIR}/spec/fixtures/global_config.json")
+	}
+
+	context 'configuration' do
+		it 'add configuration' do
+			expect(subject.add_plugin_config(cfg1)).to be(true)
+
+			cfg_result = subject.dump
+			expect(cfg_result['domains']['example.com']['www']['redirects']).to eql(cfg1['domains']['example.com']['www']['redirects'])
+			expect(cfg_result['domains']['example.com']['www']['config']).to eql(cfg1['domains']['example.com']['www']['config'])
+
+			cfg1['domains']['example.com']['www']['direct'].each_pair do |path, data|
+
+				expect(cfg_result['domains']['example.com']['www']['direct'][path]['plugin_url']).to eql(data['plugin_url'])
+			end
+
+		end
+
+		it 'detects duplicates' do
+			expect(subject.add_plugin_config(cfg1)).to be(true)
+			expect(subject.duplicates).to be_empty
+			expect(subject.add_plugin_config(cfg1)).to be(true)
+
+			duplicates = subject.duplicates
+			expect(subject.duplicates).not_to be_empty
+			expect(duplicates).to have_key(:config)
+			expect(duplicates).to have_key(:direct)
+			expect(duplicates).to have_key(:redirect)
+		end
+
+		it 'generate global configuration' do
+			cfg_name = cfg1['plugin-config']['name']
+			$consul_mock.config.set("plugins_config/#{cfg_name}", cfg1)
+
+			$consul_mock.service.services = {
+				cfg_name => [
+					OpenStruct.new({
+						'Node' => 'agent-one',
+						'Address' => '172.20.20.1',
+						'ServiceID' => "#{cfg_name}_1",
+						'ServiceName' => cfg_name,
+						'ServiceTags' => [],
+						'ServicePort' => 80,
+						'ServiceAddress' => '172.20.20.1'
+					}),
+					OpenStruct.new({
+						'Node' => 'agent-two',
+						'Address' => '172.20.20.2',
+						'ServiceID' => "#{cfg_name}_2",
+						'ServiceName' => cfg_name,
+						'ServiceTags' => [],
+						'ServicePort' => 80,
+						'ServiceAddress' => '172.20.20.1'
+					})
+				]
+			}
+
+			global_config = subject.generate_global_config
+			expect(global_config).not_to be_empty
+		end
+	end
+end

data/spec/lib/odania/config/plugin_config_spec.rb

@@ -0,0 +1,28 @@
+describe Odania::Config::PluginConfig do
+	let(:cfg) {
+		JSON.parse File.read("#{BASE_DIR}/spec/fixtures/plugin_config_1.json")
+	}
+
+	context 'configuration' do
+		it 'should be valid' do
+			expect(subject.config).to be_a(Hash)
+			expect(subject.domains).to be_a(Hash)
+			subject.domains.each_pair do |domain, data|
+				expect(data).to be_a(Odania::Config::Domain)
+			end
+		end
+
+		it 'loads configuration' do
+			expect(subject.load(cfg)).to be(true)
+
+			expect(subject.config).to eql(cfg['config'])
+			expect(subject.plugin_config).to eql(cfg['plugin-config'])
+			expect(subject.domains.keys).to eql(cfg['domains'].keys)
+		end
+
+		it 'dumps the same config' do
+			expect(subject.load(cfg)).to be(true)
+			expect(subject.dump).to eql(cfg)
+		end
+	end
+end

data/spec/lib/odania/erb_spec.rb

@@ -0,0 +1,16 @@
+describe Odania::Erb do
+	context 'render simple template' do
+		let(:subject) {
+			Odania::Erb.new('This is a very simple template', 'example.com', {}, 'odania-test', 'test.odania.com')
+		}
+
+		let(:global_cfg) {
+			JSON.parse File.read("#{BASE_DIR}/spec/fixtures/global_config.json")
+		}
+
+		it 'renders simple template' do
+			$consul_mock.config.set('global_plugins_config', global_cfg)
+			expect(subject.render).to eq('This is a very simple template')
+		end
+	end
+end

data/spec/lib/odania/plugin_spec.rb

@@ -0,0 +1,25 @@
+describe Odania::Plugin do
+	context 'services' do
+		let(:subject) {
+			Odania::Plugin.new($consul_mock)
+		}
+
+		let(:cfg) {
+			JSON.parse File.read("#{BASE_DIR}/spec/fixtures/plugin_config_1.json")
+		}
+
+		it 'registers a plugin' do
+			cfg_name = cfg['plugin-config']['name']
+			instance_name = 'cfg_instance_1'
+			key_name = "#{cfg_name}|#{instance_name}"
+			expect(subject.register(instance_name, cfg)).to eql(key_name)
+			expect($consul_mock.configuration["plugins_config/#{cfg_name}"]).to eql(cfg)
+		end
+
+		it 'deregisters a plugin' do
+			instance_name = 'cfg_instance_1'
+			subject.register(instance_name, cfg)
+			expect(subject.deregister(instance_name)).to be_truthy
+		end
+	end
+end

data/spec/lib/odania/varnish_spec.rb

@@ -0,0 +1,37 @@
+describe Odania::Varnish do
+	context 'generate' do
+		before do
+			$consul_mock.service.services = {
+				'odania_static' => [
+					OpenStruct.new({
+						'Node' => 'agent-one',
+						'Address' => '172.20.20.1',
+						'ServiceID' => 'odania_static_1',
+						'ServiceName' => 'odania_static',
+						'ServiceTags' => [],
+						'ServicePort' => 80,
+						'ServiceAddress' => '172.20.20.1'
+					}),
+					OpenStruct.new({
+						'Node' => 'agent-two',
+						'Address' => '172.20.20.2',
+						'ServiceID' => 'odania_static_2',
+						'ServiceName' => 'odania_static',
+						'ServiceTags' => [],
+						'ServicePort' => 80,
+						'ServiceAddress' => '172.20.20.1'
+					})
+				]
+			}
+		end
+
+		let(:global_cfg) {
+			JSON.parse File.read("#{BASE_DIR}/spec/fixtures/global_config.json")
+		}
+
+		it 'generates the varnish config' do
+			$consul_mock.config.set('global_plugins_config', global_cfg)
+			expect(subject.generate('/tmp/varnish')).to eq('odania-varnish|odania_varnish_1')
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -1 +1,16 @@
+ENV['ENVIRONMENT'] = 'test'
+
 require 'odania'
+require_relative 'support/consul_mock'
+
+
+RSpec.configure do |config|
+	config.before(:each) do
+		$consul_mock = ConsulMock.new
+
+
+		allow(Odania).to receive(:plugin) do
+			Odania::Plugin.new($consul_mock)
+		end
+	end
+end

data/spec/support/consul_mock.rb

@@ -0,0 +1,116 @@
+class ConsulMock < Odania::Consul
+	attr_reader :service, :config, :event, :health
+	attr_accessor :configuration
+
+	def initialize
+		self.configuration = {
+			'global_plugins_config' => {
+				'domains' => {}
+			}
+		}
+
+		@service = Service.new
+		@config = Config.new(self.configuration)
+		@event = Event.new
+		@health = Health.new
+	end
+
+	class Config
+		def initialize(configuration)
+			@configuration = configuration
+		end
+
+		def get(path)
+			@configuration[path]
+		end
+
+		def get_all(path)
+			result = {}
+			@configuration.each_pair do |key, value|
+				result[key] = value if key.start_with? path
+			end
+
+			result
+		end
+
+		def set(key, value)
+			@configuration[key] = value
+		end
+
+		def delete(key)
+			@configuration.delete[key]
+		end
+	end
+
+	class Service
+		attr_accessor :services
+
+		def initialize
+			@services = {}
+		end
+
+		def get_all
+			@services
+		end
+
+		def get_all_for(plugin_name)
+			result = []
+			@services.each_pair do |key, val|
+				result << val if key.start_with? plugin_name
+			end
+			result
+		end
+
+		def get(key, scope=:first)
+			@services[key]
+		end
+
+		def register(consul_config)
+			@services[consul_config['id']] = consul_config
+		end
+
+		def deregister(name)
+			@services.delete 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 initialize
+			@events = Hash.new { |hash, key| hash[key] = [] }
+		end
+
+		def fire(key, value)
+			@events[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/tasks/odania.rake

@@ -2,11 +2,7 @@ namespace :odania do
 	namespace :global do
 		desc 'Generate the global config'
 		task :generate_config do
-			puts 'Loading plugin configs from consul'
-			Odania.plugin.plugin_config.load_from_consul
-
-			puts 'Generating global config'
-			Odania.plugin.plugin_config.generate
+			Odania.plugin.plugin_config.generate_global_config
 		end
 	end
 end

data/templates/varnish/backend.vcl.erb

@@ -1,5 +1,6 @@
 vcl 4.0;
 # generated varnish config: <%= ENVIRONMENT %>
+# local test: <%= LOCAL_TEST_MODE ? 'ENABLED' : 'DISABLED' %>
 
 import std;
 import directors;
@@ -7,7 +8,7 @@ import directors;
 probe www_probe {
 	.url = "/health";
 	.timeout = 1s;
-	.interval = 4s;
+	.interval = <%= LOCAL_TEST_MODE ? '60s' : '4s' %>;
 	.window = 5;
 	.threshold = 3;
 }
@@ -40,4 +41,9 @@ sub vcl_init {
 		<%= Odania.varnish_sanitize(backend_group.name) %>_director.add_backend(<%= Odania.varnish_sanitize(group_name) %>_<%= Odania.varnish_sanitize(backend.instance_name) %>);
 	<% end %>
 <% end %>
+
+	new core_backend_director = directors.round_robin();
+<% core_backends.each do |core_backend_name| %>
+	core_backend_director.add_backend(<%= core_backend_name %>);
+<% end %>
 }

data/templates/varnish/catch_all.vcl.erb

@@ -1,4 +1,5 @@
 vcl 4.0;
 # generated varnish config: <%= ENVIRONMENT %>
+# local test: <%= LOCAL_TEST_MODE ? 'ENABLED' : 'DISABLED' %>
 
 # Catch all

data/templates/varnish/default.vcl.erb

@@ -1,5 +1,6 @@
 vcl 4.0;
 # generated varnish config: <%= ENVIRONMENT %>
+# local test: <%= LOCAL_TEST_MODE ? 'ENABLED' : 'DISABLED' %>
 
 sub vcl_synth {
 	if (resp.status == 750) {

data/templates/varnish/general.vcl.erb

@@ -3,11 +3,27 @@
 %>
 vcl 4.0;
 # generated varnish config: <%= ENVIRONMENT %>
+# local test: <%= LOCAL_TEST_MODE ? 'ENABLED' : 'DISABLED' %>
 
 ### Called when a client request is received
 sub vcl_recv {
+	## Internal requests for content/partials
+	## we use internal.core to not have this part open to public
+	if (req.http.host ~ "^internal.core$") {
+		if (req.url ~ "^/template/content") {
+			std.log("template content identified! Page:" + req.url);
+			set req.backend_hint = core_backend_director.backend();
+			return (hash);
+		} else if (req.url ~ "^/template/partial") {
+			std.log("template partial identified! Page:" + req.url);
+			set req.backend_hint = core_backend_director.backend();
+			return (hash);
+		}
+	}
+
 	### always cache these items:
 
+	# varnish is alive. Get health state from core plugin.
 	if (req.url ~ "^/health$") {
 		return (hash);
 	}
@@ -17,25 +33,25 @@ sub vcl_recv {
 	#}
 
 	## images
-	if (req.method == "GET" && req.url ~ "\.(gif|jpg|jpeg|bmp|png|tiff|tif|ico|img|tga|wmf)$") {
-		return (hash);
-	}
+	#if (req.method == "GET" && req.url ~ "\.(gif|jpg|jpeg|bmp|png|tiff|tif|ico|img|tga|wmf)$") {
+	#	return (hash);
+	#}
 
 	## various other content pages
-	if (req.method == "GET" && req.url ~ "\.(css)$") {
-		return (hash);
-	}
+	#if (req.method == "GET" && req.url ~ "\.(css)$") {
+	#	return (hash);
+	#}
 
 	## multimedia
-	if (req.method == "GET" && req.url ~ "\.(svg|swf|ico|mp3|mp4|m4a|ogg|mov|avi|wmv)$") {
-		return (hash);
-	}
+	#if (req.method == "GET" && req.url ~ "\.(svg|swf|ico|mp3|mp4|m4a|ogg|mov|avi|wmv)$") {
+	#	return (hash);
+	#}
 
 	## xml
 
-	if (req.method == "GET" && req.url ~ "\.(xml)$") {
-		return (hash);
-	}
+	#if (req.method == "GET" && req.url ~ "\.(xml)$") {
+	#	return (hash);
+	#}
 }
 
 ### Called when the requested object has been retrieved from the backend, or the request to the backend has failed
@@ -73,7 +89,7 @@ sub vcl_backend_response {
 	set beresp.do_esi = true;
 	set beresp.grace = 6h;
 
-	<% unless ENVIRONMENT.eql?('production') %>
+	<% if LOCAL_TEST_MODE %>
 	set beresp.ttl = 1s;
 	<% end %>
 }