Class: HybridPlatformsConductor::HpcPlugins::Report::Confluence

Inherits:
Report
  • Object
show all
Defined in:
lib/hybrid_platforms_conductor/hpc_plugins/report/confluence.rb

Overview

Export in the Mediawiki format

Constant Summary

Constants included from LoggerHelpers

LoggerHelpers::LEVELS_MODIFIERS, LoggerHelpers::LEVELS_TO_STDERR

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Report

#initialize

Methods inherited from Plugin

extend_config_dsl_with, #initialize, valid?

Methods included from LoggerHelpers

#err, #init_loggers, #log_component=, #log_debug?, #log_level=, #out, #section, #set_loggers_format, #stderr_device, #stderr_device=, #stderr_displayed?, #stdout_device, #stdout_device=, #stdout_displayed?, #stdouts_to_s, #with_progress_bar

Constructor Details

This class inherits a constructor from HybridPlatformsConductor::Report

Class Method Details

.supported_locales ⇒ Object

Give the list of supported locales by this report generator

API

  • This method is mandatory.

Result

  • Array<Symbol>: List of supported locales



22
23
24
 
# File 'lib/hybrid_platforms_conductor/hpc_plugins/report/confluence.rb', line 22

def self.supported_locales
  [:en]
end

Instance Method Details

#report_for(nodes, locale_code) ⇒ Object

Create a report for a list of nodes, in a given locale

API

  • This method is mandatory.

Parameters

  • nodes (Array<String>): List of nodes

  • locale_code (Symbol): The locale code



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/hybrid_platforms_conductor/hpc_plugins/report/confluence.rb', line 32

def report_for(nodes, locale_code)
  confluence_info = @config.confluence_info
  if confluence_info
    if confluence_info[:inventory_report_page_id]
      @nodes = nodes
      HybridPlatformsConductor::Confluence.with_confluence(confluence_info[:url], @logger, @logger_stderr) do |confluence|
        confluence.update_page(confluence_info[:inventory_report_page_id], render('confluence_inventory'))
      end
      out "Inventory report Confluence page updated. Please visit #{confluence_info[:url]}/pages/viewpage.action?pageId=#{confluence_info[:inventory_report_page_id]}"
    else
      log_warn 'No inventory_report_page_id in the Confluence information defined. Ignoring the Confluence report.'
    end
  else
    log_warn 'No Confluence information defined. Ignoring the Confluence report.'
  end
end