[
https://issues.apache.org/jira/browse/FINERACT-2781?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Krishna Mewara updated FINERACT-2781:
-------------------------------------
Fix Version/s: 1.16.0
> Document the Feign integration test conventions and guard them with Checkstyle
> ------------------------------------------------------------------------------
>
> Key: FINERACT-2781
> URL: https://issues.apache.org/jira/browse/FINERACT-2781
> Project: Apache Fineract
> Issue Type: Improvement
> Components: Test
> Affects Versions: 1.15.0
> Reporter: Krishna Mewara
> Assignee: Krishna Mewara
> Priority: Trivial
> Labels: CI, documentaion, documentation-update, feign-migration
> Fix For: 1.16.0
>
>
> h3. Documentation & Tooling: Feign Integration Tests
> *Overview* The current integration testing chapter has become outdated. It
> incorrectly teaches the REST Assured setup block as the standard for new
> tests and documents non-existent base-class methods and Gradle invocations.
> Furthermore, the conventions guiding the Feign migration currently only exist
> in pull request comments rather than official documentation.
> h3. Key Additions & Updates
> * *New Feign Documentation:* Added a new "Feign Integration Tests" chapter
> that officially captures Feign migration conventions with stable rule
> identifiers.
> * *Checkstyle Enforcement:* Introduced a Checkstyle rule to strictly keep
> REST Assured out of the shared Feign base classes and helpers (the code
> inherited by all migrated tests).
> * *Tooling Efficiency:* The new rule reuses the
> {{ForbidCertainImportsCheck}} already present in
> {{{}config/checkstyle/checkstyle.xml{}}}. It runs within the existing
> {{checkstyleTest}} job, requiring no new tooling or CI workflow changes.
> * *Cleaned Up Legacy Documentation:* Removed fabricated and non-existent
> base-class methods from the existing chapter.
> * *Fixed Gradle Invocations:* Cleaned up documentation by removing invalid
> flags ({{{}--exclude{}}}, {{{}-Xmx4g{}}}, {{{}-Dtest.timeout{}}}) and adding
> the previously missing {{-PcargoDisabled}} flag.
> * *Updated Database Troubleshooting:* Replaced MySQL-only troubleshooting
> commands to align with the *FSIP-9* standard, which dictates PostgreSQL.
> {quote}*Scope Note:* This update focuses entirely on documentation and build
> validation. No production or test code is changed.
> {quote}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
