Bertrand Delacretaz created SLING-10747:
-------------------------------------------
Summary: Remove test-99 and better sync docs page with repoinit
parser tests
Key: SLING-10747
URL: https://issues.apache.org/jira/browse/SLING-10747
Project: Sling
Issue Type: Bug
Components: Repoinit
Affects Versions: Repoinit Parser 1.6.10
Reporter: Bertrand Delacretaz
The docs page at
[https://sling.apache.org/documentation/bundles/repository-initialization.html]
is supposed to show examples of all repoinit statements, but it's hard to keep
in sync manually and is often slightly out of sync.
The {{src/test/resources/testcases/test-99.txt}} is supposed to also expose all
the repoinit syntax, is also maintained manually and is not 100% in sync with
that docs page.
To make sure the docs stay in sync with minimal effort, we should:
* Remove the {{test-99.txt}} and adapt the other tests scenarios to make sure
the test coverage remains the same or better. Currently there's a slight
difference in "missed branches" in the {{-P jacoco-report}} output for the
parser.impl package if I remove it.
* Create a script that aggregates all the
{{src/test/resources/testcases/test-*.txt}} scenarios, ordered by name, and use
that output in the docs page.
* Verify that the result is at least as good as the current docs page in terms
of examples, comments and notes on required versions, and adapt the test
scenarios if not.
* Add information to the docs page on how to keep it up to date.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
