grafyaml/tests/base.py
Paul Belanger 42ef61dde0 Add a slug to better track dashboards
Currently grafana will generate a slug based on the title name. For
now, we can use an existing python library to do this.  Ideally, we'll
need to make sure the slugs generated between both are kept in sync.

How hard can that be?

Also move our validation logic into parser.py, since they are closely
related.

Change-Id: Id43f51d3f9db9131c25a8130f957572344a7d8f1
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
2015-09-28 10:15:10 -04:00

73 lines
2.2 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2010-2011 OpenStack Foundation
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
# 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 doctest
import json
import os
import re
import testtools
from grafana_dashboards.parser import YamlParser
def get_scenarios(fixtures_path, in_ext='yaml', out_ext='json'):
scenarios = []
files = []
for dirpath, dirs, fs in os.walk(fixtures_path):
files.extend([os.path.join(dirpath, f) for f in fs])
input_files = [f for f in files if re.match(r'.*\.{0}$'.format(in_ext), f)]
for input_filename in input_files:
output_candidate = re.sub(
r'\.{0}$'.format(in_ext), '.{0}'.format(out_ext), input_filename)
if output_candidate not in files:
output_candidate = None
scenarios.append((input_filename, {
'in_filename': input_filename,
'out_filename': output_candidate,
}))
return scenarios
class TestCase(object):
"""Test case base class for all unit tests."""
def _read_raw_content(self):
# if None assume empty file
if self.out_filename is None:
return ""
content = open(self.out_filename, 'r').read()
return content
def test_yaml_snippet(self):
parser = YamlParser()
expected_json = self._read_raw_content()
parser.parse(self.in_filename)
valid_yaml = parser.data
pretty_json = json.dumps(
valid_yaml, indent=4, separators=(',', ': '), sort_keys=True)
self.assertThat(pretty_json, testtools.matchers.DocTestMatches(
expected_json, doctest.ELLIPSIS | doctest.REPORT_NDIFF))