fix: email formats, use case, description of tests

Author: ChengShi-1

docs/useCases.md

@@ -1428,6 +1428,6 @@ In ContactDTO, it takes the following information:
 
 - **targetId**: the numeric identifier of the collection, dataset, or datafile. Persistent ids and collection aliases are not supported. (Optional)
 - **identifier**: the alias of a collection or the persistence id of a dataset or datafile. (Optional)
-- **subject**: the email subject line
-- **body**: the email body to send
+- **subject**: the email subject line.
+- **body**: the email body to send.
 - **fromEmail**: the email to list in the reply-to field.

test/functional/contact/SubmitContactInfo.test.ts

@@ -11,12 +11,12 @@ describe('submitContactInfo', () => {
     )
   })
 
-  test('should return Contact result successfully', async () => {
+  test('should return Contact result successfully with targetId', async () => {
     const contactDTO: ContactDTO = {
       targetId: 1,
       subject: 'Data Question',
       body: 'Please help me understand your data. Thank you!',
-      fromEmail: 'example@gmail.com'
+      fromEmail: 'example@dataverse.org'
     }
 
     let contactInfo: Contact[] = []
@@ -26,7 +26,7 @@ describe('submitContactInfo', () => {
       throw new Error('Contact info should be submitted')
     } finally {
       expect(contactInfo).toBeDefined()
-      expect(contactInfo[0].fromEmail).toEqual('example@gmail.com')
+      expect(contactInfo[0].fromEmail).toEqual('example@dataverse.org')
       expect(contactInfo[0].subject).toEqual(expect.any(String))
       expect(contactInfo[0].body).toEqual(expect.any(String))
     }
@@ -36,7 +36,7 @@ describe('submitContactInfo', () => {
     const contactDTO: ContactDTO = {
       subject: 'General Inquiry',
       body: 'I have a general question.',
-      fromEmail: 'example@gmail.com'
+      fromEmail: 'example@dataverse.org'
     }
 
     let contactInfo: Contact[] = []
@@ -46,18 +46,18 @@ describe('submitContactInfo', () => {
       throw new Error('Contact info should be submitted even if target id is missing')
     } finally {
       expect(contactInfo).toBeDefined()
-      expect(contactInfo[0].fromEmail).toEqual('example@gmail.com')
+      expect(contactInfo[0].fromEmail).toEqual('example@dataverse.org')
       expect(contactInfo[0].subject).toEqual(expect.any(String))
       expect(contactInfo[0].body).toEqual(expect.any(String))
     }
   })
 
-  test('should return Contact when contact info is successfully submitted', async () => {
+  test('should return Contact when contact info is successfully submitted with identifier', async () => {
     const test2ContactDTO: ContactDTO = {
       identifier: 'root',
       subject: 'Data Question',
       body: 'Please help me understand your data. Thank you!',
-      fromEmail: 'example@gmail.com'
+      fromEmail: 'example@dataverse.org'
     }
     const contactInfo = await submitContactInfo.execute(test2ContactDTO)
 
@@ -72,7 +72,7 @@ describe('submitContactInfo', () => {
       targetId: 0,
       subject: '',
       body: '',
-      fromEmail: 'example@gmail.com'
+      fromEmail: 'example@dataverse.org'
     }
     const expectedError = new WriteError(`[400] Feedback target object not found.`)
     await expect(submitContactInfo.execute(contactDTO)).rejects.toThrow(expectedError)

test/integration/contact/ContactRepository.test.ts

@@ -16,14 +16,14 @@ describe('submitContactInfo', () => {
     targetId: 1,
     subject: 'Data Question',
     body: 'Please help me understand your data. Thank you!',
-    fromEmail: 'example@gmail.com'
+    fromEmail: 'example@dataverse.org'
   }
 
   const test2ContactDTO: ContactDTO = {
     identifier: 'root',
     subject: 'Data Question',
     body: 'Please help me understand your data. Thank you!',
-    fromEmail: 'example@gmail.com'
+    fromEmail: 'example@dataverse.org'
   }
 
   const sut: ContactRepository = new ContactRepository()
@@ -50,7 +50,7 @@ describe('submitContactInfo', () => {
     const contactDTOWithoutTargetId: Partial<ContactDTO> = {
       subject: 'General Inquiry',
       body: 'I have a general question.',
-      fromEmail: 'example@gmail.com'
+      fromEmail: 'example@dataverse.org'
     }
 
     const contactInfo: Contact[] = await sut.submitContactInfo(

test/unit/contact/SubmitContactInfo.test.ts

@@ -5,7 +5,7 @@ import { TestConstants } from '../../testHelpers/TestConstants'
 
 describe('execute submit information to contacts', () => {
   test('should return a Contact when repository call is successful', async () => {
-    const fromEmail = 'example@gmail.com'
+    const fromEmail = 'example@dataverse.org'
 
     const contactDTO: ContactDTO = {
       targetId: 6,