[WIP][Experiment] zwe TS + PR 4282

.github/scripts/cicd_test/make_matrix.sh

@@ -12,6 +12,12 @@
 
 case $install_test_choice in
 
+"ZWE_CI_Build")
+  test_file="ZWE_CI_Build"
+  ;;
+"ZWE_Full_Tests")
+  test_file="ZWE_Full_Tests"
+  ;;
 "Convenience Pax")
   test_file="$CONVENIENCE_PAX_TESTFILE"
   ;;
@@ -87,6 +93,14 @@ else
   if [[ -z "$dont_parse_test_server" ]]; then
     if [[ "$test_server" == "Any zzow servers" ]]; then
       test_server="zzow"$(printf %02d $(($RANDOM % 3 + 9)))
+    elif [[ "$test_server" == "Any("* ]]; then
+      # keeping this all posix compliant
+      any_options=$(echo "$test_server" | cut -d ")" -f1 | cut -d "(" -f2) # Any(x,y,z) -> x,y,z
+      anyopts_comma_count=$(echo "$any_options" | tr -cd ',' | wc -c)
+      num_choices=$(($anyopts_comma_count + 1))
+      #  add 1 to RANDOM % num_choices because cut won't handle 0-indexed elements
+      server_choice=$(printf %01d $(($RANDOM % $num_choices + 1)))
+      test_server=$(echo $any_options | cut -d "," -f$server_choice) # pick one of x,y,z at random
     fi
     TEST_FILE_SERVER="$test_file($test_server)"
   else

.github/workflows/build-packaging.yml

@@ -236,7 +236,7 @@ jobs:
       - name: '[Prep 7] Comment on PR to indicate build is started'         
         uses: actions/github-script@v5
         id: create-comment
-        if: (github.event_name == 'workflow_dispatch' || github.event_name == 'pull_request') && startsWith(env.CURRENT_BRANCH, 'PR-')
+        if: (github.event_name == 'workflow_dispatch' || github.event_name == 'pull_request') && startsWith(env.CURRENT_BRANCH, 'PR-') &&  !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -404,7 +404,7 @@ jobs:
 
       - name: '[Post Prep 7] Update PR comment to indicate build succeeded'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != '' && success()
+        if: steps.create-comment.outputs.result != '' && success() && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -417,7 +417,7 @@ jobs:
 
       - name: '[Post Prep 7] Update PR comment to indicate build failed'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != '' && failure()
+        if: steps.create-comment.outputs.result != '' && failure() && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -430,7 +430,7 @@ jobs:
 
       - name: '[Post Prep 7] Update PR comment to indicate build cancelled'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != '' && cancelled()
+        if: steps.create-comment.outputs.result != '' && cancelled() && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -485,7 +485,7 @@ jobs:
           workflow-filename: cicd-test.yml
           branch-name: ${{ env.BRANCH_NAME }}
           poll-frequency: 3
-          inputs-json-string: '{"custom-zowe-artifactory-pattern-or-build-number":"${{ github.run_number }}", "install-test": "${{ steps.get-test-suite.outputs.TEST_SUITE }}"}'
+          inputs-json-string: '{"custom-zowe-artifactory-pattern-or-build-number":"${{ github.run_number }}", "install-test": "${{ steps.get-test-suite.outputs.TEST_SUITE }}", "origin-event" : "${{ github.event_name }}"}'
         # env:
         #   DEBUG: 'workflow-remote-call-wait'
 

.github/workflows/cicd-test.yml

@@ -57,6 +57,11 @@ on:
         description: 'random dispatch event id'
         required: false
         type: string
+      origin-event:
+        description: '[Automation] if caller was a pull request' # caller sets var to 'pull_request'
+        type: string
+        required: false
+        default: ''
 
 # create a new branch to overwrite following defaults if necessary
 env:
@@ -93,6 +98,36 @@ env:
   ZOWE_RELEASE_TESTS_FULL: basic/install.ts(all);basic/install-ptf.ts(all);basic/install-ext.ts(any);extended/keyring.ts(all);extended/node-versions/node-v20.ts(any);extended/node-versions/node-v22.ts(any);extended/certificates/nonstrict-verify-external-certificate.ts(any);extended/caching-storages/infinispan-storage.ts(any);extended/config-manager/enable-config-manager.ts(any)
 
 jobs:
+
+  set-run-conditions:
+    runs-on: ubuntu-latest
+    outputs:
+      pr-labels: ${{ steps.get-labels.outputs.result }}
+    steps:
+      - name: 'Get labels'
+        id: get-labels
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            if ('${{ github.event_name}}' == 'pull_request') {
+              return JSON.stringify(${{ toJson(github.event.pull_request.labels) }})
+            }  
+            else if ('${{ github.event.inputs.origin-event }}' == 'pull_request') {
+              const res = await github.rest.pulls.list({
+                state: 'open',
+                head: 'zowe:${{ github.ref_name }}',
+                owner: 'zowe',
+                repo: 'zowe-install-packaging'
+              }).then((resp) => {
+                const pr = resp.data.find((item) => item.head.ref == '${{ github.ref_name }}')
+                return JSON.stringify(pr.labels)
+              })
+              return res;
+            } else {
+              return '[]'
+            }
+
   display-dispatch-event-id:
     if: github.event.inputs.RANDOM_DISPATCH_EVENT_ID != ''
     runs-on: ubuntu-latest
@@ -130,7 +165,7 @@ jobs:
 
   cicd-test:
     runs-on: ubuntu-latest
-    needs: make-matrix
+    needs: [set-run-conditions, make-matrix]
     strategy:
       matrix: ${{ fromJson(needs.make-matrix.outputs.matrix) }}
       fail-fast: false
@@ -234,7 +269,7 @@ jobs:
       - name: '[Comment] Post comments on PR about what tests are gonna be run'
         uses: actions/github-script@v5
         id: create-comment
-        if: startsWith(env.CURRENT_BRANCH, 'PR-')
+        if: startsWith(env.CURRENT_BRANCH, 'PR-') && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -273,7 +308,7 @@ jobs:
 
       - name: '[Comment] Update comment after lock is acquired'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != ''
+        if: steps.create-comment.outputs.result != '' && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -389,7 +424,7 @@ jobs:
 
       - name: '[Comment] Update PR comment to indicate test succeeded'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != '' && success()
+        if: steps.create-comment.outputs.result != '' && success() && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -416,7 +451,7 @@ jobs:
 
       - name: '[Comment] Update PR comment to indicate test failed'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != '' && failure()
+        if: steps.create-comment.outputs.result != '' && failure() && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
@@ -443,7 +478,7 @@ jobs:
 
       - name: '[Comment] Update PR comment to indicate test cancelled'
         uses: actions/github-script@v5
-        if: steps.create-comment.outputs.result != '' && cancelled()
+        if: steps.create-comment.outputs.result != '' && cancelled() && !contains(fromJson(needs.set-run-conditions.outputs.pr-labels), 'CICD_Quiet')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |

.github/workflows/zwe-integration-tests.yml

@@ -0,0 +1,206 @@
+name: Zwe Remote Integration Tests
+
+permissions: 
+  contents: write
+
+on:   
+  pull_request:
+    types: [opened, synchronize]
+  workflow_dispatch:
+    inputs:
+      test-server:
+        description: 'Choose Test Server'
+        type: choice
+        required: true
+        default: 'Any(zzow10,zzow11)'
+        options: 
+          - Any(zzow10,zzow11)
+          - zzow10
+          - zzow11
+          - zzow10,zzow11
+      zwe-test:
+        description: 'Choose Zwe Test'
+        type: choice
+        required: true
+        default: ZWE_CI_Build
+        options:
+          - ZWE_CI_Build
+          - ZWE_Full_Tests
+      RANDOM_DISPATCH_EVENT_ID:
+        description: 'random dispatch event id'
+        required: false
+        type: string
+
+# create a new branch to overwrite following defaults if necessary
+env:
+  # constants
+  ZWE_TEST_PATH: tests/zwe-remote-integration
+
+jobs:
+  display-dispatch-event-id:
+    if: github.event.inputs.RANDOM_DISPATCH_EVENT_ID != ''
+    runs-on: ubuntu-latest
+    steps:
+      - name: RANDOM_DISPATCH_EVENT_ID is ${{ github.event.inputs.RANDOM_DISPATCH_EVENT_ID }}
+        run: echo "prints random dispatch event id sent from workflow dispatch event"
+
+  # necessary for pull_requests without a caller issuing a workflow_dispatch
+  set-test-vars:
+    runs-on: ubuntu-latest
+    outputs:
+      test-suite: ${{ steps.set-test-vars.outputs.test-suite }}
+      test-server: ${{ steps.set-test-vars.outputs.test-server }}
+    steps:
+      - name: 'Set Test Vars'
+        id: set-test-vars
+        run: |
+          if [[ ${{ github.event_name }} == 'workflow_dispatch' ]]; then
+            echo "test-suite=${{ github.event.inputs.zwe-test }}" >> $GITHUB_OUTPUT
+            echo "test-server=${{ github.event.inputs.test-server }}" >> $GITHUB_OUTPUT
+          else
+            echo "test-suite=ZWE_CI_Build" >> $GITHUB_OUTPUT
+            echo "test-server=Any(zzow10,zzow11)" >> $GITHUB_OUTPUT
+          fi
+
+  check-permission:
+    runs-on: ubuntu-latest
+    steps:
+      # this action will fail the whole workflow if permission check fails
+      - name: check permission
+        uses: zowe-actions/shared-actions/permission-check@main
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  make-matrix:
+    runs-on: ubuntu-latest
+    needs: [set-test-vars, check-permission]
+    steps:
+      - name: '[Prep 1] Checkout'
+        uses: actions/checkout@v2
+
+      - name: Make matrix
+        id: set-matrix
+        run: |
+          cd .github/scripts/cicd_test
+          chmod +x make_matrix.sh
+          source make_matrix.sh
+        env:
+          test_server: ${{ needs.set-test-vars.outputs.test-server }}
+          install_test_choice: ${{ needs.set-test-vars.outputs.test-suite }}
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+
+  cicd-test:
+    runs-on: ubuntu-latest
+    needs: make-matrix
+    strategy:
+      matrix: ${{ fromJson(needs.make-matrix.outputs.matrix) }}
+      fail-fast: false
+    environment: ${{ matrix.server }}
+    steps:
+      - name: '[Prep 1] Checkout'
+        uses: actions/checkout@v4
+
+      - name: '[Prep 2] Setup Node'
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: '[Prep 3] Cache node modules'
+        uses: actions/cache@v4
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: |
+            ~/.npm
+            ~/.nvm/.cache
+            ~/.nvm/versions
+          key: ${{ runner.os }}-build-cache-node-modules-${{ hashFiles('tests/installation/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-cache-node-modules-
+
+      - name: '[Prep 4] Setup jFrog CLI'
+        uses: jfrog/setup-jfrog-cli@v2
+        env:
+          JF_ENV_1: ${{ secrets.JF_ARTIFACTORY_TOKEN }}
+
+      - name: '[Prep 5] Validate package.json'
+        uses: zowe-actions/shared-actions/validate-package-json@main
+
+      - name: '[Prep 6] Prepare workflow'
+        uses: zowe-actions/shared-actions/prepare-workflow@main
+
+      - name: '[Setup 1] Test Project Dependencies'
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: |
+          npm ci
+
+      # Error on this step is likely a schema mismatch. See test README
+      - name: '[Setup 2] Test Project Build'
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: |
+          npm run build
+
+      - name: '[Lint 1] Lint 1'
+        timeout-minutes: 2
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: |
+          npm run lint
+
+      - name: '[LOCK] Lock marist servers'
+        uses: zowe-actions/shared-actions/lock-resource@main
+        with:
+          lock-repository: ${{ github.repository }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          lock-resource-name: zowe-zwe-system-test-${{ matrix.server }}-lock
+          lock-avg-retry-interval: 60
+
+      - name: '[Pre-Test] Prepare configuration YAML'
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: echo "$ZWE_INTEGRATION_YAML" > config.yaml
+        shell: bash
+        env:
+          ZWE_INTEGRATION_YAML: ${{ secrets.ZWE_INTEGRATION_YAML }}
+
+      - name: '[Test] CI Test Suite'
+        if: ${{ matrix.test == 'ZWE_CI_Build' }}
+        timeout-minutes: 180
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: npm run test:ci
+        env:
+          TEST_CONFIG_FILE: config.yaml
+          ZOS_HOST: ${{ secrets.SSH_HOST }}
+          ZOS_USER: ${{ secrets.SSH_USER }}
+          ZOS_PASSWORD: ${{ secrets.SSH_PASSWORD }}
+          ZOSMF_PORT: ${{ secrets.ZOSMF_PORT }}
+          SSH_PORT: ${{ secrets.SSH_PORT }}
+          JFROG_USER: ${{ secrets.ZWE_TEST_RT_USER }}
+          JFROG_TOKEN: ${{ secrets.ZWE_TEST_RT_TOKEN }}
+
+      - name: '[Test] Extended Test Suite'
+        if: ${{ matrix.test == 'ZWE_Full_Tests' }}
+        timeout-minutes: 180
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: npm run test:extended
+        env:
+          TEST_CONFIG_FILE: ${{ env.ZWE_TEST_PATH }}/config.yaml
+          ZOS_HOST: ${{ secrets.SSH_HOST }}
+          ZOS_USER: ${{ secrets.SSH_USER }}
+          ZOS_PASSWORD: ${{ secrets.SSH_PASSWORD }}
+          ZOSMF_PORT: ${{ secrets.ZOSMF_PORT }}
+          SSH_PORT: ${{ secrets.SSH_PORT }}
+          JFROG_USER: ${{ secrets.ZWE_TEST_RT_USER }}
+          JFROG_TOKEN: ${{ secrets.ZWE_TEST_RT_TOKEN }}
+
+      - name: '[After Test 1] Prepare to upload test report'
+        if: always()
+        working-directory: ${{ env.ZWE_TEST_PATH }}
+        run: | 
+          echo CURRENT_TIME=$(date +%s) >> $GITHUB_ENV
+          echo TEST_NAME=$(echo "${{ matrix.test }}" | sed 's#.*\/##g') >> $GITHUB_ENV
+
+      - name: '[After Test 2] Upload test report'
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: ZweTestReports-${{ env.TEST_NAME }}-${{ matrix.server }}-${{ github.run_id }}-${{ env.CURRENT_TIME }}
+          path: ${{ env.ZWE_TEST_PATH }}/reports/

CHANGELOG.md

@@ -31,6 +31,9 @@ All notable changes to the Zowe Installer will be documented in this file.
 
 <!--Add the PR or issue number to the entry if available.-->
 
+## `2.18.1`
+- Bugfix: Error message `ZWEL0141E` did not print user ID. [#3971](https://github.com/zowe/zowe-install-packaging/pull/3971)
+
 ## `2.17.0`
 
 ## New features and enhancements