adding asciidoc generator tests

simplify setup and expand coverage

linting

scripts/tests/test_asciidoc_fields.py

@@ -0,0 +1,132 @@
+import os
+import sys
+import unittest
+
+sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+
+from scripts.generators import asciidoc_fields
+from scripts.generators import intermediate_files
+from scripts.schema import cleaner
+from scripts.schema import loader
+from scripts.schema import finalizer
+
+
+class TestGeneratorsAsciiFields(unittest.TestCase):
+
+ def setUp(self):
+ self.foo_fieldset = self.dummy_fieldset()
+
+ def dummy_fieldset(self):
+ return {
+ 'description': 'foo',
+ 'fields': {
+ 'foo.type': {
+ 'dashed_name': 'foo-type',
+ 'description': 'describes the foo',
+ 'example': '2016-05-23T08:05:34.853Z',
+ 'flat_name': 'foo.type',
+ 'level': 'core',
+ 'name': 'type',
+ 'normalize': ['array'],
+ 'short': 'describes the foo',
+ 'ignore_above': 1024,
+ 'type': 'keyword',
+ 'allowed_values': [{
+ 'description': 'fluffy foo',
+ 'name': 'fluffy',
+ },
+ {
+ 'description': 'coarse foo',
+ 'name': 'coarse',
+ }
+ ]
+ },
+ 'foo.id': {
+ 'dashed_name': 'foo-id',
+ 'description': 'Unique ID of the foo.',
+ 'example': 'foo123',
+ 'flat_name': 'foo.id',
+ 'ignore_above': 1024,
+ 'level': 'core',
+ 'name': 'id',
+ 'normalize': [],
+ 'short': 'Unique ID of the foo.',
+ 'type': 'keyword'
+ }
+ },
+ 'reusable': {
+ 'expected': [
+ {
+ 'as': 'foo',
+ 'at': 'server',
+ 'full': 'server.foo'
+ },
+ {
+ 'as': 'foo',
+ 'at': 'source',
+ 'full': 'source.foo'
+ },
+ {
+ 'as': 'foo',
+ 'at': 'client',
+ 'full': 'client.foo',
+ },
+ {
+ 'as': 'foo',
+ 'at': 'destination',
+ 'full': 'destination.foo'
+ }
+ ],
+ 'top_level': False,
+ },
+ 'reused_here': [
+ {
+ 'full': 'foo.as',
+ 'schema_name': 'as',
+ 'short': 'Fields describing an AS'
+ }
+ ],
+ 'group': 2,
+ 'name': 'foo',
+ 'prefix': 'foo.',
+ 'short': 'Foo fields',
+ 'title': 'Foo',
+ 'type': 'group'
+ }
+
+ def test_validate_sort_fieldset(self):
+ sorted_foo_fields = asciidoc_fields.sort_fields(self.foo_fieldset)
+ #import pdb;pdb.set_trace()
+ self.assertIsInstance(sorted_foo_fields, list)
+
+ # `allowed_value_names` always present
+ for field in sorted_foo_fields:
+ self.assertIsInstance(field.get('allowed_value_names'), list)
+
+ self.assertFalse(sorted_foo_fields[0]['allowed_value_names'])
+ self.assertEqual('id', sorted_foo_fields[0]['name'])
+ self.assertEqual('type', sorted_foo_fields[1]['name'])
+ self.assertIn('fluffy', sorted_foo_fields[1]['allowed_value_names'])
+ self.assertIn('coarse', sorted_foo_fields[1]['allowed_value_names'])
+
+ def test_rendering_fieldset_reuse(self):
+ foo_reuse_fields = asciidoc_fields.render_fieldset_reuse_text(self.foo_fieldset)
+ expected_sorted_reuse_fields = (
+ 'client.foo',
+ 'destination.foo',
+ 'server.foo',
+ 'source.foo'
+ )
+
+ self.assertEqual(expected_sorted_reuse_fields, tuple(foo_reuse_fields))
+
+ def test_rendering_fieldset_nesting(self):
+ foo_nesting_fields = asciidoc_fields.render_nestings_reuse_section(self.foo_fieldset)
+ self.assertIsInstance(foo_nesting_fields, list)
+ self.assertEqual('foo.as.*', foo_nesting_fields[0]['flat_nesting'])
+ self.assertEqual('as', foo_nesting_fields[0]['name'])
+ self.assertEqual('Fields describing an AS', foo_nesting_fields[0]['short'])
+
+
+if __name__ == '__main__':
+ unittest.main()