shellcheck fixes

Author: yelizhenden-mdb

.github/scripts/handle_warning_violations.sh

@@ -28,7 +28,7 @@ if [ "$DRY_RUN" = "true" ]; then
   echo "Would create Jira ticket with:"
   echo "Summary: Warning-level IPA violations found - $WARNING_COUNT violations"
   echo "Description:"
-  echo "Warning-level violations were found during IPA validation.
+  echo "Warning-level violations were found during IPA validation. Please review and add exceptions if valid, or address false positives.
 
 Violation Summary:
 $VIOLATION_DETAILS
@@ -37,13 +37,10 @@ Total violations: $WARNING_COUNT"
   echo ""
   echo "Would send Slack message:"
   SLACK_SUMMARY=$(echo "$VIOLATION_DETAILS" | head -3)
-  if [ $(echo "$VIOLATION_DETAILS" | wc -l) -gt 3 ]; then
+  if [ "$(echo "$VIOLATION_DETAILS" | wc -l)" -gt 3 ]; then
     SLACK_SUMMARY="$SLACK_SUMMARY\n... and more"
   fi
-  echo "Warning-level IPA violations found ($WARNING_COUNT violations). 
-
-Top violations:
-$SLACK_SUMMARY
+  echo "Warning-level IPA violations found ($WARNING_COUNT violations).
 
 Jira ticket: [DRY RUN - no ticket created]"
   exit 0
@@ -90,16 +87,13 @@ if [ "$TICKET_KEY" != "null" ]; then
   SLACK_SUMMARY=""
   if [ -n "$VIOLATION_DETAILS" ]; then
     SLACK_SUMMARY=$(echo "$VIOLATION_DETAILS" | head -3)
-    if [ $(echo "$VIOLATION_DETAILS" | wc -l) -gt 3 ]; then
+    if [ "$(echo "$VIOLATION_DETAILS" | wc -l)" -gt 3 ]; then
       SLACK_SUMMARY="$SLACK_SUMMARY\n... and more"
     fi
   fi
 
   # Send Slack notification with violation summary
-  SLACK_MESSAGE="Warning-level IPA violations found ($WARNING_COUNT violations). 
-
-Top violations:
-$SLACK_SUMMARY
+  SLACK_MESSAGE="Warning-level IPA violations found ($WARNING_COUNT violations).
 
 Jira ticket: https://jira.mongodb.org/browse/$TICKET_KEY"
 

.github/workflows/release-IPA-metrics.yml

@@ -43,10 +43,10 @@ jobs:
         run: |
           node runMetricCollection.js "${{ github.workspace }}/v2.json"
           if [ -f "../outputs/warning-count.txt" ]; then
-            warning_count=$(cat ../outputs/warning-count.txt)
-            echo "warning_count=${warning_count}" >> $GITHUB_OUTPUT
+            warning_count=$(cat "../outputs/warning-count.txt")
+            echo "warning_count=${warning_count}" >> "$GITHUB_OUTPUT"
           else
-            echo "warning_count=0" >> $GITHUB_OUTPUT
+            echo "warning_count=0" >> "$GITHUB_OUTPUT"
           fi
 
       - name: aws configure

tools/spectral/ipa/__tests__/metrics/metricCollection.test.js

@@ -30,6 +30,16 @@ describe('tools/spectral/ipa/metrics/metricCollection.js runMetricCollectionJob'
 
     expect(results).not.toBe(undefined);
     expect(results.metrics.length).toEqual(expectedResults.length);
+    results.metrics.forEach((entry, index) => {
+      const expectedEntry = getEntry(expectedResults, entry['component_id'], entry['ipa_rule']);
+      expect(entry['component_id']).toEqual(expectedEntry['component_id']);
+      expect(entry['adoption_status']).toEqual(expectedEntry['adoption_status']);
+      expect(entry['ipa']).toEqual(expectedEntry['ipa']);
+      expect(entry['ipa_rule']).toEqual(expectedEntry['ipa_rule']);
+      expect(entry['exception_reason']).toEqual(expectedEntry['exception_reason']);
+      expect(entry['owner_team']).toEqual(expectedEntry['owner_team']);
+      expect(entry['severity_level']).toEqual(expectedEntry['severity_level']);
+    });
 
     expect(results.warnings.count).toEqual(1);
     const violations = [
@@ -41,17 +51,6 @@ describe('tools/spectral/ipa/metrics/metricCollection.js runMetricCollectionJob'
       },
     ];
     expect(results.warnings.violations).toEqual(violations);
-
-    results.metrics.forEach((entry, index) => {
-      const expectedEntry = getEntry(expectedResults, entry['component_id'], entry['ipa_rule']);
-      expect(entry['component_id']).toEqual(expectedEntry['component_id']);
-      expect(entry['adoption_status']).toEqual(expectedEntry['adoption_status']);
-      expect(entry['ipa']).toEqual(expectedEntry['ipa']);
-      expect(entry['ipa_rule']).toEqual(expectedEntry['ipa_rule']);
-      expect(entry['exception_reason']).toEqual(expectedEntry['exception_reason']);
-      expect(entry['owner_team']).toEqual(expectedEntry['owner_team']);
-      expect(entry['severity_level']).toEqual(expectedEntry['severity_level']);
-    });
   });
 });
 

tools/spectral/ipa/metrics/outputs/warning-violations.json

@@ -0,0 +1,8 @@
+[
+  {
+    "code": "xgen-IPA-104-valid-operation-id",
+    "message": "IPA rule xgen-IPA-104-valid-operation-id violated",
+    "path": "paths./api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}.get",
+    "source": null
+  }
+]