Merge pull request #35 from omc/dds/error-msg

Provide configuration help

lib/searchyll.rb

@@ -11,12 +11,15 @@
 
   Jekyll::Hooks.register(:site, :pre_render) do |site|
     config = Searchyll::Configuration.new(site)
-    if config.elasticsearch_url && !config.elasticsearch_url.empty?
+    if config.valid?
       puts "setting up indexer hook with url #{config.elasticsearch_url.inspect}"
       indexers[site] = Searchyll::Indexer.new(config)
       indexers[site].start
     else
-      puts 'No ElasticSearch URL provided, skipping indexing...'
+      puts 'Invalid Elasticsearch configuration provided, skipping indexing...'
+      config.reasons.each do |r|
+        puts "  #{r}"
+      end
     end
   end
 

lib/searchyll/configuration.rb

@@ -1,6 +1,7 @@
 module Searchyll
   class Configuration
     attr_accessor :site
+
     def initialize(site)
       self.site = site
     end
@@ -11,6 +12,38 @@ def elasticsearch_url
         ((site.config||{})['elasticsearch']||{})['url']
     end
 
+    def valid?
+      elasticsearch_url && !elasticsearch_url.empty? && elasticsearch_url.start_with?('http')
+    end
+
+    def reasons
+      reasons = []
+      if elasticsearch_url && elasticsearch_url.empty?
+        reasons << 'No Elasticsearch url configured'
+        reasons << '  Looked in ENV[BONSAI_URL]'
+        reasons << '  Looked in ENV[ELASTICSEARCH_URL]'
+        reasons << '  Looked in _config.elasticsearch.url'
+      elsif ! elasticsearch_url.start_with? 'http'
+        reasons << "Elasticsearch url must start with 'http' or 'https'"
+        reasons << "  Current Value: #{elasticsearch_url}"
+        reasons << "  Current Source: #{elasticsearch_url_source}"
+      end
+
+      reasons
+    end
+
+    def elasticsearch_url_source
+      if ENV['BONSAI_URL']
+        'ENV[BONSAI_URL]'
+      elsif ENV['ELASTICSEARCH_URL']
+        'ENV[ELASTICSEARCH_URL]'
+      elsif ((site.config||{})['elasticsearch']||{})['url']
+        'CONFIG'
+      else
+        'NOT FOUND'
+      end
+    end
+
     # Getter for the number of primary shards
     def elasticsearch_number_of_shards
       site.config['elasticsearch']['number_of_shards'] || 1