Patrole project is not active anymore and its gate is broken.
We waited for couple of cycle to see if there is any interest
in this project and anyone can maintain it. But we did not get any
new maintainers and current QA team does not have bandwidth/interest
to continue maintaining it.
This project was for RBAc testing which is moving towards unit/functional
tests on service side as well as tempest plugins tests.
In QA 2023.2 PTG, we decided to retire this project
- https://etherpad.opendev.org/p/qa-bobcat-ptg
Change-Id: I7721cf06104e5871ec27cdd87d4608dace60a8b7
This commit add PDF building tox.ini environment and options for LaTeX
output. The chapter header in README.rst has been changed because "Team
and repository tags" is not appropriate for the title of this document.
And, this commit also updates repository URLs to opendev.org.
Change-Id: I1337f3185d72108eef2968cca3cb81d52e742e90
Story: #2006070
Task: #35469
Updates references to Launchpad to now point to Storyboard.
Patrole moved to Stoyboard with patchset [0], which was
relatively straightforward since Patrole did not have much
baggage left in Launchpad.
(#just like Tempest) to reduce documentation maintenance
[0] https://review.openstack.org/#/c/575182/
Change-Id: Id20a1940a8679ec6222b9b9445631fc86e1af6d5
- When the URL refers to cloning or using git repositories, use the
cloning URL (https://git.openstack.org/<namespace>/<project>)
- When the URL refers to the browsable version of the repository, point to
the cgit frontend (https://git.openstack.org/cgit/<namespace>/<project>)
Change-Id: Iaeaa153a05aa85b9cf7451ae3c28aec56722222c
This documentation is included in HACKING at the top to let
newcomers know that Patrole's testing scope is confined to the
following projects:
* Cinder
* Glance
* Keystone
* Neutron
* Nova
Depends-On: https://review.openstack.org/#/c/615394
Change-Id: I6f70a6169592fec41de67ecfed6e5ca5b9af0deb
This patch set adds documentation about white box vs block box
testing and their relationship in Patrole. This is so that
devs/test writers understand that Patrole is a bit different than
Tempest and requires digging a bit deeper in the internals of
the API implementation in order to properly test RBAC.
Also removes a misleading link in the README.rst section. The
discussion on member vs. _member_ role is very outdated and
so a link is provided to the RBAC overview section instead which
is concerned with documenting such information.
Change-Id: I0a014c2e917caeb058dd5b5294dd0af2e5e49132
Since 'all-plugin' is deprecated in Tempest, this is to
switch to 'all' instead in .zuul.yaml; for more info,
see: 9b4c50cf63/tox.ini (L64)
Depends-On: Ib3264f54075216471720483c8dd816887c1f413c
Change-Id: I440b6cff2b5378e18304017589e3e7cf4748c28c
This patchset replaces ``CONF.patrole.rbac_test_role`` with
``CONF.patrole.rbac_test_roles``, where instead of single role
we can specify list of roles to be assigned to test user.
Change-Id: Ia68bcbdbb523dfe7c4abd6107fb4c426a566ae9d
While releasing new version in pypi, it perform the
validation on the package and give error if there is any
formatting issue.
README file is being used to upload on pypi and so validation
check fails[1] on current README due to 'ref' used for internal
doc link. Those links would not be available for outside the built doc.
This can be checked locally by:
python setup.py check -s -r
This commit fixes those format issue by removing the ref and provide the
external links.
Change-Id: I678e792eaf4e362f48864da761461c7779a09155
This patchset adds an RBAC overview documentation section dedicated
to:
* Defining what RBAC is
* Policy in code and validation info related to it
* Custom policies and validation info related to it
* Multiple policies and validation info related to it
* Error codes
* Glossary
This way, users can learn about what RBAC is from a high level
and how Patrole uses validation to validate that it is working
correctly.
Change-Id: Ib411e4d06210135f7bd1cb90d5b6d59da2e5d076
This patchset brings the README.rst and the overview.rst
documentation together. Previously they were maintained
separately which causes maintenance issues. This adds
a symlink from the overview.rst to the README.rst so
that the overview documentation only needs to be maintained
for the README.
This also adds a Terminology subsection underneath the
"How it works" section which expands on essential terminology
needed to understand Patrole testing architecture:
* Expected Result - The expected result of a given test.
* Actual Result - The actual result of a given test.
* Final Result - A match between both expected and actual results. A mismatch
in the expected result and the actual result will result in a test failure.
* Expected: Pass | Actual: Pass - Test Case Success
* Expected: Pass | Actual: Fail - Test Case Failure
* Expected: Fail | Actual: Pass - Test Case Failure
* Expected: Fail | Actual: Fail (Expected exception) - Test Case Success
* Expected: Fail | Actual: Fail (Unexpected exception) - Test Case Failure
Change-Id: I1d640200c55ce26cfd38197ec6face1161217b17
This patchset adds a Patrole overview documentation
section which is sorely needed. It combines the previous
usage documentation into it.
Change-Id: Ia7412f2e99f33fbdfd2e60ba54ffdba757d1f886
This documentation update adds a README.rst to
patrole_tempest_plugin/tests/api which explains the RBAC field
guide. It is modeled after Tempest's API field guide [0][1]. The
README.rst is then referenced in a new field_guide section
under doc/source/field_guide.
[0] 28b252f7f6/tempest/api
[1] https://docs.openstack.org/tempest/latest/field_guide/api.html#api-field-guide
Change-Id: I877ce4a1f681bd483c7f71b02fd7bb2b4d3b3e2a
This PS adds a blurb about Patrole design principles in the project
README file. These principles are used to explain current and future
project design innovations.
Change-Id: I58ab03114d695f4beaa5ce4e52fa03fda90cd4dc
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links
Change-Id: I86b5f7fe245bc3731e16ef9a5db239d6da44c69d
This is a trivial fix which corrects the headers so that way
they are rendered correctly, as currently they are not [0].
[0] See README at https://github.com/openstack/patrole
Change-Id: I8b1303b1a92828289187d7a0b7377f7f2524cdda
This commit improves the Patrole README by making it a high-level
introduction to Patrole. Implementation-specific details have been
removed from the README; they will be included in greater detail
in the Patrole documentation in a follow-up commit.
Change-Id: I6a0b4a4ef8017df24a8b8465750dae21039b1afc
Depends-On: I4d468b7f1bb6a000fde42d656635159176d5ef7f
Fixed README.rst formatting and added information about stable
interfaces for Patrole and release notes and versioning.
Change-Id: I2ba7c8b7dd2b4db82f19e661ef798f95e588ee62
Updates patrole's current documentation with improved formatting.
Also updates many sections to add more clarity and detail.
Change-Id: Idebe341e2fcb0ee04db979d41df9bef5395af1b5
Ghanshyam Mann