add functions

 - dashboard_all_versions()
 - dashboard_version()
 - restore_dashboard()
 - compare_dashboard_version()

Author: bodsch

lib/grafana/dashboard_versions.rb

@@ -19,14 +19,13 @@ def dashboard_all_versions( params )
       raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
-      v, mv = version.values
-      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+#      v, mv = version.values
+#      return { 'status' => 404, 'message' => format( 'only Grafana 5 has dashboard version support. you use version %s', v) } if(mv != 5)
 
       dashboard_id  = validate( params, required: true , var: 'dashboard_id', type: Integer )
       start         = validate( params, required: false, var: 'start'       , type: Integer )
       limit         = validate( params, required: false, var: 'limit'       , type: Integer )
 
-
       api     = []
       api << format( 'start=%s', start ) unless( start.nil? )
       api << format( 'limit=%s', limit ) unless( limit.nil? )
@@ -41,24 +40,85 @@ def dashboard_all_versions( params )
     # GET /api/dashboards/id/:dashboardId/versions/:id
     def dashboard_version( params )
 
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
+      v, mv = version.values
+      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+
+      dashboard_id  = validate( params, required: true, var: 'dashboard_id', type: Integer )
+      version       = validate( params, required: true, var: 'version'     , type: Integer )
+
+      endpoint = format('/api/dashboards/id/%s/versions/%s', dashboard_id, version)
+
+      r = get(endpoint)
+
+      r['message'] = format('no dashboard version \'%s\' for dashboard \'%s\' found', version, dashboard_id) if(r.dig('status') == 404)
+      r['message'] = format('no dashboard version \'%s\' for dashboard \'%s\' found', version, dashboard_id) if(r.dig('status') == 500)
+      r
     end
 
     # Restore dashboard
     # http://docs.grafana.org/http_api/dashboard_versions/#restore-dashboard
     # POST /api/dashboards/id/:dashboardId/restore
     def restore_dashboard( params )
 
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
 
+#      v, mv = version.values
+#      return { 'status' => 404, 'message' => format( 'only Grafana 5 has folder support. you use version %s', v) } if(mv != 5)
+
+      dashboard_id  = validate( params, required: true, var: 'dashboard_id', type: Integer )
+      version       = validate( params, required: true, var: 'version'    , type: Integer )
+
+      endpoint = format('/api/dashboards/id/%s/restore', dashboard_id)
+
+      payload = {
+        version: version
+      }
+
+      post(endpoint, payload.to_json)
     end
 
     # Compare dashboard versions
     # http://docs.grafana.org/http_api/dashboard_versions/#compare-dashboard-versions
     # POST /api/dashboards/calculate-diff
     def compare_dashboard_version( params )
 
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      base      = validate( params, required: true , var: 'base'     , type: Hash )
+      new       = validate( params, required: true , var: 'new'      , type: Hash )
+      diff_type = validate( params, required: false, var: 'diff_type', type: String ) || 'json'
+
+      base_dashboard_id      = validate( base, required: true , var: 'dashboard_id', type: Integer )
+      base_dashboard_version = validate( base, required: true , var: 'version'     , type: Integer )
+      new_dashboard_id       = validate( new , required: true , var: 'dashboard_id', type: Integer )
+      new_dashboard_version  = validate( new , required: true , var: 'version'     , type: Integer )
+
+      valid_diff_type = %w[json basic]
+
+      r = validate_hash(diff_type, valid_diff_type)
+
+      return r unless(r == true)
+
+      payload = {
+        base: {
+          dashboardId: base_dashboard_id,
+          version: base_dashboard_version
+        },
+        new: {
+          dashboardId: new_dashboard_id,
+          version: new_dashboard_version
+        },
+        diffType: diff_type
+      }
 
+      endpoint = '/api/dashboards/calculate-diff'
 
+      post(endpoint, payload.to_json)
     end
 
   end

spec/grafana_spec.rb

@@ -1421,7 +1421,46 @@
     end
 
 
-    it 'Gets all existing permissions for a existing dashboard' do
+    it 'get all dashboard versions' do
+      search = { query: 'QA Graphite Carbon Metrics' }
+      r = @g.search_dashboards( search )
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 200
+      message = r.dig('message')
+      expect(message).to be_a(Array)
+      id = message.first.dig('id')
+
+      r = @g.dashboard_all_versions(dashboard_id: id)
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 200
+    end
+
+    it 'get all dashboard versions of dashboard \'999\' (must be fail)' do
+      r = @g.dashboard_all_versions(dashboard_id: 999)
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 404
+    end
+
+    it 'get version 1 of dashboard' do
+      search = { query: 'QA Graphite Carbon Metrics' }
+      r = @g.search_dashboards( search )
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 200
+      message = r.dig('message')
+      expect(message).to be_a(Array)
+      id = message.first.dig('id')
+
+      r = @g.dashboard_version(dashboard_id: id, version: 1)
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 200
+    end
+
+    it 'get version 15 of dashboard (must be fail)' do
       search = { query: 'QA Graphite Carbon Metrics' }
       r = @g.search_dashboards( search )
       expect(r).to be_a(Hash)
@@ -1431,15 +1470,56 @@
       expect(message).to be_a(Array)
       id = message.first.dig('id')
 
-      r = @g.dashboard_all_versions(id)
-      puts r
+      r = @g.dashboard_version(dashboard_id: id, version: 15)
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 500
+    end
+
+
+    it 'restore dashboard version 2' do
+      search = { query: 'QA Graphite Carbon Metrics' }
+      r = @g.search_dashboards( search )
       expect(r).to be_a(Hash)
       status  = r.dig('status')
       expect(status).to be == 200
+      message = r.dig('message')
+      expect(message).to be_a(Array)
+      id = message.first.dig('id')
+
+      r = @g.restore_dashboard(dashboard_id: id, version: 2)
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be_a(Integer)
     end
 
 
+    it 'compare dashboard versions' do
+      search = { query: 'QA Graphite Carbon Metrics' }
+      r = @g.search_dashboards( search )
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be == 200
+      message = r.dig('message')
+      expect(message).to be_a(Array)
+      id = message.first.dig('id')
 
+      params = {
+        'base': {
+          'dashboard_id' => id,
+          'version' => 1
+        },
+        'new': {
+          'dashboard_id' => id,
+          'version' => 2
+        }
+      }
+
+      r = @g.compare_dashboard_version(params)
+      expect(r).to be_a(Hash)
+      status  = r.dig('status')
+      expect(status).to be_a(Integer)
+    end