diff --git a/lib/puppet/provider/grafana_dashboard/grafana.rb b/lib/puppet/provider/grafana_dashboard/grafana.rb index e5b879b..0add4c2 100644 --- a/lib/puppet/provider/grafana_dashboard/grafana.rb +++ b/lib/puppet/provider/grafana_dashboard/grafana.rb @@ -1,138 +1,167 @@ # Copyright 2015 Mirantis, Inc. # require 'json' require File.expand_path(File.join(File.dirname(__FILE__), '..', 'grafana')) # Note: this class doesn't implement the self.instances and self.prefetch # methods because the Grafana API doesn't allow to retrieve the dashboards and # all their properties in a single call. Puppet::Type.type(:grafana_dashboard).provide(:grafana, parent: Puppet::Provider::Grafana) do desc 'Support for Grafana dashboards stored into Grafana' defaultfor kernel: 'Linux' def organization resource[:organization] end def grafana_api_path resource[:grafana_api_path] end def fetch_organizations response = send_request('GET', format('%s/orgs', resource[:grafana_api_path])) if response.code != '200' raise format('Fail to retrieve organizations (HTTP response: %s/%s)', response.code, response.body) end begin fetch_organizations = JSON.parse(response.body) fetch_organizations.map { |x| x['id'] }.map do |id| response = send_request 'GET', format('%s/orgs/%s', resource[:grafana_api_path], id) if response.code != '200' raise format('Failed to retrieve organization %d (HTTP response: %s/%s)', id, response.code, response.body) end fetch_organization = JSON.parse(response.body) { id: fetch_organization['id'], name: fetch_organization['name'] } end rescue JSON::ParserError raise format('Failed to parse response: %s', response.body) end end def fetch_organization unless @fetch_organization @fetch_organization = if resource[:organization].is_a?(Numeric) || resource[:organization].match(%r{^[0-9]*$}) fetch_organizations.find { |x| x[:id] == resource[:organization] } else fetch_organizations.find { |x| x[:name] == resource[:organization] } end end @fetch_organization end + def folders + response = send_request('GET', format('%s/folders', resource[:grafana_api_path])) + if response.code != '200' + raise format('Fail to retrieve the folders (HTTP response: %s/%s)', response.code, response.body) + end + + begin + @folders = JSON.parse(response.body) + rescue JSON::ParserError + raise format('Fail to parse folders (HTTP response: %s/%s)', response.code, response.body) + end + end + + def find_folder + folders unless @folders + + begin + @folders.each do |folder| + @folder = folder if folder['title'] == resource[:folder] + end + raise format('Folder not found: %s', resource[:folder]) unless @folder['title'] == resource[:folder] + rescue JSON::ParserError + raise format('Fail to parse folder %s: %s', resource[:folder], response.body) + end + end + # Return the list of dashboards def dashboards response = send_request('GET', format('%s/search', resource[:grafana_api_path]), nil, q: '', starred: false) if response.code != '200' raise format('Fail to retrieve the dashboards (HTTP response: %s/%s)', response.code, response.body) end begin JSON.parse(response.body) rescue JSON::ParserError raise format('Fail to parse dashboards (HTTP response: %s/%s)', response.code, response.body) end end # Return the dashboard matching with the resource's title def find_dashboard return unless dashboards.find { |x| x['title'] == resource[:title] } response = send_request('GET', format('%s/dashboards/db/%s', resource[:grafana_api_path], slug)) if response.code != '200' raise format('Fail to retrieve dashboard %s (HTTP response: %s/%s)', resource[:title], response.code, response.body) end begin # Cache the dashboard's content @dashboard = JSON.parse(response.body)['dashboard'] rescue JSON::ParserError raise format('Fail to parse dashboard %s: %s', resource[:title], response.body) end end def save_dashboard(dashboard) + find_folder if resource[:folder] + # change organizations response = send_request 'POST', format('%s/user/using/%s', resource[:grafana_api_path], fetch_organization[:id]) unless response.code == '200' raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body) end data = { dashboard: dashboard.merge('title' => resource[:title], 'id' => @dashboard ? @dashboard['id'] : nil, 'version' => @dashboard ? @dashboard['version'] + 1 : 0), + folderId: @folder ? @folder['id'] : nil, overwrite: !@dashboard.nil? } response = send_request('POST', format('%s/dashboards/db', resource[:grafana_api_path]), data) return unless (response.code != '200') && (response.code != '412') raise format('Fail to save dashboard %s (HTTP response: %s/%s', resource[:name], response.code, response.body) end def slug resource[:title].downcase.gsub(%r{[ \+]+}, '-').gsub(%r{[^\w\- ]}, '') end def content @dashboard.reject { |k, _| k =~ %r{^id|version|title$} } end def content=(value) save_dashboard(value) end def create save_dashboard(resource[:content]) end def destroy response = send_request('DELETE', format('%s/dashboards/db/%s', resource[:grafana_api_path], slug)) return unless response.code != '200' raise Puppet::Error, format('Failed to delete dashboard %s (HTTP response: %s/%s', resource[:title], response.code, response.body) end def exists? find_dashboard end end diff --git a/lib/puppet/type/grafana_dashboard.rb b/lib/puppet/type/grafana_dashboard.rb index a0a6cb3..967669e 100644 --- a/lib/puppet/type/grafana_dashboard.rb +++ b/lib/puppet/type/grafana_dashboard.rb @@ -1,81 +1,85 @@ # Copyright 2015 Mirantis, Inc. # require 'json' Puppet::Type.newtype(:grafana_dashboard) do @doc = 'Manage dashboards in Grafana' ensurable newparam(:title, namevar: true) do desc 'The title of the dashboard.' end + newparam(:folder) do + desc 'The folder to place the dashboard in (optional)' + end + newproperty(:content) do desc 'The JSON representation of the dashboard.' validate do |value| begin JSON.parse(value) rescue JSON::ParserError raise ArgumentError, 'Invalid JSON string for content' end end munge do |value| new_value = JSON.parse(value).reject { |k, _| k =~ %r{^id|version|title$} } new_value.sort.to_h end def should_to_s(value) if value.length > 12 "#{value.to_s.slice(0, 12)}..." else value end end end newparam(:grafana_url) do desc 'The URL of the Grafana server' defaultto '' validate do |value| unless value =~ %r{^https?://} raise ArgumentError, format('%s is not a valid URL', value) end end end newparam(:grafana_user) do desc 'The username for the Grafana server (optional)' end newparam(:grafana_password) do desc 'The password for the Grafana server (optional)' end newparam(:grafana_api_path) do desc 'The absolute path to the API endpoint' defaultto '/api' validate do |value| unless value =~ %r{^/.*/?api$} raise ArgumentError, format('%s is not a valid API path', value) end end end newparam(:organization) do desc 'The organization name to create the datasource on' defaultto 1 end # rubocop:disable Style/SignalException validate do fail('content is required when ensure is present') if self[:ensure] == :present && self[:content].nil? end autorequire(:service) do 'grafana-server' end end diff --git a/spec/acceptance/grafana_folder_spec.rb b/spec/acceptance/grafana_folder_spec.rb index 5373887..8ccbe6c 100644 --- a/spec/acceptance/grafana_folder_spec.rb +++ b/spec/acceptance/grafana_folder_spec.rb @@ -1,63 +1,99 @@ require 'spec_helper_acceptance' describe 'grafana_folder' do context 'setup grafana server' do it 'runs successfully' do pp = <<-EOS class { 'grafana': cfg => { security => { admin_user => 'admin', admin_password => 'admin' } } } EOS apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end end context 'create folder resource' do it 'creates the folder' do pp = <<-EOS grafana_folder { 'example-folder': ensure => present, grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => 'admin' } EOS apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end it 'has the folder' do shell('curl --user admin:admin http://localhost:3000/api/folders') do |f| expect(f.stdout).to match(%r{example-folder}) end end end - context 'destroy folder resource' do - it 'destroys the folder' do + context 'create folder containing dashboard' do + it 'creates an example dashboard in the example folder' do + pp = <<-EOS + grafana_dashboard { 'example-dashboard': + ensure => present, + grafana_url => 'http://localhost:3000', + grafana_user => 'admin', + grafana_password => 'admin', + content => '{"uid": "abc123xy"}', + folder => 'example-folder' + } + EOS + apply_manifest(pp, catch_failures: true) + apply_manifest(pp, catch_changes: true) + end + + it 'folder contains dashboard' do + shell('curl --user admin:admin http://localhost:3000/api/dashboards/db/example-dashboard') do |f| + expect(f.stdout).to match(%r{"folderId":1}) + end + end + end + + context 'destroy resources' do + it 'destroys the folders and dashboard' do pp = <<-EOS grafana_folder { 'example-folder': ensure => absent, grafana_url => 'http://localhost:3000', grafana_user => 'admin', grafana_password => 'admin', } + grafana_folder { 'nomatch-folder': + ensure => absent, + grafana_url => 'http://localhost:3000', + grafana_user => 'admin', + grafana_password => 'admin', + } + grafana_dashboard { 'example-dashboard': + ensure => absent, + grafana_url => 'http://localhost:3000', + grafana_user => 'admin', + grafana_password => 'admin', + } EOS apply_manifest(pp, catch_failures: true) apply_manifest(pp, catch_changes: true) end - it 'does not have the folder' do + it 'does not have the folders' do shell('curl --user admin:admin http://localhost:3000/api/folders') do |f| expect(f.stdout).not_to match(%r{example-folder}) + expect(f.stdout).not_to match(%r{nomatch-folder}) end end end end