[PHEE-296A] Email Api Tc by ankita10r · Pull Request #293 · openMF/ph-ee-integration-test

ankita10r · 2024-06-10T09:23:09Z

Description

The Tc design is done based on greenmail mock

`Use placeholder/pod ip of int test repo in the host field of the smtp mail config : this to be done on the chart
This will make the tc pass in ephemeral only
Once it passes and evidence attached the @gov tag can be changed to @govtodo for ci runs 
Also one failure tc to be written that gives failed to send mail in callback - this will be enabled in ci

Reason for this:

1. Gmail smtp setup requires a password to be set in gmail app
2. And mail sent by gmail cant be verifed via greenmail mock in int test
3. So greenmail mock setup is used to send mail and check server for all sent mails
4. But it faced an issue in host name(which was localhost) that works locally but fails in ci
5. Now there is no way to access integration test service using service name or ingress that’s why host name can only be in pod ip level (that only works in ephemeral mode)`

PR title should have jira ticket enclosed in [].

Format: [jira_ticket] description

ex: [phee-123] PR title.
Add a link to the Jira ticket.
Describe the changes made and why they were made.

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

Followed the PR title naming convention mentioned above.
Acknowledge that we will not merge PRs that are not passing the checks ("green") - it is your (author's) responsibility to get a proposed PR to pass all the checks, not primarily the project's maintainers.
The PR title should include a JIRA ticket
Design-related bullet points or design document links related to this PR added in the description above.
Updated corresponding Postman Collection or API documentation for the changes in this PR.
Create/update unit or integration tests for verifying the changes made.
Add required Swagger annotation and update API documentation with details of any API changes if applicable
Followed the naming conventions as given in https://docs.google.com/document/d/1Q4vaMSzrTxxh9TS0RILuNkSkYCxotuYk1Xe0CMIkkCU/edit?usp=sharing
Followed coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.

FYI our guidelines for code reviews same as https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.

jit-ci · 2024-06-10T09:23:36Z

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

fynmanoj

None of the test cases are verifying the callback.

fynmanoj · 2024-07-05T11:45:43Z

src/test/java/org/mifos/integrationtest/cucumber/stepdef/EmailStepDef.java

+
+    @Value("${messageGateway.endpoint.email}")
+    private String mgMail;
+    @Value("${spring.mail.host}")


why do we need to use 'spring' here

fynmanoj · 2024-07-05T11:47:22Z

.github/workflows/jit-security.yml

      with:
        security_control: registry.jit.io/control-semgrep-alpine:latest
-        
+


looks like there are lots of formatting changes, you can remove this from this PR

fynmanoj · 2024-07-05T11:48:52Z

.jit/jit-integration.yml

@@ -0,0 +1 @@
+


is this empty file?

fynmanoj · 2024-07-05T11:49:18Z

src/main/resources/application.yaml

+  endpoint:
+    email: "/emails"
+
+spring:


you can ignore this level: spring. we don't need unless we cant avoid it

fynmanoj · 2024-07-05T11:50:17Z

src/main/resources/application.yaml

+        smtp:
+          auth: false
+          starttls:
+            enable: false


google smtp requies TLS. can we test this with TLS for more compatibility?

fynmanoj · 2024-07-05T11:54:53Z

src/test/java/resources/email.feature

+  Scenario: Sending an email to the recipient with failure in callback
+    Given I can inject MockServer
+    And I can start mock server
+    And I can register the stub with "/sendMail" endpoint for "POST" request with status of 200


All tests with same callback URL may cause issues like it use to cause before. use unique strings and add a check based on URL

fynmanoj · 2024-07-05T11:55:12Z

src/test/java/resources/email.feature

+    And I have tenant as "paymentBB2"
+    And I generate clientCorrelationId
+    When I send an email to the following recipients with subject "Test Email" and body "This is a test email" with callbackurl as "/sendMail" and get 202
+      | recipient1@example.com |


move subject and body to this datatable

fynmanoj · 2024-07-05T11:56:55Z

src/test/java/org/mifos/integrationtest/cucumber/stepdef/EmailStepDef.java

+                    rootNode = request.getRequest().getBodyAsString();
+                    logger.info("Rootnode value:" + rootNode);
+                    assertThat(rootNode
+                            .contains("Email could not be sent to [recipient1@example.com] because of Mail server connection failed"))


already mentioned in other PR, The error request body is not proper.
the message should be in sentence case

fynmanoj · 2024-07-05T11:57:22Z

src/test/java/org/mifos/integrationtest/cucumber/stepdef/EmailStepDef.java

+                if (!(request.getRequest().getBodyAsString()).isEmpty() && request.getRequest().getUrl().equals("/sendMail")) {
+                    String rootNode = null;
+                    rootNode = request.getRequest().getBodyAsString();
+                    logger.info("Rootnode value:" + rootNode);


donot use + for concatenating log statements

fynmanoj · 2024-07-05T11:59:14Z

src/test/java/resources/email.feature

+    And the email service is running
+    And I have tenant as "paymentBB2"
+    And I generate clientCorrelationId
+    When I send an email to the following recipients with subject "Test Email" and body "This is a test email" with callbackurl as "/sendMail" and get 202


None of the test cases are verifying the callback.

ankita10r force-pushed the PHEE296A branch from 51b6590 to 2c83fa4 Compare June 10, 2024 09:53

[PHEE-296A] Email Api Tc

f93df2b

ankita10r force-pushed the PHEE296A branch from 2c83fa4 to f93df2b Compare June 12, 2024 05:16

[PHEE-296A] Email Api Tc

e045bc0

ankita10r mentioned this pull request Jun 18, 2024

[PHEE-296A] Email api openMF/message-gateway#79

Open

6 tasks

ankita10r added 6 commits June 21, 2024 13:30

[PHEE-296A] Email Api Tc

c9f4c61

[PHEE-296A] Email Api Tc

b2d47e3

[PHEE-296A] Email Api Tc

4de4df6

[PHEE-296A] Email Api Tc

6490bfe

[PHEE-296A] Email Api Tc

2f7d496

[PHEE-296A] Email Api Tc

f36e220

fynmanoj suggested changes Jul 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PHEE-296A] Email Api Tc#293

[PHEE-296A] Email Api Tc#293
ankita10r wants to merge 8 commits intoopenMF:masterfrom
ankita10r:PHEE296A

ankita10r commented Jun 10, 2024 •

edited

Loading

Uh oh!

jit-ci bot commented Jun 10, 2024

Uh oh!

fynmanoj left a comment

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

fynmanoj Jul 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		with:
		security_control: registry.jit.io/control-semgrep-alpine:latest

Conversation

ankita10r commented Jun 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

jit-ci bot commented Jun 10, 2024

Uh oh!

fynmanoj left a comment

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!

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!

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!

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!

2 participants

ankita10r commented Jun 10, 2024 •

edited

Loading