Built-in content.table plugin

[traut]

Background

In addition to the installable plugins (#3), fabric must have built-in plugins to allow generation of simple content without the need to download extra components.

Related: #13, #15

Design

content.table plugin is a part of the fabric binary.

Specification

• the plugin has no configuration options
• API interface:
  • local context object
  • required columns attribute, a list of strings
  • optional datapoints attribute, a list of strings

Behavior

The plugin formats and returns a Markdown-formatted table with the header row.

The values in columns attribute are the column names. datapoints attribute contains a list of jq queries to be applied to every object in query_result object.

If query is not set, or datapoints is not set, or query_result is nil or an empty list, an empty table with the header is returned.

For example, with the content block

content table {
  query = <<-EOT
        data.elasticsearch.critical_alerts | (
            group_by(."kibana.alert.rule.name") |
            map({rule_name: .[0]."kibana.alert.rule.name", count: length})
        )
    EOT

  columns    = ["Rule Name", "Alerts Count"]
  datapoints = [".rule_name", ".count"]
}

and with the query_result set to

[
  {
    "rule_name": "Rule A",
    "count": 11
  },
  {
    "rule_name": "Rule B",
    "count": 22
  }
]

the expected result table would be

|Rule Name|Alerts Count|
|-|-|
|Rule A|11|
|Rule B|22|

Deliverables

• new built-in content.table plugin
• unit test for the plugin

[dobarx]

Updated specs

• columns & datapoints bindings described together using single object with header & value properties.
• use go templates instead of jq for row cels
• header can also use go template literals and access all data context.

Example

columns = [{
   header = "Rule Name" 
   value = "{{.rule_name}}"
}, {
   header = "Alerts Count ({{.total_alerts}})" 
   value = "{{.count}}"
}]

[traut]

implemented in #44