2320ee61a3
This will provide a more parsable sample policy file for us in docs. This compliments the 'sphinxpolicygen' module. Change-Id: Id99b21e7c0a66aaf4223e60074626914235e0ca5
83 lines
2.0 KiB
Python
83 lines
2.0 KiB
Python
# Copyright 2017 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 textwrap
|
|
|
|
from oslotest import base
|
|
|
|
from oslo_policy import policy
|
|
from oslo_policy import sphinxext
|
|
|
|
|
|
class FormatPolicyTest(base.BaseTestCase):
|
|
|
|
def test_minimal(self):
|
|
results = '\n'.join(list(sphinxext._format_policy_section(
|
|
'foo', [policy.RuleDefault('rule_a', '@')])))
|
|
|
|
self.assertEqual(textwrap.dedent("""
|
|
foo
|
|
===
|
|
|
|
``rule_a``
|
|
|
|
Default::
|
|
|
|
@
|
|
""").lstrip(), results)
|
|
|
|
def test_with_description(self):
|
|
results = '\n'.join(list(sphinxext._format_policy_section(
|
|
'foo', [policy.RuleDefault('rule_a', '@', 'My sample rule')]
|
|
)))
|
|
|
|
self.assertEqual(textwrap.dedent("""
|
|
foo
|
|
===
|
|
|
|
``rule_a``
|
|
|
|
My sample rule
|
|
|
|
Default::
|
|
|
|
@
|
|
""").lstrip(), results)
|
|
|
|
def test_with_operations(self):
|
|
results = '\n'.join(list(sphinxext._format_policy_section(
|
|
'foo', [policy.DocumentedRuleDefault(
|
|
'rule_a', '@', 'My sample rule', [
|
|
{'method': 'GET', 'path': '/foo'},
|
|
{'method': 'POST', 'path': '/some'}])]
|
|
)))
|
|
|
|
self.assertEqual(textwrap.dedent("""
|
|
foo
|
|
===
|
|
|
|
``rule_a``
|
|
|
|
My sample rule
|
|
|
|
Default::
|
|
|
|
@
|
|
|
|
Operations:
|
|
|
|
- **GET** ``/foo``
|
|
- **POST** ``/some``
|
|
""").lstrip(), results)
|