document fields

Author: terrywbrady

src-colladmin/actions/opensearch_describe_action.rb

@@ -8,66 +8,80 @@ class OpenSearchDescribeAction < AdminAction
   def initialize(config, action, path, myparams)
     super(config, action, path, myparams)
     file = 'import/filebeat/fields.json'
-    @title = "Merritt OpenSearch Fields (#{File.ctime(file).to_s[0..15]})"
-    @fields = JSON.parse(File.read(file))
-    # load_registry
-  end
-
-  def load_registry
-    reg = YAML.safe_load(File.read('import/filebeat/opensearch.registry.yml'), aliases: true)
-    process_registry_node(LambdaBase.ssm_root_path.chop, reg)
-  end
-
-  def process_registry_node(path, reg)
-    if reg.key?('description')
-      p = @parameters.fetch(path, SsmInfo.new(path))
-      p.set_description(reg['description'])
-      p.set_deprecated(reg.fetch('deprecated', ''))
-      p.set_skip(reg.fetch('skip', false))
-      @parameters[path] = p
-      return
-    end
-
-    reg.each_key do |k|
-      r = reg[k]
-      next unless r.instance_of?(::Hash)
+    @title = "Merritt OpenSearch Fields (#{File.mtime(file).to_s[0..15]})"
+    @fields = {}
+    JSON.parse(File.read(file)).each do |val|
+      name = val.fetch('name', '')
+      next if name =~ /\.keyword$/
 
-      process_registry_node("#{path}/#{k}", r)
+      type = val.fetch('type', '')
+      @fields[name] = {
+        name: name,
+        type: type,
+        status: 'PASS'
+      }
     end
+    @reg = load_registry
+  end
 
-    return unless reg.fetch('skip', false)
-
-    @parameters.each_key do |pp|
-      next unless pp =~ /^#{path}.*/
-
-      @parameters[pp].set_skip(true)
-    end
+  def load_registry
+    YAML.safe_load(File.read('import/filebeat/opensearch.registry.yml'), aliases: true)
   end
 
   def get_title
     @title
   end
 
   def table_headers
-    ['Field Name', 'Type', 'Statis']
+    ['Field Name', 'Type', 'Description', 'Note', 'Source', 'Status']
   end
 
   def table_types
-    ['name', '', 'status']
+    ['', '', '', '', '', 'status']
   end
 
   def perform_action
     convert_json_to_table({}.to_json)
   end
 
+  def get_doc(freg, key, defval)
+    v = freg.fetch(key, defval)
+    # empty yaml is returned as nil
+    v = defval if v.nil?
+    v
+  end
+
+  def process_key(k, defstat)
+    f = @fields.fetch(k, {})
+    freg = @reg.fetch(k, {})
+    stat = 'PASS'
+    stat = defstat if f.empty? || freg.empty?
+    desc = get_doc(freg, 'description', '')
+    source = get_doc(freg, 'source', '')
+    note = get_doc(freg, 'note', '')
+    [
+      k,
+      f.fetch(:type, ''),
+      desc,
+      note,
+      source,
+      stat
+    ]
+  end
+
   def table_rows(_body)
     rows = []
-    @fields.each do |val|
-      name = val.fetch('name', '')
-      next if name =~ /\.keyword$/
+    oskeys = {}
 
-      type = val.fetch('type', '')
-      rows.append([name, type, 'PASS'])
+    @fields.keys.each do |k|
+      oskeys[k] = process_key(k, 'FAIL')
+    end
+    @reg.keys.each do |k|
+      next if oskeys.key?(k)
+      oskeys[k] = process_key(k, 'WARN')
+    end
+    oskeys.keys.sort.each do |k|
+      rows.append(oskeys[k])
     end
     rows
   end