grafyaml/tests/test_parser.py
Ian Wienand 5f785f7782 Add import of json files
This simply takes any json files present and loads them into Grafana
directly.  The idea is that you can edit the dashboards using the
inbuilt editor, then copy the dashboard JSON and keep it externally
version controlled.  No parsing or validation is done on the JSON
files; we are assuming they have not been hand-modified from what
Grafana generates.

Change-Id: I38695aed2404f8b7fc350d949b7a9212498c35cb
2020-06-25 15:04:14 +10:00

112 lines
3.6 KiB
Python

# Copyright 2015 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import os
from testtools import TestCase
from grafana_dashboards import parser
class TestCaseParser(TestCase):
def setUp(self):
super(TestCaseParser, self).setUp()
self.parser = parser.YamlParser()
def test_get_dashboard_empty(self):
self._get_empty_dashboard('foobar')
def test_parse_multiple(self):
path = os.path.join(
os.path.dirname(__file__), 'fixtures/parser/dashboard-0001.yaml')
self.parser.parse(path)
dashboard = {
'foobar': {
'rows': [],
'templating': {
'enabled': False,
'list': [],
},
'timezone': 'utc',
'title': 'foobar',
},
'new-dashboard': {
'rows': [],
'templating': {
'enabled': False,
'list': [],
},
'timezone': 'utc',
'title': 'New dashboard',
},
}
# Get parsed dashboard
res, md5 = self.parser.get_dashboard('new-dashboard')
self.assertEqual(res, dashboard['new-dashboard'])
# Check for a dashboard that does not exist
self._get_empty_dashboard('foobar')
# Parse another file to ensure we are appending data.
path = os.path.join(
os.path.dirname(__file__), 'fixtures/parser/dashboard-0002.yaml')
self.parser.parse(path)
res, md5 = self.parser.get_dashboard('foobar')
self.assertEqual(res, dashboard['foobar'])
# Ensure our first dashboard still exists.
res, md5 = self.parser.get_dashboard('new-dashboard')
self.assertEqual(res, dashboard['new-dashboard'])
def test_parse_duplicate(self):
path = os.path.join(
os.path.dirname(__file__), 'fixtures/parser/dashboard-0001.yaml')
self.parser.parse(path)
dashboard = {
'new-dashboard': {
'rows': [],
'templating': {
'enabled': False,
'list': [],
},
'timezone': 'utc',
'title': 'New dashboard',
},
}
# Get parsed dashboard
res, md5 = self.parser.get_dashboard('new-dashboard')
self.assertEqual(res, dashboard['new-dashboard'])
path = os.path.join(
os.path.dirname(__file__), 'fixtures/parser/dashboard-0003.yaml')
# Fail to parse duplicate dashboard
self.assertRaises(Exception, self.parser.parse, path)
def _get_empty_dashboard(self, name):
res, md5 = self.parser.get_dashboard(name)
self.assertEqual(res, None)
def test_parse_json(self):
path = os.path.join(
os.path.dirname(__file__),
'fixtures/parser/json-dashboard-0001.json')
self.parser.parse(path)
# Get parsed dashboard
res, md5 = self.parser.get_dashboard('test-json')
self.assertEqual(res['title'], 'test json')