Merge branch 'edge' into components_deck-info-label

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,62 +1,48 @@
 <!--
-Thanks for taking the time to open a pull request! Please make sure you've read the "Opening Pull Requests" section of our Contributing Guide:
+Thanks for taking the time to open a Pull Request (PR)! Please make sure you've read the "Opening Pull Requests" section of our Contributing Guide:
 
 https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests
 
+GitHub provides robust markdown to format your PR. Links, diagrams, pictures, and videos along with text formatting make it possible to create a rich and informative PR. For more information on GitHub markdown, see:
+
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
 To ensure your code is reviewed quickly and thoroughly, please fill out the sections below to the best of your ability!
 -->
 
 # Overview
 
 <!--
-Use this section to describe your pull-request at a high level. If the PR addresses any open issues, please tag the issues here.
+Describe your PR at a high level. State acceptance criteria and how this PR fits into other work. Link issues, PRs, and other relevant resources.
 -->
 
-# Test Plan
+## Test Plan and Hands on Testing
 
 <!--
-Use this section to describe the steps that you took to test your Pull Request.
-If you did not perform any testing provide justification why.
-
-OT-3 Developers: You should default to testing on actual physical hardware.
-Once again, if you did not perform testing against hardware, justify why.
-
-Note: It can be helpful to write a test plan before doing development
-
-Example Test Plan (HTTP API Change)
-
-- Verified that new optional argument `dance-party` causes the robot to flash its lights, move the pipettes,
-then home.
-- Verified that when you omit the `dance-party` option the robot homes normally
-- Added protocol that uses `dance-party` argument to G-Code Testing Suite
-- Ran protocol that did not use `dance-party` argument and everything was successful
-- Added unit tests to validate that changes to pydantic model are correct
-
+Describe your testing of the PR. Emphasize testing not reflected in the code. Attach protocols, logs, screenshots and any other assets that support your testing.
 -->
 
-# Changelog
+## Changelog
 
 <!--
-List out the changes to the code in this PR. Please try your best to categorize your changes and describe what has changed and why.
-
-Example changelog:
-- Fixed app crash when trying to calibrate an illegal pipette
-- Added state to API to track pipette usage
-- Updated API docs to mention only two pipettes are supported
-
-IMPORTANT: MAKE SURE ANY BREAKING CHANGES ARE PROPERLY COMMUNICATED
+List changes introduced by this PR considering future developers and the end user. Give careful thought and clear documentation to breaking changes.
 -->
 
-# Review requests
+## Review requests
 
 <!--
-Describe any requests for your reviewers here.
+- What do you need from reviewers to feel confident this PR is ready to merge?
+- Ask questions.
 -->
 
-# Risk assessment
+## Risk assessment
 
 <!--
-Carefully go over your pull request and look at the other parts of the codebase it may affect. Look for the possibility, even if you think it's small, that your change may affect some other part of the system - for instance, changing return tip behavior in protocol may also change the behavior of labware calibration.
-
-Identify the other parts of the system your codebase may affect, so that in addition to your own review and testing, other people who may not have the system internalized as much as you can focus their attention and testing there.
+- Indicate the level of attention this PR needs.
+- Provide context to guide reviewers.
+- Discuss trade-offs, coupling, and side effects.
+- Look for the possibility, even if you think it's small, that your change may affect some other part of the system.
+  - For instance, changing return tip behavior may also change the behavior of labware calibration.
+- How do your unit tests and on hands on testing mitigate this PR's risks and the risk of future regressions?
+- Especially in high risk PRs, explain how you know your testing is enough.
 -->

.github/workflows/analyses-snapshot-test.yaml

@@ -23,8 +23,18 @@ on:
       - 'api/**'
       - '!api/tests/**'
       - '!api/docs/**'
+      - '!api/release-notes-internal.md'
+      - '!api/release-notes.md'
       - 'shared-data/**/*'
       - '!shared-data/js/**'
+      - '.github/workflows/analyses-snapshot-test.yaml'
+      - 'analyses-snapshot-testing/**'
+
+    types:
+      - opened #default
+      - synchronize #default
+      - reopened #default
+      - labeled
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -40,14 +50,27 @@ jobs:
       # If we're running because of workflow_dispatch, use the user input to decide
       # whether to open a PR on failure. Otherwise, there is no user input, so always
       # open a PR on failure.
-      OPEN_PR_ON_FAILURE: ${{ (github.event_name == 'workflow_dispatch' && github.events.inputs.OPEN_PR_ON_FAILURE) || (github.event_name != 'workflow_dispatch') }}
-
+      OPEN_PR_ON_FAILURE: ${{ (github.event_name == 'workflow_dispatch' && github.events.inputs.OPEN_PR_ON_FAILURE) || ((github.event_name != 'workflow_dispatch') && (contains(github.event.pull_request.labels.*.name, 'gen-analyses-snapshot-pr'))) }}
+      PR_TARGET_BRANCH: ${{ github.event.pull_request.base.ref || 'not a pr'}}
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
         with:
           ref: ${{ env.SNAPSHOT_REF }}
 
+      - name: Are the analyses snapshots in my PR branch in sync with the target branch?
+        if: github.event_name == 'pull_request'
+        run: |
+          git fetch origin ${{ env.PR_TARGET_BRANCH }}
+          DIFF_OUTPUT=$(git diff HEAD origin/${{ env.PR_TARGET_BRANCH }} -- analyses-snapshot-testing/tests/__snapshots__/analyses_snapshot_test)
+          if [ -n "$DIFF_OUTPUT" ]; then
+            echo "Analyses snapshots do NOT match ${{ env.PR_TARGET_BRANCH }} snapshots."
+            echo "Is this becasue you have not pulled and merged ${{ env.PR_TARGET_BRANCH }}?"
+            echo "Or is this because you have already updated your snapshots and are all good 😊?"
+          else
+            echo "Analyses snapshots match ${{ env.PR_TARGET_BRANCH }} snapshots."
+          fi
+
       - name: Docker Build
         working-directory: analyses-snapshot-testing
         run: make build-opentrons-analysis
@@ -77,30 +100,40 @@ jobs:
 
       - name: Handle Test Failure
         id: handle_failure
-        if: always() && steps.run_test.outcome == 'failure'
+        if: always() && steps.run_test.outcome == 'failure' && (env.OPEN_PR_ON_FAILURE == 'true' || github.event_name == 'schedule')
         working-directory: analyses-snapshot-testing
         run: make snapshot-test-update
 
       - name: Create Snapshot update Request
         id: create_pull_request
-        if: always() && steps.handle_failure.outcome == 'success' && env.OPEN_PR_ON_FAILURE
+        if: always() && steps.handle_failure.outcome == 'success' && env.OPEN_PR_ON_FAILURE == 'true' && github.event_name == 'pull_request'
         uses: peter-evans/create-pull-request@v6
         with:
-          commit-message: 'fix(analyses-snapshot-testing): snapshot failure capture'
-          title: 'fix(analyses-snapshot-testing): ${{ env.ANALYSIS_REF }} snapshot failure capture'
-          body: 'This PR is an automated snapshot update request. Please review the changes and merge if they are acceptable or find your bug and fix it.'
+          commit-message: 'fix(analyses-snapshot-testing): heal analyses snapshots'
+          title: 'fix(analyses-snapshot-testing): heal ${{ env.ANALYSIS_REF }} snapshots'
+          body: 'This PR was requested on the PR https://github.com/${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
           branch: 'analyses-snapshot-testing/${{ env.ANALYSIS_REF }}-from-${{ env.SNAPSHOT_REF}}'
           base: ${{ env.SNAPSHOT_REF}}
 
-      - name: Comment on PR
+      - name: Comment on feature PR
         if: always() && steps.create_pull_request.outcome == 'success' && github.event_name == 'pull_request'
         uses: actions/github-script@v7
         with:
           script: |
-            const message = 'A PR has been opened to address analyses snapshot changes. Please review the changes here: https://github.com/${{ github.repository }}/pull/${{ steps.create-pull-request.outputs.pull-request-number }}';
+            const message = 'A PR has been opened to address analyses snapshot changes. Please review the changes here: https://github.com/${{ github.repository }}/pull/${{ steps.create_pull_request.outputs.pull-request-number }}';
             github.rest.issues.createComment({
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: context.issue.number,
               body: message
             });
+
+      - name: Create Snapshot update Request on edge overnight failure
+        if: always() && steps.handle_failure.outcome == 'success' && github.event_name == 'schedule'
+        uses: peter-evans/create-pull-request@v6
+        with: # scheduled run uses the default values for ANALYSIS_REF and SNAPSHOT_REF which are edge
+          commit-message: 'fix(analyses-snapshot-testing): heal ${{ env.ANALYSIS_REF }} snapshots'
+          title: 'fix(analyses-snapshot-testing): heal ${{ env.ANALYSIS_REF }} snapshots'
+          body: 'The ${{ env.ANALYSIS_REF }} overnight analyses snapshot test is failing. This PR was opened to alert us to the failure.'
+          branch: 'analyses-snapshot-testing/${{ env.ANALYSIS_REF }}-from-${{ env.SNAPSHOT_REF}}'
+          base: ${{ env.SNAPSHOT_REF}}

abr-testing/abr_testing/automation/jira_tool.py

@@ -23,25 +23,79 @@ def __init__(self, url: str, api_token: str, email: str) -> None:
             "Content-Type": "application/json",
         }
 
-    def issues_on_board(self, board_id: str) -> List[str]:
+    def issues_on_board(self, project_key: str) -> List[List[Any]]:
         """Print Issues on board."""
+        params = {"jql": f"project = {project_key}"}
         response = requests.get(
-            f"{self.url}/rest/agile/1.0/board/{board_id}/issue",
+            f"{self.url}/rest/api/3/search",
             headers=self.headers,
+            params=params,
             auth=self.auth,
         )
+
         response.raise_for_status()
         try:
             board_data = response.json()
             all_issues = board_data["issues"]
         except json.JSONDecodeError as e:
             print("Error decoding json: ", e)
+        # convert issue id's into array and have one key as
+        # the issue key and one be summary, return entire array
         issue_ids = []
         for i in all_issues:
             issue_id = i.get("id")
-            issue_ids.append(issue_id)
+            issue_summary = i["fields"].get("summary")
+            issue_ids.append([issue_id, issue_summary])
         return issue_ids
 
+    def match_issues(self, issue_ids: List[List[str]], ticket_summary: str) -> List:
+        """Matches related ticket ID's."""
+        to_link = []
+        error = ticket_summary.split("_")[3]
+        robot = ticket_summary.split("_")[0]
+        # for every issue see if both match, if yes then grab issue ID and add it to a list
+        for issue in issue_ids:
+            summary = issue[1]
+            try:
+                issue_error = summary.split("_")[3]
+                issue_robot = summary.split("_")[0]
+            except IndexError:
+                continue
+            issue_id = issue[0]
+            if robot == issue_robot and error == issue_error:
+                to_link.append(issue_id)
+        return to_link
+
+    def link_issues(self, to_link: list, ticket_key: str) -> None:
+        """Links relevant issues in Jira."""
+        for issue in to_link:
+            link_data = json.dumps(
+                {
+                    "inwardIssue": {"key": ticket_key},
+                    "outwardIssue": {"id": issue},
+                    "type": {"name": "Relates"},
+                }
+            )
+            try:
+                response = requests.post(
+                    f"{self.url}/rest/api/3/issueLink",
+                    headers=self.headers,
+                    auth=self.auth,
+                    data=link_data,
+                )
+                response.raise_for_status()
+            except requests.exceptions.HTTPError:
+                print(
+                    f"HTTP error occurred. Ticket ID {issue} was not linked. \
+                        Check user permissions and authentication credentials"
+                )
+            except requests.exceptions.ConnectionError:
+                print(f"Connection error occurred. Ticket ID {issue} was not linked.")
+            except json.JSONDecodeError:
+                print(
+                    f"JSON decoding error occurred. Ticket ID {issue} was not linked."
+                )
+
     def open_issue(self, issue_key: str) -> str:
         """Open issue on web browser."""
         url = f"{self.url}/browse/{issue_key}"

abr-testing/abr_testing/data_collection/abr_robot_error.py

@@ -481,7 +481,6 @@ def get_run_error_info_from_robot(
     reporter_id = args.reporter_id[0]
     file_paths = read_robot_logs.get_logs(storage_directory, ip)
     ticket = jira_tool.JiraTicket(url, api_token, email)
-    ticket.issues_on_board(board_id)
     users_file_path = ticket.get_jira_users(storage_directory)
     assignee_id = get_user_id(users_file_path, assignee)
     run_log_file_path = ""
@@ -519,6 +518,9 @@ def get_run_error_info_from_robot(
     print(robot)
     parent_key = project_key + "-" + robot.split("ABR")[1]
 
+    # Grab all previous issues
+    all_issues = ticket.issues_on_board(project_key)
+
     # TODO: read board to see if ticket for run id already exists.
     # CREATE TICKET
     issue_key, raw_issue_url = ticket.create_ticket(
@@ -533,6 +535,11 @@ def get_run_error_info_from_robot(
         affects_version,
         parent_key,
     )
+
+    # Link Tickets
+    to_link = ticket.match_issues(all_issues, summary)
+    ticket.link_issues(to_link, issue_key)
+
     # OPEN TICKET
     issue_url = ticket.open_issue(issue_key)
     # MOVE FILES TO ERROR FOLDER.

analyses-snapshot-testing/automation/data/protocols.py

@@ -635,6 +635,12 @@ class Protocols:
         robot="Flex",
     )
 
+    Flex_S_v2_19_P1000_96_GRIP_HS_MB_TC_TM_Smoke: Protocol = Protocol(
+        file_stem="Flex_S_v2_19_P1000_96_GRIP_HS_MB_TC_TM_Smoke",
+        file_extension="py",
+        robot="Flex",
+    )
+
     OT2_X_v2_18_None_None_duplicateRTPVariableName: Protocol = Protocol(
         file_stem="OT2_X_v2_18_None_None_duplicateRTPVariableName",
         file_extension="py",
@@ -665,6 +671,12 @@ class Protocols:
         robot="OT2",
     )
 
+    OT2_S_v2_19_P300M_P20S_HS_TC_TM_SmokeTestV3: Protocol = Protocol(
+        file_stem="OT2_S_v2_19_P300M_P20S_HS_TC_TM_SmokeTestV3",
+        file_extension="py",
+        robot="OT2",
+    )
+
     ##########################################################################################################
     # Begin Protocol Library Protocols #######################################################################
     ##########################################################################################################