Added a readme for fs-integration-test-suite#922
Added a readme for fs-integration-test-suite#922De-Silva-Madhushankha wants to merge 1 commit intowso2:mainfrom
Conversation
WalkthroughA comprehensive README documentation file is added to the fs-integration-test-suite project, covering project overview, repository structure, prerequisites, environment setup, TestConfiguration.xml configuration, build and run instructions, test modules, reporting, and architecture details. No code modifications. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip You can disable the changed files summary in the walkthrough.Disable the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@fs-integration-test-suite/README.md`:
- Line 343: The README uses mixed English spelling—this line says
"authorization" while earlier sections use "authorisation"; update this sentence
(the one mentioning the `is-setup` module and "user creation and API
authorization pre-steps") to use the project's chosen variant (match all other
occurrences, e.g., change "authorization" to "authorisation" or vice versa) so
the document is consistent across the file.
- Around line 138-139: Replace concrete example secrets with explicit
placeholders and add a short warning about not committing real credentials:
change values like the `wso2carbon` entry for `<Password>` and
`cIYo-5zX4OTWZpHrmmiZDVxACJM` for `<SigningKid>` to generic placeholders (e.g.,
<YOUR_PASSWORD>, <YOUR_SIGNING_KID>) and insert a one-line note such as "Do not
use real credentials—replace with placeholders and never commit secrets." Apply
the same replacement pattern to the other occurrences mentioned (near the blocks
referenced at 147-148, 166-167, 195-206, 245-249) so all example credentials are
placeholders.
- Around line 11-34: Update the fenced code block in README.md that displays the
directory tree (the block that starts with "fs-integration-test-suite/" and the
triple backticks) to include a language tag (e.g., change ``` to ```text) so
markdownlint MD040 is satisfied; modify the opening fence for that tree block
only, leaving the tree contents (lines containing "bfsi-test-framework",
"accelerator-tests", "test-artifacts", "pom.xml", etc.) unchanged.
- Around line 81-83: Update the fenced code block that contains the path
"fs-integration-test-suite/accelerator-test-framework/src/main/resources/TestConfiguration.xml"
to include a language tag to satisfy MD040; add the tag "text" immediately after
the opening backticks (i.e., change ``` to ```text) so the block becomes a text
fenced block.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a3c05eef-af76-423c-8a69-34f0aa62562b
📒 Files selected for processing (1)
fs-integration-test-suite/README.md
| ``` | ||
| fs-integration-test-suite/ | ||
| ├── bfsi-test-framework/ # Base BFSI test framework | ||
| ├── accelerator-test-framework/ # FS Accelerator test framework & TestConfiguration | ||
| │ └── src/main/resources/ | ||
| │ └── TestConfigurationExample.xml | ||
| ├── accelerator-tests/ | ||
| │ ├── is-tests/ # IS integration tests | ||
| │ │ ├── dcr/ | ||
| │ │ ├── token/ | ||
| │ │ ├── pre-configuration-step/ | ||
| │ │ ├── consent-management/ | ||
| │ │ └── event-notification/ | ||
| │ └── gateway-tests/ # Gateway integration tests | ||
| │ ├── accounts/ | ||
| │ ├── payments/ | ||
| │ ├── cof/ | ||
| │ ├── dcr/ | ||
| │ ├── token/ | ||
| │ ├── schema.validation/ | ||
| │ └── non.regulatory.scenarios/ | ||
| ├── test-artifacts/ # Keystores, SSAs, and other test artifacts | ||
| └── pom.xml | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to the fenced tree block.
The block should specify a language (for example text) to satisfy markdownlint MD040.
Suggested edit
-```
+```text
fs-integration-test-suite/
├── bfsi-test-framework/ # Base BFSI test framework
...
└── pom.xml</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@fs-integration-test-suite/README.md` around lines 11 - 34, Update the fenced
code block in README.md that displays the directory tree (the block that starts
with "fs-integration-test-suite/" and the triple backticks) to include a
language tag (e.g., change ``` to ```text) so markdownlint MD040 is satisfied;
modify the opening fence for that tree block only, leaving the tree contents
(lines containing "bfsi-test-framework", "accelerator-tests", "test-artifacts",
"pom.xml", etc.) unchanged.
| ``` | ||
| fs-integration-test-suite/accelerator-test-framework/src/main/resources/TestConfiguration.xml | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to this fenced path block.
This also triggers MD040; use text for consistency.
Suggested edit
-```
+```text
fs-integration-test-suite/accelerator-test-framework/src/main/resources/TestConfiguration.xml</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.21.0)</summary>
[warning] 81-81: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @fs-integration-test-suite/README.md around lines 81 - 83, Update the fenced
code block that contains the path
"fs-integration-test-suite/accelerator-test-framework/src/main/resources/TestConfiguration.xml"
to include a language tag to satisfy MD040; add the tag "text" immediately after
the opening backticks (i.e., change totext) so the block becomes a text
fenced block.
</details>
<!-- fingerprinting:phantom:triton:hawk -->
<!-- This is an auto-generated comment by CodeRabbit -->
| | `<Password>` | Keystore password | `wso2carbon` | | ||
| | `<SigningKid>` | Key ID (`kid`) used in JWT headers | `cIYo-5zX4OTWZpHrmmiZDVxACJM` | |
There was a problem hiding this comment.
Avoid realistic secrets in examples; use explicit placeholders.
Several snippets show concrete passwords/client secrets. Even in docs, this can normalize insecure copy-paste. Prefer placeholders and add a short “never commit real credentials” note.
Suggested edit pattern
-| `<Password>` | Keystore password | `wso2carbon` |
+| `<Password>` | Keystore password | `<CHANGE_ME>` |
- <Password>testUser@wso2123</Password>
+ <Password><PSU_PASSWORD></Password>
- <ISAdminPassword>wso2123</ISAdminPassword>
+ <ISAdminPassword><IS_ADMIN_PASSWORD></ISAdminPassword>Also applies to: 147-148, 166-167, 195-206, 245-249
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@fs-integration-test-suite/README.md` around lines 138 - 139, Replace concrete
example secrets with explicit placeholders and add a short warning about not
committing real credentials: change values like the `wso2carbon` entry for
`<Password>` and `cIYo-5zX4OTWZpHrmmiZDVxACJM` for `<SigningKid>` to generic
placeholders (e.g., <YOUR_PASSWORD>, <YOUR_SIGNING_KID>) and insert a one-line
note such as "Do not use real credentials—replace with placeholders and never
commit secrets." Apply the same replacement pattern to the other occurrences
mentioned (near the blocks referenced at 147-148, 166-167, 195-206, 245-249) so
all example credentials are placeholders.
|
|
||
| - The `TestConfigurationExample.xml` must be copied to `TestConfiguration.xml` before running - the automated `test.sh` script does this automatically. | ||
|
|
||
| - The `is-setup` module is commented out in the IS test modules' `pom.xml` and is not run by default. It contains Groovy scripts for user creation and API authorization pre-steps. |
There was a problem hiding this comment.
Keep one English variant for consistency.
This line uses authorization while earlier sections use authorisation. Pick one variant across the document (prefer repo/project convention).
🧰 Tools
🪛 LanguageTool
[uncategorized] ~343-~343: Do not mix variants of the same word (‘authorization’ and ‘authorisation’) within a single text.
Context: ...roovy scripts for user creation and API authorization pre-steps. - The `test-artifacts/Dynam...
(EN_WORD_COHERENCY)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@fs-integration-test-suite/README.md` at line 343, The README uses mixed
English spelling—this line says "authorization" while earlier sections use
"authorisation"; update this sentence (the one mentioning the `is-setup` module
and "user creation and API authorization pre-steps") to use the project's chosen
variant (match all other occurrences, e.g., change "authorization" to
"authorisation" or vice versa) so the document is consistent across the file.
1 participant
Added a readme for fs-integration-test-suite
Issue link: closes #921
Development Checklist
Testing Checklist
Summary by CodeRabbit