test: introduced bruno collections for API Flows testing #489

nora-weisser · 2026-01-27T20:56:03Z

Description

Bruno is a fast, Git-friendly API client (think Postman, but local-first and text-based). This flow is designed so the whole team can run the same requests with minimal setup and predictable results. One of the main advantages for our team is the fact that it is easy to collaborate and version control our test cases and flows.

In this PR I implemented one test flow as an example:
Mentor creation → Get Mentors and validate if the mentor was created → Update Mentor data → Get Mentors and validate if the mentor was updated → Delete Mentor → Get Mentors and validate if the mentor was deleted

For more information, please refer to the updated documentation in README.md

Note: PUT /mentor doesn't work properly for now, since there was a bug, will be fixed soon.

Screenshots

Report in html:

Pull request checklist

Please check if your PR fulfills the following requirements:

I checked and followed the contributor guide
I have tested my changes locally.

goelsonali · 2026-01-28T11:44:29Z

api-flows/MentorRegisterUpdateDeleteFlow/API to update mentor data.bru

+}
+
+put {
+  url: {{baseUrl}}/api/platform/v1/mentors/:mentorId


There is an automated way to populate the bruno collection in an openAPI format via the gradle build plugin ( similar to what we have done for generating the postman collection), not sure if that can help you import the endpoints quicker ?

Unfortunately (bc I also got excited with that idea) I don't think openapi-generator supports Bruno, as neither their README nor the languages folder list it :(

We can be creative and parse the OpenAPI ourselves via a custom script and re-populate the Bruno URLs or do it manually, but either approach seems too much for this PR...

gpaOliveira · 2026-01-28T12:29:21Z

README.md

+
+Mentor creation → Get Mentors and validate if the mentor was created → Update Mentor data → Get Mentors and validate if the mentor was updated → Delete Mentor → Get Mentors and validate if the mentor was deleted
+
+**Run a Folder and Generate HRML Report**


Despite the suggestion, maybe worth to explain why such a report is useful?

Suggested change

**Run a Folder and Generate HRML Report**

**Run a Folder and Generate HTML Report**

gpaOliveira · 2026-01-28T12:30:13Z

README.md

+3. Give the request a clear, descriptive name
+4. Select the HTTP method and configure the endpoint, headers, and body
+5. Use environment variables (e.g. {{baseUrl}}, {{mentorId}}) instead of hardcoded values
+6. Use faker built-in faker library to generate realistic data for payloads


This item-6 deserves some pointers to articles or how-to... are there some available?

gpaOliveira · 2026-01-28T12:31:25Z

README.md

+3. Name the folder after the business flow or feature
+4. Example: `Mentee Registration & Approval Flow`, `Matching Flow`
+5. Add requests in the order they should be executed
+6. Ensure each request can be run sequentially as part of a folder execution


Maybe worth adding a stage in the CI to run the folder via CLI so we know when it breaks?

Suggested change

6. Ensure each request can be run sequentially as part of a folder execution

6. Ensure each request can be run sequentially as part of a folder execution by running the whole folder and making sure the HTML report is generated

gpaOliveira · 2026-01-28T12:37:15Z

The GIF is missing 🤣

https://tenor.com/view/we-dont-talk-about-bruno-encanto-encanto-bruno-disney-we-dont-talk-about-bruno-encan-gif-24365426

gpaOliveira · 2026-01-28T14:54:22Z

README.md

+
+### Prerequisites
+Before using this flow, make sure you have:
+1. Bruno installed: https://www.usebruno.com/


Maybe 3. would be npm install -g @usebruno/cli (that is only seen below) ?

Could we create package.json or dependencies so we could just execute npm install?

gpaOliveira · 2026-01-28T14:57:14Z

README.md

+
+**Run a Folder and Generate HRML Report**
+
+1. Install Bruno CLI: `npm install -g @usebruno/cli`


Maybe step 0 would be to put up the application in docker?

dricazenck · 2026-01-28T21:32:11Z

Note: PUT /mentor doesn't work properly for now, since there was a bug, will be fixed soon.

Actually could you test again, the PR was merged with the fix ;)

dricazenck · 2026-01-28T21:40:30Z

...ows/MentorRegisterUpdateDeleteFlow/GET list of mentors and verify that mentor is created.bru

@@ -0,0 +1,39 @@
+meta {
+  name: GET list of mentors and verify that mentor is created


I am wondering if tis the convention of use files with spaces in Bruno. For me it is a bit confuse 🙈

dricazenck · 2026-01-28T21:41:45Z

api-flows/bruno.json

@@ -0,0 +1,9 @@
+{


Please add this .DS_Store‎ to gitignore, they are mac metadata files and they should not be pushed to git

dricazenck · 2026-01-28T21:52:42Z

README.md

+**Adding a New Request**
+1. In Bruno, right-click the target folder
+2. Select New Request
+3. Give the request a clear, descriptive name


Is this step necessary to have spaces?
GET list of mentors and verify that mentor is deleted.bru

or could be like this:
get_active_mentors_and_delete_mentor.bru

nora-weisser added 4 commits January 27, 2026 21:40

feat: added bruno collection to craft API test flows

666b510

feat: updated README

9abfed0

feat: deleted results from PR

c6a7dbe

feat: added results.html from bruno to gitignore

28f4b8f

nora-weisser requested a review from a team as a code owner January 27, 2026 20:56

nora-weisser requested review from dricazenck, goelsonali, gpaOliveira, nverbic, silkenodwell and wilsonadenuga January 27, 2026 20:56

goelsonali reviewed Jan 28, 2026

View reviewed changes

gpaOliveira reviewed Jan 28, 2026

View reviewed changes

dricazenck reviewed Jan 28, 2026

View reviewed changes

dricazenck approved these changes Jan 28, 2026

View reviewed changes


		Mentor creation → Get Mentors and validate if the mentor was created → Update Mentor data → Get Mentors and validate if the mentor was updated → Delete Mentor → Get Mentors and validate if the mentor was deleted

		Run a Folder and Generate HRML Report

	Run a Folder and Generate HRML Report
	Run a Folder and Generate HTML Report

	6. Ensure each request can be run sequentially as part of a folder execution
	6. Ensure each request can be run sequentially as part of a folder execution by running the whole folder and making sure the HTML report is generated


		Run a Folder and Generate HRML Report

		1. Install Bruno CLI: `npm install -g @usebruno/cli`

		@@ -0,0 +1,39 @@
		meta {
		name: GET list of mentors and verify that mentor is created

test: introduced bruno collections for API Flows testing #489

Are you sure you want to change the base?

test: introduced bruno collections for API Flows testing #489

Conversation

nora-weisser commented Jan 27, 2026

Description

Screenshots

Pull request checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gpaOliveira Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gpaOliveira Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gpaOliveira commented Jan 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dricazenck commented Jan 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gpaOliveira Jan 28, 2026 •

edited

Loading

gpaOliveira Jan 28, 2026 •

edited

Loading