Connect Your Automation with JIRA

Integrate Maeris with JIRA to sync test results, create issues for test failures, and keep your team informed about test automation status. This integration bridges the gap between testing and issue tracking.

JIRA Integration Overview

The JIRA integration allows you to connect your Maeris test automation with your JIRA project, enabling automatic issue creation, test result synchronization, and seamless workflow between testing and development teams.

Integration Benefits

  • Automatic Issue Creation: Create JIRA issues automatically when tests fail
  • Test Result Sync: Sync test execution results to JIRA
  • Traceability: Link tests to JIRA stories, bugs, and tasks
  • Team Visibility: Keep team informed about test status in JIRA
  • Workflow Integration: Integrate testing into your development workflow
  • Reporting: Generate test reports directly in JIRA

Setting Up JIRA Integration

Step 1: Get JIRA Credentials

Obtain the necessary credentials to connect to your JIRA instance.

  • JIRA instance URL (e.g., https://yourcompany.atlassian.net)
  • JIRA API token or username/password
  • Project key where issues should be created
  • Issue type for test failures (Bug, Task, etc.)

Step 2: Configure Integration in Maeris

Set up the JIRA connection in Maeris settings.

  1. Navigate to Platform Settings → Integrations
  2. Select JIRA integration
  3. Enter JIRA instance URL
  4. Provide authentication credentials
  5. Test the connection
  6. Save configuration

Step 3: Configure Integration Rules

Set up rules for when and how to sync with JIRA.

  • Configure when to create JIRA issues (on failure, always, etc.)
  • Set up issue fields and templates
  • Configure test result sync frequency
  • Set up project and issue type mappings

Integration Features

Automatic Issue Creation

Automatically create JIRA issues when tests fail, with detailed information about the failure.

  • Issue title includes test name and failure reason
  • Issue description contains test details and error messages
  • Screenshots and logs are attached to issues
  • Issues are linked to related JIRA stories or epics

Test Result Synchronization

Sync test execution results to JIRA for visibility and reporting.

  • Update JIRA issues with test execution status
  • Add test results as comments to related issues
  • Update custom fields with test metrics
  • Create test execution reports in JIRA

Test-to-Issue Linking

Link tests to JIRA stories, bugs, and tasks for traceability.

  • Link tests to JIRA issues using issue keys
  • View test status directly in JIRA issues
  • Track which tests cover which features
  • Generate test coverage reports

Notifications and Updates

Keep team members informed about test status through JIRA.

  • Notify assignees when tests fail
  • Update issue status based on test results
  • Add comments with test execution details
  • Create JIRA dashboards with test metrics

Configuration Options

Issue Creation Settings

  • Trigger Conditions: When to create issues (on failure, on specific errors, etc.)
  • Issue Type: Type of JIRA issue to create (Bug, Task, Story, etc.)
  • Project: JIRA project where issues should be created
  • Assignee: Default assignee for created issues
  • Labels: Labels to add to created issues
  • Components: JIRA components to associate with issues

Issue Template

  • Title Template: Customize issue title format
  • Description Template: Customize issue description with test details
  • Custom Fields: Map test data to JIRA custom fields
  • Attachments: Configure which files to attach (screenshots, logs)

Sync Settings

  • Sync Frequency: How often to sync test results
  • Sync Scope: Which tests to sync (all, tagged, specific suites)
  • Update Existing Issues: Whether to update existing issues or create new ones
  • Comment on Issues: Add test results as comments to linked issues

Integration Workflow

  1. Test Execution: Tests run in Maeris as configured

    Tests execute normally, results are captured

  2. Result Processing: Maeris processes test results

    Failures are identified, screenshots and logs are collected

  3. JIRA Sync: Results are synced to JIRA based on configuration

    Issues are created or updated, comments are added

  4. Team Notification: Team members are notified in JIRA

    Assignees receive notifications, issues appear in JIRA

  5. Issue Resolution: Team addresses issues in JIRA

    Issues are tracked, fixed, and verified

Best Practices

  • Use Meaningful Issue Titles: Configure templates that include test name and failure reason

    Makes issues easy to identify and prioritize

  • Include Relevant Details: Ensure issue descriptions contain actionable information

    Screenshots, logs, and error messages help debugging

  • Link Tests to Stories: Link tests to JIRA stories for traceability

    Shows test coverage and helps with reporting

  • Configure Appropriate Assignees: Set up rules for issue assignment

    Ensures issues go to the right team members

  • Review and Tune: Regularly review created issues and adjust configuration

    Improves issue quality and reduces noise

  • Use Labels and Components: Organize issues with labels and components

    Makes it easier to filter and manage issues

Troubleshooting

Common Issues

  • Authentication Failures: Verify credentials and API token validity
  • Permission Issues: Ensure JIRA user has permissions to create issues
  • Connection Problems: Check network connectivity and JIRA instance URL
  • Issue Creation Failures: Verify project key, issue type, and field mappings

Testing the Integration

  • Use the "Test Connection" feature in settings
  • Run a test and verify issue creation
  • Check JIRA for created issues and verify content
  • Review integration logs for errors

Next Steps

After setting up JIRA integration: