Receive Job Reports and Artifacts via Email

Downloading Job Reports and Artifacts manually from the HyperExecute UI can be a time-consuming and repetitive task. To address this pain point, HyperExecute now provides the convenience of receiving Job Reports and Artifacts directly to your specified email addresses. This eliminates the need for manual downloads, allowing you to access critical job information instantly and effortlessly. Embrace the efficiency of automated delivery and spend less time navigating the UI and more time focusing on your development tasks.

YAML Configuration

To receive the Artifacts and Reports via mail, you will have to add the email flag with a to tag to select the email IDs where the report or artifacts should be sent. The example added below shows you how to add your email IDs:

email:
  to: 
    - <your_email_id@example.com>
    - <another_email_id@example.com>

You can also use the currentUser tag to send the reports to the email ID of your choice.

• currentUser: This tag will allow you to send the report to the email ID associated with your TestMu AI account.

email:
  to: 
    - currentUser

How to receive your Artifacts via Email?

Follow the below mentioned steps to receive your Artifacts via email:

Step 1: You need to mention the email flag along with the to tag under the uploadArtifacts flag in the YAML file configuration.

NOTE: You can also add a separate email ID for each report generated, as mentioned below in the YAML code.

uploadArtifacts:
  - name: Reports 1
    path:
      - ProtractorTestReport.html
      - xmlresults.xml
    email:
      to: 
        - <your_email_id@example.com>
        - <another_email_id@example.com>
        
  - name: Reports 2
    path:
      - ProtractorTestReport.html
      - xmlresults.xml
    email:
      to: 
        - currentUser

How to receive your Job Report via Email?

Follow the below mentioned steps to receive your Job Reports via email:

Step 1: Set the report flag to true in the HyperExecute YAML.

Step 2: Make sure to check the location, type and frameworkName fields in the partialReports flag are configured correctly.

Step 3: Add the email flag with to tag in the YAML file configuration:

report: true
partialReports:
  frameworkName: testng
  location: target/surefire-reports/html
  type: html
  email:
    to: 
      - <your_email_id@example.com>
      - <another_email_id@example.com>

Correct format of entering the Email IDs

The Email IDs that you enter must be valid. You can enter your email IDs in the formats mentioned below.

- John Doe <johndoe@example.com>
- John <johndoe@example.com>
- johndoe@example.com

However, if your email IDs are added in an unsupported format, the feature will not work. A few examples of unsupported email ID formats are added below.

- John Doe johndoe@example.com>
- John <<johndoe@example.com>
- John johndoe@example.com
- John Doe

Now that you have added your email IDs successfully, you can access your job reports. Download the report from the email, and get all the information that you need. Alternatively, you can also open the clickable link in the email and view the report on your browser.

How to dynamically set your email address?

In your YAML configuration file instead of hardcoding the email address to which you want to share the report or artifacts, you can use a variable that can be set dynamically when you pass the execution command.

In this example, the ${email} and ${email1} variables are used to specify the email address. You can pass the value of this variable using the vars flag as an argument when executing your test via CLI.

hyperexecute.yaml

report: true
partialReports:
  location: target/surefire-reports/html
  type: html
  frameworkName: extent
  email:
      to:
        - "${email}"
        - "${email1}"

uploadArtifacts:
  - name: Reports 1
    path:
      - ProtractorTestReport.html
    email:
      to: 
        - "${email}"
        - "${email1}"

This is how you can pass the value of your email address via CLI by running the command

./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE --vars "email=xyz@abc.com" --vars "email1=abc@xyz.com"

note

If you have a pipeline that requires multiple email values, consider consolidating them into a single variable separated by commas. This approach eliminates the need for multiple variables or manual pipeline edits whenever the email list changes.

hyperexecute.yaml

report: true
partialReports:
  location: target/surefire-reports/html
  type: html
  frameworkName: extent
  email:
      to:
        - "${email}"

uploadArtifacts:
  - name: Reports 1
    path:
      - ProtractorTestReport.html
    email:
      to: 
        - "${email}"

./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE --vars "email=xyz@abc.com,abc@xyz.com,def@wxy.com"